Class BusinessAddress

Hierarchy

UrlSection
- BusinessAddress

Index

Constructors

constructor

Methods

Constructors

constructor

new BusinessAddress(prv: PathSegment, id?: string, service?: any): BusinessAddress

Overrides UrlSection.constructor
- Defined in paths/BusinessAddress.ts:7
Parameters
- prv: PathSegment
- Optional id: string
- Optional service: any
Returns BusinessAddress

Methods

get

get(): Promise<GetAccountInfoResponse>

- Defined in paths/BusinessAddress.ts:15
Required Permissions
Permission Description
ReadAccounts Viewing user account info (including name, business name, address and phone number/account number)
Usage Plan Group
Light

Returns Promise<GetAccountInfoResponse>

getEndpoint

getEndpoint(withValue?: boolean): string

Inherited from UrlSection.getEndpoint
- Defined in PathSegment.ts:26
Parameters
- Default value withValue: boolean = true
Returns string

Protected getRest

getRest(): RestClient

Inherited from UrlSection.getRest
- Defined in PathSegment.ts:34
Returns RestClient

put

put(body: ModifyAccountBusinessAddressRequest): Promise<AccountBusinessAddressResource>

Required Permissions

Permission	Description
EditAccounts	Viewing and updating user account info (including name, business name, address and phone number/account number)
ReadAccounts	Viewing user account info (including name, business name, address and phone number/account number)

Usage Plan Group

Medium

Parameters

body: ModifyAccountBusinessAddressRequest

Returns Promise<AccountBusinessAddressResource>

toString

toString(withValue?: boolean): string

Inherited from UrlSection.toString
- Defined in PathSegment.ts:18
Parameters
- Default value withValue: boolean = true
Returns string

Generated using TypeDoc