Interface ItineraryInventoryItemsRepository

interface ItineraryInventoryItemsRepository {
    modelName: string;
    bulkUpdateInventoryItemsCostSchedule(
        inventoryItems: ItineraryInventoryItem[],
    ): Promise<void>;
    countAvailableInventoryItemsByItinerary(
        itineraryId: string,
        enabledPackages: PackageLevel[],
        minStartDate: Date,
    ): Promise<number>;
    countDocuments(
        query?: FilterQuery<ItineraryInventoryItem>,
    ): Promise<number>;
    create(
        entity: ItineraryInventoryItem,
    ): Promise<Saved<ItineraryInventoryItem>>;
    createMany(
        entity: ItineraryInventoryItem[],
        options?: CreateManyOptions,
    ): Promise<string[]>;
    deleteById(id: string): Promise<null | Saved<ItineraryInventoryItem>>;
    destroyById(id: string): Promise<null | Saved<ItineraryInventoryItem>>;
    findById(
        id: string,
        fields?: SelectQuery<ItineraryInventoryItem>[],
        ListQueryOptions?: ListQueryOptions<ItineraryInventoryItem>,
    ): Promise<null | Saved<ItineraryInventoryItem>>;
    findOne(
        query?: FilterQuery<ItineraryInventoryItem>,
        fields?: SelectQuery<ItineraryInventoryItem>[],
        ListQueryOptions?: ListQueryOptions<ItineraryInventoryItem>,
    ): Promise<null | Saved<ItineraryInventoryItem>>;
    getInventoryItemsWithTrips(
        itineraryId: string,
    ): Promise<SavedItineraryInventoryItemWithTrips[]>;
    list(
        query?: FilterQuery<ItineraryInventoryItem>,
        fields?: SelectQuery<ItineraryInventoryItem>[],
        ListQueryOptions?: ListQueryOptions<ItineraryInventoryItem>,
    ): Promise<Saved<ItineraryInventoryItem>[]>;
    paginate(
        options?: PaginateQueryOptions<ItineraryInventoryItem>,
    ): Promise<PaginationResponse<Saved<ItineraryInventoryItem>>>;
    updateById(
        id: string,
        entity: PartialQuery<ItineraryInventoryItem>,
        options?: UpdateOptions,
    ): Promise<null | Saved<ItineraryInventoryItem>>;
    updateMany(
        filter: FilterQuery<ItineraryInventoryItem>,
        update: PartialQuery<ItineraryInventoryItem>,
    ): Promise<number>;
    updateOne(
        filter: FilterQuery<ItineraryInventoryItem>,
        update: PartialQuery<ItineraryInventoryItem>,
        options?: UpdateOneOptions,
    ): Promise<null | Saved<ItineraryInventoryItem>>;
    upsertOne(
        filter: FilterQuery<ItineraryInventoryItem>,
        entity: PartialQuery<ItineraryInventoryItem>,
    ): Promise<null | string>;
}

Hierarchy (View Summary)

BaseRepo<ItineraryInventoryItem>
- ItineraryInventoryItemsRepository

Index

Properties

modelName

Methods

bulkUpdateInventoryItemsCostSchedule countAvailableInventoryItemsByItinerary countDocuments create createMany deleteById destroyById findById findOne getInventoryItemsWithTrips list paginate updateById updateMany updateOne upsertOne

Properties

modelName

modelName: string

The name of the model.

Methods

bulkUpdateInventoryItemsCostSchedule

bulkUpdateInventoryItemsCostSchedule(
inventoryItems: ItineraryInventoryItem[],
): Promise<void>
Bulk update operation to set the cost schedule of the inventory items.
Parameters
- inventoryItems: ItineraryInventoryItem[]
  The inventory items to update.
Returns Promise<void>
- Defined in packages/data-access/src/repositories/ItineraryInventoryItemsRepo/ItineraryInventoryItemsRepo.types.ts:17

countAvailableInventoryItemsByItinerary

countAvailableInventoryItemsByItinerary(
    itineraryId: string,
    enabledPackages: PackageLevel[],
    minStartDate: Date,
): Promise<number>
Counts the available inventory items for a specific itinerary and package levels. It will also check if the inventory items have a start date greater than or equal to the minStartDate.
Parameters
- itineraryId: string
- enabledPackages: PackageLevel[]
- minStartDate: Date
Returns Promise<number>
- Defined in packages/data-access/src/repositories/ItineraryInventoryItemsRepo/ItineraryInventoryItemsRepo.types.ts:28

countDocuments

countDocuments(query?: FilterQuery<ItineraryInventoryItem>): Promise<number>
Count the number of documents matching the query.
Parameters
- Optionalquery: FilterQuery<ItineraryInventoryItem>
Returns Promise<number>
- A promise that resolves to the count of matching documents.
Inherited from BaseRepo.countDocuments
- Defined in packages/data-access/src/repositories/baseRepo/BaseRepo.types.ts:40

