diff --git a/.gitignore b/.gitignore index 6637873..0d91023 100644 --- a/.gitignore +++ b/.gitignore @@ -85,11 +85,4 @@ tests/cases/user/axios-src/axios-src tests/cases/user/prettier/prettier .eslintcache *v8.log -**/*.env - - -getmember.json -getMembers.ts -members.json -getMember.ts -getIncident.ts \ No newline at end of file +**/*.env \ No newline at end of file diff --git a/README.md b/README.md index 98246a6..4f68887 100644 --- a/README.md +++ b/README.md @@ -44,4 +44,14 @@ The available commands are: Build simply builds the test project, while launch both builds and runs it. If you've made changes to lib, be sure to build there first. -Before launching, you should setup environment variables. `sample.env` shows you what variables are necessary. Copy the contents to a new file, `.env`, in the same folder and populate it appropriately. \ No newline at end of file +Before launching, you should setup environment variables. `sample.env` shows you what variables are necessary. Copy the contents to a new file, `.env`, in the same folder and populate it appropriately. + +## Contributing + +### Updating Docs + +To update typedoc docs after changes to code, run in the root of the repo: + +```npm install``` + +```npm run docs``` \ No newline at end of file diff --git a/docs/classes/default.html b/docs/classes/default.html index c1548a8..2d0e988 100644 --- a/docs/classes/default.html +++ b/docs/classes/default.html @@ -1,4 +1,4 @@ -default | d4h-typescript

Class default

Constructors

constructor +default | d4h-typescript

Class default

Constructors

constructor

Methods

getAnimal getAnimalQualification getAnimalQualifications @@ -16,10 +16,10 @@ getMembers updateCustomFields updateMember -

Constructors

constructor

Methods

getAnimal

  • getAnimal(
        context: string,
        contextId: number,
        id: number | "me",
    ): Promise<Animal>
  • -

    Parameters

    • context: string
    • contextId: number
    • id: number | "me"

    Returns Promise<Animal>

getAnimalQualification

  • getAnimalQualification(
        context: string,
        contextId: number,
        id: number,
    ): Promise<Qualification>

  • Parameters

    • context: string
    • contextId: number
    • id: number

    Returns Promise<Qualification>

getAnimalQualifications

getAnimals

getHandlerQualification

  • getHandlerQualification(
        context: string,
        contextId: number,
        id: number,
    ): Promise<Qualification>

  • Parameters

    • context: string
    • contextId: number
    • id: number

    Returns Promise<Qualification>

getHandlerQualifications

getIncident

  • getIncident(
        context: string,
        contextId: number,
        activityId: number,
    ): Promise<Incident>
  • -

    Parameters

    • context: string
    • contextId: number
    • activityId: number

    Returns Promise<Incident>

getIncidents

getMember

  • getMember(
        context: string,
        contextId: number,
        id: number | "me",
        options?: GetMemberOptions,
    ): Promise<Member>
  • -

    Parameters

    • context: string
    • contextId: number
    • id: number | "me"
    • Optionaloptions: GetMemberOptions

    Returns Promise<Member>

getMemberAwards

getMemberGroup

  • getMemberGroup(
        context: string,
        contextId: number,
        groupId: number,
    ): Promise<memberGroup>
  • -

    Parameters

    • context: string
    • contextId: number
    • groupId: number

    Returns Promise<memberGroup>

getMemberGroups

getMemberQualification

  • getMemberQualification(
        context: string,
        contextId: number,
        id: number | "me",
    ): Promise<Qualification>
  • -

    Parameters

    • context: string
    • contextId: number
    • id: number | "me"

    Returns Promise<Qualification>

getMemberQualifications

getMembers

updateCustomFields

  • updateCustomFields(
        entity: Entity,
        updates: CustomFieldUpdate[],
        onlyMemberEditOwn: boolean,
    ): Promise<void>
  • -

    Parameters

    Returns Promise<void>

updateMember

  • updateMember(
        context: string,
        contextId: number,
        id: number,
        updates: MemberUpdate,
    ): Promise<void>

  • Parameters

    • context: string
    • contextId: number
    • id: number
    • updates: MemberUpdate

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

getAnimal

  • getAnimal(
        context: string,
        contextId: number,
        id: number | "me",
    ): Promise<Animal>
  • +

    Parameters

    • context: string
    • contextId: number
    • id: number | "me"

    Returns Promise<Animal>

getAnimalQualification

  • getAnimalQualification(
        context: string,
        contextId: number,
        id: number,
    ): Promise<Qualification>

  • Parameters

    • context: string
    • contextId: number
    • id: number

    Returns Promise<Qualification>

getAnimalQualifications

getAnimals

getHandlerQualification

  • getHandlerQualification(
        context: string,
        contextId: number,
        id: number,
    ): Promise<Qualification>

  • Parameters

    • context: string
    • contextId: number
    • id: number

    Returns Promise<Qualification>

getHandlerQualifications

getIncident

  • getIncident(
        context: string,
        contextId: number,
        activityId: number,
    ): Promise<Incident>
  • +

    Parameters

    • context: string
    • contextId: number
    • activityId: number

    Returns Promise<Incident>

getIncidents

getMember

  • getMember(
        context: string,
        contextId: number,
        id: number | "me",
        options?: GetMemberOptions,
    ): Promise<Member>
  • +

    Parameters

    • context: string
    • contextId: number
    • id: number | "me"
    • Optionaloptions: GetMemberOptions

    Returns Promise<Member>

getMemberAwards

getMemberGroup

  • getMemberGroup(
        context: string,
        contextId: number,
        groupId: number,
    ): Promise<memberGroup>
  • +

    Parameters

    • context: string
    • contextId: number
    • groupId: number

    Returns Promise<memberGroup>

getMemberGroups

getMemberQualification

  • getMemberQualification(
        context: string,
        contextId: number,
        id: number | "me",
    ): Promise<Qualification>
  • +

    Parameters

    • context: string
    • contextId: number
    • id: number | "me"

    Returns Promise<Qualification>

getMemberQualifications

getMembers

updateCustomFields

  • updateCustomFields(
        entity: Entity,
        updates: CustomFieldUpdate[],
        onlyMemberEditOwn: boolean,
    ): Promise<void>
  • +

    Parameters

    Returns Promise<void>

updateMember

  • updateMember(
        context: string,
        contextId: number,
        id: number,
        updates: MemberUpdate,
    ): Promise<void>

  • Parameters

    • context: string
    • contextId: number
    • id: number
    • updates: MemberUpdate

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/docs/enums/CustomFieldType.html b/docs/enums/CustomFieldType.html index de6a6a1..2885f42 100644 --- a/docs/enums/CustomFieldType.html +++ b/docs/enums/CustomFieldType.html @@ -1,4 +1,4 @@ -CustomFieldType | d4h-typescript

Enumeration CustomFieldType

Enumeration Members

Date +CustomFieldType | d4h-typescript

Enumeration CustomFieldType

Enumeration Members

Date Number Text -

Enumeration Members

Date

Date: "date"

Number

Number: "number"

Text

Text: "text"

Settings

Member Visibility

On This Page

Enumeration Members
+

Enumeration Members

Date

Date: "date"

Number

Number: "number"

Text

Text: "text"

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/docs/index.html b/docs/index.html index 803ef00..24c4f64 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,6 +1,6 @@ d4h-typescript

d4h-typescript

d4h-typescript

Typescript library for accessing D4H

Documentation

Typedoc Generated Documentation available at:

-

https://chewbaccalakis.github.io/d4h-typescript/modules.html

+

https://kc4x4sar.github.io/d4h-typescript

How to Consume

This library is not in NPM. As a result, you need to add it to your project locally. To do so, you have three options:

  1. Add the repository to the consuming repository as a Git submodule.
    2. @@ -27,4 +27,7 @@

    Build simply builds the test project, while launch both builds and runs it. If you've made changes to lib, be sure to build there first.

    Before launching, you should setup environment variables. sample.env shows you what variables are necessary. Copy the contents to a new file, .env, in the same folder and populate it appropriately.

    -

Settings

Member Visibility

On This Page

d4h-typescript
+

Contributing

Updating Docs

To update typedoc docs after changes to code, run in the root of the repo:

+

npm install

+

npm run docs

+

Settings

Member Visibility

On This Page

d4h-typescript
diff --git a/docs/interfaces/AddressInfo.html b/docs/interfaces/AddressInfo.html index 4d9b1ff..a59221c 100644 --- a/docs/interfaces/AddressInfo.html +++ b/docs/interfaces/AddressInfo.html @@ -1,6 +1,6 @@ -AddressInfo | d4h-typescript

Interface AddressInfo

interface AddressInfo {
    country: string;
    postCode: string;
    region: string;
    street: string;
    town: string;
}

Properties

country +AddressInfo | d4h-typescript

Interface AddressInfo

interface AddressInfo {
    country: string;
    postCode: string;
    region: string;
    street: string;
    town: string;
}

Properties

country postCode region street town -

Properties

country

country: string

postCode

postCode: string

region

region: string

street

street: string

town

town: string

