Class PersonAPI

An API to retrieve data from the Person store

Hierarchy

DataSource<ContextBase>
- PersonAPI

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PersonAPI(personStore: typeof Person, logger: LogEntryAPI, sequelize: Sequelize): PersonAPI

- Defined in apollo/server/datasources/person.ts:34
Create the API instance.

Parameters
- personStore: typeof Person
  
  A Person store.
- logger: LogEntryAPI
- sequelize: Sequelize
  
  The sequelize connection.
Returns PersonAPI

Properties

Private logger

logger: LogEntryAPI

The logger

Private sequelize

sequelize: Sequelize

The sequelize connection

Private store

store: typeof Person

The Person store

Methods

addNewPerson

addNewPerson(arg: PersonCreationAttributes, who: string | undefined): Promise<PersonModelAttributes>

- Defined in apollo/server/datasources/person.ts:140
Add a new person

async

Parameters
- arg: PersonCreationAttributes
  
  The arg for the new person
- who: string | undefined
Returns Promise<PersonModelAttributes>

An instance of the new person

approveMembership

approveMembership(__namedParameters: { memberUntil: null | string; sid: string }, who: string | undefined): Promise<PersonModelAttributes>

- Defined in apollo/server/datasources/person.ts:228
Approve someone's membership

async

Parameters
- __namedParameters: { memberUntil: null | string; sid: string }
  - memberUntil: null | string
  - sid: string
- who: string | undefined
Returns Promise<PersonModelAttributes>

The updated person

countPeople

countPeople(): Promise<number>

- Defined in apollo/server/datasources/person.ts:57
Count number of people

async

Returns Promise<number>

Number of people

findMembers

findMembers(): Promise<PersonModelAttributes[]>

- Defined in apollo/server/datasources/person.ts:114
Find all active and expired members
Including expired members but not those who have never finished registration

async

Returns Promise<PersonModelAttributes[]>

An array of active and expired members

findPeople

findPeople(): Promise<PersonModelAttributes[]>

- Defined in apollo/server/datasources/person.ts:66
Find all people

async

Returns Promise<PersonModelAttributes[]>

An array of people

findPerson

findPerson(sid: string): Promise<PersonModelAttributes | null>

- Defined in apollo/server/datasources/person.ts:130
Find a person by sid

async

Parameters
- sid: string
  
  The sid of the person
Returns Promise<PersonModelAttributes | null>

The matched person or null if not found

findRegistrations

findRegistrations(): Promise<PersonModelAttributes[]>

- Defined in apollo/server/datasources/person.ts:76
Find all pending registrations
A registration maybe for new member or for renewal of membership

async

Returns Promise<PersonModelAttributes[]>

An array of pending registrations

Optional initialize

initialize(config: DataSourceConfig<ContextBase>): void | Promise<void>

Inherited from CollegeAPI.initialize
- Defined in node_modules/apollo-datasource/dist/index.d.ts:7
Parameters
- config: DataSourceConfig<ContextBase>
Returns void | Promise<void>

updatePerson

updatePerson(arg: PersonUpdateAttributes, onlyNewRegistration: boolean, who: string | undefined): Promise<PersonModelAttributes>

- Defined in apollo/server/datasources/person.ts:181
Update a person

async

Parameters
- arg: PersonUpdateAttributes
  
  The arg for updating the person
- onlyNewRegistration: boolean
  
  Update only if it is a new registration
- who: string | undefined
Returns Promise<PersonModelAttributes>

The updated people

Generated using TypeDoc