Class UltimakerClient

Type declaration

• v1: {
      airmanager: {
          get: (() => Promise<HttpResponse<AirManagerDetails | AirManagerNotAvailable>>);
      };
      auth: {
          check: {
              get: (() => Promise<HttpResponse<AuthCheck>>);
          };
          request: {
              post: ((application, user) => Promise<HttpResponse<AuthRequest>>);
          };
          verify: {
              get: (() => Promise<HttpResponse<any>>);
          };
      };
      history: {
          events: {
              get: (() => Promise<HttpResponse<Event[]>>);
          };
          printJobs: {
              get: ((id?) => Promise<HttpResponse<HistoricJob>> | Promise<HttpResponse<HistoricJob[]>>);
          };
      };
      materials: {
          get: ((id?) => Promise<HttpResponse<string>> | Promise<HttpResponse<string[]>>);
      };
      printJob: {
          cleaned: {
              get: (() => Promise<HttpResponse<string>>);
          };
          finished: {
              get: (() => Promise<HttpResponse<string>>);
          };
          get: (() => Promise<HttpResponse<Job>>);
          name: {
              get: (() => Promise<HttpResponse<string>>);
          };
          pauseSource: {
              get: (() => Promise<HttpResponse<string>>);
          };
          post: ((jobname, gcode) => Promise<HttpResponse<PostJobResponse>>);
          progress: {
              get: (() => Promise<HttpResponse<number>>);
          };
          put: ((target) => Promise<HttpResponse<any>>);
          reprintUuid: {
              get: (() => Promise<HttpResponse<string>>);
          };
          result: {
              get: (() => Promise<HttpResponse<string>>);
          };
          source: {
              get: (() => Promise<HttpResponse<JobSource>>);
          };
          sourceApplication: {
              get: (() => Promise<HttpResponse<string>>);
          };
          sourceUser: {
              get: (() => Promise<HttpResponse<string>>);
          };
          started: {
              get: (() => Promise<HttpResponse<string>>);
          };
          state: {
              get: (() => Promise<HttpResponse<JobTargetState>>);
          };
          timeElapsed: {
              get: (() => Promise<HttpResponse<number>>);
          };
          timeTotal: {
              get: (() => Promise<HttpResponse<number>>);
          };
          uuid: {
              get: (() => Promise<HttpResponse<string>>);
          };
      };
      printer: {
          bed: {
              preHeat: {
                  get: (() => Promise<HttpResponse<number>>);
              };
              temperature: {
                  get: (() => Promise<HttpResponse<PrinterBed>>);
              };
              type: {
                  get: (() => Promise<HttpResponse<string>>);
              };
          };
          get: (() => Promise<HttpResponse<Printer>>);
          heads: {
              get: ((id?) => Promise<HttpResponse<PrinterHead>> | Promise<HttpResponse<PrinterHead[]>>);
          };
          led: {
              brightness: {
                  get: (() => Promise<HttpResponse<number>>);
              };
              get: (() => Promise<HttpResponse<HSV>>);
              hue: {
                  get: (() => Promise<HttpResponse<any>>);
              };
              put: ((hsv) => Promise<HttpResponse<any>>);
              saturation: {
                  get: (() => Promise<HttpResponse<number>>);
              };
          };
          status: {
              get: (() => Promise<HttpResponse<string>>);
          };
      };
      system: {
          country: {
              get: (() => Promise<HttpResponse<string>>);
          };
          firmware: {
              get: (() => Promise<HttpResponse<string>>);
              stable: {
                  get: (() => Promise<HttpResponse<string>>);
              };
              testing: {
                  get: (() => Promise<HttpResponse<string>>);
              };
          };
          get: (() => Promise<HttpResponse<System>>);
          guid: {
              get: (() => Promise<HttpResponse<string>>);
          };
          hardware: {
              get: (() => Promise<HttpResponse<SystemHardware>>);
              revision: {
                  get: (() => Promise<HttpResponse<number>>);
              };
              typeId: {
                  get: (() => Promise<HttpResponse<number>>);
              };
          };
          language: {
              get: (() => Promise<HttpResponse<string>>);
          };
          memory: {
              get: (() => Promise<HttpResponse<SystemMemory>>);
          };
          name: {
              get: (() => Promise<HttpResponse<string>>);
          };
          platform: {
              get: (() => Promise<HttpResponse<string>>);
          };
          time: {
              get: (() => Promise<HttpResponse<SystemTime>>);
          };
          type: {
              get: (() => Promise<HttpResponse<string>>);
          };
          uptime: {
              get: (() => Promise<HttpResponse<string>>);
          };
          variant: {
              get: (() => Promise<HttpResponse<string>>);
          };
      };
  }

  • airmanager: {
        get: (() => Promise<HttpResponse<AirManagerDetails | AirManagerNotAvailable>>);
    }

    • get: (() => Promise<HttpResponse<AirManagerDetails | AirManagerNotAvailable>>)

      • • (): Promise<HttpResponse<AirManagerDetails | AirManagerNotAvailable>>

        • Returns Promise<HttpResponse<AirManagerDetails | AirManagerNotAvailable>>

  • auth: {
        check: {
            get: (() => Promise<HttpResponse<AuthCheck>>);
        };
        request: {
            post: ((application, user) => Promise<HttpResponse<AuthRequest>>);
        };
        verify: {
            get: (() => Promise<HttpResponse<any>>);
        };
    }

    • check: {
          get: (() => Promise<HttpResponse<AuthCheck>>);
      }

      • get: (() => Promise<HttpResponse<AuthCheck>>)

        • • (): Promise<HttpResponse<AuthCheck>>

          • Returns Promise<HttpResponse<AuthCheck>>

    • request: {
          post: ((application, user) => Promise<HttpResponse<AuthRequest>>);
      }

      • post: ((application, user) => Promise<HttpResponse<AuthRequest>>)

        • • (application, user): Promise<HttpResponse<AuthRequest>>

          • Parameters

            • application: string
            • user: string

            Returns Promise<HttpResponse<AuthRequest>>

    • verify: {
          get: (() => Promise<HttpResponse<any>>);
      }

      • get: (() => Promise<HttpResponse<any>>)

        • • (): Promise<HttpResponse<any>>

          • Returns Promise<HttpResponse<any>>

  • history: {
        events: {
            get: (() => Promise<HttpResponse<Event[]>>);
        };
        printJobs: {
            get: ((id?) => Promise<HttpResponse<HistoricJob>> | Promise<HttpResponse<HistoricJob[]>>);
        };
    }

    • events: {
          get: (() => Promise<HttpResponse<Event[]>>);
      }

      • get: (() => Promise<HttpResponse<Event[]>>)

        • • (): Promise<HttpResponse<Event[]>>

          • Returns Promise<HttpResponse<Event[]>>

    • printJobs: {
          get: ((id?) => Promise<HttpResponse<HistoricJob>> | Promise<HttpResponse<HistoricJob[]>>);
      }

      • get: ((id?) => Promise<HttpResponse<HistoricJob>> | Promise<HttpResponse<HistoricJob[]>>)

        • • (id?): Promise<HttpResponse<HistoricJob>> | Promise<HttpResponse<HistoricJob[]>>

          • Parameters

            • Optional id: string

            Returns Promise<HttpResponse<HistoricJob>> | Promise<HttpResponse<HistoricJob[]>>

  • materials: {
        get: ((id?) => Promise<HttpResponse<string>> | Promise<HttpResponse<string[]>>);
    }

    • get: ((id?) => Promise<HttpResponse<string>> | Promise<HttpResponse<string[]>>)

      • • (id?): Promise<HttpResponse<string>> | Promise<HttpResponse<string[]>>

        • Parameters

          • Optional id: string

          Returns Promise<HttpResponse<string>> | Promise<HttpResponse<string[]>>

  • printJob: {
        cleaned: {
            get: (() => Promise<HttpResponse<string>>);
        };
        finished: {
            get: (() => Promise<HttpResponse<string>>);
        };
        get: (() => Promise<HttpResponse<Job>>);
        name: {
            get: (() => Promise<HttpResponse<string>>);
        };
        pauseSource: {
            get: (() => Promise<HttpResponse<string>>);
        };
        post: ((jobname, gcode) => Promise<HttpResponse<PostJobResponse>>);
        progress: {
            get: (() => Promise<HttpResponse<number>>);
        };
        put: ((target) => Promise<HttpResponse<any>>);
        reprintUuid: {
            get: (() => Promise<HttpResponse<string>>);
        };
        result: {
            get: (() => Promise<HttpResponse<string>>);
        };
        source: {
            get: (() => Promise<HttpResponse<JobSource>>);
        };
        sourceApplication: {
            get: (() => Promise<HttpResponse<string>>);
        };
        sourceUser: {
            get: (() => Promise<HttpResponse<string>>);
        };
        started: {
            get: (() => Promise<HttpResponse<string>>);
        };
        state: {
            get: (() => Promise<HttpResponse<JobTargetState>>);
        };
        timeElapsed: {
            get: (() => Promise<HttpResponse<number>>);
        };
        timeTotal: {
            get: (() => Promise<HttpResponse<number>>);
        };
        uuid: {
            get: (() => Promise<HttpResponse<string>>);
        };
    }

    • cleaned: {
          get: (() => Promise<HttpResponse<string>>);
      }

      • get: (() => Promise<HttpResponse<string>>)

        • • (): Promise<HttpResponse<string>>

          • Returns Promise<HttpResponse<string>>

    • finished: {
          get: (() => Promise<HttpResponse<string>>);
      }

      • get: (() => Promise<HttpResponse<string>>)

        • • (): Promise<HttpResponse<string>>

          • Returns Promise<HttpResponse<string>>

    • get: (() => Promise<HttpResponse<Job>>)

      • • (): Promise<HttpResponse<Job>>

        • Returns Promise<HttpResponse<Job>>

    • name: {
          get: (() => Promise<HttpResponse<string>>);
      }

      • get: (() => Promise<HttpResponse<string>>)

        • • (): Promise<HttpResponse<string>>

          • Returns Promise<HttpResponse<string>>

    • pauseSource: {
          get: (() => Promise<HttpResponse<string>>);
      }

      • get: (() => Promise<HttpResponse<string>>)

        • • (): Promise<HttpResponse<string>>

          • Returns Promise<HttpResponse<string>>

    • post: ((jobname, gcode) => Promise<HttpResponse<PostJobResponse>>)

      • • (jobname, gcode): Promise<HttpResponse<PostJobResponse>>

        • Parameters

          • jobname: string
          • gcode: string

          Returns Promise<HttpResponse<PostJobResponse>>

    • progress: {
          get: (() => Promise<HttpResponse<number>>);
      }

      • get: (() => Promise<HttpResponse<number>>)

        • • (): Promise<HttpResponse<number>>

          • Returns Promise<HttpResponse<number>>

    • put: ((target) => Promise<HttpResponse<any>>)

      • • (target): Promise<HttpResponse<any>>

        • Parameters

          • target: JobTargetState

          Returns Promise<HttpResponse<any>>

    • reprintUuid: {
          get: (() => Promise<HttpResponse<string>>);
      }

      • get: (() => Promise<HttpResponse<string>>)

        • • (): Promise<HttpResponse<string>>

          • Returns Promise<HttpResponse<string>>

    • result: {
          get: (() => Promise<HttpResponse<string>>);
      }

      • get: (() => Promise<HttpResponse<string>>)

        • • (): Promise<HttpResponse<string>>

          • Returns Promise<HttpResponse<string>>

    • source: {
          get: (() => Promise<HttpResponse<JobSource>>);
      }

      • get: (() => Promise<HttpResponse<JobSource>>)

        • • (): Promise<HttpResponse<JobSource>>

          • Returns Promise<HttpResponse<JobSource>>

    • sourceApplication: {
          get: (() => Promise<HttpResponse<string>>);
      }

      • get: (() => Promise<HttpResponse<string>>)

        • • (): Promise<HttpResponse<string>>

          • Returns Promise<HttpResponse<string>>

    • sourceUser: {
          get: (() => Promise<HttpResponse<string>>);
      }

      • get: (() => Promise<HttpResponse<string>>)

        • • (): Promise<HttpResponse<string>>

          • Returns Promise<HttpResponse<string>>

    • started: {
          get: (() => Promise<HttpResponse<string>>);
      }

      • get: (() => Promise<HttpResponse<string>>)

        • • (): Promise<HttpResponse<string>>

          • Returns Promise<HttpResponse<string>>

    • state: {
          get: (() => Promise<HttpResponse<JobTargetState>>);
      }

      • get: (() => Promise<HttpResponse<JobTargetState>>)

        • • (): Promise<HttpResponse<JobTargetState>>

          • Returns Promise<HttpResponse<JobTargetState>>

    • timeElapsed: {
          get: (() => Promise<HttpResponse<number>>);
      }

      • get: (() => Promise<HttpResponse<number>>)

        • • (): Promise<HttpResponse<number>>

          • Returns Promise<HttpResponse<number>>

    • timeTotal: {
          get: (() => Promise<HttpResponse<number>>);
      }

      • get: (() => Promise<HttpResponse<number>>)

        • • (): Promise<HttpResponse<number>>

          • Returns Promise<HttpResponse<number>>

    • uuid: {
          get: (() => Promise<HttpResponse<string>>);
      }

      • get: (() => Promise<HttpResponse<string>>)

        • • (): Promise<HttpResponse<string>>

          • Returns Promise<HttpResponse<string>>

  • printer: {
        bed: {
            preHeat: {
                get: (() => Promise<HttpResponse<number>>);
            };
            temperature: {
                get: (() => Promise<HttpResponse<PrinterBed>>);
            };
            type: {
                get: (() => Promise<HttpResponse<string>>);
            };
        };
        get: (() => Promise<HttpResponse<Printer>>);
        heads: {
            get: ((id?) => Promise<HttpResponse<PrinterHead>> | Promise<HttpResponse<PrinterHead[]>>);
        };
        led: {
            brightness: {
                get: (() => Promise<HttpResponse<number>>);
            };
            get: (() => Promise<HttpResponse<HSV>>);
            hue: {
                get: (() => Promise<HttpResponse<any>>);
            };
            put: ((hsv) => Promise<HttpResponse<any>>);
            saturation: {
                get: (() => Promise<HttpResponse<number>>);
            };
        };
        status: {
            get: (() => Promise<HttpResponse<string>>);
        };
    }

    • bed: {
          preHeat: {
              get: (() => Promise<HttpResponse<number>>);
          };
          temperature: {
              get: (() => Promise<HttpResponse<PrinterBed>>);
          };
          type: {
              get: (() => Promise<HttpResponse<string>>);
          };
      }

      • preHeat: {
            get: (() => Promise<HttpResponse<number>>);
        }

        • get: (() => Promise<HttpResponse<number>>)

          • • (): Promise<HttpResponse<number>>

            • Returns Promise<HttpResponse<number>>

      • temperature: {
            get: (() => Promise<HttpResponse<PrinterBed>>);
        }

        • get: (() => Promise<HttpResponse<PrinterBed>>)

          • • (): Promise<HttpResponse<PrinterBed>>

            • Returns Promise<HttpResponse<PrinterBed>>

      • type: {
            get: (() => Promise<HttpResponse<string>>);
        }

        • get: (() => Promise<HttpResponse<string>>)

          • • (): Promise<HttpResponse<string>>

            • Returns Promise<HttpResponse<string>>

    • get: (() => Promise<HttpResponse<Printer>>)

      • • (): Promise<HttpResponse<Printer>>

        • Returns Promise<HttpResponse<Printer>>

    • heads: {
          get: ((id?) => Promise<HttpResponse<PrinterHead>> | Promise<HttpResponse<PrinterHead[]>>);
      }

      • get: ((id?) => Promise<HttpResponse<PrinterHead>> | Promise<HttpResponse<PrinterHead[]>>)

        • • (id?): Promise<HttpResponse<PrinterHead>> | Promise<HttpResponse<PrinterHead[]>>

          • Parameters

            • Optional id: string

            Returns Promise<HttpResponse<PrinterHead>> | Promise<HttpResponse<PrinterHead[]>>

    • led: {
          brightness: {
              get: (() => Promise<HttpResponse<number>>);
          };
          get: (() => Promise<HttpResponse<HSV>>);
          hue: {
              get: (() => Promise<HttpResponse<any>>);
          };
          put: ((hsv) => Promise<HttpResponse<any>>);
          saturation: {
              get: (() => Promise<HttpResponse<number>>);
          };
      }

      • brightness: {
            get: (() => Promise<HttpResponse<number>>);
        }

        • get: (() => Promise<HttpResponse<number>>)

          • • (): Promise<HttpResponse<number>>

            • Returns Promise<HttpResponse<number>>

      • get: (() => Promise<HttpResponse<HSV>>)

        • • (): Promise<HttpResponse<HSV>>

          • Returns Promise<HttpResponse<HSV>>

      • hue: {
            get: (() => Promise<HttpResponse<any>>);
        }

        • get: (() => Promise<HttpResponse<any>>)

          • • (): Promise<HttpResponse<any>>

            • Returns Promise<HttpResponse<any>>

      • put: ((hsv) => Promise<HttpResponse<any>>)

        • • (hsv): Promise<HttpResponse<any>>

          • Parameters

            • hsv: HSV

            Returns Promise<HttpResponse<any>>

      • saturation: {
            get: (() => Promise<HttpResponse<number>>);
        }

        • get: (() => Promise<HttpResponse<number>>)

          • • (): Promise<HttpResponse<number>>

            • Returns Promise<HttpResponse<number>>

    • status: {
          get: (() => Promise<HttpResponse<string>>);
      }

      • get: (() => Promise<HttpResponse<string>>)

        • • (): Promise<HttpResponse<string>>

          • Returns Promise<HttpResponse<string>>

  • system: {
        country: {
            get: (() => Promise<HttpResponse<string>>);
        };
        firmware: {
            get: (() => Promise<HttpResponse<string>>);
            stable: {
                get: (() => Promise<HttpResponse<string>>);
            };
            testing: {
                get: (() => Promise<HttpResponse<string>>);
            };
        };
        get: (() => Promise<HttpResponse<System>>);
        guid: {
            get: (() => Promise<HttpResponse<string>>);
        };
        hardware: {
            get: (() => Promise<HttpResponse<SystemHardware>>);
            revision: {
                get: (() => Promise<HttpResponse<number>>);
            };
            typeId: {
                get: (() => Promise<HttpResponse<number>>);
            };
        };
        language: {
            get: (() => Promise<HttpResponse<string>>);
        };
        memory: {
            get: (() => Promise<HttpResponse<SystemMemory>>);
        };
        name: {
            get: (() => Promise<HttpResponse<string>>);
        };
        platform: {
            get: (() => Promise<HttpResponse<string>>);
        };
        time: {
            get: (() => Promise<HttpResponse<SystemTime>>);
        };
        type: {
            get: (() => Promise<HttpResponse<string>>);
        };
        uptime: {
            get: (() => Promise<HttpResponse<string>>);
        };
        variant: {
            get: (() => Promise<HttpResponse<string>>);
        };
    }

    • country: {
          get: (() => Promise<HttpResponse<string>>);
      }

      • get: (() => Promise<HttpResponse<string>>)

        • • (): Promise<HttpResponse<string>>

          • Returns Promise<HttpResponse<string>>

    • firmware: {
          get: (() => Promise<HttpResponse<string>>);
          stable: {
              get: (() => Promise<HttpResponse<string>>);
          };
          testing: {
              get: (() => Promise<HttpResponse<string>>);
          };
      }

      • get: (() => Promise<HttpResponse<string>>)

        • • (): Promise<HttpResponse<string>>

          • Returns Promise<HttpResponse<string>>

      • stable: {
            get: (() => Promise<HttpResponse<string>>);
        }

        • get: (() => Promise<HttpResponse<string>>)

          • • (): Promise<HttpResponse<string>>

            • Returns Promise<HttpResponse<string>>

      • testing: {
            get: (() => Promise<HttpResponse<string>>);
        }

        • get: (() => Promise<HttpResponse<string>>)

          • • (): Promise<HttpResponse<string>>

            • Returns Promise<HttpResponse<string>>

    • get: (() => Promise<HttpResponse<System>>)

      • • (): Promise<HttpResponse<System>>

        • Returns Promise<HttpResponse<System>>

    • guid: {
          get: (() => Promise<HttpResponse<string>>);
      }

      • get: (() => Promise<HttpResponse<string>>)

        • • (): Promise<HttpResponse<string>>

          • Returns Promise<HttpResponse<string>>

    • hardware: {
          get: (() => Promise<HttpResponse<SystemHardware>>);
          revision: {
              get: (() => Promise<HttpResponse<number>>);
          };
          typeId: {
              get: (() => Promise<HttpResponse<number>>);
          };
      }

      • get: (() => Promise<HttpResponse<SystemHardware>>)

        • • (): Promise<HttpResponse<SystemHardware>>

          • Returns Promise<HttpResponse<SystemHardware>>

      • revision: {
            get: (() => Promise<HttpResponse<number>>);
        }

        • get: (() => Promise<HttpResponse<number>>)

          • • (): Promise<HttpResponse<number>>

            • Returns Promise<HttpResponse<number>>

      • typeId: {
            get: (() => Promise<HttpResponse<number>>);
        }

        • get: (() => Promise<HttpResponse<number>>)

          • • (): Promise<HttpResponse<number>>

            • Returns Promise<HttpResponse<number>>

    • language: {
          get: (() => Promise<HttpResponse<string>>);
      }

      • get: (() => Promise<HttpResponse<string>>)

        • • (): Promise<HttpResponse<string>>

          • Returns Promise<HttpResponse<string>>

    • memory: {
          get: (() => Promise<HttpResponse<SystemMemory>>);
      }

      • get: (() => Promise<HttpResponse<SystemMemory>>)

        • • (): Promise<HttpResponse<SystemMemory>>

          • Returns Promise<HttpResponse<SystemMemory>>

    • name: {
          get: (() => Promise<HttpResponse<string>>);
      }

      • get: (() => Promise<HttpResponse<string>>)

        • • (): Promise<HttpResponse<string>>

          • Returns Promise<HttpResponse<string>>

    • platform: {
          get: (() => Promise<HttpResponse<string>>);
      }

      • get: (() => Promise<HttpResponse<string>>)

        • • (): Promise<HttpResponse<string>>

          • Returns Promise<HttpResponse<string>>

    • time: {
          get: (() => Promise<HttpResponse<SystemTime>>);
      }

      • get: (() => Promise<HttpResponse<SystemTime>>)

        • • (): Promise<HttpResponse<SystemTime>>

          • Returns Promise<HttpResponse<SystemTime>>

    • type: {
          get: (() => Promise<HttpResponse<string>>);
      }

      • get: (() => Promise<HttpResponse<string>>)

        • • (): Promise<HttpResponse<string>>

          • Returns Promise<HttpResponse<string>>

    • uptime: {
          get: (() => Promise<HttpResponse<string>>);
      }

      • get: (() => Promise<HttpResponse<string>>)

        • • (): Promise<HttpResponse<string>>

          • Returns Promise<HttpResponse<string>>

    • variant: {
          get: (() => Promise<HttpResponse<string>>);
      }

      • get: (() => Promise<HttpResponse<string>>)

        • • (): Promise<HttpResponse<string>>

          • Returns Promise<HttpResponse<string>>