diff --git a/doc/.nojekyll b/docs/.nojekyll similarity index 100% rename from doc/.nojekyll rename to docs/.nojekyll diff --git a/doc/assets/hierarchy.js b/docs/assets/hierarchy.js similarity index 100% rename from doc/assets/hierarchy.js rename to docs/assets/hierarchy.js diff --git a/doc/assets/highlight.css b/docs/assets/highlight.css similarity index 100% rename from doc/assets/highlight.css rename to docs/assets/highlight.css diff --git a/doc/assets/icons.js b/docs/assets/icons.js similarity index 100% rename from doc/assets/icons.js rename to docs/assets/icons.js diff --git a/doc/assets/icons.svg b/docs/assets/icons.svg similarity index 100% rename from doc/assets/icons.svg rename to docs/assets/icons.svg diff --git a/doc/assets/main.js b/docs/assets/main.js similarity index 100% rename from doc/assets/main.js rename to docs/assets/main.js diff --git a/doc/assets/navigation.js b/docs/assets/navigation.js similarity index 100% rename from doc/assets/navigation.js rename to docs/assets/navigation.js diff --git a/doc/assets/search.js b/docs/assets/search.js similarity index 100% rename from doc/assets/search.js rename to docs/assets/search.js diff --git a/doc/assets/style.css b/docs/assets/style.css similarity index 100% rename from doc/assets/style.css rename to docs/assets/style.css diff --git a/doc/classes/default.html b/docs/classes/default.html similarity index 96% rename from doc/classes/default.html rename to docs/classes/default.html index 762c317..328c49d 100644 --- a/doc/classes/default.html +++ b/docs/classes/default.html @@ -1,4 +1,4 @@ -default | d4h-typescript

Constructors

constructor +default | d4h-typescript

Constructors

Methods


  • -

    Parameters

    • id: number

    Returns Promise<Group>


  • -

    Parameters

    Returns Promise<void>

+

Constructors

Methods


  • +

    Parameters

    • id: number

    Returns Promise<Group>


  • +

    Parameters

    Returns Promise<void>

diff --git a/doc/enums/CustomFieldType.html b/docs/enums/CustomFieldType.html similarity index 95% rename from doc/enums/CustomFieldType.html rename to docs/enums/CustomFieldType.html index b3eece4..5e2777f 100644 --- a/doc/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

Enumeration Members

Date: "date"
Number: "number"
Text: "text"
+

Enumeration Members

Date: "date"
Number: "number"
Text: "text"
diff --git a/doc/index.html b/docs/index.html similarity index 100% rename from doc/index.html rename to docs/index.html diff --git a/doc/interfaces/CustomField.html b/docs/interfaces/CustomField.html similarity index 95% rename from doc/interfaces/CustomField.html rename to docs/interfaces/CustomField.html index 634c9e7..6907749 100644 --- a/doc/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: unknown
id: number
label: string
member_edit_own: boolean
value: null | string
value_string: null | string
+

Properties

bundle: unknown
id: number
label: string
member_edit_own: boolean
value: null | string
value_string: null | string
diff --git a/doc/interfaces/CustomFieldUpdate.html b/docs/interfaces/CustomFieldUpdate.html similarity index 95% rename from doc/interfaces/CustomFieldUpdate.html rename to docs/interfaces/CustomFieldUpdate.html index e827ce4..53e71cf 100644 --- a/doc/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

Properties

id: number
value: null | string
+

Properties

id: number
value: null | string
diff --git a/doc/interfaces/EmergencyContact.html b/docs/interfaces/EmergencyContact.html similarity index 94% rename from doc/interfaces/EmergencyContact.html rename to docs/interfaces/EmergencyContact.html index ccf3634..1def9d3 100644 --- a/doc/interfaces/EmergencyContact.html +++ b/docs/interfaces/EmergencyContact.html @@ -1,5 +1,5 @@ -EmergencyContact | d4h-typescript

Interface EmergencyContact

interface EmergencyContact {
    alt_phone: null | string;
    name: null | string;
    phone: null | string;
    relation: null | string;
}

Properties

alt_phone +EmergencyContact | d4h-typescript

Interface EmergencyContact

interface EmergencyContact {
    alt_phone: null | string;
    name: null | string;
    phone: null | string;
    relation: null | string;
}

Properties

alt_phone: null | string
name: null | string
phone: null | string
relation: null | string
+

Properties

alt_phone: null | string
name: null | string
phone: null | string
relation: null | string
diff --git a/doc/interfaces/EmergencyContacts.html b/docs/interfaces/EmergencyContacts.html similarity index 97% rename from doc/interfaces/EmergencyContacts.html rename to docs/interfaces/EmergencyContacts.html index cccd727..a746506 100644 --- a/doc/interfaces/EmergencyContacts.html +++ b/docs/interfaces/EmergencyContacts.html @@ -1,3 +1,3 @@ -EmergencyContacts | d4h-typescript

