Class UltimakerClient

Hierarchy

UltimakerClient

Index

Constructors

Properties

_accountUrl _bearerToken _clientId _clientSecret _connectUrl _fetch _redirectUri _refreshToken _scope accountServiceStatus addClusterMaintenanceTask addClusterNote addSubscription applicationList bulkAccountDetails bulkAccountImport checkToken cluster clusterActionStatus clusterPrint clusterPrintJob clusterSharingSettings clusterStatus clusterTeamCounts clusters completedMaintenanceTasks confirmRegistration confirmRegistrationPin confirmUserCreationFromBulkAccountImport connectServiceStatus createTeam currentOrganization currentOrganizationMembers currentUsers deleteInvitationToOrganization deleteTeam deleteTeamImage deleteToken getTeamMembers inviteNewTeamMembers inviteUserToOrganization jwks listJobFilter materialsUpload newOrganization newSpatialLicense openIdConfiguration organizationInvitiation pendingMaintenanceTasks postToken printJobReports publicKey removeCluster removeMemberFromOgranization removeTeamMember reprint scopes sendEmailToUser sendPrinterAction settings spec submitPrinterAction subscriptions team teams teapot updateClusterPrintJob updateInvitationStatus updateOrganization updateOrganizationMemberData updateSettings updateSubscription updateTeamMembers updateTeamName uploadTeamImage userPermissions userRoles users

Methods

ping

Constructors

constructor

new UltimakerClient(config: ClientConfig): UltimakerClient
Parameters
- config: ClientConfig
Returns UltimakerClient
- Defined in index.ts:28

Properties

`Protected` _accountUrl

_accountUrl: string = "https://account.ultimaker.com"

`Protected` _bearerToken

_bearerToken: string = ""

`Protected` _clientId

_clientId: string = ""

`Protected` _clientSecret

_clientSecret: string = ""

`Protected` _connectUrl

_connectUrl: string = "https://api.ultimaker.com/connect/v1"

`Protected` _fetch

_fetch: (<T>(this: UltimakerClient, method: "GET" | "POST" | "PUT" | "DELETE", url: string, urlArgs?: {
[k: string]: any;
}, bodyArgs?: {
[k: string]: any;
}) => Promise<HttpResponse<T>>) = augmentedFetch

Type declaration

- <T>(this: UltimakerClient, method: "GET" | "POST" | "PUT" | "DELETE", url: string, urlArgs?: {
  [k: string]: any;
  }, bodyArgs?: {
  [k: string]: any;
  }): Promise<HttpResponse<T>>
- Type Parameters
  - T
  Parameters
  - this: UltimakerClient
  - method: "GET" | "POST" | "PUT" | "DELETE"
  - url: string
  - urlArgs: {
    [k: string]: any;
    } = {}
    - [k: string]: any
  - bodyArgs: {
    [k: string]: any;
    } = {}
    - [k: string]: any
  Returns Promise<HttpResponse<T>>

`Protected` _redirectUri

_redirectUri: string = ""

`Protected` _refreshToken

_refreshToken: string = ""

`Protected` _scope

_scope: Scopes[] = []

accountServiceStatus

accountServiceStatus: ((this: UltimakerClient) => Promise<HttpResponse<ApiStatus>>) = Authentication.accountServiceStatus

Type declaration

- (this: UltimakerClient): Promise<HttpResponse<ApiStatus>>
- Parameters
  - this: UltimakerClient
  Returns Promise<HttpResponse<ApiStatus>>

addClusterMaintenanceTask

addClusterMaintenanceTask: ((this: UltimakerClient, clusterId: string, taskCodes: string[], summary?: string, description?: string) => Promise<HttpResponse<unknown>>) = Connect.addClusterMaintenanceTask

Type declaration

- (this: UltimakerClient, clusterId: string, taskCodes: string[], summary?: string, description?: string): Promise<HttpResponse<unknown>>
- Parameters
  - this: UltimakerClient
  - clusterId: string
  - taskCodes: string[]
  - summary: string = ""
  - description: string = ""
  Returns Promise<HttpResponse<unknown>>

addClusterNote

addClusterNote: ((this: UltimakerClient, id: string, note: string, summary?: string, description?: string) => Promise<HttpResponse<unknown>>) = Connect.addClusterNote

Type declaration

- (this: UltimakerClient, id: string, note: string, summary?: string, description?: string): Promise<HttpResponse<unknown>>
- Parameters
  - this: UltimakerClient
  - id: string
  - note: string
  - summary: string = ""
  - description: string = ""
  Returns Promise<HttpResponse<unknown>>

addSubscription

addSubscription: ((this: UltimakerClient) => Promise<string>) = Authentication.addSubscription

Type declaration

- (this: UltimakerClient): Promise<string>
- Parameters
  - this: UltimakerClient
  Returns Promise<string>

applicationList

applicationList: ((this: UltimakerClient) => Promise<HttpResponse<ApplicationList>>) = Authentication.applicationList

Type declaration

- (this: UltimakerClient): Promise<HttpResponse<ApplicationList>>
- Parameters
  - this: UltimakerClient
  Returns Promise<HttpResponse<ApplicationList>>

bulkAccountDetails

bulkAccountDetails: ((this: UltimakerClient, bulkAccountId: string) => Promise<HttpResponse<BulkAccountDetails>>) = Authentication.bulkAccountDetails

Type declaration

- (this: UltimakerClient, bulkAccountId: string): Promise<HttpResponse<BulkAccountDetails>>
- Parameters
  - this: UltimakerClient
  - bulkAccountId: string
  Returns Promise<HttpResponse<BulkAccountDetails>>

bulkAccountImport

bulkAccountImport: (() => Promise<string>) = Authentication.bulkAccountImport

Type declaration

- (): Promise<string>
- Returns Promise<string>

checkToken

checkToken: ((this: UltimakerClient) => Promise<HttpResponse<DecodedAccessToken>>) = Authentication.checkToken

Type declaration

- (this: UltimakerClient): Promise<HttpResponse<DecodedAccessToken>>
- Parameters
  - this: UltimakerClient
  Returns Promise<HttpResponse<DecodedAccessToken>>

cluster

cluster: ((this: UltimakerClient, id: string) => Promise<HttpResponse<Cluster>>) = Connect.cluster

Type declaration

- (this: UltimakerClient, id: string): Promise<HttpResponse<Cluster>>
- Parameters
  - this: UltimakerClient
  - id: string
  Returns Promise<HttpResponse<Cluster>>

clusterActionStatus

clusterActionStatus: ((this: UltimakerClient, clusterId: string, actionId: string) => Promise<HttpResponse<{
actionId: string;
status: string;
}>>) = Connect.clusterActionStatus

Type declaration

- (this: UltimakerClient, clusterId: string, actionId: string): Promise<HttpResponse<{
  actionId: string;
  status: string;
  }>>
- Parameters
  - this: UltimakerClient
  - clusterId: string
  - actionId: string
  Returns Promise<HttpResponse<{
  actionId: string;
  status: string;
  }>>

clusterPrint

clusterPrint: ((this: UltimakerClient, clusterId: string, jobId: string) => Promise<HttpResponse<ClusterPrint>>) = Connect.clusterPrint

Type declaration

- (this: UltimakerClient, clusterId: string, jobId: string): Promise<HttpResponse<ClusterPrint>>
- Parameters
  - this: UltimakerClient
  - clusterId: string
  - jobId: string
  Returns Promise<HttpResponse<ClusterPrint>>

clusterPrintJob

clusterPrintJob: ((this: UltimakerClient, clusterId: string, jobId: string) => Promise<HttpResponse<PrintJobDetails>>) = Connect.clusterPrintJob

Type declaration

- (this: UltimakerClient, clusterId: string, jobId: string): Promise<HttpResponse<PrintJobDetails>>
- Parameters
  - this: UltimakerClient
  - clusterId: string
  - jobId: string
  Returns Promise<HttpResponse<PrintJobDetails>>

clusterSharingSettings

clusterSharingSettings: ((this: UltimakerClient) => Promise<string>) = Connect.clusterSharingSettings

Type declaration

- (this: UltimakerClient): Promise<string>
- Parameters
  - this: UltimakerClient
  Returns Promise<string>

clusterStatus

clusterStatus: ((this: UltimakerClient, clusterId: string) => Promise<HttpResponse<any>>) = Connect.clusterStatus

Type declaration

- (this: UltimakerClient, clusterId: string): Promise<HttpResponse<any>>
- Parameters
  - this: UltimakerClient
  - clusterId: string
  Returns Promise<HttpResponse<any>>

