clients/soap/types

@prismatic-io/spectral › "clients/soap/types"

Index

Interfaces

• BasicAuthConnection
• ClientOverrides
• DescribeWSDL
• GenerateHeader
• HeaderPayload
• RequestParams
• SOAPAuth
• SOAPConnection
• SOAPRequest

Type aliases

• SOAPResponse

Functions

• isBasicAuthConnection
• isSOAPConnection

Type aliases

SOAPResponse

Ƭ SOAPResponse: []

Defined in packages/spectral/src/clients/soap/types.ts:32

SOAP requests return a 4-tuple or 5-tuple with the response first, the XML response second, headers third, and the XML request fourth, and optional message attachments fifth.

Functions

Const isBasicAuthConnection

▸ isBasicAuthConnection(connection: Connection): connection is BasicAuthConnection

Defined in packages/spectral/src/clients/soap/types.ts:96

This function determines if the object presented is a Basic Auth connection with username, password, and loginMethod fields.

Parameters:

Name	Type	Description
connection	Connection	The connection to test

Returns: connection is BasicAuthConnection

This function returns true if the connection is a SOAPConnection, and false otherwise.

---

Const isSOAPConnection

▸ isSOAPConnection(connection: unknown): connection is SOAPConnection

Defined in packages/spectral/src/clients/soap/types.ts:21

This function determines if the object presented is a SOAP connection with a wsdlDefinitionUrl field.

Parameters:

Name	Type	Description
connection	unknown	The connection to test

Returns: connection is SOAPConnection

This function returns true if the connection is a SOAPConnection, and false otherwise.