create

create(entity: ItineraryInventoryItem): Promise<Saved<ItineraryInventoryItem>>
Create a new entity.
Parameters
- entity: ItineraryInventoryItem
  The entity to create.
Returns Promise<Saved<ItineraryInventoryItem>>
- A promise that resolves to the saved entity.
Inherited from BaseRepo.create
- Defined in packages/data-access/src/repositories/baseRepo/BaseRepo.types.ts:27

createMany

createMany(
entity: ItineraryInventoryItem[],
options?: CreateManyOptions,
): Promise<string[]>
Create multiple entities.
Parameters
- entity: ItineraryInventoryItem[]
  An array of entities to create.
- Optionaloptions: CreateManyOptions
Returns Promise<string[]>
- A promise that resolves to an array of created entity IDs.
Inherited from BaseRepo.createMany
- Defined in packages/data-access/src/repositories/baseRepo/BaseRepo.types.ts:34

deleteById

deleteById(id: string): Promise<null | Saved<ItineraryInventoryItem>>
Soft delete an entity by its ID. This operation marks the entity as deleted without permanently destroying the record.
Parameters
- id: string
  The ID of the entity to delete. @returns- A promise that resolves to the deleted entity or null if not found.
Returns Promise<null | Saved<ItineraryInventoryItem>>
Inherited from BaseRepo.deleteById
- Defined in packages/data-access/src/repositories/baseRepo/BaseRepo.types.ts:47

destroyById

destroyById(id: string): Promise<null | Saved<ItineraryInventoryItem>>
Destroy an entity by its ID (permanently deletes it).
Parameters
- id: string
  The ID of the entity to destroy.
Returns Promise<null | Saved<ItineraryInventoryItem>>
- A promise that resolves to the destroyed entity or null if not found.
Inherited from BaseRepo.destroyById
- Defined in packages/data-access/src/repositories/baseRepo/BaseRepo.types.ts:53

findById

findById(
    id: string,
    fields?: SelectQuery<ItineraryInventoryItem>[],
    ListQueryOptions?: ListQueryOptions<ItineraryInventoryItem>,
): Promise<null | Saved<ItineraryInventoryItem>>
Find an entity by its ID.
Parameters
- id: string
  The ID of the entity to find.
- Optionalfields: SelectQuery<ItineraryInventoryItem>[]
  Fields to select in the returned entity.
- OptionalListQueryOptions: ListQueryOptions<ItineraryInventoryItem>
  Options for listing queries.
Returns Promise<null | Saved<ItineraryInventoryItem>>
- A promise that resolves to the found entity or null if not found.
Inherited from BaseRepo.findById
- Defined in packages/data-access/src/repositories/baseRepo/BaseRepo.types.ts:61

findOne

findOne(
    query?: FilterQuery<ItineraryInventoryItem>,
    fields?: SelectQuery<ItineraryInventoryItem>[],
    ListQueryOptions?: ListQueryOptions<ItineraryInventoryItem>,
): Promise<null | Saved<ItineraryInventoryItem>>
Find one entity matching the query.
Parameters
- Optionalquery: FilterQuery<ItineraryInventoryItem>
- Optionalfields: SelectQuery<ItineraryInventoryItem>[]
- OptionalListQueryOptions: ListQueryOptions<ItineraryInventoryItem>
Returns Promise<null | Saved<ItineraryInventoryItem>>
- A promise that resolves to the found entity or null if not found.
Inherited from BaseRepo.findOne
- Defined in packages/data-access/src/repositories/baseRepo/BaseRepo.types.ts:73

getInventoryItemsWithTrips

getInventoryItemsWithTrips(
itineraryId: string,
): Promise<SavedItineraryInventoryItemWithTrips[]>
Parameters
- itineraryId: string
Returns Promise<SavedItineraryInventoryItemWithTrips[]>
- Defined in packages/data-access/src/repositories/ItineraryInventoryItemsRepo/ItineraryInventoryItemsRepo.types.ts:34

list

list(
    query?: FilterQuery<ItineraryInventoryItem>,
    fields?: SelectQuery<ItineraryInventoryItem>[],
    ListQueryOptions?: ListQueryOptions<ItineraryInventoryItem>,
): Promise<Saved<ItineraryInventoryItem>[]>
List entities matching the query.
Parameters
- Optionalquery: FilterQuery<ItineraryInventoryItem>
  The query to filter documents.
- Optionalfields: SelectQuery<ItineraryInventoryItem>[]
  Fields to select in the returned entities.
- OptionalListQueryOptions: ListQueryOptions<ItineraryInventoryItem>
  Options for listing queries.
Returns Promise<Saved<ItineraryInventoryItem>[]>
- A promise that resolves to an array of found entities.
Inherited from BaseRepo.list
- Defined in packages/data-access/src/repositories/baseRepo/BaseRepo.types.ts:85

paginate

