@mammoth_developer/mm-sdk-ts

v1.0.3

Published

4 months ago

OpenAPI client for @mammoth_developer/mm-sdk-ts

0High
0Medium
0Low

axios typescript openapi-client openapi-generator @mammoth_developer/mm-sdk-ts

@mammoth_developer/[email protected]

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

Node.js
Webpack
Browserify

Language level

ES5 - you must have a Promises/A+ library installed
ES6

Module system

CommonJS
ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @mammoth_developer/[email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to /api/v2

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AcceptInviteApi | acceptInvite | POST /accept-invite | Accept invitation to workspace AppUsageApi | getAppUsage | GET /workspaces/{workspace_id}/app-usage | Get app usage details AutomationsApi | createAutomation | POST /workspaces/{workspace_id}/projects/{project_id}/automations | Create automation AutomationsApi | deleteAutomation | DELETE /workspaces/{workspace_id}/projects/{project_id}/automations/{automation_id} | Delete automation and its tasks AutomationsApi | getAutomation | GET /workspaces/{workspace_id}/projects/{project_id}/automations/{automation_id} | Get automation data AutomationsApi | getList | GET /workspaces/{workspace_id}/projects/{project_id}/automations | Get list of automations AutomationsApi | updateAutomation | PATCH /workspaces/{workspace_id}/projects/{project_id}/automations/{automation_id} | Update automation related data BatchesApi | createBatch | POST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/batches | Create batch BatchesApi | deleteBatch | DELETE /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/batches/{batch_id} | Delete batch BatchesApi | deleteBatches | DELETE /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/batches | Delete multiple batches BatchesApi | getBatch | GET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/batches/{batch_id} | List batches BatchesApi | getBatches | GET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/batches | List batches BatchesApi | updateBatches | PATCH /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/batches | Update batches BrowseApi | browseFolderFolders | GET /workspaces/{workspace_id}/projects/{project_id}/folders/{folder_id}/browse | Browse and discover folder resources BrowseApi | browseProjectProjects | GET /workspaces/{workspace_id}/projects/{project_id}/browse | Browse and discover project resources BrowseApi | browseResources | GET /browse | Browse and discover resources BrowseApi | browseWorkspaceWorkspaces | GET /workspaces/{workspace_id}/browse | Browse and discover workspace resources ChargebeePlanApi | getChargebeePlan | GET /workspaces/{workspace_id}/chargebee-plan | Get Chargebee plan ClientAppsApi | appDetails | GET /workspaces/{workspace_id}/clientapps/{client_key} | Get client app details ClientAppsApi | createApp | POST /workspaces/{workspace_id}/clientapps | Create api tokens to access api ClientAppsApi | deleteApp | DELETE /workspaces/{workspace_id}/clientapps/{client_key} | Delete a client app ClientAppsApi | listApps | GET /workspaces/{workspace_id}/clientapps | Get list of client apps ClientAppsApi | updateApp | PATCH /workspaces/{workspace_id}/clientapps/{client_key} | Update client app ConditionalFormatApi | createConditionalFormat | POST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/conditional-format | create conditional format ConditionalFormatApi | deleteConditionalFormat | DELETE /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/conditional-format | delete conditional format ConditionalFormatApi | getConditionalFormat | GET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/conditional-format | get conditional format ConditionalFormatApi | updateConditionalFormat | PATCH /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/conditional-format | update conditional format ConnectionsApi | deleteConnection | DELETE /workspaces/{workspace_id}/projects/{project_id}/connectors/{connector_key}/connections/{connection_key} | Delete Connection ConnectionsApi | getConnection | GET /workspaces/{workspace_id}/projects/{project_id}/connectors/{connector_key}/connections/{connection_key} | Get Connection ConnectionsApi | listConnections | GET /workspaces/{workspace_id}/projects/{project_id}/connectors/{connector_key}/connections | List Connections ConnectionsApi | saveConnection | POST /workspaces/{workspace_id}/projects/{project_id}/connectors/{connector_key}/connections | Create Connection ConnectionsApi | updateConnection | PATCH /workspaces/{workspace_id}/projects/{project_id}/connectors/{connector_key}/connections/{connection_key} | Update Connection ConnectorProfilesApi | addConnectorToProfile | POST /subscription/connector-profiles/{profile_id}/connectors | Add connector to profile ConnectorProfilesApi | createConnectorProfile | POST /subscription/connector-profiles | Create a new connector profile ConnectorProfilesApi | deleteConnectorProfile | DELETE /subscription/connector-profiles/{profile_id} | Delete a connector profile ConnectorProfilesApi | listConnectorProfiles | GET /subscription/connector-profiles | List all connector profiles ConnectorProfilesApi | updateConnectorProfile | PUT /subscription/connector-profiles/{profile_id} | Update a connector profile ConnectorsApi | createConnector | POST /subscription/connectors | Create a new connector ConnectorsApi | deleteConnector | DELETE /subscription/connectors/{connector_id} | Delete a connector ConnectorsApi | getConnector | GET /workspaces/{workspace_id}/connectors/{connector_key} | Get connector details ConnectorsApi | listSubscriptionConnectors | GET /subscription/connectors | List all connectors ConnectorsApi | listWorkspaceConnectors | GET /workspaces/{workspace_id}/connectors | List connectors ConnectorsApi | updateConnector | PUT /subscription/connectors/{connector_id} | Update a connector DatasetsApi | createDatasets | POST /workspaces/{workspace_id}/projects/{project_id}/datasets | Create dataset DatasetsApi | deleteDataset | DELETE /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id} | Delete dataset DatasetsApi | deleteDatasets | DELETE /workspaces/{workspace_id}/projects/{project_id}/datasets | Delete multiple datasets DatasetsApi | getDataset | GET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id} | Get dataset details DatasetsApi | getDatasetData | GET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/data | Get dataset data DatasetsApi | getDatasets | GET /workspaces/{workspace_id}/projects/{project_id}/datasets | Get list of datasets DatasetsApi | updateDataset | PATCH /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id} | Update dataset DatasetsApi | updateDatasets | PATCH /workspaces/{workspace_id}/projects/{project_id}/datasets | Update datasets name DataviewPipelineApi | editPipeline | PATCH /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline | Edit and perform bulk operations on a dataview pipeline DataviewPipelineApi | getPipeline | GET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline | Get dataview pipeline information DataviewPipelineExportApi | deleteExport | DELETE /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/exports/{export_id} | Delete an export DataviewPipelineExportApi | editExport | PATCH /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/exports/{export_id} | Edit a dataview pipeline export DataviewPipelineExportApi | getPipelineExport | GET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/exports/{export_id} | Get dataview pipeline export information DataviewPipelineExportsApi | addExport | POST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/exports | Add a export in the pipeline DataviewPipelineExportsApi | getPipelineExports | GET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/exports | Get dataview pipeline exports information DataviewPipelineItemsApi | getPipelineItems | GET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/items | Get dataview pipeline items DataviewPipelineTaskApi | deleteTask | DELETE /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/tasks/{task_id} | Delete a task DataviewPipelineTaskApi | editTask | PATCH /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/tasks/{task_id} | Edit a dataview pipeline task DataviewPipelineTaskApi | getPipelineTask | GET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/tasks/{task_id} | Get dataview pipeline task information DataviewPipelineTasksApi | addTask | POST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/tasks | Add a task in the pipeline DataviewPipelineTasksApi | getPipelineTasks | GET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/pipeline/tasks | Get dataview pipeline tasks information DataviewsApi | addDataview | POST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews | Create or duplicate dataview DataviewsApi | aiSuggestions | POST /workspaces/{workspace_id}/projects/{project_id}/suggestions | Generate AI-based Suggestions for Dataview DataviewsApi | deleteDataview | DELETE /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id} | Delete dataview safely DataviewsApi | deleteMultipleDataviews | DELETE /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews | Delete multiple dataviews DataviewsApi | generateProfile | POST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/profile_generation | Generate or Update Dataset Profile DataviewsApi | generateSql | POST /workspaces/{workspace_id}/projects/{project_id}/sql_generation | Generate SQL query based on intent DataviewsApi | getActiveUsers | GET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/activities | Get list of active users on this dataview DataviewsApi | getDataviewData | GET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/data | Get dataview data DataviewsApi | getDataviewDataPost | POST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/data | Get dataview data DataviewsApi | getDataviewInformationIndividual | GET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id} | Get dataview information DataviewsApi | listDataviews | GET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews | Get list of dataviews present in a dataset DataviewsApi | markActiveUser | 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 | deleteUserData | POST /gdpr_hooks/{integration_name}/deauthorization | Delete user's data from the system DsConfigApi | deleteDsConfig | DELETE /workspaces/{workspace_id}/projects/{project_id}/connectors/{connector_key}/connections/{connection_key}/ds_configs/{ds_config_key} | Delete ds config DsConfigApi | deleteDsConfigs | DELETE /workspaces/{workspace_id}/projects/{project_id}/connectors/{connector_key}/connections/{connection_key}/ds_configs | Delete ds configs DsConfigApi | getDsConfig | GET /workspaces/{workspace_id}/projects/{project_id}/connectors/{connector_key}/connections/{connection_key}/ds_configs/{ds_config_key} | Get ds config details DsConfigApi | listDsConfigs | GET /workspaces/{workspace_id}/projects/{project_id}/connectors/{connector_key}/connections/{connection_key}/ds_configs | List ds configs DsConfigApi | updateDsConfigs | PATCH /workspaces/{workspace_id}/projects/{project_id}/connectors/{connector_key}/connections/{connection_key}/ds_configs/{ds_config_key} | Validate and get sample data DsConfigApi | validateAndGetDsConfig | POST /workspaces/{workspace_id}/projects/{project_id}/connectors/{connector_key}/connections/{connection_key}/ds_configs | Validate and get sample data ExternalKeyApi | deleteExternalKey | DELETE /workspaces/{workspace_id}/external_keys/{key_id} | Delete an external key ExternalKeyApi | getExternalKey | GET /workspaces/{workspace_id}/external_keys/{key_id} | Get the given external key ExternalKeysApi | addExternalKey | POST /workspaces/{workspace_id}/external_keys | Add external keys to access the intended services ExternalKeysApi | getKeysByWorkspaceId | GET /workspaces/{workspace_id}/external_keys | Get external keys of the given Workspace ID FeatureProfilesApi | addFeatureToProfile | POST /subscription/feature-profiles/{profile_id}/features | Add feature to profile FeatureProfilesApi | createFeatureProfile | POST /subscription/feature-profiles | Create a new feature profile FeatureProfilesApi | deleteFeatureProfile | DELETE /subscription/feature-profiles/{profile_id} | Delete a feature profile FeatureProfilesApi | listFeatureProfiles | GET /subscription/feature-profiles | List all feature profiles FeatureProfilesApi | updateFeatureProfile | PUT /subscription/feature-profiles/{profile_id} | Update a feature profile FeaturesApi | createFeature | POST /subscription/features | Create a new feature FeaturesApi | deleteFeature | DELETE /subscription/features/{feature_id} | Delete a feature FeaturesApi | listFeatures | GET /subscription/features | List all features FeaturesApi | updateFeature | PUT /subscription/features/{feature_id} | Update a feature FilesApi | createFileDataset | POST /workspaces/{workspace_id}/projects/{project_id}/files | Upload file or folder FilesApi | deleteFile | DELETE /workspaces/{workspace_id}/projects/{project_id}/files/{file_id} | Delete file FilesApi | deleteFiles | DELETE /workspaces/{workspace_id}/projects/{project_id}/files | Delete files FilesApi | getFileDetails | GET /workspaces/{workspace_id}/projects/{project_id}/files/{file_id} | Get file details FilesApi | listFiles | GET /workspaces/{workspace_id}/projects/{project_id}/files | List files FilesApi | updateFileConfigs | PATCH /workspaces/{workspace_id}/projects/{project_id}/files/{file_id} | Updates the file configs FoldersApi | createFolder | POST /workspaces/{workspace_id}/projects/{project_id}/folders | Create Folder FoldersApi | deleteFolder | DELETE /workspaces/{workspace_id}/projects/{project_id}/folders/{folder_id} | Delete Folder FoldersApi | deleteFolders | DELETE /workspaces/{workspace_id}/projects/{project_id}/folders | Delete folders FoldersApi | getFolder | GET /workspaces/{workspace_id}/projects/{project_id}/folders/{folder_id} | Get Folder Details FoldersApi | listFolders | GET /workspaces/{workspace_id}/projects/{project_id}/folders | List folders FoldersApi | updateFolderDetails | PATCH /workspaces/{workspace_id}/projects/{project_id}/folders/{folder_id} | Updates the folder details FoldersApi | updateFolderResources | PATCH /workspaces/{workspace_id}/projects/{project_id}/folders | Move resources from/to folder GenerateAIDataApi | aiSuggestions | POST /workspaces/{workspace_id}/projects/{project_id}/suggestions | Generate AI-based Suggestions for Dataview GenerateAIDataApi | getValidationInfo | GET /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/data/generate | Get validation information GenerateAIDataApi | preview | POST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/data/generate | Generate AI preview data for a dataview for the given sequence GenerateProfileApi | generateProfile | POST /workspaces/{workspace_id}/projects/{project_id}/datasets/{dataset_id}/dataviews/{dataview_id}/profile_generation | Generate or Update Dataset Profile JobsApi | getJob | GET /jobs/{job_id} | Get job by id JobsApi | getJobs | GET /jobs | Track multiple job ids OwnerUserControlSettingsApi | listUsersOfWorkspaces | GET /settings/users | List users of all workspaces OwnerUserControlSettingsApi | transferOwnerships | PATCH /settings/users | Transfer ownerships of the workspaces PreferencesApi | getUserPreferences | GET /preferences | Fetch user preferences PreferencesApi | updateUserPreferences | PATCH /preferences | Update user preferences ProjectsApi | addUserProject | POST /workspaces/{workspace_id}/projects/{project_id}/users | Add user to a project ProjectsApi | createProject | POST /workspaces/{workspace_id}/projects | Create a new project in given workspace ProjectsApi | deleteProject | DELETE /workspaces/{workspace_id}/projects/{project_id} | Delete a project ProjectsApi | deleteProjects | DELETE /workspaces/{workspace_id}/projects | Delete multiple projects ProjectsApi | getPendingChanges | GET /workspaces/{workspace_id}/projects/{project_id}/pending-changes | Get pending changes for a project ProjectsApi | getProject | GET /workspaces/{workspace_id}/projects | Get list of projects ProjectsApi | getResourceStatus | GET /workspaces/{workspace_id}/projects/{project_id}/resource-status | Get resource status ProjectsApi | removeUserProject | DELETE /workspaces/{workspace_id}/projects/{project_id}/users | Remove user from a project ProjectsApi | updateProject | PATCH /workspaces/{workspace_id}/projects/{project_id} | Update a project ProjectsApi | updateProjects | PATCH /workspaces/{workspace_id}/projects | Update multiple projects by adding/removing users or changing roles of the users ProjectsApi | updateUserProject | PATCH /workspaces/{workspace_id}/projects/{project_id}/users | Update user role on a project QueryGenApi | getChatStatus | GET /workspaces/{workspace_id}/projects/{project_id}/connectors/{connector_key}/connections/{connection_key}/chat | Get status QueryGenApi | getQuerySuggestion | POST /workspaces/{workspace_id}/projects/{project_id}/connectors/{connector_key}/connections/{connection_key}/chat | Generate query RegistrationSupportApi | registerUser | POST /support/users | Register a user RegistrationSupportApi | updateUserVerification | PATCH /support/users | Update user details ReportsApi | getReports | GET /reports | Get list of reports SQLGenerationApi | generateSql | POST /workspaces/{workspace_id}/projects/{project_id}/sql_generation | Generate SQL query based on intent SchedulesApi | createSchedule | POST /workspaces/{workspace_id}/projects/{project_id}/schedules | Create schedule SchedulesApi | deleteSchedule | DELETE /workspaces/{workspace_id}/projects/{project_id}/schedules/{schedule_id} | Delete schedule data SchedulesApi | getSchedule | GET /workspaces/{workspace_id}/projects/{project_id}/schedules/{schedule_id} | Get schedule data SchedulesApi | listSchedules | GET /workspaces/{workspace_id}/projects/{project_id}/schedules | Get list of schedules SchedulesApi | patchSchedule | PATCH /workspaces/{workspace_id}/projects/{project_id}/schedules/{schedule_id} | Patch schedule related data SelfApi | deleteAvatar | DELETE /self/avatar | Delete profile picture SelfApi | deleteSelf | DELETE /self | Delete self SelfApi | getUserDetails | GET /self | Get request user details SelfApi | updateUser | PATCH /self | Update user details SelfApi | uploadProfilePic | POST /self/avatar | Add profile picture SelfServeSubscriptionPlansApi | listSelfServePlans | GET /subscription/self-serve-plans | List all subscription plans for self-serve ShopifyPrivacyWebhooksApi | shopifyCustomerRedact | POST /gdpr_hooks/shopify/customers/redact | Delete requested shopify customer orders data from the system ShopifyPrivacyWebhooksApi | shopifyDataRequest | POST /gdpr_hooks/shopify/customers/data_request | Get requested data of shopify user ShopifyPrivacyWebhooksApi | shopifyShopRedact | POST /gdpr_hooks/shopify/shop/redact | Delete requested shopify shop's data from the system SplitSegmentsApi | getSegments | GET /workspaces/{workspace_id}/split-segments | Get segments and features SplitSegmentsApi | updateSegments | PATCH /workspaces/{workspace_id}/split-segments | Update segments with workspace Id StripeSubscriptionsApi | cancelWorkspaceSubscription | POST /workspaces/{workspace_id}/subscription/cancel | Cancel workspace subscription in Stripe StripeSubscriptionsApi | createCheckoutUrl | POST /workspaces/{workspace_id}/subscription/create-checkout | Create Stripe checkout URL for workspace subscription StripeSubscriptionsApi | createCustomerPortalUrl | POST /workspaces/{workspace_id}/subscription/customer-portal | Create Stripe customer portal URL StripeSubscriptionsApi | createWorkspaceSubscription | POST /workspaces/{workspace_id}/subscription | Create Stripe subscription for workspace StripeSubscriptionsApi | deletePaymentMethod | DELETE /workspaces/{workspace_id}/subscription/payment-methods/{payment_method_id} | Delete payment method StripeSubscriptionsApi | endTrialAndStartSubscription | POST /workspaces/{workspace_id}/subscription/end-trial | End trial immediately and start subscription StripeSubscriptionsApi | getPaymentMethods | GET /workspaces/{workspace_id}/subscription/payment-methods | Get workspace payment methods from Stripe StripeSubscriptionsApi | getUpcomingInvoice | GET /workspaces/{workspace_id}/subscription/upcoming-invoice | Get upcoming invoice from Stripe StripeSubscriptionsApi | getWorkspaceBillingHistory | GET /workspaces/{workspace_id}/subscription/billing-history | Get workspace billing history from Stripe StripeSubscriptionsApi | getWorkspaceSubscription | GET /workspaces/{workspace_id}/subscription | Get workspace subscription from Stripe StripeSubscriptionsApi | getWorkspaceSubscriptionStatus | GET /workspaces/{workspace_id}/subscription/status | Get workspace subscription status StripeSubscriptionsApi | getWorkspaceUsage | GET /workspaces/{workspace_id}/subscription/usage | Get workspace usage from Stripe StripeSubscriptionsApi | previewInvoice | GET /workspaces/{workspace_id}/subscription/preview-invoice | Preview next invoice StripeSubscriptionsApi | setDefaultPaymentMethod | POST /workspaces/{workspace_id}/subscription/payment-methods/default | Set default payment method StripeWebhooksApi | handleStripeWebhook | POST /subscription/stripe/webhook | Handle Stripe webhook SubscriptionApi | fetchHostedPage | POST /workspaces/{workspace_id}/subscription_v1/hosted-page | Get hosted pages SubscriptionApi | getInvoice | GET /workspaces/{workspace_id}/subscription_v1/invoices/{invoice_id} | Get associated plan details SubscriptionApi | getWkspSubscriptionDetail | GET /workspaces/{workspace_id}/subscription_v1 | Get subscription details SubscriptionApi | listInvoices | GET /workspaces/{workspace_id}/subscription_v1/invoices | List all invoices SubscriptionApi | updateSubscriptionDetail | PATCH /workspaces/{workspace_id}/subscription_v1 | Update subscription details SubscriptionPlansApi | archivePlan | POST /subscription/plans/{plan_id}/archive | Archive a subscription plan SubscriptionPlansApi | createPlan | POST /subscription/plans | Create a new subscription plan SubscriptionPlansApi | deletePlan | DELETE /subscription/plans/{plan_id} | Delete a subscription plan SubscriptionPlansApi | getPlan | GET /subscription/plans/{plan_id} | Get a specific plan SubscriptionPlansApi | listSubscriptionPlans | GET /subscription/plans | List all subscription plans SubscriptionPlansApi | updatePlan | PUT /subscription/plans/{plan_id} | Update a subscription plan SubscriptionPlansApi | updateStorageTiers | PUT /subscription/plans/{plan_id}/storage-tiers | Update storage tiers for a plan SubscriptionsSupportApi | getPlans | GET /support/sms | Get available plans and other chargebee resources SubscriptionsSupportApi | getSubscriptionDetail | GET /support/workspaces/{workspace_id}/sms | Get subscription details SubscriptionsSupportApi | registerSubscription | POST /support/workspaces/{workspace_id}/sms | Create subscription for workspace SubscriptionsSupportApi | updateSubscription | PATCH /support/workspaces/{workspace_id}/sms | Update subscription for workspace UsersSupportApi | addUserToWorkspace | POST /support/workspaces/{workspace_id}/users | Add a user to the workspace UsersSupportApi | getUserList | GET /support/workspaces/{workspace_id}/users | Get users list UsersSupportApi | removeWorkspaceUser | DELETE /support/workspaces/{workspace_id}/users/{user_id} | Remove a user in a workspace UsersSupportApi | transferUserRoles | PATCH /support/workspaces/{workspace_id}/users | Transfer workspace ownership WebhooksApi | addDataToWebhook | POST /webhooks/data/{webhook_uri} | Add data to webhook WebhooksApi | addDataToWebhookUsingGetMethod | GET /webhooks/data/{webhook_uri} | Add data to the webhook WebhooksApi | createAWebhook | POST /workspaces/{workspace_id}/projects/{project_id}/webhooks | Create a webhook WebhooksApi | deleteWebhook | DELETE /workspaces/{workspace_id}/projects/{project_id}/webhooks/{webhook_id} | Delete webhook WebhooksApi | getWebhookDetails | GET /workspaces/{workspace_id}/projects/{project_id}/webhooks/{webhook_id} | Get webhook details WebhooksApi | listWebhooks | GET /workspaces/{workspace_id}/projects/{project_id}/webhooks | List webhooks WebhooksApi | updateWebhookConfigurations | PATCH /workspaces/{workspace_id}/projects/{project_id}/webhooks/{webhook_id} | Updates the webhook WorkspacesApi | addConnectorAddon | POST /workspaces/{workspace_id}/addons/connectors | Add connector addon to workspace WorkspacesApi | addStorageAddon | POST /workspaces/{workspace_id}/addons/storage | Add storage addon to workspace WorkspacesApi | addUserInWorkspace | POST /workspaces/{workspace_id}/users | Add user in workspace WorkspacesApi | addUserSeatsAddon | POST /workspaces/{workspace_id}/addons/users | Add user seats addon to workspace WorkspacesApi | createWorkspace | POST /workspaces | Create workspace WorkspacesApi | deleteUserWorkspace | DELETE /workspaces/{workspace_id} | Delete a workspace WorkspacesApi | getUsersInWorkspace | GET /workspaces/{workspace_id}/users | Get users in workspace WorkspacesApi | getWorkspace | GET /workspaces/{workspace_id} | Get workspace details WorkspacesApi | getWorkspaces | GET /workspaces | Get workspaces WorkspacesApi | reactivateWorkspace | POST /workspaces/{workspace_id}/reactivate | Reactivate a workspace WorkspacesApi | removeConnectorAddon | DELETE /workspaces/{workspace_id}/addons/connectors | Remove connector addon from workspace WorkspacesApi | removeStorageAddon | DELETE /workspaces/{workspace_id}/addons/storage | Remove storage addon from workspace WorkspacesApi | removeUser | DELETE /workspaces/{workspace_id}/users/{user_id} | Remove user from workspace/Leave workspace WorkspacesApi | removeUserFromWorkspace | DELETE /workspaces/{workspace_id}/users | Remove users or invites from workspace WorkspacesApi | removeUserSeatsAddon | DELETE /workspaces/{workspace_id}/addons/users | Remove user seats addon from workspace WorkspacesApi | updateUserInWorkspace | PATCH /workspaces/{workspace_id}/users/{user_id} | Change user role in workspace WorkspacesApi | updateUserToWorkspace | PATCH /workspaces/{workspace_id}/users | Resend invite, remove invitation, or change role in workspace WorkspacesApi | updateWorkspace | PATCH /workspaces/{workspace_id} | Update workspace WorkspacesSupportApi | createWorkspaces | POST /support/workspaces | Create new workspace WorkspacesSupportApi | deleteWorkspace | DELETE /support/workspaces/{workspace_id} | Delete a workspace WorkspacesSupportApi | getWorkspaceDetail | GET /support/workspaces/{workspace_id} | Get workspace details WorkspacesSupportApi | listWorkspaces | GET /support/workspaces | Get workspaces list WorkspacesSupportApi | updateWorkspaceDetail | PATCH /support/workspaces/{workspace_id} | Update workspace details

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

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme