Skip to content

Latest commit

 

History

History
331 lines (231 loc) · 19.3 KB

README.md

File metadata and controls

331 lines (231 loc) · 19.3 KB
Raw

Computerinvitations

(computerinvitations)

Available Operations

createComputerInvitationsById

Creates a new computer invitation 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.computerinvitations.createComputerInvitationsById({
    id: 426166,
  });

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

run();

Parameters

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

Response

Promise<operations.CreateComputerInvitationsByIdResponse>

Errors

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

createComputerInvitationsByInvitation

Creates a new computer invitation by invitation

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.computerinvitations.createComputerInvitationsByInvitation({
    invitation: 107268,
  });

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

run();

Parameters

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

Response

Promise<operations.CreateComputerInvitationsByInvitationResponse>

Errors

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

deleteComputerInvitationById

Deletes a computer invitation 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.computerinvitations.deleteComputerInvitationById({
    id: 620598,
  });

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

run();

Parameters

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

Response

Promise<operations.DeleteComputerInvitationByIdResponse>

Errors

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

deleteComputerInvitationByInvitation

Deletes a computer invitation by invitation

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.computerinvitations.deleteComputerInvitationByInvitation({
    invitation: 706715,
  });

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

run();

Parameters

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

Response

Promise<operations.DeleteComputerInvitationByInvitationResponse>

Errors

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

findComputerInvitations

Finds all computer invitations

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.computerinvitations.findComputerInvitations();

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

run();

Parameters

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

Response

Promise<operations.FindComputerInvitationsResponse>

Errors

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

findComputerInvitationsById

Finds computer invitations 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.computerinvitations.findComputerInvitationsById({
    id: 737242,
  });

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

run();

Parameters

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

Response

Promise<operations.FindComputerInvitationsByIdResponse>

Errors

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

findComputerInvitationsByInvitation

Finds computer invitations by invitation

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.computerinvitations.findComputerInvitationsByInvitation({
    invitation: 681787,
  });

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

run();

Parameters

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

Response

Promise<operations.FindComputerInvitationsByInvitationResponse>

Errors

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