paginate(
options?: PaginateQueryOptions<ItineraryInventoryItem>,
): Promise<PaginationResponse<Saved<ItineraryInventoryItem>>>
Retrieve paginated results. Only intended for use with the admin portal for performance reasons.
Parameters
- Optionaloptions: PaginateQueryOptions<ItineraryInventoryItem>
  The pagination options
Returns Promise<PaginationResponse<Saved<ItineraryInventoryItem>>>
Inherited from BaseRepo.paginate
- Defined in packages/data-access/src/repositories/baseRepo/BaseRepo.types.ts:94

updateById

updateById(
    id: string,
    entity: PartialQuery<ItineraryInventoryItem>,
    options?: UpdateOptions,
): Promise<null | Saved<ItineraryInventoryItem>>
Update an entity by its ID.
Parameters
- id: string
  The ID of the entity to update.
- entity: PartialQuery<ItineraryInventoryItem>
  The partial entity to update.
- Optionaloptions: UpdateOptions
Returns Promise<null | Saved<ItineraryInventoryItem>>
- A promise that resolves to the updated entity or null if not found.
Inherited from BaseRepo.updateById
- Defined in packages/data-access/src/repositories/baseRepo/BaseRepo.types.ts:104

updateMany

updateMany(
filter: FilterQuery<ItineraryInventoryItem>,
update: PartialQuery<ItineraryInventoryItem>,
): Promise<number>
Update multiple entities matching the filter.
Parameters
- filter: FilterQuery<ItineraryInventoryItem>
  The filter to match documents.
- update: PartialQuery<ItineraryInventoryItem>
  The partial update to apply.
Returns Promise<number>
- A promise that resolves to the number of documents updated.
Inherited from BaseRepo.updateMany
- Defined in packages/data-access/src/repositories/baseRepo/BaseRepo.types.ts:115

updateOne

updateOne(
    filter: FilterQuery<ItineraryInventoryItem>,
    update: PartialQuery<ItineraryInventoryItem>,
    options?: UpdateOneOptions,
): Promise<null | Saved<ItineraryInventoryItem>>
Update a single entity matching the filter.
Parameters
- filter: FilterQuery<ItineraryInventoryItem>
  The filter to match documents.
- update: PartialQuery<ItineraryInventoryItem>
  The partial update to apply.
- Optionaloptions: UpdateOneOptions
  Options for updating a single document.
Returns Promise<null | Saved<ItineraryInventoryItem>>
| null>} - A promise that resolves to the updated entity or null if not found.
Inherited from BaseRepo.updateOne
- Defined in packages/data-access/src/repositories/baseRepo/BaseRepo.types.ts:126

upsertOne

upsertOne(
filter: FilterQuery<ItineraryInventoryItem>,
entity: PartialQuery<ItineraryInventoryItem>,
): Promise<null | string>
Upsert a single record based on certain criteria.
Parameters
- filter: FilterQuery<ItineraryInventoryItem>
  The filter to find the record to update or insert.
- entity: PartialQuery<ItineraryInventoryItem>
  The entity to upsert.
Returns Promise<null | string>
The return types of this method align with the MongoDB UpdateResult interface
- Returns models.baseModel.Saved<T>['_id'] if the document did not exist (an upsert took place).
- Returns null if the document did exist before the upsert operation.
Inherited from BaseRepo.upsertOne
- Defined in packages/data-access/src/repositories/baseRepo/BaseRepo.types.ts:140

Interface ItineraryInventoryItemsRepository

Hierarchy (View Summary)

Index

Properties

Methods

Properties

modelName

Methods

bulkUpdateInventoryItemsCostSchedule

Parameters

Returns Promise<void>

countAvailableInventoryItemsByItinerary

Parameters

Returns Promise<number>

countDocuments

Parameters

Returns Promise<number>

create

Parameters

Returns Promise<Saved<ItineraryInventoryItem>>

createMany

Parameters

Returns Promise<string[]>

deleteById

Parameters

Returns Promise<null | Saved<ItineraryInventoryItem>>

destroyById

Parameters

Returns Promise<null | Saved<ItineraryInventoryItem>>

findById

Parameters

Returns Promise<null | Saved<ItineraryInventoryItem>>

findOne

Parameters

Returns Promise<null | Saved<ItineraryInventoryItem>>

getInventoryItemsWithTrips

Parameters

Returns Promise<SavedItineraryInventoryItemWithTrips[]>

list

Parameters

Returns Promise<Saved<ItineraryInventoryItem>[]>

paginate

Parameters

Returns Promise<PaginationResponse<Saved<ItineraryInventoryItem>>>

updateById

Parameters

Returns Promise<null | Saved<ItineraryInventoryItem>>

updateMany

Parameters

Returns Promise<number>

updateOne

Parameters

Returns Promise<null | Saved<ItineraryInventoryItem>>

upsertOne

Parameters

Returns Promise<null | string>

Settings

On This Page