Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ConsumerWebService

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected http

http: Http

Protected options

options: BaseModelWebServiceOptions

Static Protected instance

instance: ConsumerWebService

Methods

block

  • block(id: string): Promise<boolean>

  • Block an User with role Consumer.

    Parameters

    • id: string

      The User ID.

    Returns Promise<boolean>

create

  • create(consumer: UserSchema): Promise<User>

  • Create a new User with role Consumer.

    Parameters

    • consumer: UserSchema

      The User schema.

    Returns Promise<User>

delete

  • delete(id: string): Promise<boolean>

  • Delete a User with role Consumer.

    Parameters

    • id: string

      The User ID.

    Returns Promise<boolean>

findAll

  • findAll(pagination: Pagination): Promise<PaginatedArray<User>>

  • Find all Users with role Consumer.

    Parameters

    • pagination: Pagination

    Returns Promise<PaginatedArray<User>>

findOne

  • findOne(id: string): Promise<User>

  • Find a User with role Consumer.

    Parameters

    • id: string

      The User ID.

    Returns Promise<User>

unblock

  • unblock(id: string): Promise<boolean>

  • Block an User with role Consumer.

    Parameters

    • id: string

      The User ID.

    Returns Promise<boolean>

update

  • update(id: string, consumer: Partial<UserSchema>): Promise<User>

  • Partially update an existing User with role Consumer.

    Parameters

    • id: string

      The User ID.

    • consumer: Partial<UserSchema>

      The partial User schema.

    Returns Promise<User>

Static getInstance

Static initialize

Generated using TypeDoc