clusterTeamCounts

clusterTeamCounts: ((this: UltimakerClient) => Promise<HttpResponse<TeamCounts>>) = Connect.clusterTeamCounts

Type declaration

- (this: UltimakerClient): Promise<HttpResponse<TeamCounts>>
- Parameters
  - this: UltimakerClient
  Returns Promise<HttpResponse<TeamCounts>>

clusters

clusters: ((this: UltimakerClient) => Promise<HttpResponse<Cluster[]>>) = Connect.clusters

Type declaration

- (this: UltimakerClient): Promise<HttpResponse<Cluster[]>>
- Parameters
  - this: UltimakerClient
  Returns Promise<HttpResponse<Cluster[]>>

completedMaintenanceTasks

completedMaintenanceTasks: ((this: UltimakerClient) => Promise<HttpResponse<CompletedMaintenanceTask[]>>) = Connect.completedMaintenanceTasks

Type declaration

- (this: UltimakerClient): Promise<HttpResponse<CompletedMaintenanceTask[]>>
- Parameters
  - this: UltimakerClient
  Returns Promise<HttpResponse<CompletedMaintenanceTask[]>>

confirmRegistration

confirmRegistration: ((this: UltimakerClient, connectionId: string) => Promise<HttpResponse<{
clusterId: string;
hostName: string;
}>>) = Connect.confirmRegistration

Type declaration

- (this: UltimakerClient, connectionId: string): Promise<HttpResponse<{
  clusterId: string;
  hostName: string;
  }>>
- Parameters
  - this: UltimakerClient
  - connectionId: string
  Returns Promise<HttpResponse<{
  clusterId: string;
  hostName: string;
  }>>

confirmRegistrationPin

confirmRegistrationPin: ((this: UltimakerClient, pinCode: string) => Promise<HttpResponse<any>>) = Connect.confirmRegistrationPin

Type declaration

- (this: UltimakerClient, pinCode: string): Promise<HttpResponse<any>>
- Parameters
  - this: UltimakerClient
  - pinCode: string
  Returns Promise<HttpResponse<any>>

confirmUserCreationFromBulkAccountImport

confirmUserCreationFromBulkAccountImport: (() => Promise<string>) = Authentication.confirmUserCreationFromBulkAccountImport

Type declaration

- (): Promise<string>
- Returns Promise<string>

connectServiceStatus

connectServiceStatus: ((this: UltimakerClient) => Promise<HttpResponse<ApiStatus>>) = Connect.connectServiceStatus

Type declaration

- (this: UltimakerClient): Promise<HttpResponse<ApiStatus>>
- Parameters
  - this: UltimakerClient
  Returns Promise<HttpResponse<ApiStatus>>

createTeam

createTeam: ((this: UltimakerClient, name: string) => Promise<HttpResponse<any>>) = Authentication.createTeam

Type declaration

- (this: UltimakerClient, name: string): Promise<HttpResponse<any>>
- Parameters
  - this: UltimakerClient
  - name: string
  Returns Promise<HttpResponse<any>>

currentOrganization

currentOrganization: ((this: UltimakerClient) => Promise<HttpResponse<Organization>>) = Authentication.currentOrganization

Type declaration

- (this: UltimakerClient): Promise<HttpResponse<Organization>>
- Parameters
  - this: UltimakerClient
  Returns Promise<HttpResponse<Organization>>

currentOrganizationMembers

currentOrganizationMembers: ((this: UltimakerClient) => Promise<HttpResponse<User[]>>) = Authentication.currentOrganizationMembers

Type declaration

- (this: UltimakerClient): Promise<HttpResponse<User[]>>
- Parameters
  - this: UltimakerClient
  Returns Promise<HttpResponse<User[]>>

currentUsers

currentUsers: ((this: UltimakerClient) => Promise<string>) = Authentication.currentUsers

Type declaration

- (this: UltimakerClient): Promise<string>
- Parameters
  - this: UltimakerClient
  Returns Promise<string>

deleteInvitationToOrganization

deleteInvitationToOrganization: ((this: UltimakerClient, id: string) => Promise<HttpResponse<undefined>>) = Authentication.deleteInvitationToOrganization

Type declaration

