@ptkl/sdk - v1.3.4
    Preparing search index...

    Class default

    Base client for the platform API Classes that extend PlatformBaseClient have intentins of only working in platform context

    PlatformBaseClient

    The axios instance to use for the client

    // if sdk is used in the forge app that is running in the platform context
    const utils = new ComponentUtils()
    // this won't work outside of platform context because client needs authtorization to communicate with the API.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    client env host token

    Methods

    acceptInvite archive create createWorkspace deleteUser deleteWorkspace getAvailableTemplates getInvite getInvites getTemplate getTemplateByCode getUser getUsers getWorkspaceTemplates info installTemplate invite list registerWithInvite revokeInvite searchTemplates setClient uninstallTemplate updateSettings updateUser updateWorkspace upgradeTemplate

    Constructors

    • Parameters

      • Optionaloptions: { env?: string; host?: string; token?: string }

      Returns default

    Properties

    client: AxiosInstance
    env: null | string = null
    host: null | string = null
    token: null | string = null

    Methods

    • Accept an invite

      Parameters

      • uuid: string

        Invite UUID

      Returns Promise<AxiosResponse<any, any>>

    • Archive a project

      Returns Promise<AxiosResponse<any, any>>

    • Create a new project

      Parameters

      • data: { description?: string; name: string; [key: string]: any }

        Project creation data

      Returns Promise<AxiosResponse<any, any>>

    • Create a new workspace

      Parameters

      • data: { description?: string; name: string; [key: string]: any }

        Workspace data

      Returns Promise<AxiosResponse<any, any>>

    • Delete a user from the project

      Parameters

      • uuid: string

        User UUID

      Returns Promise<AxiosResponse<any, any>>

    • Delete a workspace

      Parameters

      • uuid: string

        Workspace UUID

      Returns Promise<AxiosResponse<any, any>>

    • Get available templates

      Returns Promise<AxiosResponse<any, any>>

    • Get a specific invite by UUID

      Parameters

      • uuid: string

        Invite UUID

      Returns Promise<AxiosResponse<any, any>>

    • Get list of project invites

      Returns Promise<AxiosResponse<any, any>>

    • Get template by ID

      Parameters

      • id: string

        Template ID

      Returns Promise<AxiosResponse<any, any>>

    • Get template by activation code

      Parameters

      • code: string

        Activation code

      Returns Promise<AxiosResponse<any, any>>

    • Get a specific project user

      Parameters

      • uuid: string

        User UUID

      Returns Promise<AxiosResponse<any, any>>

    • Get list of project users

      Returns Promise<AxiosResponse<any, any>>

    • Get templates for a workspace

      Returns Promise<AxiosResponse<any, any>>

    • Get information about a specific project

      Returns Promise<AxiosResponse<any, any>>

    • Install a template

      Parameters

      • data: { template_id: string; workspace_uuid: string; [key: string]: any }

        Installation data

      Returns Promise<AxiosResponse<any, any>>

    • Invite a user to the project

      Parameters

      • emails: string[]

        Array of emails

      • roles: string[]

        Array of role UUIDs

      Returns Promise<AxiosResponse<any, any>>

    • Get list of all projects for the current user

      Returns Promise<AxiosResponse<any, any>>

    • Register through an invite

      Parameters

      • uuid: string

        Invite UUID

      • data: any

        Registration data

      Returns Promise<AxiosResponse<any, any>>

    • Revoke an invite

      Parameters

      • uuid: string

        Invite UUID

      Returns Promise<AxiosResponse<any, any>>

    • Search for templates

      Parameters

      • query: any

        Search query

      Returns Promise<AxiosResponse<any, any>>

    • Parameters

      • client: AxiosInstance

      Returns default

    • Uninstall a template

      Parameters

      • data: { template_id: string; workspace_uuid: string; [key: string]: any }

        Uninstallation data

      Returns Promise<AxiosResponse<any, any>>

    • Update project settings

      Parameters

      • settings: any

        Settings data

      Returns Promise<AxiosResponse<any, any>>

    • Update a project user

      Parameters

      • uuid: string

        User UUID

      • data: any

        Update data

      Returns Promise<AxiosResponse<any, any>>

    • Update a workspace

      Parameters

      • uuid: string

        Workspace UUID

      • data: any

        Update data

      Returns Promise<AxiosResponse<any, any>>

    • Upgrade a template

      Parameters

      • data: { template_id: string; workspace_uuid: string; [key: string]: any }

        Upgrade data

      Returns Promise<AxiosResponse<any, any>>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods