Skip to content

Latest commit

 

History

History
552 lines (394 loc) · 22.2 KB

README.md

File metadata and controls

552 lines (394 loc) · 22.2 KB

User

(user)

Overview

Operations about user

Available Operations

createUserForm

This can only be done by the logged in user.

Example Usage

import { Test } from "Test";

async function run() {
  const sdk = new Test({
    security: {
      petstoreAuth: "<YOUR_PETSTORE_AUTH_HERE>",
    },
  });

  const res = await sdk.user.createUserForm({
    email: "[email protected]",
    firstName: "John",
    id: 10,
    lastName: "James",
    password: "12345",
    phone: "12345",
    userStatus: 1,
    username: "theUser",
  });

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

run();

Parameters

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

Response

Promise<operations.CreateUserFormResponse>

Errors

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

createUserJson

This can only be done by the logged in user.

Example Usage

import { Test } from "Test";

async function run() {
  const sdk = new Test({
    security: {
      petstoreAuth: "<YOUR_PETSTORE_AUTH_HERE>",
    },
  });

  const res = await sdk.user.createUserJson({
    email: "[email protected]",
    firstName: "John",
    id: 10,
    lastName: "James",
    password: "12345",
    phone: "12345",
    userStatus: 1,
    username: "theUser",
  });

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

run();

Parameters

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

Response

Promise<operations.CreateUserJsonResponse>

Errors

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

createUserRaw

This can only be done by the logged in user.

Example Usage

import { Test } from "Test";

async function run() {
  const sdk = new Test({
    security: {
      petstoreAuth: "<YOUR_PETSTORE_AUTH_HERE>",
    },
  });

  const res = await sdk.user.createUserRaw(new TextEncoder().encode("0xB4dDB1Eeed"));

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

run();

Parameters

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

Response

Promise<operations.CreateUserRawResponse>

Errors

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

createUsersWithListInput

Creates list of users with given input array

Example Usage

import { Test } from "Test";

async function run() {
  const sdk = new Test({
    security: {
      petstoreAuth: "<YOUR_PETSTORE_AUTH_HERE>",
    },
  });

  const res = await sdk.user.createUsersWithListInput([
    {
      email: "[email protected]",
      firstName: "John",
      id: 10,
      lastName: "James",
      password: "12345",
      phone: "12345",
      userStatus: 1,
      username: "theUser",
    },
  ]);

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

run();

Parameters

Parameter Type Required Description
request shared.User[] ✔️ The request object to use for the request.
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.CreateUsersWithListInputResponse>

Errors

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

deleteUser

This can only be done by the logged in user.

Example Usage

import { Test } from "Test";

async function run() {
  const sdk = new Test({
    security: {
      petstoreAuth: "<YOUR_PETSTORE_AUTH_HERE>",
    },
  });

  const res = await sdk.user.deleteUser({
    username: "Demetris_Torphy",
  });

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

run();

Parameters

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

Response

Promise<operations.DeleteUserResponse>

Errors

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

getUserByName

Get user by user name

Example Usage

import { Test } from "Test";

async function run() {
  const sdk = new Test({
    security: {
      petstoreAuth: "<YOUR_PETSTORE_AUTH_HERE>",
    },
  });

  const res = await sdk.user.getUserByName({
    username: "Zachery_Schneider",
  });

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

run();

Parameters

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

Response

Promise<operations.GetUserByNameResponse>

Errors

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

loginUser

Logs user into the system

Example Usage

import { Test } from "Test";

async function run() {
  const sdk = new Test({
    security: {
      petstoreAuth: "<YOUR_PETSTORE_AUTH_HERE>",
    },
  });

  const res = await sdk.user.loginUser({});

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

run();

Parameters

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

Response

Promise<operations.LoginUserResponse>

Errors

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

logoutUser

Logs out current logged in user session

Example Usage

import { Test } from "Test";

async function run() {
  const sdk = new Test({
    security: {
      petstoreAuth: "<YOUR_PETSTORE_AUTH_HERE>",
    },
  });

  const res = await sdk.user.logoutUser();

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

run();

Parameters

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

Response

Promise<operations.LogoutUserResponse>

Errors

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

updateUserForm

This can only be done by the logged in user.

Example Usage

import { Test } from "Test";

async function run() {
  const sdk = new Test({
    security: {
      petstoreAuth: "<YOUR_PETSTORE_AUTH_HERE>",
    },
  });

  const res = await sdk.user.updateUserForm({
    user: {
      email: "[email protected]",
      firstName: "John",
      id: 10,
      lastName: "James",
      password: "12345",
      phone: "12345",
      userStatus: 1,
      username: "theUser",
    },
    username: "Bo_Lynch4",
  });

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

run();

Parameters

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

Response

Promise<operations.UpdateUserFormResponse>

Errors

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

updateUserJson

This can only be done by the logged in user.

Example Usage

import { Test } from "Test";

async function run() {
  const sdk = new Test({
    security: {
      petstoreAuth: "<YOUR_PETSTORE_AUTH_HERE>",
    },
  });

  const res = await sdk.user.updateUserJson({
    user: {
      email: "[email protected]",
      firstName: "John",
      id: 10,
      lastName: "James",
      password: "12345",
      phone: "12345",
      userStatus: 1,
      username: "theUser",
    },
    username: "Alanna_Waters81",
  });

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

run();

Parameters

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

Response

Promise<operations.UpdateUserJsonResponse>

Errors

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

updateUserRaw

This can only be done by the logged in user.

Example Usage

import { Test } from "Test";

async function run() {
  const sdk = new Test({
    security: {
      petstoreAuth: "<YOUR_PETSTORE_AUTH_HERE>",
    },
  });

  const res = await sdk.user.updateUserRaw({
    requestBody: new TextEncoder().encode("0xf4D36eFb83"),
    username: "Eleonore2",
  });

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

run();

Parameters

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

Response

Promise<operations.UpdateUserRawResponse>

Errors

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