- (this: UltimakerClient, id: string): Promise<HttpResponse<undefined>>
- Parameters
  - this: UltimakerClient
  - id: string
  Returns Promise<HttpResponse<undefined>>

deleteTeam

deleteTeam: ((this: UltimakerClient, id: string) => Promise<HttpResponse<undefined>>) = Authentication.deleteTeam

Type declaration

- (this: UltimakerClient, id: string): Promise<HttpResponse<undefined>>
- Parameters
  - this: UltimakerClient
  - id: string
  Returns Promise<HttpResponse<undefined>>

deleteTeamImage

deleteTeamImage: ((this: UltimakerClient, id: string) => Promise<HttpResponse<undefined>>) = Authentication.deleteTeamImage

Type declaration

- (this: UltimakerClient, id: string): Promise<HttpResponse<undefined>>
- Parameters
  - this: UltimakerClient
  - id: string
  Returns Promise<HttpResponse<undefined>>

deleteToken

deleteToken: ((this: UltimakerClient) => Promise<HttpResponse<undefined>>) = Authentication.deleteToken

Type declaration

- (this: UltimakerClient): Promise<HttpResponse<undefined>>
- Parameters
  - this: UltimakerClient
  Returns Promise<HttpResponse<undefined>>

getTeamMembers

getTeamMembers: ((this: UltimakerClient, id: string) => Promise<HttpResponse<User[]>>) = Authentication.getTeamMembers

Type declaration

- (this: UltimakerClient, id: string): Promise<HttpResponse<User[]>>
- Parameters
  - this: UltimakerClient
  - id: string
  Returns Promise<HttpResponse<User[]>>

inviteNewTeamMembers

inviteNewTeamMembers: ((this: UltimakerClient, id: string, emails: string[]) => Promise<HttpResponse<undefined>>) = Authentication.inviteNewTeamMembers

Type declaration

- (this: UltimakerClient, id: string, emails: string[]): Promise<HttpResponse<undefined>>
- Parameters
  - this: UltimakerClient
  - id: string
  - emails: string[]
  Returns Promise<HttpResponse<undefined>>

inviteUserToOrganization

inviteUserToOrganization: ((this: UltimakerClient, emails: string[], redirectUri: string, roles: [], summary: string, description: string) => Promise<HttpResponse<undefined>>) = Authentication.inviteUserToOrganization

Type declaration

- (this: UltimakerClient, emails: string[], redirectUri: string, roles: [], summary: string, description: string): Promise<HttpResponse<undefined>>
- Parameters
  - this: UltimakerClient
  - emails: string[]
  - redirectUri: string
  - roles: []
  - summary: string
  - description: string
  Returns Promise<HttpResponse<undefined>>

jwks

jwks: ((this: UltimakerClient) => Promise<HttpResponse<Jwks>>) = Authentication.jwks

Type declaration

- (this: UltimakerClient): Promise<HttpResponse<Jwks>>
- Parameters
  - this: UltimakerClient
  Returns Promise<HttpResponse<Jwks>>

listJobFilter

listJobFilter: ((this: UltimakerClient) => Promise<HttpResponse<[{
    displayName: string;
    key: string;
    type: string;
}]>>) = Connect.listJobFilter

Type declaration

- (this: UltimakerClient): Promise<HttpResponse<[{
      displayName: string;
      key: string;
      type: string;
  }]>>
- Parameters
  - this: UltimakerClient
  Returns Promise<HttpResponse<[{
      displayName: string;
      key: string;
      type: string;
  }]>>

materialsUpload

materialsUpload: ((this: UltimakerClient) => Promise<string>) = Connect.materialsUpload

Type declaration

- (this: UltimakerClient): Promise<string>
- Parameters
  - this: UltimakerClient
  Returns Promise<string>

newOrganization

newOrganization: ((this: UltimakerClient, name: string, summary: string, description: string) => Promise<HttpResponse<Organization>>) = Authentication.newOrganization

Type declaration

- (this: UltimakerClient, name: string, summary: string, description: string): Promise<HttpResponse<Organization>>
- Parameters
  - this: UltimakerClient
  - name: string
  - summary: string
  - description: string
  Returns Promise<HttpResponse<Organization>>

newSpatialLicense

newSpatialLicense: ((this: UltimakerClient) => Promise<string>) = Authentication.newSpatialLicense

Type declaration

