Class NxSys\Library\Clients\Brex\API\Payments\Endpoint\ListVendors

`extends`	`BaseEndpoint`
`implements`	`Endpoint`
`uses`	`EndpointTrait`

NxSys\Library\Clients\Brex\API\Payments\Runtime\Client\BaseEndpoint implements Endpoint
- NxSys\Library\Clients\Brex\API\Payments\Endpoint\ListVendors implements Endpoint uses EndpointTrait

Located at gen\Payments\Endpoint\ListVendors.php

Methods


					
	public

__construct(array $queryParameters = [])

This endpoint lists all existing vendors for an account. Takes an optional parameter to match by vendor name.

Parameters

$queryParameters

{


					
	public

getMethod(): string

Get the HTTP method of an endpoint (like GET, POST, ...).

Implements

NxSys\Library\Clients\Brex\API\Payments\Runtime\Client\Endpoint::getMethod()


					
	public

getUri(): string

Get the URI of an endpoint (like /foo-uri).

Implements

NxSys\Library\Clients\Brex\API\Payments\Runtime\Client\Endpoint::getUri()


					
	public

getBody(SerializerInterface $serializer, $streamFactory = null): array

Get body for an endpoint.

Return value consist of an array where the first item will be a list of headers to add on the request (like the Content Type) And the second value consist of the body object.

Implements

NxSys\Library\Clients\Brex\API\Payments\Runtime\Client\Endpoint::getBody()


					
	public

getExtraHeaders(): array

Overrides

NxSys\Library\Clients\Brex\API\Payments\Runtime\Client\BaseEndpoint::getExtraHeaders()


					
	protected

getQueryOptionsResolver(): OptionsResolver

Overrides

NxSys\Library\Clients\Brex\API\Payments\Runtime\Client\BaseEndpoint::getQueryOptionsResolver()


					
	protected

transformResponseBody(
	ResponseInterface $response,
	SerializerInterface $serializer,
	?string $contentType = null,
): PageVendorResponse|null

{@inheritdoc}

Throws

`NxSys\Library\Clients\Brex\API\Payments\Exception\ListVendorsBadRequestException`
`NxSys\Library\Clients\Brex\API\Payments\Exception\ListVendorsUnauthorizedException`
`NxSys\Library\Clients\Brex\API\Payments\Exception\ListVendorsForbiddenException`

Implements

NxSys\Library\Clients\Brex\API\Payments\Runtime\Client\BaseEndpoint::transformResponseBody()


					
	public

getAuthenticationScopes(): array

Get security scopes of an endpoint.

Implements

NxSys\Library\Clients\Brex\API\Payments\Runtime\Client\Endpoint::getAuthenticationScopes()

Methods inherited from NxSys\Library\Clients\Brex\API\Payments\Runtime\Client\BaseEndpoint
`getQueryString(), getHeaders(), getHeadersOptionsResolver(), getFormBody(), getMultipartBody(), getFormOptionsResolver(), getSerializedBody()`

Methods used from NxSys\Library\Clients\Brex\API\Payments\Runtime\Client\EndpointTrait
`parseResponse()`

Properties inherited from NxSys\Library\Clients\Brex\API\Payments\Runtime\Client\BaseEndpoint
`$queryParameters, $headerParameters, $body`

Namespaces

Classes

Class NxSys\Library\Clients\Brex\API\Payments\Endpoint\ListVendors

Parameters

Implements

Implements

Implements

Overrides

Overrides

Throws

Implements

Implements