Settings

Member Visibility

On This Page

Properties
+

Properties

country

country: string

postCode

postCode: string

region

region: string

street

street: string

town

town: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/Animal.html b/docs/interfaces/Animal.html index 36ad489..c171767 100644 --- a/docs/interfaces/Animal.html +++ b/docs/interfaces/Animal.html @@ -1,4 +1,4 @@ -Animal | d4h-typescript

Interface Animal

interface Animal {
    bornAt: string;
    breed: string;
    countRollingHours: number;
    createdAt: string;
    custom_fields?: CustomField[];
    entityType: EntityType;
    id: number;
    joinedAt: string;
    leftAt: null | string;
    name: string;
    notes: string;
    ref: string;
    resourceType: string;
    status: string;
    type: string;
    updatedAt: string;
}

Hierarchy

  • Entity
    • Animal

Properties

bornAt +Animal | d4h-typescript

Interface Animal

interface Animal {
    bornAt: string;
    breed: string;
    countRollingHours: number;
    createdAt: string;
    custom_fields?: CustomField[];
    entityType: EntityType;
    id: number;
    joinedAt: string;
    leftAt: null | string;
    name: string;
    notes: string;
    ref: string;
    resourceType: string;
    status: string;
    type: string;
    updatedAt: string;
}

Hierarchy

  • Entity
    • Animal

Properties

bornAt breed countRollingHours createdAt @@ -14,4 +14,4 @@ status type updatedAt -

Properties

bornAt

bornAt: string

breed

breed: string

countRollingHours

countRollingHours: number

createdAt

createdAt: string

Optionalcustom_fields

custom_fields?: CustomField[]

entityType

entityType: EntityType

id

id: number

joinedAt

joinedAt: string

leftAt

leftAt: null | string

name

name: string

notes

notes: string

ref

ref: string

resourceType

resourceType: string

status

status: string

type

type: string

updatedAt

updatedAt: string

Settings

Member Visibility

On This Page

Properties
+

Properties

bornAt

bornAt: string

breed

breed: string

countRollingHours

countRollingHours: number

createdAt

createdAt: string

Optionalcustom_fields

custom_fields?: CustomField[]

entityType

entityType: EntityType

id

id: number

joinedAt

joinedAt: string

leftAt

leftAt: null | string

name

name: string

notes

notes: string

ref

ref: string

resourceType

resourceType: string

status

status: string

type

type: string

updatedAt

updatedAt: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/CustomField.html b/docs/interfaces/CustomField.html index 34ac78a..8eaaad5 100644 --- a/docs/interfaces/CustomField.html +++ b/docs/interfaces/CustomField.html @@ -1,8 +1,8 @@ -CustomField | d4h-typescript

Interface CustomField

interface CustomField {
    bundle: unknown;
    id: number;
    label: string;
    member_edit_own: boolean;
    type: CustomFieldType;
    value: null | string;
    value_string: null | string;
}

Properties

bundle +CustomField | d4h-typescript

Interface CustomField

interface CustomField {
    bundle: unknown;
    id: number;
    label: string;
    member_edit_own: boolean;
    type: CustomFieldType;
    value: null | string;
    value_string: null | string;
}

Properties

bundle id label member_edit_own type value value_string -

Properties

bundle

bundle: unknown

id

id: number

label

label: string

member_edit_own

member_edit_own: boolean

type

type: CustomFieldType

value

value: null | string

value_string

value_string: null | string

Settings

Member Visibility

On This Page

Properties
+

Properties

bundle

bundle: unknown

id

id: number

label

label: string

member_edit_own

member_edit_own: boolean

type

type: CustomFieldType

value

value: null | string

value_string

value_string: null | string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/CustomFieldUpdate.html b/docs/interfaces/CustomFieldUpdate.html index 282589f..b61d418 100644 --- a/docs/interfaces/CustomFieldUpdate.html +++ b/docs/interfaces/CustomFieldUpdate.html @@ -1,3 +1,3 @@ -CustomFieldUpdate | d4h-typescript

Interface CustomFieldUpdate

interface CustomFieldUpdate {
    id: number;
    value: null | string;
}

Properties

id +CustomFieldUpdate | d4h-typescript

Interface CustomFieldUpdate

interface CustomFieldUpdate {
    id: number;
    value: null | string;
}

Properties

id value -

Properties

id

id: number

value

value: null | string

Settings

Member Visibility

On This Page

Properties
+

Properties

id

id: number

value

value: null | string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/CustomMemberStatus.html b/docs/interfaces/CustomMemberStatus.html index 6c627b6..582d62c 100644 --- a/docs/interfaces/CustomMemberStatus.html +++ b/docs/interfaces/CustomMemberStatus.html @@ -1,3 +1,3 @@ -CustomMemberStatus | d4h-typescript

Interface CustomMemberStatus

interface CustomMemberStatus {
    id: null | number;
    resourceType: string;
}

Properties

id +CustomMemberStatus | d4h-typescript

Interface CustomMemberStatus

interface CustomMemberStatus {
    id: null | number;
    resourceType: string;
}

Properties

id resourceType -

Properties

id

id: null | number

resourceType

resourceType: string

Settings

Member Visibility

On This Page

Properties
+

Properties

id

id: null | number

resourceType

resourceType: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/EmailInfo.html b/docs/interfaces/EmailInfo.html index b83aaee..1e2a3fc 100644 --- a/docs/interfaces/EmailInfo.html +++ b/docs/interfaces/EmailInfo.html @@ -1,3 +1,3 @@ -EmailInfo | d4h-typescript

Interface EmailInfo

interface EmailInfo {
    value: string;
    verified: boolean;
}

Properties

value +EmailInfo | d4h-typescript

Interface EmailInfo

interface EmailInfo {
    value: string;
    verified: boolean;
}

Properties

value verified -

Properties

value

value: string

verified

verified: boolean

Settings

Member Visibility

On This Page

Properties
+

Properties

value

value: string

verified

verified: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/EquipmentLocation.html b/docs/interfaces/EquipmentLocation.html index 2f4b45f..07ab1d6 100644 --- a/docs/interfaces/EquipmentLocation.html +++ b/docs/interfaces/EquipmentLocation.html @@ -1,3 +1,3 @@ -EquipmentLocation | d4h-typescript

Interface EquipmentLocation

interface EquipmentLocation {
    id: null | number;
    resourceType: string;
}

Properties

id +EquipmentLocation | d4h-typescript

Interface EquipmentLocation

interface EquipmentLocation {
    id: null | number;
    resourceType: string;
}

Properties

id resourceType -

Properties

id

id: null | number

resourceType

resourceType: string

Settings

Member Visibility

On This Page

Properties
+

Properties

id

id: null | number

resourceType

resourceType: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/GetAnimalsOptions.html b/docs/interfaces/GetAnimalsOptions.html index 20042fb..171566c 100644 --- a/docs/interfaces/GetAnimalsOptions.html +++ b/docs/interfaces/GetAnimalsOptions.html @@ -1,4 +1,4 @@ -GetAnimalsOptions | d4h-typescript

Interface GetAnimalsOptions

interface GetAnimalsOptions {
    handler_member_id?: number | number[];
    id?: number | number[];
    order?: "asc" | "desc";
    page?: number;
    size?: number;
    sort?: string | string[];
    status?: string;
    team_id?: number;
}

Properties

handler_member_id? +GetAnimalsOptions | d4h-typescript

Interface GetAnimalsOptions

interface GetAnimalsOptions {
    handler_member_id?: number | number[];
    id?: number | number[];
    order?: "asc" | "desc";
    page?: number;
    size?: number;
    sort?: string | string[];
    status?: string;
    team_id?: number;
}

Properties

handler_member_id? id? order? page? @@ -6,4 +6,4 @@ sort? status? team_id? -

Properties

Optionalhandler_member_id

handler_member_id?: number | number[]

Optionalid

id?: number | number[]

Optionalorder

order?: "asc" | "desc"

Optionalpage

page?: number

Optionalsize

size?: number

Optionalsort

sort?: string | string[]

Optionalstatus

status?: string

Optionalteam_id

team_id?: number

Settings

Member Visibility

On This Page

Properties
+

Properties

Optionalhandler_member_id

handler_member_id?: number | number[]

Optionalid

id?: number | number[]

Optionalorder

order?: "asc" | "desc"

Optionalpage

page?: number

Optionalsize

size?: number

Optionalsort

sort?: string | string[]

Optionalstatus

status?: string

Optionalteam_id

team_id?: number

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/GetGroupsOptions.html b/docs/interfaces/GetGroupsOptions.html index e61f7fc..271d861 100644 --- a/docs/interfaces/GetGroupsOptions.html +++ b/docs/interfaces/GetGroupsOptions.html @@ -1,3 +1,3 @@ -GetGroupsOptions | d4h-typescript

Interface GetGroupsOptions

interface GetGroupsOptions {
    memberId?: number;
    title?: string;
}

Properties

memberId? +GetGroupsOptions | d4h-typescript

Interface GetGroupsOptions

interface GetGroupsOptions {
    memberId?: number;
    title?: string;
}