- (this: UltimakerClient): Promise<string>
- Parameters
  - this: UltimakerClient
  Returns Promise<string>

openIdConfiguration

openIdConfiguration: ((this: UltimakerClient) => Promise<HttpResponse<OpenIdConfiguration>>) = Authentication.openIdConfiguration

Type declaration

- (this: UltimakerClient): Promise<HttpResponse<OpenIdConfiguration>>
- Parameters
  - this: UltimakerClient
  Returns Promise<HttpResponse<OpenIdConfiguration>>

organizationInvitiation

organizationInvitiation: ((this: UltimakerClient, organizationId: string, invitationId: string) => Promise<HttpResponse<{
    email: string;
    invitationId: string;
    organizationName: string;
}>>) = Authentication.organizationInvitiation

Type declaration

- (this: UltimakerClient, organizationId: string, invitationId: string): Promise<HttpResponse<{
      email: string;
      invitationId: string;
      organizationName: string;
  }>>
- Parameters
  - this: UltimakerClient
  - organizationId: string
  - invitationId: string
  Returns Promise<HttpResponse<{
      email: string;
      invitationId: string;
      organizationName: string;
  }>>

pendingMaintenanceTasks

pendingMaintenanceTasks: ((this: UltimakerClient) => Promise<HttpResponse<PendingMaintenanceTask[]>>) = Connect.pendingMaintenanceTasks

Type declaration

- (this: UltimakerClient): Promise<HttpResponse<PendingMaintenanceTask[]>>
- Parameters
  - this: UltimakerClient
  Returns Promise<HttpResponse<PendingMaintenanceTask[]>>

postToken

postToken: ((this: UltimakerClient) => Promise<string>) = Authentication.postToken

Type declaration

- (this: UltimakerClient): Promise<string>
- Parameters
  - this: UltimakerClient
  Returns Promise<string>

printJobReports

printJobReports: ((this: UltimakerClient) => Promise<HttpResponse<any>>) = Connect.printJobReports

Type declaration

- (this: UltimakerClient): Promise<HttpResponse<any>>
- Parameters
  - this: UltimakerClient
  Returns Promise<HttpResponse<any>>

publicKey

publicKey: ((this: UltimakerClient) => Promise<HttpResponse<string>>) = Authentication.publicKey

Type declaration

- (this: UltimakerClient): Promise<HttpResponse<string>>
- Parameters
  - this: UltimakerClient
  Returns Promise<HttpResponse<string>>

removeCluster

removeCluster: ((this: UltimakerClient, id: string) => Promise<HttpResponse<unknown>>) = Connect.removeCluster

Type declaration

- (this: UltimakerClient, id: string): Promise<HttpResponse<unknown>>
- Parameters
  - this: UltimakerClient
  - id: string
  Returns Promise<HttpResponse<unknown>>

removeMemberFromOgranization

removeMemberFromOgranization: ((this: UltimakerClient, id: string) => Promise<HttpResponse<undefined>>) = Authentication.removeMemberFromOgranization

Type declaration

- (this: UltimakerClient, id: string): Promise<HttpResponse<undefined>>
- Parameters
  - this: UltimakerClient
  - id: string
  Returns Promise<HttpResponse<undefined>>

removeTeamMember

removeTeamMember: ((this: UltimakerClient, teamId: string, userId: string) => Promise<HttpResponse<undefined>>) = Authentication.removeTeamMember

Type declaration

- (this: UltimakerClient, teamId: string, userId: string): Promise<HttpResponse<undefined>>
- Parameters
  - this: UltimakerClient
  - teamId: string
  - userId: string
  Returns Promise<HttpResponse<undefined>>

reprint

reprint: ((this: UltimakerClient) => Promise<string>) = Connect.reprint

Type declaration

- (this: UltimakerClient): Promise<string>
- Parameters
  - this: UltimakerClient
  Returns Promise<string>

scopes

scopes: ((this: UltimakerClient) => Promise<HttpResponse<ScopeDetails[]>>) = Authentication.scopes

Type declaration

- (this: UltimakerClient): Promise<HttpResponse<ScopeDetails[]>>
- Parameters
  - this: UltimakerClient
  Returns Promise<HttpResponse<ScopeDetails[]>>

sendEmailToUser

sendEmailToUser: ((this: UltimakerClient) => Promise<string>) = Authentication.sendEmailToUser

Type declaration

