SudoSOS Back-end API / catalogue/containers / ContainerService

Class: ContainerService

Constructors

Constructor

new ContainerService(): ContainerService;

Returns

ContainerService

Methods

canViewContainer()

static canViewContainer(userId, container): Promise<ContainerVisibility>;

Test to see if the user can view a specified container

Parameters

Parameter	Type	Description
userId	number	The User to test
container	Container	The container to view

Returns

Promise<ContainerVisibility>

---

createContainer()

static createContainer(container): Promise<ContainerRevision>;

Creates a new container.

Parameters

Parameter	Type	Description
container	CreateContainerParams	The params that describe the container to be created.

Returns

Promise<ContainerRevision>

---

deleteContainer()

static deleteContainer(containerId): Promise<void>;

(Soft) delete a container

Parameters

Parameter	Type	Description
containerId	number	-

Returns

Promise<void>

---

getContainers()

static getContainers(
   filters?, 
   pagination?, 
user?): Promise<[ContainerRevision[], number]>;

Query for getting all containers.

Parameters

Parameter	Type	Description
filters	ContainerFilterParameters	-
pagination	PaginationParameters	-
user?	User	-

Returns

Promise<[ContainerRevision[], number]>

---

getOptions()

static getOptions(params, user?): Promise<FindManyOptions<ContainerRevision>>;

Returns the options for the query

Parameters

Parameter	Type	Description
params	ContainerFilterParameters	-
user?	User	-

Returns

Promise<FindManyOptions<ContainerRevision>>

---

getSingleContainer()

static getSingleContainer(filters?): Promise<ContainerRevision>;

Parameters

Parameter	Type
filters	ContainerFilterParameters

Returns

Promise<ContainerRevision>

---

propagateContainerUpdate()

static propagateContainerUpdate(containerId): Promise<void>;

Propagates the container update to all point of sales.

All POS that contain the previous version of this container will be revised to include the new revision.

Parameters

Parameter	Type	Description
containerId	number	The container to propagate

Returns

Promise<void>

---

revisionSubQuery()

static revisionSubQuery(revision?): string;

Parameters

Parameter	Type
revision?	number

Returns

string

---

revisionToBaseResponse()

static revisionToBaseResponse(revision): BaseContainerResponse;

Parameters

Parameter	Type
revision	ContainerRevision

Returns

BaseContainerResponse

---

revisionToResponse()

static revisionToResponse(revision): 
  | ContainerResponse
  | ContainerWithProductsResponse;

Parameters

Parameter	Type
revision	ContainerRevision

Returns

| ContainerResponse | ContainerWithProductsResponse

---

updateContainer()

static updateContainer(update): Promise<ContainerRevision>;

Updates a container by directly creating a revision.

Parameters

Parameter	Type	Description
update	UpdateContainerParams	The container update

Returns

Promise<ContainerRevision>