Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ClassDoAPIClient

The ClassDoAPIClient class encapsulates all logics to call ClassDo APIs from client side.

Hierarchy

  • ClassDoAPIClient

Index

Constructors

constructor

  • The ClassDoAPIClient constructor

    const client = new ClassDoAPIClient({ apiKey: 'xxxxxxxxxxxx' })
    client.viewer.get(['id'], { rooms: { fields: ['id', 'name'] }}).then(v => {
      console.log(v)
    })

    Parameters

    • params: { apiKey: string }

      apiKey: API Key to call ClassDo public API.

      • apiKey: string

    Returns ClassDoAPIClient

Properties

billing

billing: BillingClient

Client to call Billing schema

Private client

client: ApolloClient<NormalizedCacheObject>

invitatoins

invitatoins: InvitatationsClient

Client to call mutation for invitations

organization

organization: ViewerClient

Client to call Viewer schema

organizationMembers

organizationMembers: OrganizationMembersClient

Client to call OrganizatoinMembers schema

roles

Client to call Roles schema

roomMembers

roomMembers: RoomMembersClient

Client to call RoomMembers schema

rooms

Client to call Rooms schema and mutation for rooms

Accessors

viewer

Methods

getClient

  • getClient(): ApolloClient<NormalizedCacheObject>

mutate

  • mutate<R>(src: R): Promise<FetchResult<R>>
  • Type parameters

    • R

    Parameters

    • src: R

    Returns Promise<FetchResult<R>>

query

  • query<R>(src: R): Promise<ApolloQueryResult<R>>
  • Type parameters

    • R

    Parameters

    • src: R

    Returns Promise<ApolloQueryResult<R>>

Generated using TypeDoc