Properties

memberId? title? -

Properties

OptionalmemberId

memberId?: number

Optionaltitle

title?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

OptionalmemberId

memberId?: number

Optionaltitle

title?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/GetIncidentOptions.html b/docs/interfaces/GetIncidentOptions.html index c338fcd..3293690 100644 --- a/docs/interfaces/GetIncidentOptions.html +++ b/docs/interfaces/GetIncidentOptions.html @@ -1,4 +1,4 @@ -GetIncidentOptions | d4h-typescript

Interface GetIncidentOptions

interface GetIncidentOptions {
    after?: string;
    before?: string;
    deleted?: boolean;
    ends_before?: string;
    id?: number | number[];
    order?: "asc" | "desc";
    page?: number;
    published?: boolean;
    reference?: string;
    size?: number;
    sort?: string | string[];
    starts_after?: string;
    tag_bundle_id?: number;
    tag_id?: number;
    team_id?: number;
}

Properties

after? +GetIncidentOptions | d4h-typescript

Interface GetIncidentOptions

interface GetIncidentOptions {
    after?: string;
    before?: string;
    deleted?: boolean;
    ends_before?: string;
    id?: number | number[];
    order?: "asc" | "desc";
    page?: number;
    published?: boolean;
    reference?: string;
    size?: number;
    sort?: string | string[];
    starts_after?: string;
    tag_bundle_id?: number;
    tag_id?: number;
    team_id?: number;
}

Properties

after? before? deleted? ends_before? @@ -13,4 +13,4 @@ tag_bundle_id? tag_id? team_id? -

Properties

Optionalafter

after?: string

Optionalbefore

before?: string

Optionaldeleted

deleted?: boolean

Optionalends_before

ends_before?: string

Optionalid

id?: number | number[]

Optionalorder

order?: "asc" | "desc"

Optionalpage

page?: number

Optionalpublished

published?: boolean

Optionalreference

reference?: string

Optionalsize

size?: number

Optionalsort

sort?: string | string[]

Optionalstarts_after

starts_after?: string

Optionaltag_bundle_id

tag_bundle_id?: number

Optionaltag_id

tag_id?: number

Optionalteam_id

team_id?: number

Settings

Member Visibility

On This Page

Properties
+

Properties

Optionalafter

after?: string

Optionalbefore

before?: string

Optionaldeleted

deleted?: boolean

Optionalends_before

ends_before?: string

Optionalid

id?: number | number[]

Optionalorder

order?: "asc" | "desc"

Optionalpage

page?: number

Optionalpublished

published?: boolean

Optionalreference

reference?: string

Optionalsize

size?: number

Optionalsort

sort?: string | string[]

Optionalstarts_after

starts_after?: string

Optionaltag_bundle_id

tag_bundle_id?: number

Optionaltag_id

tag_id?: number

Optionalteam_id

team_id?: number

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/GetMemberAwardsOptions.html b/docs/interfaces/GetMemberAwardsOptions.html index 2d2eebb..7eb9ae0 100644 --- a/docs/interfaces/GetMemberAwardsOptions.html +++ b/docs/interfaces/GetMemberAwardsOptions.html @@ -1,9 +1,9 @@ -GetMemberAwardsOptions | d4h-typescript

Interface GetMemberAwardsOptions

interface GetMemberAwardsOptions {
    exclude_org_data?: boolean;
    exclude_teams_data?: boolean;
    member_id: number | "me";
    order?: "asc" | "desc";
    page?: number;
    qualification_id?: number;
    size?: number;
    sort?: string | string[];
}

Properties

exclude_org_data? +GetMemberAwardsOptions | d4h-typescript

Interface GetMemberAwardsOptions

interface GetMemberAwardsOptions {
    exclude_org_data?: boolean;
    exclude_teams_data?: boolean;
    member_id?: number | "me";
    order?: "asc" | "desc";
    page?: number;
    qualification_id?: number;
    size?: number;
    sort?: string | string[];
}

Properties

exclude_org_data? exclude_teams_data? -member_id +member_id? order? page? qualification_id? size? sort? -

Properties

Optionalexclude_org_data

exclude_org_data?: boolean

Optionalexclude_teams_data

exclude_teams_data?: boolean

member_id

member_id: number | "me"

Optionalorder

order?: "asc" | "desc"

Optionalpage

page?: number

Optionalqualification_id

qualification_id?: number

Optionalsize

size?: number

Optionalsort

sort?: string | string[]

Settings

Member Visibility

On This Page

Properties
+

Properties

Optionalexclude_org_data

exclude_org_data?: boolean

Optionalexclude_teams_data

exclude_teams_data?: boolean

Optionalmember_id

member_id?: number | "me"

Optionalorder

order?: "asc" | "desc"

Optionalpage

page?: number

Optionalqualification_id

qualification_id?: number

Optionalsize

size?: number

Optionalsort

sort?: string | string[]

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/GetMemberGroupsOptions.html b/docs/interfaces/GetMemberGroupsOptions.html index 0753baa..0506d96 100644 --- a/docs/interfaces/GetMemberGroupsOptions.html +++ b/docs/interfaces/GetMemberGroupsOptions.html @@ -1,8 +1,8 @@ -GetMemberGroupsOptions | d4h-typescript

Interface GetMemberGroupsOptions

interface GetMemberGroupsOptions {
    id: number;
    order?: "asc" | "desc";
    page?: number;
    size?: number;
    sort?: string | string[];
    team_id?: number | number[];
    title?: string;
}

Properties

id +GetMemberGroupsOptions | d4h-typescript

Interface GetMemberGroupsOptions

interface GetMemberGroupsOptions {
    id: number;
    order?: "asc" | "desc";
    page?: number;
    size?: number;
    sort?: string | string[];
    team_id?: number | number[];
    title?: string;
}

Properties

id order? page? size? sort? team_id? title? -

Properties

id

id: number

Optionalorder

order?: "asc" | "desc"

Optionalpage

page?: number

Optionalsize

size?: number

Optionalsort

sort?: string | string[]

Optionalteam_id

team_id?: number | number[]

Optionaltitle

title?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

id

id: number

Optionalorder

order?: "asc" | "desc"

Optionalpage

page?: number

Optionalsize

size?: number

Optionalsort

sort?: string | string[]

Optionalteam_id

team_id?: number | number[]

Optionaltitle

title?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/GetMemberOptions.html b/docs/interfaces/GetMemberOptions.html index df6281e..44c4aa7 100644 --- a/docs/interfaces/GetMemberOptions.html +++ b/docs/interfaces/GetMemberOptions.html @@ -1,2 +1,2 @@ -GetMemberOptions | d4h-typescript

Interface GetMemberOptions

interface GetMemberOptions {
    includeDetails?: boolean;
}

Properties

includeDetails? -

Properties

OptionalincludeDetails

includeDetails?: boolean

Settings

Member Visibility

On This Page

Properties
+GetMemberOptions | d4h-typescript

Interface GetMemberOptions

interface GetMemberOptions {
    includeDetails?: boolean;
}

Properties

includeDetails? +

Properties

OptionalincludeDetails

includeDetails?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/GetMembersOptions.html b/docs/interfaces/GetMembersOptions.html index 6c63741..05be6a4 100644 --- a/docs/interfaces/GetMembersOptions.html +++ b/docs/interfaces/GetMembersOptions.html @@ -1,4 +1,4 @@ -GetMembersOptions | d4h-typescript

Interface GetMembersOptions

interface GetMembersOptions {
    deleted?: boolean;
    id_tag?: string;
    name?: string;
    order?: "asc" | "desc";
    page?: number;
    size?: number;
    sort?: string | string[];
    statuses?: (null | number)[];
    team_id?: number;
}

Properties

deleted? +GetMembersOptions | d4h-typescript

Interface GetMembersOptions

interface GetMembersOptions {
    deleted?: boolean;
    id_tag?: string;
    name?: string;
    order?: "asc" | "desc";
    page?: number;
    size?: number;
    sort?: string | string[];
    statuses?: (null | number)[];
    team_id?: number;
}

Properties

deleted? id_tag? name? order? @@ -7,4 +7,4 @@ sort? statuses? team_id? -

Properties

Optionaldeleted

deleted?: boolean

Optionalid_tag

id_tag?: string

Optionalname

name?: string

Optionalorder

order?: "asc" | "desc"

Optionalpage

page?: number

Optionalsize

size?: number

Optionalsort

sort?: string | string[]

Optionalstatuses

statuses?: (null | number)[]

Optionalteam_id

team_id?: number

Settings

Member Visibility

On This Page

Properties
+

Properties

Optionaldeleted

deleted?: boolean

Optionalid_tag

id_tag?: string

Optionalname

name?: string

Optionalorder

order?: "asc" | "desc"

Optionalpage

page?: number

Optionalsize

size?: number

Optionalsort

sort?: string | string[]

Optionalstatuses

statuses?: (null | number)[]

Optionalteam_id

