Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Claim

A container for claim-related data and static methods for interfacing with hackerapi.com

class

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Claim(__namedParameters?: { collaborators: undefined | {}[]; createdAt: undefined | Date; created_at: undefined | Date; eventSlug: undefined | string; event_slug: undefined | string; fields: undefined | {}; id: undefined | number; name: undefined | string; pipelineId: undefined | number; pipelineSlug: undefined | string; pipeline_id: undefined | number; pipeline_slug: undefined | string; reviews: undefined | {}[]; stage: undefined | {}; stageId: undefined | number; stage_id: undefined | number; updatedAt: undefined | Date; updated_at: undefined | Date; user: undefined | User; userId: undefined | number; user_id: undefined | number }): Claim

  • Creates a new Claim instance

    constructor

    Parameters

    • Default value __namedParameters: { collaborators: undefined | {}[]; createdAt: undefined | Date; created_at: undefined | Date; eventSlug: undefined | string; event_slug: undefined | string; fields: undefined | {}; id: undefined | number; name: undefined | string; pipelineId: undefined | number; pipelineSlug: undefined | string; pipeline_id: undefined | number; pipeline_slug: undefined | string; reviews: undefined | {}[]; stage: undefined | {}; stageId: undefined | number; stage_id: undefined | number; updatedAt: undefined | Date; updated_at: undefined | Date; user: undefined | User; userId: undefined | number; user_id: undefined | number } = {}
      • collaborators: undefined | {}[]
      • createdAt: undefined | Date
      • created_at: undefined | Date
      • eventSlug: undefined | string
      • event_slug: undefined | string
      • fields: undefined | {}
      • id: undefined | number
      • name: undefined | string
      • pipelineId: undefined | number
      • pipelineSlug: undefined | string
      • pipeline_id: undefined | number
      • pipeline_slug: undefined | string
      • reviews: undefined | {}[]
      • stage: undefined | {}
      • stageId: undefined | number
      • stage_id: undefined | number
      • updatedAt: undefined | Date
      • updated_at: undefined | Date
      • user: undefined | User
      • userId: undefined | number
      • user_id: undefined | number

    Returns Claim

Properties

Optional collaborators

collaborators: Partial<Collaborator>[]

Optional createdAt

createdAt: Date

Optional eventSlug

eventSlug: undefined | string

Optional fields

fields: undefined | {}

Optional id

id: undefined | number

Optional name

name: undefined | string

Optional pipelineId

pipelineId: undefined | number

Optional pipelineSlug

pipelineSlug: undefined | string

Optional reviews

reviews: Partial<Review>[]

specialHandlers

specialHandlers: {}

Type declaration

  • [key: string]: (...args: unknown[]) => [string, undefined | string]
      • (...args: unknown[]): [string, undefined | string]

      • Parameters

        • Rest ...args: unknown[]

        Returns [string, undefined | string]

Optional stage

stage: Partial<Stage>

Optional stageId

stageId: undefined | number

Optional updatedAt

updatedAt: Date

Optional user

user: User

Optional userId

userId: undefined | number

Accessors

Static Collaborator

Static FieldAnswer

Static Filters

Static Review

Methods

setFieldAnswer

  • setFieldAnswer(fieldAnswer: FieldAnswer, deepCopy?: boolean): void

toHackerAPIFormat

  • toHackerAPIFormat(method?: undefined | string): {}

Static create

  • create(__namedParameters: { id: string | number }, claim: Claim, token?: undefined | string): Promise<{}>

  • Creates a new claim for a pipeline

    Parameters

    • __namedParameters: { id: string | number }
      • id: string | number
    • claim: Claim
    • Optional token: undefined | string

    Returns Promise<{}>

Static dateHandler

  • dateHandler(key: string, date: string | Date): string[]

  • Converts a Javascript date (where only day, month and year are relevant) to a format understood by hackerapi

    Parameters

    • key: string
    • date: string | Date

      Doesn't do anything if string

    Returns string[]

    key: [0], value: [1]

Static dateTimeHandler

  • dateTimeHandler(key: string, datetime: string | Date): string[]

  • Converts Javascript date to a format understood by hackerapi

    Parameters

    • key: string
    • datetime: string | Date

    Returns string[]

    key: [0], value: [1]

Static delete

  • delete(__namedParameters: { id: undefined | number }, token?: undefined | string): Promise<null>

  • Deletes a claim using its ID from hackerapi

    Parameters

    • __namedParameters: { id: undefined | number }
      • id: undefined | number
    • Optional token: undefined | string

    Returns Promise<null>

Static doNotSendHandler

  • doNotSendHandler(key: string, _: any): (undefined | string)[]

  • Does not send the field to hackerapi

    Parameters

    • key: string
    • _: any

    Returns (undefined | string)[]

    key: [0], value: [1]

Static fetch

  • fetch(__namedParameters: { id: number }, token?: undefined | string): Promise<{}>

  • Gets a claim using its ID from hackerapi

    Parameters

    • __namedParameters: { id: number }
      • id: number
    • Optional token: undefined | string

    Returns Promise<{}>

Static fetchAllByPipeline

  • fetchAllByPipeline(__namedParameters: { id: string | number }, filters?: Filters, token?: undefined | string): Promise<{}[]>

  • Returns the filtered claims for a pipeline

    Parameters

    • __namedParameters: { id: string | number }
      • id: string | number
    • Optional filters: Filters
    • Optional token: undefined | string

    Returns Promise<{}[]>

Static fetchAllByUserId

  • fetchAllByUserId(__namedParameters?: { id: number | "me" }, pipeline?: Wild<{ slug: string }>, event?: Wild<{ slug: string }>, token?: undefined | string): Promise<{}[]>

  • Gets all the claims belonging to a user

    Parameters

    • Default value __namedParameters: { id: number | "me" } = { id: "me" }
      • id: number | "me"
    • Optional pipeline: Wild<{ slug: string }>
    • Optional event: Wild<{ slug: string }>
    • Optional token: undefined | string

    Returns Promise<{}[]>

Static renameHandler

  • renameHandler(renamedKey: string): (Anonymous function)

  • HOC for renaming a field before sending it to hackerapi

    Parameters

    • renamedKey: string

      The string to rename the key to

    Returns (Anonymous function)

    key: [0], value: [1]

Static update

  • update(claim: Claim, token?: undefined | string): Promise<{}>

  • Updates a claim on hackerapi

    Parameters

    • claim: Claim
    • Optional token: undefined | string

    Returns Promise<{}>

Static updateNoResponse

  • updateNoResponse(claim: Claim, token?: undefined | string): Promise<null>

  • Updates a claim on hackerapi. This method is faster than Claim.update because the claim is not returned in the response.

    Parameters

    • claim: Claim
    • Optional token: undefined | string

    Returns Promise<null>

Generated using TypeDoc