- (this: UltimakerClient): Promise<string>
- Parameters
  - this: UltimakerClient
  Returns Promise<string>

sendPrinterAction

sendPrinterAction: ((this: UltimakerClient) => Promise<string>) = Connect.sendPrinterAction

Type declaration

- (this: UltimakerClient): Promise<string>
- Parameters
  - this: UltimakerClient
  Returns Promise<string>

settings

settings: ((this: UltimakerClient) => Promise<HttpResponse<any>>) = Connect.settings

Type declaration

- (this: UltimakerClient): Promise<HttpResponse<any>>
- Parameters
  - this: UltimakerClient
  Returns Promise<HttpResponse<any>>

spec

spec: ((this: UltimakerClient) => Promise<string>) = Authentication.spec

Type declaration

- (this: UltimakerClient): Promise<string>
- Parameters
  - this: UltimakerClient
  Returns Promise<string>

submitPrinterAction

submitPrinterAction: ((this: UltimakerClient) => Promise<string>) = Connect.submitPrinterAction

Type declaration

- (this: UltimakerClient): Promise<string>
- Parameters
  - this: UltimakerClient
  Returns Promise<string>

subscriptions

subscriptions: ((this: UltimakerClient) => Promise<HttpResponse<Subscription[]>>) = Authentication.subscriptions

Type declaration

- (this: UltimakerClient): Promise<HttpResponse<Subscription[]>>
- Parameters
  - this: UltimakerClient
  Returns Promise<HttpResponse<Subscription[]>>

team

team: ((this: UltimakerClient, id: string) => Promise<HttpResponse<Team>>) = Authentication.team

Type declaration

- (this: UltimakerClient, id: string): Promise<HttpResponse<Team>>
- Parameters
  - this: UltimakerClient
  - id: string
  Returns Promise<HttpResponse<Team>>

teams

teams: ((this: UltimakerClient) => Promise<HttpResponse<Team[]>>) = Authentication.teams

Type declaration

- (this: UltimakerClient): Promise<HttpResponse<Team[]>>
- Parameters
  - this: UltimakerClient
  Returns Promise<HttpResponse<Team[]>>

teapot

teapot: ((this: UltimakerClient) => Promise<HttpResponse<unknown>>) = Connect.teapot

Type declaration

- (this: UltimakerClient): Promise<HttpResponse<unknown>>
- Parameters
  - this: UltimakerClient
  Returns Promise<HttpResponse<unknown>>

updateClusterPrintJob

updateClusterPrintJob: ((this: UltimakerClient) => Promise<string>) = Connect.updateClusterPrintJob

Type declaration

- (this: UltimakerClient): Promise<string>
- Parameters
  - this: UltimakerClient
  Returns Promise<string>

updateInvitationStatus

updateInvitationStatus: ((this: UltimakerClient) => Promise<string>) = Authentication.updateInvitationStatus

Type declaration

- (this: UltimakerClient): Promise<string>
- Parameters
  - this: UltimakerClient
  Returns Promise<string>

updateOrganization

updateOrganization: ((this: UltimakerClient, name: string, summary: string, description: string) => Promise<HttpResponse<Organization>>) = Authentication.updateOrganization

Type declaration

- (this: UltimakerClient, name: string, summary: string, description: string): Promise<HttpResponse<Organization>>
- Parameters
  - this: UltimakerClient
  - name: string
  - summary: string
  - description: string
  Returns Promise<HttpResponse<Organization>>

updateOrganizationMemberData

updateOrganizationMemberData: ((this: UltimakerClient) => Promise<string>) = Authentication.updateOrganizationMemberData

Type declaration

- (this: UltimakerClient): Promise<string>
- Parameters
  - this: UltimakerClient
  Returns Promise<string>

updateSettings

updateSettings: ((this: UltimakerClient) => Promise<HttpResponse<any>>) = Connect.updateSettings

Type declaration

- (this: UltimakerClient): Promise<HttpResponse<any>>
- Parameters
  - this: UltimakerClient
  Returns Promise<HttpResponse<any>>

updateSubscription

updateSubscription: ((this: UltimakerClient, id: string, expiresAt: string) => Promise<HttpResponse<any>>) = Authentication.updateSubscription

Type declaration

