Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PhoneWebService

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected http

http: Http

Protected options

options: PhoneWebServiceOptions

Static Protected instance

instance: PhoneWebService

Methods

create

  • create(userId: string, phone: PhoneSchema): Promise<Phone>

  • Create a new Phone in the platform.

    Parameters

    • userId: string

      The Consumer's User ID.

    • phone: PhoneSchema

      The Phone schema.

    Returns Promise<Phone>

delete

  • delete(userId: string, phoneId: string): Promise<boolean>

findAll

  • findAll(userId: string, pagination: Pagination): Promise<PaginatedArray<Phone>>

  • Find all Phones from a Consumer.

    Parameters

    • userId: string

      The Consumer's User ID.

    • pagination: Pagination

      The pagination parameters.

    Returns Promise<PaginatedArray<Phone>>

findOne

  • findOne(userId: string, phoneId: string): Promise<Phone>

update

  • update(userId: string, phoneId: string, phone: Partial<PhoneSchema>): Promise<Phone>

  • Partially update an existing Phone.

    Parameters

    • userId: string

      The Consumer's User ID.

    • phoneId: string

      The Phone ID.

    • phone: Partial<PhoneSchema>

      The partial Phone schema.

    Returns Promise<Phone>

Static getInstance

Static initialize

Generated using TypeDoc