Interface EmergencyContacts

interface EmergencyContacts {
    primary: EmergencyContact;
    secondary: EmergencyContact;
}

Properties

primary +EmergencyContacts | d4h-typescript

Interface EmergencyContacts

interface EmergencyContacts {
    primary: EmergencyContact;
    secondary: EmergencyContact;
}

Properties

Properties

secondary: EmergencyContact
+

Properties

secondary: EmergencyContact
diff --git a/doc/interfaces/GetGroupsOptions.html b/docs/interfaces/GetGroupsOptions.html similarity index 96% rename from doc/interfaces/GetGroupsOptions.html rename to docs/interfaces/GetGroupsOptions.html index 0d62c23..b50a814 100644 --- a/doc/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

Properties

memberId?: number
title?: string
+

Properties

memberId?: number
title?: string
diff --git a/doc/interfaces/GetMemberOptions.html b/docs/interfaces/GetMemberOptions.html similarity index 98% rename from doc/interfaces/GetMemberOptions.html rename to docs/interfaces/GetMemberOptions.html index 1542fe4..6ca22f0 100644 --- a/doc/interfaces/GetMemberOptions.html +++ b/docs/interfaces/GetMemberOptions.html @@ -1,2 +1,2 @@ -GetMemberOptions | d4h-typescript

Interface GetMemberOptions

interface GetMemberOptions {
    includeDetails?: boolean;
}

Properties

Properties

includeDetails?: boolean
+GetMemberOptions | d4h-typescript

Interface GetMemberOptions

interface GetMemberOptions {
    includeDetails?: boolean;
}

Properties

Properties

includeDetails?: boolean
diff --git a/doc/interfaces/GetMembersOptions.html b/docs/interfaces/GetMembersOptions.html similarity index 95% rename from doc/interfaces/GetMembersOptions.html rename to docs/interfaces/GetMembersOptions.html index 0817291..554fda6 100644 --- a/doc/interfaces/GetMembersOptions.html +++ b/docs/interfaces/GetMembersOptions.html @@ -1,4 +1,4 @@ -GetMembersOptions | d4h-typescript

Interface GetMembersOptions

interface GetMembersOptions {
    groupId?: number;
    includeCustomFields?: boolean;
    includeDetails?: boolean;
}

Properties

groupId? +GetMembersOptions | d4h-typescript

Interface GetMembersOptions

interface GetMembersOptions {
    groupId?: number;
    includeCustomFields?: boolean;
    includeDetails?: boolean;
}

Properties

groupId?: number
includeCustomFields?: boolean
includeDetails?: boolean
+

Properties

groupId?: number
includeCustomFields?: boolean
includeDetails?: boolean
diff --git a/doc/interfaces/Group.html b/docs/interfaces/Group.html similarity index 96% rename from doc/interfaces/Group.html rename to docs/interfaces/Group.html index 872bc08..cb2ab40 100644 --- a/doc/interfaces/Group.html +++ b/docs/interfaces/Group.html @@ -1,4 +1,4 @@ -Group | d4h-typescript

Interface Group

interface Group {
    bundle: string;
    id: number;
    title: string;
}

Properties

bundle +Group | d4h-typescript

Interface Group

interface Group {
    bundle: string;
    id: number;
    title: string;
}

Properties

Properties

bundle: string
id: number
title: string
+

Properties

bundle: string
id: number
title: string
diff --git a/doc/interfaces/Incident.html b/docs/interfaces/Incident.html similarity index 95% rename from doc/interfaces/Incident.html rename to docs/interfaces/Incident.html index 1d97c16..b71d3a4 100644 --- a/doc/interfaces/Incident.html +++ b/docs/interfaces/Incident.html @@ -1,4 +1,4 @@ -Incident | d4h-typescript

Interface Incident

interface Incident {
    date: string;
    description?: string;
    enddate?: string;
    id: number;
    lat?: number;
    lng?: number;
    ref_desc: string;
    tags?: string[];
}

Properties

date +Incident | d4h-typescript

Interface Incident

interface Incident {
    date: string;
    description?: string;
    enddate?: string;
    id: number;
    lat?: number;
    lng?: number;
    ref_desc: string;
    tags?: string[];
}

Properties

Properties

date: string
description?: string
enddate?: string
id: number
lat?: number
lng?: number
ref_desc: string
tags?: string[]
+

Properties

