Skip to content

Latest commit

 

History

History
378 lines (264 loc) · 20.8 KB

README.md

File metadata and controls

378 lines (264 loc) · 20.8 KB
Raw

Licensedsoftware

(licensedsoftware)

Available Operations

createLicensedSoftwareById

Matching computers are derived from software definitions, therefore they cannot be set with this operation.

Example Usage

import { Jamf } from "jamf-classic-sdk-nodejs";

async function run() {
  const sdk = new Jamf({
    security: {
      password: "<YOUR_PASSWORD_HERE>",
      username: "<YOUR_USERNAME_HERE>",
    },
  });

  const res = await sdk.licensedsoftware.createLicensedSoftwareById({
    id: 186021,
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.CreateLicensedSoftwareByIdRequest ✔️ The request object to use for the request.
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.CreateLicensedSoftwareByIdResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

deleteLicensedSoftwareById

Deletes licensed software by ID

Example Usage

import { Jamf } from "jamf-classic-sdk-nodejs";

async function run() {
  const sdk = new Jamf({
    security: {
      password: "<YOUR_PASSWORD_HERE>",
      username: "<YOUR_USERNAME_HERE>",
    },
  });

  const res = await sdk.licensedsoftware.deleteLicensedSoftwareById({
    id: 61769,
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.DeleteLicensedSoftwareByIdRequest ✔️ The request object to use for the request.
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.DeleteLicensedSoftwareByIdResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

deleteLicensedSoftwareByName

Deletes licensed software by name

Example Usage

import { Jamf } from "jamf-classic-sdk-nodejs";

async function run() {
  const sdk = new Jamf({
    security: {
      password: "<YOUR_PASSWORD_HERE>",
      username: "<YOUR_USERNAME_HERE>",
    },
  });

  const res = await sdk.licensedsoftware.deleteLicensedSoftwareByName({
    name: "<value>",
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.DeleteLicensedSoftwareByNameRequest ✔️ The request object to use for the request.
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.DeleteLicensedSoftwareByNameResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

findLicensedSoftware

Finds all licensed software

Example Usage

import { Jamf } from "jamf-classic-sdk-nodejs";

async function run() {
  const sdk = new Jamf({
    security: {
      password: "<YOUR_PASSWORD_HERE>",
      username: "<YOUR_USERNAME_HERE>",
    },
  });

  const res = await sdk.licensedsoftware.findLicensedSoftware();

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.FindLicensedSoftwareResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

findLicensedSoftwareById

Finds licensed software by ID

Example Usage

import { Jamf } from "jamf-classic-sdk-nodejs";

async function run() {
  const sdk = new Jamf({
    security: {
      password: "<YOUR_PASSWORD_HERE>",
      username: "<YOUR_USERNAME_HERE>",
    },
  });

  const res = await sdk.licensedsoftware.findLicensedSoftwareById({
    id: 987654,
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.FindLicensedSoftwareByIdRequest ✔️ The request object to use for the request.
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.FindLicensedSoftwareByIdResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

findLicensedSoftwareByName

Finds licensed software by name

Example Usage

import { Jamf } from "jamf-classic-sdk-nodejs";

async function run() {
  const sdk = new Jamf({
    security: {
      password: "<YOUR_PASSWORD_HERE>",
      username: "<YOUR_USERNAME_HERE>",
    },
  });

  const res = await sdk.licensedsoftware.findLicensedSoftwareByName({
    name: "<value>",
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.FindLicensedSoftwareByNameRequest ✔️ The request object to use for the request.
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.FindLicensedSoftwareByNameResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

updateLicensedSoftwareById

Matching computers are derived from software definitions, therefore they cannot be set with this operation.

Example Usage

import { Jamf } from "jamf-classic-sdk-nodejs";

async function run() {
  const sdk = new Jamf({
    security: {
      password: "<YOUR_PASSWORD_HERE>",
      username: "<YOUR_USERNAME_HERE>",
    },
  });

  const res = await sdk.licensedsoftware.updateLicensedSoftwareById({
    id: 345542,
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.UpdateLicensedSoftwareByIdRequest ✔️ The request object to use for the request.
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.UpdateLicensedSoftwareByIdResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

updateLicensedSoftwareByName

Matching computers are derived from software definitions, therefore they cannot be set with this operation.

Example Usage

import { Jamf } from "jamf-classic-sdk-nodejs";

async function run() {
  const sdk = new Jamf({
    security: {
      password: "<YOUR_PASSWORD_HERE>",
      username: "<YOUR_USERNAME_HERE>",
    },
  });

  const res = await sdk.licensedsoftware.updateLicensedSoftwareByName({
    name: "<value>",
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.UpdateLicensedSoftwareByNameRequest ✔️ The request object to use for the request.
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.UpdateLicensedSoftwareByNameResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /