Class ChangeRequestDataService

Description

Service for creating and managing organization change requests.

Index

Constructors

Methods

appendChangeRequestUris createChangeRequest listChangeRequests normalizeChangeRequestResponse normalizeChangeRequestResponses

Properties

changeRequestRepository db uploadService COLLECTION_ORGANIZATION_CHANGE_REQUEST

Constructors

constructor

new ChangeRequestDataService(dependencies): ChangeRequestDataService
Parameters
- dependencies: {
  db: Db;
  uploadService: UploadDataService;
  }
  - db: Db
  - uploadService: UploadDataService
Returns ChangeRequestDataService
- Defined in adapter/default/dataServices/changeRequest.dataService.ts:25

Methods

appendChangeRequestUris

appendChangeRequestUris(changeRequest): Promise<ChangeRequestResponse>
Append change request uris to the change request
Parameters
- changeRequest: ChangeRequest
  change request
Returns Promise<ChangeRequestResponse>
change request with uris
- Defined in adapter/default/dataServices/changeRequest.dataService.ts:82

createChangeRequest

createChangeRequest(changeRequestPayload): Promise<{
id: string;
}>
Create change request into database, upload certificate image if available
Parameters
- changeRequestPayload: Partial<Omit<ChangeRequest, "id" | "orgId" | "userId" | "createdAt" | "updatedAt" | "certificateImageId"> & {
      certificateImageData: string;
  }> & {
      orgId: string;
      userId: string;
  }
  change request payload
Returns Promise<{
id: string;
}>
id of the created change request
- Defined in adapter/default/dataServices/changeRequest.dataService.ts:44

listChangeRequests

listChangeRequests(opts): Promise<PaginatedFindResult<ChangeRequestEntity>>
Retrieve a list of change requests
Parameters
- opts: ParsedPaginatedListQuery
  paginated list query options
Returns Promise<PaginatedFindResult<ChangeRequestEntity>>
paginated category list query result
- Defined in adapter/default/dataServices/changeRequest.dataService.ts:68

normalizeChangeRequestResponse

normalizeChangeRequestResponse(changeRequest): Promise<ChangeRequestResponse>
Normalize a single changeRequest response
Parameters
- changeRequest: ChangeRequest
  change request
Returns Promise<ChangeRequestResponse>
normalized change request response
- Defined in adapter/default/dataServices/changeRequest.dataService.ts:99

normalizeChangeRequestResponses

normalizeChangeRequestResponses(changeRequests): Promise<ChangeRequestResponse[]>
Normalize a list of changeRequest responses
Parameters
- changeRequests: ChangeRequest[]
  list of change requests
Returns Promise<ChangeRequestResponse[]>
normalized change request responses
- Defined in adapter/default/dataServices/changeRequest.dataService.ts:117

Properties

`Private` changeRequestRepository

changeRequestRepository: MongoRepository<ChangeRequestEntity>

`Private` db

db: Db

`Private` uploadService

uploadService: UploadDataService

`Static` `Private` `Readonly` COLLECTION_ORGANIZATION_CHANGE_REQUEST

COLLECTION_ORGANIZATION_CHANGE_REQUEST: "organization_change_requests" = 'organization_change_requests'

Class ChangeRequestDataService

Description

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

dependencies: { db: Db; uploadService: UploadDataService; }

db: Db

uploadService: UploadDataService

Returns ChangeRequestDataService

Methods

appendChangeRequestUris

Parameters

changeRequest: ChangeRequest

Returns Promise<ChangeRequestResponse>

createChangeRequest

Parameters

changeRequestPayload: Partial<Omit<ChangeRequest, "id" | "orgId" | "userId" | "createdAt" | "updatedAt" | "certificateImageId"> & { certificateImageData: string; }> & { orgId: string; userId: string; }

Returns Promise<{ id: string; }>

listChangeRequests

Parameters

opts: ParsedPaginatedListQuery

Returns Promise<PaginatedFindResult<ChangeRequestEntity>>

normalizeChangeRequestResponse

Parameters

changeRequest: ChangeRequest

Returns Promise<ChangeRequestResponse>

normalizeChangeRequestResponses

Parameters

changeRequests: ChangeRequest[]

Returns Promise<ChangeRequestResponse[]>

Properties

Private changeRequestRepository

Private db

Private uploadService

Static Private Readonly COLLECTION_ORGANIZATION_CHANGE_REQUEST

Settings

Member Visibility

Theme

On This Page

dependencies: {
db: Db;
uploadService: UploadDataService;
}

changeRequestPayload: Partial<Omit<ChangeRequest, "id" | "orgId" | "userId" | "createdAt" | "updatedAt" | "certificateImageId"> & {
certificateImageData: string;
}> & {
orgId: string;
userId: string;
}

Returns Promise<{
id: string;
}>

`Private` changeRequestRepository

`Private` db

`Private` uploadService

`Static` `Private` `Readonly` COLLECTION_ORGANIZATION_CHANGE_REQUEST