Skip to content

Latest commit

 

History

History
319 lines (225 loc) · 23.1 KB

README.md

File metadata and controls

319 lines (225 loc) · 23.1 KB

Admin

(admin)

Overview

Admin related operations, stay away from these.

Available Operations

getAccount

Example Usage

import { SteamSets } from "@steamsets/client-ts";

const steamSets = new SteamSets({
  token: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await steamSets.admin.getAccount({});

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { SteamSetsCore } from "@steamsets/client-ts/core.js";
import { adminGetAccount } from "@steamsets/client-ts/funcs/adminGetAccount.js";

// Use `SteamSetsCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const steamSets = new SteamSetsCore({
  token: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const res = await adminGetAccount(steamSets, {});

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter Type Required Description
request components.AccountSearch ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.AdminGetAccountResponse>

Errors

Error Type Status Code Content Type
errors.ErrorModel 403, 404, 422, 429 application/problem+json
errors.ErrorModel 500 application/problem+json
errors.SDKError 4XX, 5XX */*

removeVanity

Example Usage

import { SteamSets } from "@steamsets/client-ts";

const steamSets = new SteamSets({
  token: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await steamSets.admin.removeVanity({});

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { SteamSetsCore } from "@steamsets/client-ts/core.js";
import { adminRemoveVanity } from "@steamsets/client-ts/funcs/adminRemoveVanity.js";

// Use `SteamSetsCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const steamSets = new SteamSetsCore({
  token: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const res = await adminRemoveVanity(steamSets, {});

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter Type Required Description
request components.AccountSearch ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.AdminRemoveVanityResponse>

Errors

Error Type Status Code Content Type
errors.ErrorModel 403, 404, 422, 429 application/problem+json
errors.ErrorModel 500 application/problem+json
errors.SDKError 4XX, 5XX */*

updateResources

Example Usage

import { SteamSets } from "@steamsets/client-ts";

const steamSets = new SteamSets({
  token: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await steamSets.admin.updateResources({
    resources: [

    ],
  });

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { SteamSetsCore } from "@steamsets/client-ts/core.js";
import { adminUpdateResources } from "@steamsets/client-ts/funcs/adminUpdateResources.js";

// Use `SteamSetsCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const steamSets = new SteamSetsCore({
  token: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const res = await adminUpdateResources(steamSets, {
    resources: [
  
    ],
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter Type Required Description
request components.V1AdminUpdateResourcesRequestBody ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.AdminUpdateResourcesResponse>

Errors

Error Type Status Code Content Type
errors.ErrorModel 403, 404, 422, 429 application/problem+json
errors.ErrorModel 500 application/problem+json
errors.SDKError 4XX, 5XX */*

updateRoles

Example Usage

import { SteamSets } from "@steamsets/client-ts";

const steamSets = new SteamSets({
  token: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await steamSets.admin.updateRoles({
    roles: [
      "user",
      "beta",
    ],
  });

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { SteamSetsCore } from "@steamsets/client-ts/core.js";
import { adminUpdateRoles } from "@steamsets/client-ts/funcs/adminUpdateRoles.js";

// Use `SteamSetsCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const steamSets = new SteamSetsCore({
  token: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const res = await adminUpdateRoles(steamSets, {
    roles: [
      "user",
      "beta",
    ],
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter Type Required Description
request components.V1AdminUpdateRolesRequestBody ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.AdminUpdateRolesResponse>

Errors

Error Type Status Code Content Type
errors.ErrorModel 403, 404, 422, 429 application/problem+json
errors.ErrorModel 500 application/problem+json
errors.SDKError 4XX, 5XX */*