team_id?: number

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/GetQualificationOptions.html b/docs/interfaces/GetQualificationOptions.html index de26b10..82ea3f8 100644 --- a/docs/interfaces/GetQualificationOptions.html +++ b/docs/interfaces/GetQualificationOptions.html @@ -1,8 +1,8 @@ -GetQualificationOptions | d4h-typescript

Interface GetQualificationOptions

interface GetQualificationOptions {
    exclude_org_data?: boolean;
    exclude_teams_data?: boolean;
    order?: "asc" | "desc";
    page?: number;
    size?: number;
    sort?: string | string[];
    title?: string;
}

Properties

exclude_org_data? +GetQualificationOptions | d4h-typescript

Interface GetQualificationOptions

interface GetQualificationOptions {
    exclude_org_data?: boolean;
    exclude_teams_data?: boolean;
    order?: "asc" | "desc";
    page?: number;
    size?: number;
    sort?: string | string[];
    title?: string;
}

Properties

exclude_org_data? exclude_teams_data? order? page? size? sort? title? -

Properties

Optionalexclude_org_data

exclude_org_data?: boolean

Optionalexclude_teams_data

exclude_teams_data?: boolean

Optionalorder

order?: "asc" | "desc"

Optionalpage

page?: number

Optionalsize

size?: number

Optionalsort

sort?: string | string[]

Optionaltitle

title?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Optionalexclude_org_data

exclude_org_data?: boolean

Optionalexclude_teams_data

exclude_teams_data?: boolean

Optionalorder

order?: "asc" | "desc"

Optionalpage

page?: number

Optionalsize

size?: number

Optionalsort

sort?: string | string[]

Optionaltitle

title?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/Incident.html b/docs/interfaces/Incident.html index 3919947..0c19d61 100644 --- a/docs/interfaces/Incident.html +++ b/docs/interfaces/Incident.html @@ -1,4 +1,4 @@ -Incident | d4h-typescript

Interface Incident

interface Incident {
    address: AddressInfo;
    approved: boolean;
    bearing: number;
    coordinator: null | string;
    countAttendance: number;
    countGuests: number;
    createdAt: string;
    createdOrPublishedAt: string;
    custom_fields?: CustomField[];
    description: string;
    descriptionDeprecated: string;
    distance: number;
    endsAt: string;
    entityType: EntityType;
    fullTeam: boolean;
    id: number;
    location: IncidentLocation;
    locationBookmark: IncidentLocationBookmark;
    night: boolean;
    owner: IncidentOwner;
    percAttendance: number;
    plan: null | string;
    planDeprecated: null | string;
    published: boolean;
    reference: string;
    referenceDescription: string;
    resourceType: string;
    selfCoordinator: boolean;
    shared: boolean;
    startsAt: string;
    tags: IncidentTag[];
    trackingNumber: null | string;
    updatedAt: string;
    weather: WeatherInfo;
    weatherCloudCover: null | number;
    weatherPressure: null | number;
}

Hierarchy

  • Entity
    • Incident

Properties

address +Incident | d4h-typescript

Interface Incident

interface Incident {
    address: AddressInfo;
    approved: boolean;
    bearing: number;
    coordinator: null | string;
    countAttendance: number;
    countGuests: number;
    createdAt: string;
    createdOrPublishedAt: string;
    custom_fields?: CustomField[];
    description: string;
    descriptionDeprecated: string;
    distance: number;
    endsAt: string;
    entityType: EntityType;
    fullTeam: boolean;
    id: number;
    location: IncidentLocation;
    locationBookmark: IncidentLocationBookmark;
    night: boolean;
    owner: IncidentOwner;
    percAttendance: number;
    plan: null | string;
    planDeprecated: null | string;
    published: boolean;
    reference: string;
    referenceDescription: string;
    resourceType: string;
    selfCoordinator: boolean;
    shared: boolean;
    startsAt: string;
    tags: IncidentTag[];
    trackingNumber: null | string;
    updatedAt: string;
    weather: WeatherInfo;
    weatherCloudCover: null | number;
    weatherPressure: null | number;
}

Hierarchy

  • Entity
    • Incident

Properties

address approved bearing coordinator @@ -34,4 +34,4 @@ weather weatherCloudCover weatherPressure -

Properties

address

address: AddressInfo

approved

approved: boolean

bearing

bearing: number

coordinator

coordinator: null | string

countAttendance

countAttendance: number

countGuests

countGuests: number

createdAt

createdAt: string

createdOrPublishedAt

createdOrPublishedAt: string

Optionalcustom_fields

custom_fields?: CustomField[]

description

description: string

descriptionDeprecated

descriptionDeprecated: string

distance

distance: number

endsAt

endsAt: string

entityType

entityType: EntityType

fullTeam

fullTeam: boolean

id

id: number

location

location: IncidentLocation

locationBookmark

locationBookmark: IncidentLocationBookmark

night

night: boolean

owner

owner: IncidentOwner

percAttendance

percAttendance: number

plan

plan: null | string

planDeprecated

planDeprecated: null | string

published

published: boolean

reference

reference: string

referenceDescription

referenceDescription: string

resourceType

resourceType: string

selfCoordinator

selfCoordinator: boolean

shared

shared: boolean

startsAt

startsAt: string

tags

tags: IncidentTag[]

trackingNumber

trackingNumber: null | string

updatedAt

updatedAt: string

weather

weather: WeatherInfo

weatherCloudCover

weatherCloudCover: null | number

weatherPressure

weatherPressure: null | number

Settings

Member Visibility

On This Page

Properties
+

Properties

address

address: AddressInfo

approved

approved: boolean

bearing

bearing: number

coordinator

coordinator: null | string

countAttendance

countAttendance: number

countGuests

countGuests: number

createdAt

createdAt: string

createdOrPublishedAt

createdOrPublishedAt: string

Optionalcustom_fields

custom_fields?: CustomField[]

description

description: string

descriptionDeprecated

descriptionDeprecated: string

distance

distance: number

endsAt

endsAt: string

entityType

entityType: EntityType

fullTeam

fullTeam: boolean

id

id: number

location

location: IncidentLocation

locationBookmark

locationBookmark: IncidentLocationBookmark

night

night: boolean

owner

owner: IncidentOwner

percAttendance

percAttendance: number

plan

plan: null | string

planDeprecated

planDeprecated: null | string

published

published: boolean

reference

reference: string

referenceDescription

referenceDescription: string

resourceType

resourceType: string

selfCoordinator

selfCoordinator: boolean

shared

shared: boolean

startsAt

startsAt: string

tags

tags: IncidentTag[]

trackingNumber

trackingNumber: null | string

updatedAt

updatedAt: string

weather

weather: WeatherInfo

weatherCloudCover

weatherCloudCover: null | number

weatherPressure

weatherPressure: null | number

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/IncidentLocation.html b/docs/interfaces/IncidentLocation.html index 6d61e25..0cfedb8 100644 --- a/docs/interfaces/IncidentLocation.html +++ b/docs/interfaces/IncidentLocation.html @@ -1,3 +1,3 @@ -IncidentLocation | d4h-typescript

Interface IncidentLocation

interface IncidentLocation {
    coordinates: [number, number];
    type: string;
}

Properties

coordinates +IncidentLocation | d4h-typescript

Interface IncidentLocation

interface IncidentLocation {
    coordinates: [number, number];
    type: string;
}

Properties

coordinates type -

Properties

coordinates

coordinates: [number, number]

type

type: string

Settings

Member Visibility

On This Page

Properties
+

Properties

coordinates

coordinates: [number, number]

type

type: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/IncidentLocationBookmark.html b/docs/interfaces/IncidentLocationBookmark.html index d84799f..6991e32 100644 --- a/docs/interfaces/IncidentLocationBookmark.html +++ b/docs/interfaces/IncidentLocationBookmark.html @@ -1,3 +1,3 @@ -IncidentLocationBookmark | d4h-typescript

Interface IncidentLocationBookmark

interface IncidentLocationBookmark {
    id: null | number;
    resourceType: string;
}

Properties

id +IncidentLocationBookmark | d4h-typescript

Interface IncidentLocationBookmark

interface IncidentLocationBookmark {
    id: null | number;
    resourceType: string;
}

Properties

id resourceType -

Properties

id

id: null | number

resourceType

resourceType: string

Settings

Member Visibility

On This Page

Properties
+

Properties

id

id: null | number

resourceType

resourceType: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/IncidentOwner.html b/docs/interfaces/IncidentOwner.html index c7429d0..28976b1 100644 --- a/docs/interfaces/IncidentOwner.html +++ b/docs/interfaces/IncidentOwner.html @@ -1,3 +1,3 @@ -IncidentOwner | d4h-typescript

Interface IncidentOwner

interface IncidentOwner {
    id: number;
    resourceType: string;
}

Properties

id +IncidentOwner | d4h-typescript

Interface IncidentOwner

interface IncidentOwner {
    id: number;
    resourceType: string;
}

Properties

id resourceType -

Properties

id

id: number

resourceType

resourceType: string

Settings

Member Visibility

On This Page

Properties
+

Properties

id

id: number

resourceType

resourceType: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/IncidentRoster.html b/docs/interfaces/IncidentRoster.html index 2f4878f..e24ab09 100644 --- a/docs/interfaces/IncidentRoster.html +++ b/docs/interfaces/IncidentRoster.html @@ -1,7 +1,7 @@ -IncidentRoster | d4h-typescript

Interface IncidentRoster

interface IncidentRoster {
    date: string;
    enddate: string;
    id: number;
    member: { id: number; name: string };
    role: { bundle: string; id: number; title: string };
    status: string;
}

Properties

date +IncidentRoster | d4h-typescript

Interface IncidentRoster

interface IncidentRoster {
    date: string;
    enddate: string;
    id: number;
    member: { id: number; name: string };
    role: { bundle: string; id: number; title: string };
    status: string;
}

Properties

date enddate id member role status -

Properties

date

date: string

enddate

enddate: string

id

id: number

member

member: { id: number; name: string }

role

role: { bundle: string; id: number; title: string }

status

status: string

Settings

Member Visibility

On This Page

Properties
+

Properties

date

date: string

enddate

enddate: string

id

id: number

member

member: { id: number; name: string }

role

role: { bundle: string; id: number; title: string }

status

status: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/IncidentTag.html b/docs/interfaces/IncidentTag.html index ae95809..7b4ef9a 100644 --- a/docs/interfaces/IncidentTag.html +++ b/docs/interfaces/IncidentTag.html @@ -1,3 +1,3 @@ -IncidentTag | d4h-typescript

Interface IncidentTag

interface IncidentTag {
    id: number;
    resourceType: string;
}

Properties

id +IncidentTag | d4h-typescript

Interface IncidentTag

interface IncidentTag {
    id: number;
    resourceType: string;
}

Properties

id resourceType -

Properties

id

id: number

resourceType

resourceType: string

Settings

Member Visibility

On This Page

Properties
+

Properties

id

id: number

resourceType

resourceType: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/Location.html b/docs/interfaces/Location.html index d9d471c..2428a72 100644 --- a/docs/interfaces/Location.html +++ b/docs/interfaces/Location.html @@ -1,3 +1,3 @@ -Location | d4h-typescript

Interface Location

interface Location {
    coordinates: [number, number];
    type: string;
}

Properties

coordinates +Location | d4h-typescript

Interface Location

interface Location {
    coordinates: [number, number];
    type: string;
}

Properties

coordinates type -

Properties

coordinates

coordinates: [number, number]

type

type: string

Settings

Member Visibility

On This Page

Properties
+

Properties

coordinates

coordinates: [number, number]

type

type: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/Member.html b/docs/interfaces/Member.html index 903f0fa..da79936 100644 --- a/docs/interfaces/Member.html +++ b/docs/interfaces/Member.html @@ -1,4 +1,4 @@ -Member | d4h-typescript

Interface Member

interface Member {
    alertActivityApproval: boolean;
    alertAllQualifications: boolean;
    alertGear: boolean;
    alertQualifications: boolean;
    chatAutosubscribe: boolean;
    chatDailyDigest: boolean;
    contactUpdateMail: boolean;
    costPerHour: null | number;
    costPerUse: null | number;
    countReportingEvent: number;
    countReportingExercise: number;
    countReportingHours: number;
    countReportingIncident: number;
    countRollingHours: number;
    countRollingHoursEvent: number;
    countRollingHoursExercise: number;
    countRollingHoursIncident: number;
    createdAt: string;
    credits: number;
    custom_fields?: CustomField[];
    customStatus: CustomMemberStatus;
    defaultDuty: string;
    defaultEquipmentLocation: EquipmentLocation;
    deprecatedAddress: null | string;
    email: EmailInfo;
    endsAt: null | string;
    entityType: EntityType;
    home: PhoneInfo;
    icalSecret: null | string;
    id: number;
    lastLogin: null | string;
    location: Location;
    locationBookmark: MemberLocationBookmark;
    mobile: PhoneInfo;
    name: string;
    notes: null | string;
    pager: PhoneInfo;
    percReportingEvent: number;
    percReportingExercise: number;
    percReportingIncident: number;
    percRollingEvent: number;
    percRollingExercise: number;
    percRollingIncident: number;
    permission: number;
    position: string;
    primaryEmergencyContact: PrimaryEmergencyContact;
    ref: string;
    retiredReason: RetiredReason;
    role: Role;
    secondaryEmergencyContact: SecondaryEmergencyContact;
    signedTandC: null | string;
    startsAt: null | string;
    status: string;
    teamAgreementSigned: null | string;
    updatedAt: string;
    weeklyDayOfWeek: number;
    weeklyDayOfWeekUtc: number;
    weeklyHourOfDay: number;
    weeklyHourOfDayUtc: number;
    weeklyMail: boolean;
    work: PhoneInfo;
}

Hierarchy

  • Entity
    • Member

Properties

alertActivityApproval +Member | d4h-typescript

Interface Member

interface Member {
    alertActivityApproval: boolean;
    alertAllQualifications: boolean;
    alertGear: boolean;
    alertQualifications: boolean;
    chatAutosubscribe: boolean;
    chatDailyDigest: boolean;
    contactUpdateMail: boolean;
    costPerHour: null | number;
    costPerUse: null | number;
    countReportingEvent: number;
    countReportingExercise: number;
    countReportingHours: number;
    countReportingIncident: number;
    countRollingHours: number;
    countRollingHoursEvent: number;
    countRollingHoursExercise: number;
    countRollingHoursIncident: number;
    createdAt: string;
    credits: number;
    custom_fields?: CustomField[];
    customStatus: CustomMemberStatus;
    defaultDuty: string;
    defaultEquipmentLocation: EquipmentLocation;
    deprecatedAddress: null | string;
    email: EmailInfo;
    endsAt: null | string;
    entityType: EntityType;
    home: PhoneInfo;
    icalSecret: null | string;
    id: number;
    lastLogin: null | string;
    location: Location;
    locationBookmark: MemberLocationBookmark;
    mobile: PhoneInfo;
    name: string;
    notes: null | string;
    pager: PhoneInfo;
    percReportingEvent: number;
    percReportingExercise: number;
    percReportingIncident: number;
    percRollingEvent: number;
    percRollingExercise: number;
    percRollingIncident: number;
    permission: number;
    position: string;
    primaryEmergencyContact: PrimaryEmergencyContact;
    ref: string;
    retiredReason: RetiredReason;
    role: Role;
    secondaryEmergencyContact: SecondaryEmergencyContact;
    signedTandC: null | string;
    startsAt: null | string;
    status: string;
    teamAgreementSigned: null | string;
    updatedAt: string;
    weeklyDayOfWeek: number;
    weeklyDayOfWeekUtc: number;
    weeklyHourOfDay: number;
    weeklyHourOfDayUtc: number;
    weeklyMail: boolean;
    work: PhoneInfo;
}

Hierarchy

  • Entity
    • Member

Properties

alertActivityApproval alertAllQualifications alertGear alertQualifications @@ -59,4 +59,4 @@ weeklyHourOfDayUtc weeklyMail work -

Properties

alertActivityApproval

alertActivityApproval: boolean

alertAllQualifications

alertAllQualifications: boolean

alertGear

alertGear: boolean

alertQualifications

alertQualifications: boolean

chatAutosubscribe

chatAutosubscribe: boolean

chatDailyDigest

chatDailyDigest: boolean

contactUpdateMail

contactUpdateMail: boolean

costPerHour

costPerHour: null | number

costPerUse

costPerUse: null | number

countReportingEvent

countReportingEvent: number

countReportingExercise

countReportingExercise: number

countReportingHours

countReportingHours: number

countReportingIncident

countReportingIncident: number

countRollingHours

countRollingHours: number

countRollingHoursEvent

countRollingHoursEvent: number

countRollingHoursExercise

countRollingHoursExercise: number

countRollingHoursIncident

countRollingHoursIncident: number

createdAt

createdAt: string

credits

credits: number

Optionalcustom_fields

custom_fields?: CustomField[]

customStatus

customStatus: CustomMemberStatus

defaultDuty

defaultDuty: string

defaultEquipmentLocation

defaultEquipmentLocation: EquipmentLocation

deprecatedAddress

deprecatedAddress: null | string

email

email: EmailInfo

endsAt

endsAt: null | string

entityType

entityType: EntityType

home

home: PhoneInfo

icalSecret

icalSecret: null | string

id

id: number

lastLogin

lastLogin: null | string

location

location: Location

locationBookmark

locationBookmark: MemberLocationBookmark

mobile

mobile: PhoneInfo

name

name: string

notes

notes: null | string

pager

pager: PhoneInfo

percReportingEvent

percReportingEvent: number

percReportingExercise

percReportingExercise: number

percReportingIncident

percReportingIncident: number

percRollingEvent

percRollingEvent: number

percRollingExercise

percRollingExercise: number

percRollingIncident

percRollingIncident: number

permission

permission: number

position

position: string

primaryEmergencyContact

primaryEmergencyContact: PrimaryEmergencyContact

ref

ref: string

retiredReason

retiredReason: RetiredReason

role

role: Role

secondaryEmergencyContact

secondaryEmergencyContact: SecondaryEmergencyContact

signedTandC

signedTandC: null | string

startsAt

startsAt: null | string

status

status: string

teamAgreementSigned

teamAgreementSigned: null | string

updatedAt

updatedAt: string

weeklyDayOfWeek

weeklyDayOfWeek: number

weeklyDayOfWeekUtc

weeklyDayOfWeekUtc: number

weeklyHourOfDay

weeklyHourOfDay: number

weeklyHourOfDayUtc

weeklyHourOfDayUtc: number

weeklyMail

weeklyMail: boolean

work

work: PhoneInfo

Settings

Member Visibility

On This Page

Properties
alertActivityApprovalalertAllQualificationsalertGearalertQualificationschatAutosubscribechatDailyDigestcontactUpdateMailcostPerHourcostPerUsecountReportingEventcountReportingExercisecountReportingHourscountReportingIncidentcountRollingHourscountRollingHoursEventcountRollingHoursExercisecountRollingHoursIncidentcreatedAtcreditscustom_fieldscustomStatusdefaultDutydefaultEquipmentLocationdeprecatedAddressemailendsAtentityTypehomeicalSecretidlastLoginlocationlocationBookmarkmobilenamenotespagerpercReportingEventpercReportingExercisepercReportingIncidentpercRollingEventpercRollingExercisepercRollingIncidentpermissionpositionprimaryEmergencyContactrefretiredReasonrolesecondaryEmergencyContactsignedTandCstartsAtstatusteamAgreementSignedupdatedAtweeklyDayOfWeekweeklyDayOfWeekUtcweeklyHourOfDayweeklyHourOfDayUtcweeklyMailwork
+

Properties

alertActivityApproval

alertActivityApproval: boolean

alertAllQualifications

alertAllQualifications: boolean

alertGear

alertGear: boolean

alertQualifications

alertQualifications: boolean

chatAutosubscribe

chatAutosubscribe: boolean

chatDailyDigest

chatDailyDigest: boolean

contactUpdateMail

contactUpdateMail: boolean

costPerHour

costPerHour: null | number

costPerUse

costPerUse: null | number

countReportingEvent

countReportingEvent: number

countReportingExercise

countReportingExercise: number

countReportingHours

countReportingHours: number

countReportingIncident

countReportingIncident: number

countRollingHours

countRollingHours: number

countRollingHoursEvent

countRollingHoursEvent: number

countRollingHoursExercise

countRollingHoursExercise: number

countRollingHoursIncident

countRollingHoursIncident: number

createdAt

createdAt: string

credits

credits: number

Optionalcustom_fields

custom_fields?: CustomField[]

customStatus

customStatus: CustomMemberStatus

defaultDuty

defaultDuty: string

defaultEquipmentLocation

defaultEquipmentLocation: EquipmentLocation

deprecatedAddress

deprecatedAddress: null | string

email

email: EmailInfo

endsAt

endsAt: null | string

entityType

entityType: EntityType

home

home: PhoneInfo

icalSecret

icalSecret: null | string

id

id: number

lastLogin

lastLogin: null | string

location

location: Location

locationBookmark

locationBookmark: MemberLocationBookmark

mobile

mobile: PhoneInfo

name

name: string

notes

notes: null | string

pager

pager: PhoneInfo

percReportingEvent

percReportingEvent: number

percReportingExercise

percReportingExercise: number

percReportingIncident

percReportingIncident: number

percRollingEvent

percRollingEvent: number

percRollingExercise

percRollingExercise: number

percRollingIncident

percRollingIncident: number

permission

permission: number

position

position: string

primaryEmergencyContact

primaryEmergencyContact: PrimaryEmergencyContact

ref

ref: string

retiredReason

retiredReason: RetiredReason

role

role: Role

secondaryEmergencyContact

secondaryEmergencyContact: SecondaryEmergencyContact

signedTandC

signedTandC: null | string

startsAt

startsAt: null | string

status

status: string

teamAgreementSigned

teamAgreementSigned: null | string

updatedAt

updatedAt: string

weeklyDayOfWeek

weeklyDayOfWeek: number

weeklyDayOfWeekUtc

weeklyDayOfWeekUtc: number

weeklyHourOfDay

weeklyHourOfDay: number

weeklyHourOfDayUtc

weeklyHourOfDayUtc: number

weeklyMail

weeklyMail: boolean

work

work: PhoneInfo

Settings

Member Visibility

On This Page

Properties
alertActivityApprovalalertAllQualificationsalertGearalertQualificationschatAutosubscribechatDailyDigestcontactUpdateMailcostPerHourcostPerUsecountReportingEventcountReportingExercisecountReportingHourscountReportingIncidentcountRollingHourscountRollingHoursEventcountRollingHoursExercisecountRollingHoursIncidentcreatedAtcreditscustom_fieldscustomStatusdefaultDutydefaultEquipmentLocationdeprecatedAddressemailendsAtentityTypehomeicalSecretidlastLoginlocationlocationBookmarkmobilenamenotespagerpercReportingEventpercReportingExercisepercReportingIncidentpercRollingEventpercRollingExercisepercRollingIncidentpermissionpositionprimaryEmergencyContactrefretiredReasonrolesecondaryEmergencyContactsignedTandCstartsAtstatusteamAgreementSignedupdatedAtweeklyDayOfWeekweeklyDayOfWeekUtcweeklyHourOfDayweeklyHourOfDayUtcweeklyMailwork
diff --git a/docs/interfaces/MemberAwards.html b/docs/interfaces/MemberAwards.html index 9a9d090..7185bdf 100644 --- a/docs/interfaces/MemberAwards.html +++ b/docs/interfaces/MemberAwards.html @@ -1,4 +1,4 @@ -MemberAwards | d4h-typescript

Interface MemberAwards

interface MemberAwards {
    createdAt: string;
    custom_fields?: CustomField[];
    endsAt: null | string;
    entityType: EntityType;
    id: number;
    member: Resource;
    owner: Resource;
    qualification: Resource;
    resourceType: string;
    startsAt: null | string;
    updatedAt: string;
}

Hierarchy

  • Entity
    • MemberAwards

Properties

createdAt +MemberAwards | d4h-typescript

Interface MemberAwards

interface MemberAwards {
    createdAt: string;
    custom_fields?: CustomField[];
    endsAt: null | string;
    entityType: EntityType;
    id: number;
    member: Resource;
    owner: Resource;
    qualification: Resource;
    resourceType: string;
    startsAt: null | string;
    updatedAt: string;
}

Hierarchy

  • Entity
    • MemberAwards

Properties

createdAt custom_fields? endsAt entityType @@ -9,4 +9,4 @@ resourceType startsAt updatedAt -

Properties

createdAt

createdAt: string

Optionalcustom_fields

custom_fields?: CustomField[]

endsAt

endsAt: null | string

entityType

entityType: EntityType

id

id: number

member

member: Resource

owner

owner: Resource

qualification

qualification: Resource

resourceType

resourceType: string

startsAt

startsAt: null | string

updatedAt

updatedAt: string

Settings

Member Visibility

On This Page

Properties
+

Properties

createdAt

createdAt: string

Optionalcustom_fields

custom_fields?: CustomField[]

endsAt

endsAt: null | string

entityType

entityType: EntityType

id

id: number

member

member: Resource

owner

owner: Resource

qualification

qualification: Resource

resourceType

resourceType: string

startsAt

startsAt: null | string

updatedAt

updatedAt: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/MemberLocationBookmark.html b/docs/interfaces/MemberLocationBookmark.html index 41ce1ac..a409118 100644 --- a/docs/interfaces/MemberLocationBookmark.html +++ b/docs/interfaces/MemberLocationBookmark.html @@ -1,3 +1,3 @@ -MemberLocationBookmark | d4h-typescript

Interface MemberLocationBookmark

interface MemberLocationBookmark {
    id: null | number;
    resourceType: string;
}

Properties

id +MemberLocationBookmark | d4h-typescript

Interface MemberLocationBookmark

interface MemberLocationBookmark {
    id: null | number;
    resourceType: string;
}

Properties

id resourceType -

Properties

id

id: null | number

resourceType

resourceType: string

Settings

Member Visibility

On This Page

Properties
+

Properties

id

id: null | number

resourceType

resourceType: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/MemberStatus.html b/docs/interfaces/MemberStatus.html index 4946e1e..558a414 100644 --- a/docs/interfaces/MemberStatus.html +++ b/docs/interfaces/MemberStatus.html @@ -1,5 +1,5 @@ -MemberStatus | d4h-typescript

Interface MemberStatus

interface MemberStatus {
    id: number;
    label: null | MemberStatusLabel;
    type: string;
    value: string;
}

Properties

id +MemberStatus | d4h-typescript

Interface MemberStatus

interface MemberStatus {
    id: number;
    label: null | MemberStatusLabel;
    type: string;
    value: string;
}

Properties

id label type value -

Properties

id

id: number

label

label: null | MemberStatusLabel

type

type: string

value

value: string

Settings

Member Visibility

On This Page

Properties
+

