Class Member

Base class for all Shortcut resources. Provides methods for creating, updating, and deleting resources.

Hierarchy (view full)

Implements

Constructors

Properties

availableOperations: ResourceOperation[] = []

The available operations for the resource, any not in this list will raise an error when called

baseUrl: string = 'https://api.app.shortcut.com/api/v3/members'
changedFields: string[] = []

Fields that have been changed, used to determine what to update. It is not recommended to access this property directly.

createFields: string[] = []

Fields that are used when creating a new resource

createdAt: string
disabled: boolean
entityType: string
groupIds: string[]
id: string
name: string
profile: MemberProfile
role: string
service: BaseService<BaseResource<default>, default> | BaseSearchableService<BaseResource<default>, default>
state: MemberState
updatedAt: string
baseUrl: string = 'https://api.app.shortcut.com/api/v3/members'

Accessors

Methods

  • Protected

    This method can be overridden by derived classes to perform any necessary operations before saving the resource

    Returns Promise<void>

  • Create a new instance of the resource, using the current object's properties. Use the xCreateData interface to determine which fields are available for creation.

    Returns Promise<Member>

    • A Promise that resolves with the newly created instance.

    Throws

    • Throws an error if the HTTP request fails.
  • Delete the current instance of the resource.

    Returns Promise<void>

    • A Promise that resolves when the resource has been deleted.

    Throws

    • Throws an error if the HTTP request fails.
  • Save the current instance of the resource. If the resource already exists (has an ID), it will be updated. Otherwise, it will be created using the fields createFields.

    Returns Promise<void>

  • Update the current instance of the resource with the changed fields.

    Returns Promise<void>

    • A Promise that resolves when the resource has been updated.

    Throws

    • Throws an error if the HTTP request fails.