Class EigerClient

Hierarchy

  • EigerClient

Constructors

constructor

Properties

_delete _get _post _put accessKey addToBuildQueue approveBuilds approvedBuilds authToken baseUrl build builds device deviceQueue devices disableBuildApprovals part partVersion partVersionDownloadUrl ping print printJob printJobScanReport printJobs printedPart printedParts queuedJob removeFromQueue secretKey sendToBacklog

Constructors

constructor

Properties

Protected _delete

_delete: ((this: EigerClient, url: string, bodyArgs?: {}) => Promise<Response>) = del

Type declaration

    • (this: EigerClient, url: string, bodyArgs?: {}): Promise<Response>

    • Parameters

      Returns Promise<Response>

Protected _get

_get: (<T>(this: EigerClient, url: string, bodyArgs?: {}) => Promise<HttpResponse<T>>) = get

Type declaration

Protected _post

_post: (<T>(this: EigerClient, url: string, bodyArgs?: {}) => Promise<HttpResponse<T>>) = post

Type declaration

Protected _put

_put: ((this: EigerClient, url: string, bodyArgs?: {}) => Promise<Response>) = put

Type declaration

    • (this: EigerClient, url: string, bodyArgs?: {}): Promise<Response>

    • Parameters

      Returns Promise<Response>

Readonly accessKey

accessKey: string = ""

addToBuildQueue

addToBuildQueue: ((this: EigerClient, deviceId: string, buildId: string) => Promise<HttpResponse<any>>) = Devices.addToBuildQueue

Type declaration

approveBuilds

approveBuilds: ((this: EigerClient, buildIds: string[]) => Promise<Response>) = Builds.approveBuilds

Type declaration

    • (this: EigerClient, buildIds: string[]): Promise<Response>

    • Parameters

      Returns Promise<Response>

approvedBuilds

approvedBuilds: ((this: EigerClient, pageNumber?: number, pageSize?: number) => Promise<HttpResponse<ListBuildsData>>) = Builds.approvedBuilds

Type declaration

Readonly authToken

authToken: string = ""

Readonly baseUrl

baseUrl: string = "https://www.eiger.io/api/v3"

build

build: ((this: EigerClient, id: string) => Promise<HttpResponse<Build>>) = Builds.build

Type declaration

builds

builds: ((this: EigerClient, pageNumber?: number, pageSize?: number) => Promise<HttpResponse<ListBuildsData>>) = Builds.builds

Type declaration

device

device: ((this: EigerClient, id: string) => Promise<HttpResponse<Device>>) = Devices.device

Type declaration

deviceQueue

deviceQueue: ((this: EigerClient, id: string) => Promise<HttpResponse<DeviceQueue>>) = Devices.deviceQueue

Type declaration

devices

devices: ((this: EigerClient, pageNumber?: number, pageSize?: number) => Promise<HttpResponse<ListDevicesData>>) = Devices.devices

Type declaration

disableBuildApprovals

disableBuildApprovals: ((this: EigerClient) => Promise<Response>) = Builds.disableBuildApprovals

Type declaration

part

part: ((this: EigerClient, id: string) => Promise<HttpResponse<Part>>) = Parts.part

Type declaration

partVersion

partVersion: ((this: EigerClient, id: string) => Promise<HttpResponse<Part>>) = Parts.partVersion

Type declaration

partVersionDownloadUrl

partVersionDownloadUrl: ((this: EigerClient, id: string) => Promise<HttpResponse<{
    url: string;
}>>) = Parts.partVersionDownloadUrl

Type declaration

ping

ping: ((this: EigerClient) => string) = ping

Type declaration

print

print: ((this: EigerClient, deviceId: string, buildId: string) => Promise<HttpResponse<BacklogResponse>>) = Devices.print

Type declaration

printJob

printJob: ((this: EigerClient, id: string) => Promise<HttpResponse<PrintJobViewExtended>>) = PrintJobs.printJob

Type declaration

printJobScanReport

printJobScanReport: ((this: EigerClient, id: string) => Promise<HttpResponse<ScanReport>>) = PrintJobs.printJobScanReport

Type declaration

printJobs

printJobs: ((this: EigerClient, pageNumber?: number, pageSize?: number) => Promise<HttpResponse<PrintJobsData>>) = PrintJobs.printJobs

Type declaration

printedPart

printedPart: ((this: EigerClient, id: string) => Promise<HttpResponse<PrintedPartViewExtended>>) = Parts.printedPart

Type declaration

printedParts

printedParts: ((this: EigerClient, pageNumber?: number, pageSize?: number) => Promise<HttpResponse<PrintedPartsData>>) = Parts.printedParts

Type declaration

queuedJob

queuedJob: ((this: EigerClient, deviceId: string, jobId: string) => Promise<HttpResponse<QueuedPrintJobView>>) = Devices.queuedJob

Type declaration

removeFromQueue

removeFromQueue: ((this: EigerClient, deviceId: string, queuedId: string) => Promise<Response>) = Devices.removeFromQueue

Type declaration

    • (this: EigerClient, deviceId: string, queuedId: string): Promise<Response>

    • Parameters

      Returns Promise<Response>

Readonly secretKey

secretKey: string = ""

sendToBacklog

sendToBacklog: ((this: EigerClient, id: string, dueDate: string) => Promise<HttpResponse<BacklogResponse>>) = Builds.sendToBacklog

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc