Skip to content

Latest commit

 

History

History
86 lines (81 loc) · 13.3 KB

v1getsettingsbody.md

File metadata and controls

86 lines (81 loc) · 13.3 KB

V1GetSettingsBody

Example Usage

import { V1GetSettingsBody } from "@steamsets/client-ts/models/components";

let value: V1GetSettingsBody = {
  dollarSchema: "https://api.steamsets.com/schemas/V1GetSettingsBody.json",
  chosenRole: {
    role: "top_100",
    tier: "tier_1",
  },
  connections: [
    {
      avatar:
        "https://cdn.cloudflare.steamstatic.com/steamcommunity/public/images/avatars/f1/f1a1d2c3d0c9d1e1f2f3f4f5f6f7f8f9.jpg",
      connectionId: "123456",
      externalId: "123456",
      failed: true,
      hide: true,
      name: "steamsets",
      provider: "discord",
      verified: true,
    },
  ],
  developerApps: [
    {
      apiKey: "api_123",
      description: "My App Description",
      environment: "production",
      id: "da_123456",
      name: "My App",
    },
  ],
  email: "[email protected]",
  emailVerifiedAt: new Date("2023-01-01T00:00:00Z"),
  hidden: true,
  images: [
    {
      active: true,
      fileName: "avatar.png",
      imageId: "img_wasd123",
      imageType: "avatar",
    },
  ],
  language: "en",
  privacy: "public",
  sessions: [
    {
      createdAt: new Date("2023-01-01T00:00:00Z"),
      expiresAt: new Date("2023-01-01T00:00:00Z"),
      ip: "127.0.0.1",
      lastSeen: new Date("2023-01-01T00:00:00Z"),
      level: 1,
      sessionId: "123456",
      userAgent:
        "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36",
    },
  ],
  subscribed: false,
  vanity: "flo",
  vanityAnalytics: {
    clicks: 99615,
  },
};

Fields

Field Type Required Description Example
dollarSchema string ➖ A URL to the JSON Schema for this object. https://api.steamsets.com/schemas/V1GetSettingsBody.json
chosenRole components.ChosenRole ✔️ N/A
connections components.Connection[] ✔️ The connections the account has
developerApps components.DeveloperApp[] ✔️ The developer apps the account has
email string ✔️ The email the account is using [email protected]
emailVerifiedAt Date ✔️ The time the email was verified 2023-01-01T00:00:00Z
hidden boolean ✔️ Whether the account is hidden in the leaderboards true
images components.Image[] ✔️ : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

The images the account has
language string ✔️ The language the account is using en
privacy components.V1GetSettingsBodyPrivacy ✔️ The privacy of the account public
sessions components.Session[] ✔️ The sessions the account has
subscribed boolean ✔️ Whether the account is subscribed to marketing emails
vanity string ✔️ The vanity the account is using flo
vanityAnalytics components.V1VanityAnalytics ✔️ N/A