date: string
description?: string
enddate?: string
id: number
lat?: number
lng?: number
ref_desc: string
tags?: string[]
diff --git a/doc/interfaces/IncidentRoster.html b/docs/interfaces/IncidentRoster.html similarity index 95% rename from doc/interfaces/IncidentRoster.html rename to docs/interfaces/IncidentRoster.html index f318ada..825aef9 100644 --- a/doc/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: string
enddate: string
id: number
member: { id: number; name: string }
role: { bundle: string; id: number; title: string }
status: string
+

Properties

date: string
enddate: string
id: number
member: { id: number; name: string }
role: { bundle: string; id: number; title: string }
status: string
diff --git a/doc/interfaces/Member.html b/docs/interfaces/Member.html similarity index 93% rename from doc/interfaces/Member.html rename to docs/interfaces/Member.html index e3aaaa5..7e6d261 100644 --- a/doc/interfaces/Member.html +++ b/docs/interfaces/Member.html @@ -1,4 +1,4 @@ -Member | d4h-typescript

Interface Member

interface Member {
    address: string;
    custom_fields?: CustomField[];
    email: null | string;
    emergency_contacts: EmergencyContact[];
    group_ids: null | number[];
    homephone: string;
    id: number;
    joined_at: string;
    mobilephone: string;
    name: string;
    notes: null | string;
    position: string;
    ref: string;
    status: MemberStatus;
    type: EntityType;
    workphone: string;
}

Hierarchy

  • Entity
    • Member

Properties

address +Member | d4h-typescript

Interface Member

interface Member {
    address: string;
    custom_fields?: CustomField[];
    email: null | string;
    emergency_contacts: EmergencyContact[];
    group_ids: null | number[];
    homephone: string;
    id: number;
    joined_at: string;
    mobilephone: string;
    name: string;
    notes: null | string;
    position: string;
    ref: string;
    status: MemberStatus;
    type: EntityType;
    workphone: string;
}

Hierarchy

  • Entity
    • Member

Properties

address: string
custom_fields?: CustomField[]
email: null | string
emergency_contacts: EmergencyContact[]
group_ids: null | number[]
homephone: string
id: number
joined_at: string
mobilephone: string
name: string
notes: null | string
position: string
ref: string
status: MemberStatus
type: EntityType
workphone: string
+

Properties

address: string
custom_fields?: CustomField[]
email: null | string
emergency_contacts: EmergencyContact[]
group_ids: null | number[]
homephone: string
id: number
joined_at: string
mobilephone: string
name: string
notes: null | string
position: string
ref: string
status: MemberStatus
type: EntityType
workphone: string
diff --git a/doc/interfaces/MemberStatus.html b/docs/interfaces/MemberStatus.html similarity index 94% rename from doc/interfaces/MemberStatus.html rename to docs/interfaces/MemberStatus.html index 451737d..ff84e5a 100644 --- a/doc/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

Properties

id: number
label: null | MemberStatusLabel
type: string
value: string
+

Properties

id: number
label: null | MemberStatusLabel
type: string
value: string
diff --git a/doc/interfaces/MemberStatusLabel.html b/docs/interfaces/MemberStatusLabel.html similarity index 97% rename from doc/interfaces/MemberStatusLabel.html rename to docs/interfaces/MemberStatusLabel.html index 93b9120..d17d4fa 100644 --- a/doc/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

Properties

id: number
value: string
+

Properties

id: number
value: string
diff --git a/doc/interfaces/MemberUpdate.html b/docs/interfaces/MemberUpdate.html similarity index 93% rename from doc/interfaces/MemberUpdate.html rename to docs/interfaces/MemberUpdate.html index d9bbb1a..afa3505 100644 --- a/doc/interfaces/MemberUpdate.html +++ b/docs/interfaces/MemberUpdate.html @@ -1,4 +1,4 @@ -MemberUpdate | d4h-typescript

Interface MemberUpdate

interface MemberUpdate {
    address?: null | string;
    address_city?: null | string;
    address_country?: null | string;
    address_postcode?: null | string;
    address_region?: null | string;
    address_street?: 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;
    address_city?: null | string;
    address_country?: null | string;
    address_postcode?: null | string;
    address_region?: null | string;
    address_street?: 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?: null | string
address_city?: null | string
address_country?: null | string
address_postcode?: null | string
address_region?: null | string
address_street?: 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?: null | string
address_city?: null | string
address_country?: null | string
address_postcode?: null | string
address_region?: null | string
address_street?: 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
diff --git a/doc/modules.html b/docs/modules.html similarity index 100% rename from doc/modules.html rename to docs/modules.html diff --git a/typedoc.json b/typedoc.json index ba24a0c..e76ff49 100644 --- a/typedoc.json +++ b/typedoc.json @@ -1,6 +1,6 @@ { "$schema": "https://typedoc.org/schema.json", "entryPoints": ["./lib/index.ts"], - "out": "doc" + "out": "docs" }