Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DeviceAddressServiceClient

Hierarchy

Index

Constructors

constructor

Properties

Protected apiConfiguration

apiConfiguration: ApiConfiguration

ApiConfiguration instance to provide dependencies for this service client

Private userAgent

userAgent: string

Methods

callGetCountryAndPostalCode

  • callGetCountryAndPostalCode(deviceId: string): Promise<ApiResponse>
  • Parameters

    • deviceId: string

      The device Id for which to get the country and postal code

    Returns Promise<ApiResponse>

callGetFullAddress

  • callGetFullAddress(deviceId: string): Promise<ApiResponse>
  • Parameters

    • deviceId: string

      The device Id for which to get the address

    Returns Promise<ApiResponse>

getCountryAndPostalCode

  • getCountryAndPostalCode(deviceId: string): Promise<ShortAddress>
  • Parameters

    • deviceId: string

      The device Id for which to get the country and postal code

    Returns Promise<ShortAddress>

getFullAddress

  • getFullAddress(deviceId: string): Promise<Address>
  • Parameters

    • deviceId: string

      The device Id for which to get the address

    Returns Promise<Address>

Protected invoke

  • invoke(method: string, endpoint: string, path: string, pathParams: Map<string, string>, queryParams: Array<object>, headerParams: Array<object>, bodyParam: any, errors: Map<number, string>, nonJsonBody?: boolean): Promise<any>
  • Invocation wrapper to implement service operations in generated classes

    Parameters

    • method: string

      HTTP method, such as 'POST', 'GET', 'DELETE', etc.

    • endpoint: string

      base API url

    • path: string

      the path pattern with possible placeholders for path parameters in form {paramName}

    • pathParams: Map<string, string>

      path parameters collection

    • queryParams: Array<object>

      query parameters collection

    • headerParams: Array<object>

      headers collection

    • bodyParam: any

      if body parameter is present it is provided here, otherwise null or undefined

    • errors: Map<number, string>

      maps recognized status codes to messages

    • Optional nonJsonBody: boolean

      if the body is in JSON format

    Returns Promise<any>

withRequestInterceptors

  • withRequestInterceptors(...requestInterceptors: Array<function>): BaseServiceClient

withResponseInterceptors

  • withResponseInterceptors(...responseInterceptors: Array<function>): BaseServiceClient