Properties

id

id: number

label

label: null | MemberStatusLabel

type

type: string

value

value: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/MemberStatusLabel.html b/docs/interfaces/MemberStatusLabel.html index be09a93..446b7b8 100644 --- a/docs/interfaces/MemberStatusLabel.html +++ b/docs/interfaces/MemberStatusLabel.html @@ -1,3 +1,3 @@ -MemberStatusLabel | d4h-typescript

Interface MemberStatusLabel

interface MemberStatusLabel {
    id: number;
    value: string;
}

Properties

id +MemberStatusLabel | d4h-typescript

Interface MemberStatusLabel

interface MemberStatusLabel {
    id: number;
    value: string;
}

Properties

id value -

Properties

id

id: number

value

value: string

Settings

Member Visibility

On This Page

Properties
+

Properties

id

id: number

value

value: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/MemberUpdate.html b/docs/interfaces/MemberUpdate.html index a0b5325..5422fe0 100644 --- a/docs/interfaces/MemberUpdate.html +++ b/docs/interfaces/MemberUpdate.html @@ -1,4 +1,4 @@ -MemberUpdate | d4h-typescript

Interface MemberUpdate

interface MemberUpdate {
    address?: null | string;
    cost_per_hour?: number;
    cost_per_use?: number;
    date_join?: Date;
    date_leave?: Date;
    email?: null | string;
    gridref?: null | string;
    id_tag?: null | string;
    lat?: number;
    lng?: number;
    location_bookmark_id?: number;
    name?: null | string;
    notes?: null | string;
    pager?: null | string;
    pager_email?: null | string;
    phone_home?: null | string;
    phone_mobile?: null | string;
    phone_work?: null | string;
    position?: null | string;
    ref?: null | string;
    retired_reason_id?: number;
    role_id?: number;
    status_custom_id?: number;
    status_id?: number;
}

Properties

address? +MemberUpdate | d4h-typescript

Interface MemberUpdate

interface MemberUpdate {
    address?: null | string;
    cost_per_hour?: number;
    cost_per_use?: number;
    date_join?: Date;
    date_leave?: Date;
    email?: null | string;
    gridref?: null | string;
    id_tag?: null | string;
    lat?: number;
    lng?: number;
    location_bookmark_id?: number;
    name?: null | string;
    notes?: null | string;
    pager?: null | string;
    pager_email?: null | string;
    phone_home?: null | string;
    phone_mobile?: null | string;
    phone_work?: null | string;
    position?: null | string;
    ref?: null | string;
    retired_reason_id?: number;
    role_id?: number;
    status_custom_id?: number;
    status_id?: number;
}

Properties

address? cost_per_hour? cost_per_use? date_join? @@ -22,4 +22,4 @@ role_id? status_custom_id? status_id? -

Properties

Optionaladdress

address?: null | string

Optionalcost_per_hour

cost_per_hour?: number

Optionalcost_per_use

cost_per_use?: number

Optionaldate_join

date_join?: Date

Optionaldate_leave

date_leave?: Date

Optionalemail

email?: null | string

Optionalgridref

gridref?: null | string

Optionalid_tag

id_tag?: null | string

Optionallat

lat?: number

Optionallng

lng?: number

Optionallocation_bookmark_id

location_bookmark_id?: number

Optionalname

name?: null | string

Optionalnotes

notes?: null | string

Optionalpager

pager?: null | string

Optionalpager_email

pager_email?: null | string

Optionalphone_home

phone_home?: null | string

Optionalphone_mobile

phone_mobile?: null | string

Optionalphone_work

phone_work?: null | string

Optionalposition

position?: null | string

Optionalref

ref?: null | string

Optionalretired_reason_id

retired_reason_id?: number

Optionalrole_id

role_id?: number

Optionalstatus_custom_id

status_custom_id?: number

Optionalstatus_id

status_id?: number

Settings

Member Visibility

On This Page

Properties
+

Properties

Optionaladdress

address?: null | string

Optionalcost_per_hour

cost_per_hour?: number

Optionalcost_per_use

cost_per_use?: number

Optionaldate_join

date_join?: Date

Optionaldate_leave

date_leave?: Date

Optionalemail

email?: null | string

Optionalgridref

gridref?: null | string

Optionalid_tag

id_tag?: null | string

Optionallat

lat?: number

Optionallng

lng?: number

Optionallocation_bookmark_id

location_bookmark_id?: number

Optionalname

name?: null | string

Optionalnotes

notes?: null | string

Optionalpager

pager?: null | string

Optionalpager_email

pager_email?: null | string

Optionalphone_home

phone_home?: null | string

Optionalphone_mobile

phone_mobile?: null | string

Optionalphone_work

phone_work?: null | string

Optionalposition

position?: null | string

Optionalref

ref?: null | string

Optionalretired_reason_id

retired_reason_id?: number

Optionalrole_id

role_id?: number

Optionalstatus_custom_id

status_custom_id?: number

Optionalstatus_id

status_id?: number

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/PhoneInfo.html b/docs/interfaces/PhoneInfo.html index 28f275a..ca29557 100644 --- a/docs/interfaces/PhoneInfo.html +++ b/docs/interfaces/PhoneInfo.html @@ -1,3 +1,3 @@ -PhoneInfo | d4h-typescript

Interface PhoneInfo

interface PhoneInfo {
    phone: string;
    verified?: boolean;
}

Properties

phone +PhoneInfo | d4h-typescript

Interface PhoneInfo

interface PhoneInfo {
    phone: string;
    verified?: boolean;
}

Properties

phone verified? -

Properties

phone

phone: string

Optionalverified

verified?: boolean

Settings

Member Visibility

On This Page

Properties
+

Properties

phone

phone: string

Optionalverified

verified?: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/PrimaryEmergencyContact.html b/docs/interfaces/PrimaryEmergencyContact.html index 3c716b2..03c8f5f 100644 --- a/docs/interfaces/PrimaryEmergencyContact.html +++ b/docs/interfaces/PrimaryEmergencyContact.html @@ -1,5 +1,5 @@ -PrimaryEmergencyContact | d4h-typescript

Interface PrimaryEmergencyContact

interface PrimaryEmergencyContact {
    name: string;
    primaryPhone: string;
    relation: string;
    secondaryPhone: string;
}

Properties

name +PrimaryEmergencyContact | d4h-typescript

Interface PrimaryEmergencyContact

interface PrimaryEmergencyContact {
    name: string;
    primaryPhone: string;
    relation: string;
    secondaryPhone: string;
}

Properties

name primaryPhone relation secondaryPhone -

Properties

name

name: string

primaryPhone

primaryPhone: string

relation

relation: string

secondaryPhone

secondaryPhone: string

Settings

Member Visibility

On This Page

Properties
+

Properties

name

name: string

primaryPhone

primaryPhone: string

relation

relation: string

secondaryPhone

secondaryPhone: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/Qualification.html b/docs/interfaces/Qualification.html index be3459e..ba8773e 100644 --- a/docs/interfaces/Qualification.html +++ b/docs/interfaces/Qualification.html @@ -1,4 +1,4 @@ -Qualification | d4h-typescript

Interface Qualification

interface Qualification {
    cost: null | number;
    createdAt: string;
    custom_fields?: CustomField[];
    deprecatedBundle: string;
    description: string;
    entityType: EntityType;
    expiredCost: null;
    expiresMonthsDefault: null | number;
    id: number;
    reminderDays: number;
    resourceType: string;
    title: string;
    updatedAt: string;
}

Hierarchy

  • Entity
    • Qualification

Properties

cost +Qualification | d4h-typescript

Interface Qualification

interface Qualification {
    cost: null | number;
    createdAt: string;
    custom_fields?: CustomField[];
    deprecatedBundle: string;
    description: string;
    entityType: EntityType;
    expiredCost: null;
    expiresMonthsDefault: null | number;
    id: number;
    reminderDays: number;
    resourceType: string;
    title: string;
    updatedAt: string;
}

Hierarchy

  • Entity
    • Qualification

Properties

cost createdAt custom_fields? deprecatedBundle @@ -11,4 +11,4 @@ resourceType title updatedAt -

Properties

cost

cost: null | number

createdAt

createdAt: string

Optionalcustom_fields

custom_fields?: CustomField[]

deprecatedBundle

deprecatedBundle: string

description

description: string

entityType

entityType: EntityType

expiredCost

expiredCost: null

expiresMonthsDefault

expiresMonthsDefault: null | number

id

id: number

reminderDays

reminderDays: number

resourceType

resourceType: string

title

title: string

updatedAt

updatedAt: string

Settings

Member Visibility

On This Page

Properties
+

Properties

cost

cost: null | number

createdAt

createdAt: string

Optionalcustom_fields

custom_fields?: CustomField[]

deprecatedBundle

deprecatedBundle: string

description

description: string

entityType

entityType: EntityType

expiredCost

expiredCost: null

expiresMonthsDefault

expiresMonthsDefault: null | number

id

id: number

reminderDays

reminderDays: number

resourceType

resourceType: string

title

title: string

updatedAt

