Class DominoConnector

ReadonlybaseUrl

Readonlymeta

schema

getFetchOptions

• getFetchOptions(
      dominoAccess: DominoRestAccess,
      operation: DominoRestOperation,
      request: DominoRequestOptions,
  ): Promise<any>

  Parameters

  • dominoAccess: DominoRestAccess
  • operation: DominoRestOperation

    JSON information about the operation
  • request: DominoRequestOptions

    contains the options to build

  Returns Promise<any>

  a promise that resolves to the request options built.

getOperation

• getOperation(operationId: string): any

  Parameters

  • operationId: string

    the operation ID to get

  Returns any

  JSON information around the given operation ID

getOperations

• getOperations(): Map<string, any>

  Returns Map<string, any>

  all operations for the connector.

getUrl

• getUrl(
      operation: DominoRestOperation,
      scope: string,
      params: Map<string, string>,
  ): string

  Parameters

  • operation: DominoRestOperation

    JSON information about the operation
  • scope: string

    target scope name
  • params: Map<string, string>

    parameters to supply to the URL

  Returns string

  the URL built.

request

• request(
      dominoAccess: DominoRestAccess,
      operationId: string,
      options: DominoRequestOptions,
  ): Promise<DominoRequestResponse>

  Parameters

  • dominoAccess: DominoRestAccess
  • operationId: string

    operation ID according to OpenAPI specification
  • options: DominoRequestOptions

    contains all parameters for the request

  Returns Promise<DominoRequestResponse>

  a promise that resolves to the response to the request

StaticgetConnector

• getConnector(baseUrl: string, meta: DominoApiMeta): Promise<DominoConnector>

  Parameters

  • baseUrl: string
  • meta: DominoApiMeta

  Returns Promise<DominoConnector>