Platform API Documentation

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for srinivasgs from gravatar.com srinivasgs

Unverified details

These details have not been verified by PyPI
Project links
Meta
Report project as malware

Project description

do-sdk-platform

Combined API documentation for all platform services

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

  • API version: 1.0.0
  • Package version: 1.0.0
  • Generator version: 7.16.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 do_sdk_platform

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 do_sdk_platform

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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


# Enter a context with an instance of the API client
with do_sdk_platform.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = do_sdk_platform.AuthenticationApi(api_client)

    try:
        # Get Keycloak Token
        api_response = api_instance.entities_get_protected_service_token()
        print("The response of AuthenticationApi->entities_get_protected_service_token:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AuthenticationApi->entities_get_protected_service_token: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AuthenticationApi entities_get_protected_service_token GET /entities/protected/service/token:create Get Keycloak Token
AuthenticationApi entities_get_public_jwks GET /entities/public/jwks Get Keycloak JWKS
AuthenticationApi entities_refresh_token GET /entities/{orgKey}/token/{serviceName}:refresh Get Keycloak JWKS
BillingApi billing_add_credits POST /billing/{orgKey}/credits Add Credits
BillingApi billing_check GET /billing/health
BillingApi billing_delete_payment DELETE /billing/{orgKey}/payments/{paymentId} Delete payment
BillingApi billing_delete_subscription DELETE /billing/{orgKey}/subscriptions/{subscriptionId}/{immediately} Delete Subscriptions
BillingApi billing_get_active_subscriptions GET /billing/{orgKey}/subscriptions Get Active Subscriptions
BillingApi billing_get_all_subscriptions GET /billing/{orgKey}/subscriptions/all Gets All Subscriptions
BillingApi billing_get_billing_address GET /billing/{orgKey}/address Retrieve billing address
BillingApi billing_get_countries GET /billing/{orgKey}/countries Retrieve available countries
BillingApi billing_get_credit_balance GET /billing/{orgKey}/credits/balance Get Credit Balance
BillingApi billing_get_credit_line GET /billing/{orgKey}/credits/line Get credit line information
BillingApi billing_get_credits_history GET /billing/{orgKey}/credits/history Get Credits History
BillingApi billing_get_credits_usage GET /billing/{orgKey}/credits/usage Get Credits Usage
BillingApi billing_get_feature_descriptions GET /billing/{orgKey}/feature/descriptions Get feature descriptions
BillingApi billing_get_features GET /billing/{orgKey}/features Get Subscription Features
BillingApi billing_get_invoice_pdf_link GET /billing/{orgKey}/invoices/pdfLink/{id} Get invoice PDF link
BillingApi billing_get_invoices GET /billing/{orgKey}/invoices Get Invoices
BillingApi billing_get_monthly_balance GET /billing/{orgKey}/credits/monthly/{month}/{year} Get Monthly Credit Usage
BillingApi billing_get_monthly_overview GET /billing/{orgKey}/usage/monthly/{year}/{month} Get Monthly Overview
BillingApi billing_get_past_subscriptions GET /billing/{orgKey}/subscriptions/past Get Past Subscriptions
BillingApi billing_get_payment GET /billing/{orgKey}/payments List payment methods
BillingApi billing_get_payment_link GET /billing/{orgKey}/invoices/payment/{id}/{tab} Get payment link
BillingApi billing_get_recent_activity GET /billing/{orgKey}/usage/recent Get Recent Activity
BillingApi billing_get_version GET /billing/version Get service version
BillingApi billing_pay POST /billing/{orgKey}/invoices/{invoiceId}/{paymentId} Process payment
BillingApi billing_update_billing_address POST /billing/{orgKey}/address Update billing address
BillingApi billing_update_payment POST /billing/{orgKey}/payments Update payment details
BillingApi billing_update_subscription POST /billing/{orgKey}/subscriptions Updates Subscription
DataPlatformApi data_platform_add_column POST /data-platform/{orgKey}/{entity}/meta/columns Add column to an entity (physical or computed)
DataPlatformApi data_platform_batch_changes POST /data-platform/{orgKey}/{entity}/batch/changes Batch changes (multi-op) for an entity
DataPlatformApi data_platform_batch_create POST /data-platform/{orgKey}/{entity}/batch/create Batch create entities
DataPlatformApi data_platform_batch_delete POST /data-platform/{orgKey}/{entity}/batch/delete Batch delete entities by ids
DataPlatformApi data_platform_batch_truncate POST /data-platform/{orgKey}/{entity}/batch/truncate Truncate an entity (admin)
DataPlatformApi data_platform_batch_update PATCH /data-platform/{orgKey}/{entity}/batch/update Batch update entities by ids
DataPlatformApi data_platform_create_one POST /data-platform/{orgKey}/{entity} Create one entity
DataPlatformApi data_platform_delete_attribute DELETE /data-platform/{orgKey}/meta/attributes/{id} Delete a canonical attribute definition
DataPlatformApi data_platform_delete_column DELETE /data-platform/{orgKey}/{entity}/meta/columns/{name} Soft-delete column for an entity
DataPlatformApi data_platform_delete_one DELETE /data-platform/{orgKey}/{entity}/{id} Soft-delete one entity by id
DataPlatformApi data_platform_get_one GET /data-platform/{orgKey}/{entity}/{id} Get one entity by id
DataPlatformApi data_platform_health GET /data-platform/health
DataPlatformApi data_platform_list_columns GET /data-platform/{orgKey}/{entity}/meta/columns List columns for an entity
DataPlatformApi data_platform_org_health GET /data-platform/{orgKey}/health
DataPlatformApi data_platform_patch_attribute PATCH /data-platform/{orgKey}/meta/attributes/{id} Patch a canonical attribute definition by id
DataPlatformApi data_platform_patch_column_http PATCH /data-platform/{orgKey}/{entity}/meta/columns/{name} Patch column metadata or computed definition
DataPlatformApi data_platform_search POST /data-platform/{orgKey}/{entity}/search Search an entity
DataPlatformApi data_platform_search_attributes POST /data-platform/{orgKey}/meta/attributes/search Search/browse the attribute catalog
DataPlatformApi data_platform_update_one PATCH /data-platform/{orgKey}/{entity}/{id} Update one entity by id (immutable versioning)
DataPlatformApi data_platform_upsert_attribute POST /data-platform/{orgKey}/meta/attributes Upsert a canonical attribute definition
EntitiesApi entities_accept_organization_invite GET /entities/protected/organizations/invites/{code}:accept Accept an organization invite
EntitiesApi entities_check GET /entities/health Check overall service health
EntitiesApi entities_contact_us POST /entities/{orgKey}/organizations/contact/us Submit a contact request
EntitiesApi entities_create_account POST /entities/public/accounts Create Account
EntitiesApi entities_create_organization POST /entities/protected/organizations Create a new organization
EntitiesApi entities_create_signup_code POST /entities/public/accounts/verify Create Signup Code
EntitiesApi entities_create_token POST /entities/protected/accounts/user/tokens Create long-lived personal access token for user.
EntitiesApi entities_delete_organization DELETE /entities/{orgKey}/organizations
EntitiesApi entities_delete_organization_invite DELETE /entities/{orgKey}/organizations/invites/{email}
EntitiesApi entities_delete_organization_member DELETE /entities/{orgKey}/organizations/users/{userId} Delete an organization member
EntitiesApi entities_generate_referral_code POST /entities/protected/users/referral Generate a referral code
EntitiesApi entities_get_account GET /entities/protected/account Get user account
EntitiesApi entities_get_flags GET /entities/protected/account/users/flags Get user flags
EntitiesApi entities_get_keycloak_token GET /entities/{orgKey}/token/{serviceName}:create Get Keycloak Token
EntitiesApi entities_get_notifications GET /entities/{orgKey}/users/notifications/{notificationId}
EntitiesApi entities_get_organization GET /entities/{orgKey}
EntitiesApi entities_get_organization_invite GET /entities/{orgKey}/organizations/invites/{code}
EntitiesApi entities_get_organization_settings GET /entities/{orgKey}/settings
EntitiesApi entities_get_organization_threshold GET /entities/{orgKey}/approvalThreshold
EntitiesApi entities_get_organization_user GET /entities/{orgKey}/organizations/users/{userId} Get organization user details
EntitiesApi entities_get_organization_users GET /entities/{orgKey}/organizations/users List organization users
EntitiesApi entities_get_organizations GET /entities/admin/organizations List Organizations
EntitiesApi entities_get_role_by_email GET /entities/protected/{orgKey}/roles
EntitiesApi entities_get_scopes GET /entities/protected/accounts/user/tokens/scopes List all available scopes.
EntitiesApi entities_get_signup_code GET /entities/public/accounts/verify/{code} Get Signup Code
EntitiesApi entities_get_tokens GET /entities/protected/accounts/user/tokens List of users personal access token.
EntitiesApi entities_get_unique_organization_id GET /entities/protected/organizations/unique/id/{companyName} Generate a unique organization friendly ID
EntitiesApi entities_get_version GET /entities/version Get service version
EntitiesApi entities_invite_organization_member POST /entities/{orgKey}/organizations/invite
EntitiesApi entities_list_notifications GET /entities/{orgKey}/users/notifications Get billing notifications
EntitiesApi entities_list_organizations GET /entities/protected/organizations
EntitiesApi entities_read_notification POST /entities/{orgKey}/users/notifications/{notificationId}/read Mark a notification as read
EntitiesApi entities_revoke_token DELETE /entities/protected/accounts/user/tokens/{tokenId} Revoke user token.
EntitiesApi entities_send_all_notifications DELETE /entities/admin/users/{email} Delete a user
EntitiesApi entities_send_notification_all_users POST /entities/admin/users/notifications/all
EntitiesApi entities_send_notification_to_user POST /entities/{orgKey}/users/{userId}/notifications
EntitiesApi entities_send_notification_user POST /entities/admin/users/notifications/user/{userId}
EntitiesApi entities_update_account PATCH /entities/protected/account Update user account
EntitiesApi entities_update_organization PATCH /entities/{orgKey}
EntitiesApi entities_update_organization_invite_role PATCH /entities/{orgKey}/organizations/invites/{email}
EntitiesApi entities_update_organization_member_role PATCH /entities/{orgKey}/organizations/users/{userId}
EntitiesApi entities_update_organization_status PATCH /entities/{orgKey}/organizations/status
FileApi files_check GET /files/health
FileApi files_delete_object DELETE /files/{orgKey}/{filePath}
FileApi files_get_object GET /files/{orgKey}/{filePath}
FileApi files_get_object_directory GET /files/{orgKey}/directory/{filePath}
FileApi files_get_signed_url GET /files/{orgKey}/signedUrl/{filePath}
FileApi files_get_version GET /files/version Get service version
FileApi files_head_object HEAD /files/{orgKey}/{filePath}
FileApi files_post_url_file POST /files/{orgKey}/{filePath} Upload a file from a URL
FileApi files_put_object PUT /files/{orgKey}/{filePath}
ToolsApi tools_action_tool_execution PATCH /tools/{orgKey}/tools/executions/{executionId}:{action} Updates a Tool
ToolsApi tools_capture_event POST /tools/protected/ulog Capture a custom analytics event
ToolsApi tools_check GET /tools/health
ToolsApi tools_create_function POST /tools/admin/functions/definitions Creates a function
ToolsApi tools_create_tool POST /tools/admin/tools/definitions Creates a new tool definition
ToolsApi tools_delete_function DELETE /tools/tools/admin/functions/{key}/{version}/definitions Deletes a specific version of a function definition
ToolsApi tools_delete_tool DELETE /tools/admin/tools/{toolKey}/{toolVersion}/definitions Deletes a specific version of a tool definition
ToolsApi tools_enable_disable_function PUT /tools/tools/admin/functions/{key}/{version}/definitions Enable or disable a specific version of a function
ToolsApi tools_execute_tool POST /tools/{orgKey}/tools/{toolKey}/executions Executes a Tool
ToolsApi tools_execute_tool_with_version POST /tools/{orgKey}/tools/{toolKey}/{toolVersion}/executions Executes a Tool with a version
ToolsApi tools_get_admin_tool_executions GET /tools/admin/tools/executions List admin tool executions
ToolsApi tools_get_all_tools GET /tools/protected/tools/definitions Get all tools definition
ToolsApi tools_get_connection GET /tools/message-communication Check connection status
ToolsApi tools_get_function GET /tools/protected/functions/{key}/{version} Gets a function by key and version
ToolsApi tools_get_functions GET /tools/protected/functions/definitions Gets all functions
ToolsApi tools_get_functions_bykey GET /tools/protected/functions/{key}/definitions Gets all versions of function key
ToolsApi tools_get_tool GET /tools/protected/tools/{toolKey}/definitions Get all versions of a tool definition
ToolsApi tools_get_tool_execution GET /tools/{orgKey}/tools/executions/{executionId} Gets a Tool
ToolsApi tools_get_tool_executions GET /tools/{orgKey}/tools/executions Gets Paginated Tools Executions
ToolsApi tools_get_version GET /tools/version Get service version
ToolsApi tools_get_versioned_tool GET /tools/protected/tools/{toolKey}/{toolVersion}/definitions Get a specific version of a tool definition
ToolsApi tools_list_clusters GET /tools/{orgKey}/clusters List Clusters by Org ID
ToolsApi tools_run_function POST /tools/{orgKey}/functions/{key}/{version} Runs a function (specific version)
ToolsApi tools_run_function_latest POST /tools/{orgKey}/functions/{key} Runs a function (latest version)
ToolsApi tools_update_execution PATCH /tools/{orgKey}/tools/executions/{resourceId} Updates a Tool
ToolsApi tools_update_function PUT /tools/admin/functions/{key}/{version} Updates a specific version of a function
ToolsApi tools_update_tool PUT /tools/admin/tools/{toolKey}/{toolVersion}/definitions Updates a specific version of a tool definition

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearer

  • Type: Bearer authentication (JWT)

api-key

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

keycloak

  • Type: Bearer authentication (JWT)

bearerAuth

  • Type: Bearer authentication (JWT)

basic

  • Type: HTTP basic authentication

Author

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for srinivasgs from gravatar.com srinivasgs

Unverified details

These details have not been verified by PyPI
Project links
Meta

Release history Release notifications | RSS feed

This version

6.3.0

6.2.0

6.1.0

6.0.3

6.0.2

6.0.1

6.0.0

5.0.0

4.0.0

3.2.0

3.1.0

3.0.0

2.1.0

2.0.0

1.1.0

1.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

do_sdk_platform-6.3.0.tar.gz (181.2 kB view details)

Uploaded Source

File details

Details for the file do_sdk_platform-6.3.0.tar.gz.

File metadata

  • Download URL: do_sdk_platform-6.3.0.tar.gz
  • Upload date:
  • Size: 181.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for do_sdk_platform-6.3.0.tar.gz
Algorithm Hash digest
SHA256 3ce6829e07caef8788f536a40e7eeb97ec78c79db12e5eb095bf139bc25cb49d
MD5 8c982d80cceda1b83d9c04f39750b472
BLAKE2b-256 122ee0525d57406dc53c302605a0fe3500cacf57740e4c9bc167b9d06be482be

See more details on using hashes here.

Provenance

The following attestation bundles were made for do_sdk_platform-6.3.0.tar.gz:

Publisher: platform.yaml on deeporiginbio/generated-sdks

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page