- (this: UltimakerClient, id: string, expiresAt: string): Promise<HttpResponse<any>>
- Parameters
  - this: UltimakerClient
  - id: string
  - expiresAt: string
  Returns Promise<HttpResponse<any>>

updateTeamMembers

updateTeamMembers: ((this: UltimakerClient, teamId: string, userIds: string[]) => Promise<HttpResponse<Team>>) = Authentication.updateTeamMembers

Type declaration

- (this: UltimakerClient, teamId: string, userIds: string[]): Promise<HttpResponse<Team>>
- Parameters
  - this: UltimakerClient
  - teamId: string
  - userIds: string[]
  Returns Promise<HttpResponse<Team>>

updateTeamName

updateTeamName: ((this: UltimakerClient, id: string, name: string) => Promise<HttpResponse<Team>>) = Authentication.updateTeamName

Type declaration

- (this: UltimakerClient, id: string, name: string): Promise<HttpResponse<Team>>
- Parameters
  - this: UltimakerClient
  - id: string
  - name: string
  Returns Promise<HttpResponse<Team>>

uploadTeamImage

uploadTeamImage: ((this: UltimakerClient) => Promise<string>) = Authentication.uploadTeamImage

Type declaration

- (this: UltimakerClient): Promise<string>
- Parameters
  - this: UltimakerClient
  Returns Promise<string>

userPermissions

userPermissions: ((this: UltimakerClient) => Promise<string>) = Authentication.userPermissions

Type declaration

- (this: UltimakerClient): Promise<string>
- Parameters
  - this: UltimakerClient
  Returns Promise<string>

userRoles

userRoles: ((this: UltimakerClient) => Promise<string>) = Authentication.userRoles

Type declaration

- (this: UltimakerClient): Promise<string>
- Parameters
  - this: UltimakerClient
  Returns Promise<string>

users

users: ((this: UltimakerClient) => Promise<string>) = Authentication.users

Type declaration

- (this: UltimakerClient): Promise<string>
- Parameters
  - this: UltimakerClient
  Returns Promise<string>

Methods

ping

ping(): string
Returns string
- Defined in index.ts:39

Class UltimakerClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

config: ClientConfig

Returns UltimakerClient

Properties

Protected _accountUrl

Protected _bearerToken

Protected _clientId

Protected _clientSecret

Protected _connectUrl

Protected _fetch

Type declaration

Type Parameters

T

Parameters

this: UltimakerClient

method: "GET" | "POST" | "PUT" | "DELETE"

url: string

urlArgs: { [k: string]: any; } = {}

[k: string]: any

bodyArgs: { [k: string]: any; } = {}

[k: string]: any

Returns Promise<HttpResponse<T>>

Protected _redirectUri

Protected _refreshToken

Protected _scope

accountServiceStatus

Type declaration

Parameters

this: UltimakerClient

Returns Promise<HttpResponse<ApiStatus>>

addClusterMaintenanceTask

Type declaration

Parameters

this: UltimakerClient

clusterId: string

taskCodes: string[]

summary: string = ""

description: string = ""

Returns Promise<HttpResponse<unknown>>

addClusterNote

Type declaration

Parameters

this: UltimakerClient

id: string

note: string

summary: string = ""

description: string = ""

Returns Promise<HttpResponse<unknown>>

addSubscription

Type declaration

Parameters

this: UltimakerClient

Returns Promise<string>

applicationList

Type declaration

Parameters

this: UltimakerClient

Returns Promise<HttpResponse<ApplicationList>>

bulkAccountDetails

Type declaration

Parameters

this: UltimakerClient

bulkAccountId: string

Returns Promise<HttpResponse<BulkAccountDetails>>

bulkAccountImport

Type declaration

Returns Promise<string>

checkToken

Type declaration

Parameters

this: UltimakerClient

Returns Promise<HttpResponse<DecodedAccessToken>>

`Protected` _accountUrl

`Protected` _bearerToken

`Protected` _clientId

`Protected` _clientSecret

`Protected` _connectUrl

`Protected` _fetch

urlArgs: {
[k: string]: any;
} = {}

bodyArgs: {
[k: string]: any;
} = {}

`Protected` _redirectUri

`Protected` _refreshToken

`Protected` _scope

Returns Promise<HttpResponse<{
actionId: string;
status: string;
}>>

Returns Promise<HttpResponse<{
clusterId: string;
hostName: string;
}>>