Skip to content

EdgeMetric/mm-sdk-py

BranchesTags

Repository files navigation

openapi-client

Mammoth API : helps you do use mammoth app functionalities via API.

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

  • API version: 0.1.0
  • Package version: 1.0.0
  • Generator version: 7.10.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://mammoth.io

Requirements.

Python 3.8+

Installation & Usage

pip install

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

pip install git+https://github.com/EdgeMetric/mm-sdk-py.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/EdgeMetric/mm-sdk-py.git)

Then import the package:

import openapi_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 openapi_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "/api/v2"
)

# 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 API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

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

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

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


# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.AcceptInviteApi(api_client)
    accept_invite_schema = openapi_client.AcceptInviteSchema() # AcceptInviteSchema | 

    try:
        # Accept invitation to workspace
        api_instance.accept_invite(accept_invite_schema)
    except ApiException as e:
        print("Exception when calling AcceptInviteApi->accept_invite: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to /api/v2

Class Method HTTP request Description
AcceptInviteApi accept_invite POST /accept-invite Accept invitation to workspace
AppUsageApi get_app_usage GET /workspaces/{workspace_id}/app-usage Get app usage details
BatchesApi create_batch POST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/batches Create batch
BatchesApi delete_batch DELETE /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/batches/{batch_id} Delete batch
BatchesApi delete_batches DELETE /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/batches Delete multiple batches
BatchesApi get_batch GET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/batches/{batch_id} List batches
BatchesApi get_batches GET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/batches List batches
BatchesApi update_batches PATCH /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/batches Update batches
BrowseApi browse_folder_folders GET /workspaces/{workspace_id}/projects/{project_id}/folders/{folder_id}/browse Browse and discover folder resources
BrowseApi browse_project_projects GET /workspaces/{workspace_id}/projects/{project_id}/browse Browse and discover project resources
BrowseApi browse_resources GET /browse Browse and discover resources
BrowseApi browse_workspace_workspaces GET /workspaces/{workspace_id}/browse Browse and discover workspace resources
ChargebeePlanApi get_chargebee_plan GET /workspaces/{workspace_id}/chargebee-plan Get Chargebee plan
ClientAppsApi app_details GET /workspaces/{workspace_id}/clientapps/{client_key} Get client app details
ClientAppsApi create_app POST /workspaces/{workspace_id}/clientapps Create api tokens to access api
ClientAppsApi delete_app DELETE /workspaces/{workspace_id}/clientapps/{client_key} Delete a client app
ClientAppsApi list_apps GET /workspaces/{workspace_id}/clientapps Get list of client apps
ClientAppsApi update_app PATCH /workspaces/{workspace_id}/clientapps/{client_key} Update client app
ConnectionsApi delete_connection DELETE /workspaces/{workspace_id}/projects/{project_id}/connectors/{connector_key}/connections/{connection_key} Delete Connection
ConnectionsApi get_connection GET /workspaces/{workspace_id}/projects/{project_id}/connectors/{connector_key}/connections/{connection_key} Get Connection
ConnectionsApi list_connections GET /workspaces/{workspace_id}/projects/{project_id}/connectors/{connector_key}/connections List Connections
ConnectionsApi save_connection POST /workspaces/{workspace_id}/projects/{project_id}/connectors/{connector_key}/connections Create Connection
ConnectionsApi update_connection PATCH /workspaces/{workspace_id}/projects/{project_id}/connectors/{connector_key}/connections/{connection_key} Update Connection
ConnectorsApi get_connector GET /workspaces/{workspace_id}/connectors/{connector_key} Get connector details
ConnectorsApi list_connectors GET /workspaces/{workspace_id}/connectors List connectors
DatasetsApi create_datasets POST /workspaces/{workspace_id}/projects/{project_id}/datasets Create dataset
DatasetsApi delete_dataset DELETE /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id} Delete dataset
DatasetsApi delete_datasets DELETE /workspaces/{workspace_id}/projects/{project_id}/datasets Delete multiple datasets
DatasetsApi get_dataset GET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id} Get dataset details
DatasetsApi get_dataset_data GET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/data Get dataset data
DatasetsApi get_datasets GET /workspaces/{workspace_id}/projects/{project_id}/datasets Get list of datasets
DatasetsApi update_dataset PATCH /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id} Update dataset
DatasetsApi update_datasets PATCH /workspaces/{workspace_id}/projects/{project_id}/datasets Update datasets name
DataviewPipelineApi edit_pipeline PATCH /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline Edit and perform bulk operations on a dataview pipeline
DataviewPipelineApi get_pipeline GET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline Get dataview pipeline information
DataviewPipelineExportApi delete_export DELETE /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/exports/{export_id} Delete an export
DataviewPipelineExportApi edit_export PATCH /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/exports/{export_id} Edit a dataview pipeline export
DataviewPipelineExportApi get_pipeline_export GET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/exports/{export_id} Get dataview pipeline export information
DataviewPipelineExportsApi add_export POST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/exports Add a export in the pipeline
DataviewPipelineExportsApi get_pipeline_exports GET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/exports Get dataview pipeline exports information
DataviewPipelineItemsApi get_pipeline_items GET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/items Get dataview pipeline items
DataviewPipelineTaskApi delete_task DELETE /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/tasks/{task_id} Delete a task
DataviewPipelineTaskApi edit_task PATCH /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/tasks/{task_id} Edit a dataview pipeline task
DataviewPipelineTaskApi get_pipeline_task GET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/tasks/{task_id} Get dataview pipeline task information
DataviewPipelineTasksApi add_task POST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/tasks Add a task in the pipeline
DataviewPipelineTasksApi get_pipeline_tasks GET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/tasks Get dataview pipeline tasks information
DataviewsApi add_dataview POST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews Create or duplicate dataview
DataviewsApi delete_dataview DELETE /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id} Delete dataview safely
DataviewsApi delete_multiple_dataviews DELETE /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews Delete multiple dataviews
DataviewsApi get_active_users GET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/activities Get list of active users on this dataview
DataviewsApi get_dataview_data GET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/data Get dataview data
DataviewsApi get_dataview_data_post POST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/data Get dataview data
DataviewsApi get_dataview_information_individual GET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id} Get dataview information
DataviewsApi list_dataviews GET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews Get list of dataviews present in a dataset
DataviewsApi mark_active_user POST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/activities Mark active user on this dataview
DataviewsApi patch PATCH /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id} Patch dataview
DeauthorizationApi delete_user_data POST /gdpr_hooks/{integration_name}/deauthorization Delete user's data from the system
DsConfigApi delete_ds_config DELETE /workspaces/{workspace_id}/projects/{project_id}/connectors/{connector_key}/connections/{connection_key}/ds_configs/{ds_config_key} Delete ds config
DsConfigApi delete_ds_configs DELETE /workspaces/{workspace_id}/projects/{project_id}/connectors/{connector_key}/connections/{connection_key}/ds_configs Delete ds configs
DsConfigApi get_ds_config GET /workspaces/{workspace_id}/projects/{project_id}/connectors/{connector_key}/connections/{connection_key}/ds_configs/{ds_config_key} Get ds config details
DsConfigApi list_ds_configs GET /workspaces/{workspace_id}/projects/{project_id}/connectors/{connector_key}/connections/{connection_key}/ds_configs List ds configs
DsConfigApi update_ds_configs PATCH /workspaces/{workspace_id}/projects/{project_id}/connectors/{connector_key}/connections/{connection_key}/ds_configs/{ds_config_key} Validate and get sample data
DsConfigApi validate_and_get_ds_config POST /workspaces/{workspace_id}/projects/{project_id}/connectors/{connector_key}/connections/{connection_key}/ds_configs Validate and get sample data
FilesApi delete_file DELETE /workspaces/{workspace_id}/projects/{project_id}/files/{file_id} Delete file
FilesApi delete_files DELETE /workspaces/{workspace_id}/projects/{project_id}/files Delete files
FilesApi get_file_details GET /workspaces/{workspace_id}/projects/{project_id}/files/{file_id} Get file details
FilesApi list_files GET /workspaces/{workspace_id}/projects/{project_id}/files List files
FilesApi update_file_configs PATCH /workspaces/{workspace_id}/projects/{project_id}/files/{file_id} Updates the file configs
JobsApi get_job GET /jobs/{job_id} Get job by id
JobsApi get_jobs GET /jobs Track multiple job ids
PreferencesApi get_user_preferences GET /preferences Fetch user preferences
PreferencesApi update_user_preferences PATCH /preferences Update user preferences
ProjectsApi add_user_project POST /workspaces/{workspace_id}/projects/{project_id}/users Add user to a project
ProjectsApi create_project POST /workspaces/{workspace_id}/projects Create a new project in given workspace
ProjectsApi delete_project DELETE /workspaces/{workspace_id}/projects/{project_id} Delete a project
ProjectsApi get_project GET /workspaces/{workspace_id}/projects Get list of projects
ProjectsApi remove_user_project DELETE /workspaces/{workspace_id}/projects/{project_id}/users Remove user from a project
ProjectsApi update_project PATCH /workspaces/{workspace_id}/projects/{project_id} Update a project
ProjectsApi update_user_project PATCH /workspaces/{workspace_id}/projects/{project_id}/users Update user role on a project
RegistrationSupportApi register_user POST /support/users Register a user
RegistrationSupportApi update_user_verification PATCH /support/users Update user details
SchedulesApi create_schedule POST /workspaces/{workspace_id}/projects/{project_id}/schedules Create schedule
SchedulesApi delete_schedule DELETE /workspaces/{workspace_id}/projects/{project_id}/schedules/{schedule_id} Delete schedule data
SchedulesApi get_schedule GET /workspaces/{workspace_id}/projects/{project_id}/schedules/{schedule_id} Get schedule data
SchedulesApi list_schedules GET /workspaces/{workspace_id}/projects/{project_id}/schedules Get list of schedules
SchedulesApi patch_schedule PATCH /workspaces/{workspace_id}/projects/{project_id}/schedules/{schedule_id} Patch schedule related data
SelfApi delete_avatar DELETE /self/avatar Delete profile picture
SelfApi get_user_details GET /self Get request user details
SelfApi update_user PATCH /self Update user details
SelfApi upload_profile_pic POST /self/avatar Add profile picture
ShopifyPrivacyWebhooksApi shopify_customer_redact POST /gdpr_hooks/shopify/customers/redact Delete requested shopify customer orders data from the system
ShopifyPrivacyWebhooksApi shopify_data_request POST /gdpr_hooks/shopify/customers/data_request Get requested data of shopify user
ShopifyPrivacyWebhooksApi shopify_shop_redact POST /gdpr_hooks/shopify/shop/redact Delete requested shopify shop's data from the system
SubscriptionApi fetch_hosted_page POST /workspaces/{workspace_id}/subscription/hosted-page Get hosted pages
SubscriptionApi get_invoice GET /workspaces/{workspace_id}/subscription/invoices/{invoice_id} Get associated plan details
SubscriptionApi get_wksp_subscription_detail GET /workspaces/{workspace_id}/subscription Get subscription details
SubscriptionApi list_invoices GET /workspaces/{workspace_id}/subscription/invoices List all invoices
SubscriptionApi update_subscription_detail PATCH /workspaces/{workspace_id}/subscription Update subscription details
SubscriptionsSupportApi get_plans GET /support/sms Get available plans and other chargebee resources
SubscriptionsSupportApi get_subscription_detail GET /support/workspaces/{workspace_id}/sms Get subscription details
SubscriptionsSupportApi register_subscription POST /support/workspaces/{workspace_id}/sms Create subscription for workspace
SubscriptionsSupportApi update_subscription PATCH /support/workspaces/{workspace_id}/sms Update subscription for workspace
UsersSupportApi add_user_to_workspace POST /support/workspaces/{workspace_id}/users Add a user to the workspace
UsersSupportApi get_user_list GET /support/workspaces/{workspace_id}/users Get users list
UsersSupportApi remove_workspace_user DELETE /support/workspaces/{workspace_id}/users/{user_id} Remove a user in a workspace
UsersSupportApi transfer_user_roles PATCH /support/workspaces/{workspace_id}/users Transfer workspace ownership
WebhooksApi add_data_to_webhook POST /webhooks/data/{webhook_uri} Add data to webhook
WebhooksApi add_data_to_webhook_using_get_method GET /webhooks/data/{webhook_uri} Add data to the webhook
WebhooksApi create_a_webhook POST /workspaces/{workspace_id}/projects/{project_id}/webhooks Create a webhook
WebhooksApi delete_webhook DELETE /workspaces/{workspace_id}/projects/{project_id}/webhooks/{webhook_id} Delete webhook
WebhooksApi get_webhook_details GET /workspaces/{workspace_id}/projects/{project_id}/webhooks/{webhook_id} Get webhook details
WebhooksApi list_webhooks GET /workspaces/{workspace_id}/projects/{project_id}/webhooks List webhooks
WebhooksApi update_webhook_configurations PATCH /workspaces/{workspace_id}/projects/{project_id}/webhooks/{webhook_id} Updates the webhook
WorkspacesApi add_user_in_workspace POST /workspaces/{workspace_id}/users Add user in workspace
WorkspacesApi get_users_in_workspace GET /workspaces/{workspace_id}/users Get users in workspace
WorkspacesApi get_workspace GET /workspaces/{workspace_id} Get workspace details
WorkspacesApi get_workspaces GET /workspaces Get workspaces
WorkspacesApi remove_user DELETE /workspaces/{workspace_id}/users/{user_id} Remove user from workspace
WorkspacesApi remove_user_from_workspace DELETE /workspaces/{workspace_id}/users Remove users or invites from workspace
WorkspacesApi update_user_in_workspace PATCH /workspaces/{workspace_id}/users/{user_id} Change user role in workspace
WorkspacesApi update_user_to_workspace PATCH /workspaces/{workspace_id}/users Resend invite, remove invitation, or change role in workspace
WorkspacesApi update_workspace PATCH /workspaces/{workspace_id} Update workspace
WorkspacesSupportApi create_workspaces POST /support/workspaces Create new workspace
WorkspacesSupportApi delete_workspace DELETE /support/workspaces/{workspace_id} Delete a workspace
WorkspacesSupportApi get_workspace_detail GET /support/workspaces/{workspace_id} Get workspace details
WorkspacesSupportApi list_workspaces GET /support/workspaces Get workspaces list

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

apiKey

  • Type: API key
  • API key parameter name: X-API-KEY
  • Location: HTTP header

apiSecret

  • Type: API key
  • API key parameter name: X-API-SECRET
  • Location: HTTP header

Author

support@mammoth.io

About

Python SDK for Mammoth Analyics

mammoth.io/

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages