Skip to content

Latest commit

 

History

History
331 lines (231 loc) · 20.3 KB

README.md

File metadata and controls

331 lines (231 loc) · 20.3 KB
Raw

Mobiledeviceinvitations

(mobiledeviceinvitations)

Available Operations

createMobileDeviceInvitationsById

Creates a new mobile device 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.mobiledeviceinvitations.createMobileDeviceInvitationsById({
    id: 850185,
  });

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

run();

Parameters

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

Response

Promise<operations.CreateMobileDeviceInvitationsByIdResponse>

Errors

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

createMobileDeviceInvitationsByInvitation

Creates a new mobile device 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.mobiledeviceinvitations.createMobileDeviceInvitationsByInvitation({
    invitation: 60639,
  });

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

run();

Parameters

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

Response

Promise<operations.CreateMobileDeviceInvitationsByInvitationResponse>

Errors

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

deleteMobileDeviceInvitationById

Deletes a mobile device 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.mobiledeviceinvitations.deleteMobileDeviceInvitationById({
    id: 377680,
  });

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

run();

Parameters

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

Response

Promise<operations.DeleteMobileDeviceInvitationByIdResponse>

Errors

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

deleteMobileDeviceInvitationByInvitation

Deletes a mobile device 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.mobiledeviceinvitations.deleteMobileDeviceInvitationByInvitation({
    invitation: 34819,
  });

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

run();

Parameters

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

Response

Promise<operations.DeleteMobileDeviceInvitationByInvitationResponse>

Errors

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

findMobileDeviceInvitations

Finds all mobile device 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.mobiledeviceinvitations.findMobileDeviceInvitations();

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

run();

Parameters

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

Response

Promise<operations.FindMobileDeviceInvitationsResponse>

Errors

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

findMobileDeviceInvitationsById

Finds mobile device 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.mobiledeviceinvitations.findMobileDeviceInvitationsById({
    id: 522350,
  });

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

run();

Parameters

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

Response

Promise<operations.FindMobileDeviceInvitationsByIdResponse>

Errors

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

findMobileDeviceInvitationsByInvitation

Finds mobile device 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.mobiledeviceinvitations.findMobileDeviceInvitationsByInvitation({
    invitation: 313759,
  });

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

run();

Parameters

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

Response

Promise<operations.FindMobileDeviceInvitationsByInvitationResponse>

Errors

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