Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AddressWebService

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected http

http: Http

Protected options

options: AddressWebServiceOptions

Static Protected instance

instance: AddressWebService

Methods

create

  • create(userId: string, address: AddressSchema): Promise<Address>

  • Create a new Address in the platform.

    Parameters

    • userId: string

      The Consumer's User ID.

    • address: AddressSchema

      The Address schema.

    Returns Promise<Address>

delete

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

findAll

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

  • Find all Addresses from a Consumer.

    Parameters

    • userId: string

      The Consumer's User ID.

    • pagination: Pagination

      The pagination parameters.

    Returns Promise<PaginatedArray<Address>>

findOne

  • findOne(userId: string, addressId: string): Promise<Address>

update

  • update(userId: string, addressId: string, address: Partial<AddressSchema>): Promise<Address>

  • Partially update an existing Address.

    Parameters

    • userId: string

      The Consumer's User ID.

    • addressId: string

      The Address ID.

    • address: Partial<AddressSchema>

      The partial Address schema.

    Returns Promise<Address>

Static getInstance

Static initialize

Generated using TypeDoc