updatedAt: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/Resource.html b/docs/interfaces/Resource.html index cc936c2..f653f7f 100644 --- a/docs/interfaces/Resource.html +++ b/docs/interfaces/Resource.html @@ -1,3 +1,3 @@ -Resource | d4h-typescript

Interface Resource

interface Resource {
    id: number;
    resourceType: string;
}

Properties

id +Resource | d4h-typescript

Interface Resource

interface Resource {
    id: number;
    resourceType: string;
}

Properties

id resourceType -

Properties

id

id: number

resourceType

resourceType: string

Settings

Member Visibility

On This Page

Properties
+

Properties

id

id: number

resourceType

resourceType: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/RetiredReason.html b/docs/interfaces/RetiredReason.html index 2ee012e..31f12f8 100644 --- a/docs/interfaces/RetiredReason.html +++ b/docs/interfaces/RetiredReason.html @@ -1,3 +1,3 @@ -RetiredReason | d4h-typescript

Interface RetiredReason

interface RetiredReason {
    id: null | number;
    resourceType: string;
}

Properties

id +RetiredReason | d4h-typescript

Interface RetiredReason

interface RetiredReason {
    id: null | number;
    resourceType: string;
}

Properties

id resourceType -

Properties

id

id: null | number

resourceType

resourceType: string

Settings

Member Visibility

On This Page

Properties
+

Properties

id

id: null | number

resourceType

resourceType: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/Role.html b/docs/interfaces/Role.html index 4d6e8ce..ea68613 100644 --- a/docs/interfaces/Role.html +++ b/docs/interfaces/Role.html @@ -1,3 +1,3 @@ -Role | d4h-typescript

Interface Role

interface Role {
    id: null | number;
    resourceType: string;
}

Properties

id +Role | d4h-typescript

Interface Role

interface Role {
    id: null | number;
    resourceType: string;
}

Properties

id resourceType -

Properties

id

id: null | number

resourceType

resourceType: string

Settings

Member Visibility

On This Page

Properties
+

Properties

id

id: null | number

resourceType

resourceType: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/SecondaryEmergencyContact.html b/docs/interfaces/SecondaryEmergencyContact.html index f321ef5..3d32437 100644 --- a/docs/interfaces/SecondaryEmergencyContact.html +++ b/docs/interfaces/SecondaryEmergencyContact.html @@ -1,5 +1,5 @@ -SecondaryEmergencyContact | d4h-typescript

Interface SecondaryEmergencyContact

interface SecondaryEmergencyContact {
    name: string;
    primaryPhone: string;
    relation: string;
    secondaryPhone: string;
}

Properties

name +SecondaryEmergencyContact | d4h-typescript

Interface SecondaryEmergencyContact

interface SecondaryEmergencyContact {
    name: string;
    primaryPhone: string;
    relation: string;
    secondaryPhone: string;
}

Properties

name primaryPhone relation secondaryPhone -

Properties

name

name: string

primaryPhone

primaryPhone: string

relation

relation: string

secondaryPhone

secondaryPhone: string

Settings

Member Visibility

On This Page

Properties
+

Properties

name

name: string

primaryPhone

primaryPhone: string

relation

relation: string

secondaryPhone

secondaryPhone: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/WeatherInfo.html b/docs/interfaces/WeatherInfo.html index f103be3..439809b 100644 --- a/docs/interfaces/WeatherInfo.html +++ b/docs/interfaces/WeatherInfo.html @@ -1,4 +1,4 @@ -WeatherInfo | d4h-typescript

Interface WeatherInfo

interface WeatherInfo {
    symbol: null | string;
    symbolDate: null | string;
    temperature: null | number;
}

Properties

symbol +WeatherInfo | d4h-typescript

Interface WeatherInfo

interface WeatherInfo {
    symbol: null | string;
    symbolDate: null | string;
    temperature: null | number;
}

Properties

symbol symbolDate temperature -

Properties

symbol

symbol: null | string

symbolDate

symbolDate: null | string

temperature

temperature: null | number

Settings

Member Visibility

On This Page

Properties
+

Properties

symbol

symbol: null | string

symbolDate

symbolDate: null | string

temperature

temperature: null | number

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/memberGroup.html b/docs/interfaces/memberGroup.html index 574dafc..a98b2e1 100644 --- a/docs/interfaces/memberGroup.html +++ b/docs/interfaces/memberGroup.html @@ -1,4 +1,4 @@ -memberGroup | d4h-typescript

Interface memberGroup

interface memberGroup {
    createdAt: string;
    custom_fields?: CustomField[];
    deprecatedBundle: string;
    entityType: EntityType;
    id: number;
    membershipResourceType: string;
    resourceType: string;
    title: string;
    updatedAt: string;
}

Hierarchy

  • Entity
    • memberGroup

Properties

createdAt +memberGroup | d4h-typescript

Interface memberGroup

interface memberGroup {
    createdAt: string;
    custom_fields?: CustomField[];
    deprecatedBundle: string;
    entityType: EntityType;
    id: number;
    membershipResourceType: string;
    resourceType: string;
    title: string;
    updatedAt: string;
}

Hierarchy

  • Entity
    • memberGroup

Properties

createdAt custom_fields? deprecatedBundle entityType @@ -7,4 +7,4 @@ resourceType title updatedAt -

Properties

createdAt

createdAt: string

Optionalcustom_fields

custom_fields?: CustomField[]

deprecatedBundle

deprecatedBundle: string

entityType

entityType: EntityType

id

id: number

membershipResourceType

membershipResourceType: string

resourceType

resourceType: string

title

title: string

updatedAt

updatedAt: string

Settings

Member Visibility

On This Page

Properties
+

Properties

createdAt

createdAt: string

Optionalcustom_fields

custom_fields?: CustomField[]

deprecatedBundle

deprecatedBundle: string

entityType

entityType: EntityType

id

id: number

membershipResourceType

membershipResourceType: string

resourceType

resourceType: string

title

title: string

updatedAt

updatedAt: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/variables/D4H_BASE_URL.html b/docs/variables/D4H_BASE_URL.html index 3219b71..5c7e437 100644 --- a/docs/variables/D4H_BASE_URL.html +++ b/docs/variables/D4H_BASE_URL.html @@ -1 +1 @@ -D4H_BASE_URL | d4h-typescript

Variable D4H_BASE_URLConst

D4H_BASE_URL: "https://api.team-manager.us.d4h.com/v3" = 'https://api.team-manager.us.d4h.com/v3'

Settings

Member Visibility
+D4H_BASE_URL | d4h-typescript

Variable D4H_BASE_URLConst

D4H_BASE_URL: "https://api.team-manager.us.d4h.com/v3" = 'https://api.team-manager.us.d4h.com/v3'

Settings

Member Visibility
diff --git a/package.json b/package.json index 5946d8f..9ffba8a 100644 --- a/package.json +++ b/package.json @@ -1,4 +1,7 @@ { + "scripts": { + "docs": "npx typedoc" + }, "devDependencies": { "@types/node": "^22.10.2", "d4h-typescript": "file:lib", @@ -6,4 +9,4 @@ "typedoc": "^0.27.5", "typescript": "^5.7.2" } -} +} \ No newline at end of file diff --git a/test/getMember.ts b/test/getMember.ts new file mode 100644 index 0000000..e498fd2 --- /dev/null +++ b/test/getMember.ts @@ -0,0 +1,33 @@ +import D4H from '../lib/src/d4h' +import * as dotenv from 'dotenv'; + +dotenv.config() +const apiToken = process.env['apiToken'] + +if (!apiToken) { + throw new Error('apiToken is not defined in the environment variables.'); +} + +// console.log(`Your API Token is: ${apiToken}`); + +const d4hInstance = new D4H(apiToken); +const getmember = async (team: string, contextId: number, id: number) => { + + //const memberdata = await d4hInstance.getMember(team, contextId, id) + console.log(id) + const memberdata = await d4hInstance.getMembers(team, contextId) + + return memberdata +} + +const logMember = async () => { + const member = await getmember('team', 1614, 85292); + // console.log(`${JSON.stringify(member, null, 2)}`); + + // const memberName = member.name + // const memberDEM = member.ref + + console.log(member) +} + +logMember(); \ No newline at end of file diff --git a/test/getMembers.ts b/test/getMembers.ts new file mode 100644 index 0000000..e7f2b7e --- /dev/null +++ b/test/getMembers.ts @@ -0,0 +1,28 @@ +import D4H from '../lib/src/d4h' +import * as dotenv from 'dotenv'; + +dotenv.config() +const apiToken = process.env['apiToken'] + +if (!apiToken) { + throw new Error('apiToken is not defined in the environment variables.'); +} + +// console.log(`Your API Token is: ${apiToken}`); + +const d4hInstance = new D4H(apiToken); +const getmembers = async (team: string, contextId: number) => { + + const memberdata = await d4hInstance.getAnimals(team, contextId) + + return memberdata +} + +const logMember = async () => { + const members = await getmembers('team', 1614); + + console.log(`${JSON.stringify(members, null, 2)}`); + +} + +logMember(); \ No newline at end of file