Roles

Roles (scrims.roles)

Table of Contents

• Methods
• Method Signatures
• Related Type References

Methods

Method Signatures

create

create(
  role: RoleCreateInput,
): Promise<ScrimsRole>

update

update(
  roleId: string,
  data: RoleUpdateInput,
): Promise<ScrimsRole>

delete

delete(
  roleId: string,
): Promise<boolean>

Related Type References

JsonObject

type JsonObject = Record<string, unknown>;

ScrimsRole

type ScrimsRole = JsonObject
  & {
        _id?: string;
        name?: string;
        description?: string;
        permissions?: number | string;
        calendar?: string;
        color?: number;
        hoist?: boolean;
        icon?: string;
        managed?: boolean;
        mentionable?: boolean;
        rawPosition?: number;
        tags?: JsonObject;
        unicodeEmoji?: string;
        created_at?: string | Date;
        updated_at?: string | Date;
      };

RoleCreateInput

type RoleCreateInput = JsonObject
  & {
        name: string;
        calendar: string;
        permissions: number | string;
      };

RoleUpdateInput

type RoleUpdateInput = JsonObject
  & {
        name?: string;
        calendar?: string;
        permissions?: number | string;
      };