Documentation

ContactControllerApi
in package

ContactControllerApi Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech

Table of Contents

contentTypes  = ['createContact' => ['application/json'], 'deleteContact' => ['application/json'], 'getAllContacts' => ['application/json'], 'getContact' => ['application/json'], 'getContactVCard' => ['application/json'], 'getContacts' => ['application/json']]
$client  : ClientInterface
$config  : Configuration
$headerSelector  : HeaderSelector
$hostIndex  : int
__construct()  : mixed
createContact()  : ContactDto
Operation createContact
createContactAsync()  : PromiseInterface
Operation createContactAsync
createContactAsyncWithHttpInfo()  : PromiseInterface
Operation createContactAsyncWithHttpInfo
createContactRequest()  : Request
Create request for operation 'createContact'
createContactWithHttpInfo()  : array<string|int, mixed>
Operation createContactWithHttpInfo
deleteContact()  : void
Operation deleteContact
deleteContactAsync()  : PromiseInterface
Operation deleteContactAsync
deleteContactAsyncWithHttpInfo()  : PromiseInterface
Operation deleteContactAsyncWithHttpInfo
deleteContactRequest()  : Request
Create request for operation 'deleteContact'
deleteContactWithHttpInfo()  : array<string|int, mixed>
Operation deleteContactWithHttpInfo
getAllContacts()  : PageContactProjection
Operation getAllContacts
getAllContactsAsync()  : PromiseInterface
Operation getAllContactsAsync
getAllContactsAsyncWithHttpInfo()  : PromiseInterface
Operation getAllContactsAsyncWithHttpInfo
getAllContactsRequest()  : Request
Create request for operation 'getAllContacts'
getAllContactsWithHttpInfo()  : array<string|int, mixed>
Operation getAllContactsWithHttpInfo
getConfig()  : Configuration
getContact()  : ContactDto
Operation getContact
getContactAsync()  : PromiseInterface
Operation getContactAsync
getContactAsyncWithHttpInfo()  : PromiseInterface
Operation getContactAsyncWithHttpInfo
getContactRequest()  : Request
Create request for operation 'getContact'
getContacts()  : array<string|int, ContactProjection>
Operation getContacts
getContactsAsync()  : PromiseInterface
Operation getContactsAsync
getContactsAsyncWithHttpInfo()  : PromiseInterface
Operation getContactsAsyncWithHttpInfo
getContactsRequest()  : Request
Create request for operation 'getContacts'
getContactsWithHttpInfo()  : array<string|int, mixed>
Operation getContactsWithHttpInfo
getContactVCard()  : array<string|int, string>
Operation getContactVCard
getContactVCardAsync()  : PromiseInterface
Operation getContactVCardAsync
getContactVCardAsyncWithHttpInfo()  : PromiseInterface
Operation getContactVCardAsyncWithHttpInfo
getContactVCardRequest()  : Request
Create request for operation 'getContactVCard'
getContactVCardWithHttpInfo()  : array<string|int, mixed>
Operation getContactVCardWithHttpInfo
getContactWithHttpInfo()  : array<string|int, mixed>
Operation getContactWithHttpInfo
getHostIndex()  : int
Get the host index
setHostIndex()  : void
Set the host index
createHttpClientOption()  : array<string|int, mixed>
Create http client option

Constants

contentTypes

public array<string|int, string> contentTypes = ['createContact' => ['application/json'], 'deleteContact' => ['application/json'], 'getAllContacts' => ['application/json'], 'getContact' => ['application/json'], 'getContactVCard' => ['application/json'], 'getContacts' => ['application/json']]

Properties

Methods

__construct()

public __construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ], int $hostIndex) : mixed
Parameters
$client : ClientInterface = null
$config : Configuration = null
$selector : HeaderSelector = null
$hostIndex : int

(Optional) host index to select the list of hosts if defined in the OpenAPI spec

Return values
mixed

createContact()

Operation createContact

public createContact(CreateContactOptions $create_contact_options[, string $contentType = self::contentTypes['createContact'][0] ]) : ContactDto

Create a contact

Parameters
$create_contact_options : CreateContactOptions

create_contact_options (required)

$contentType : string = self::contentTypes['createContact'][0]

The value for the Content-Type header. Check self::contentTypes['createContact'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
ContactDto

createContactAsync()

Operation createContactAsync

public createContactAsync(CreateContactOptions $create_contact_options[, string $contentType = self::contentTypes['createContact'][0] ]) : PromiseInterface

Create a contact

Parameters
$create_contact_options : CreateContactOptions

(required)

$contentType : string = self::contentTypes['createContact'][0]

The value for the Content-Type header. Check self::contentTypes['createContact'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

createContactAsyncWithHttpInfo()

Operation createContactAsyncWithHttpInfo

public createContactAsyncWithHttpInfo(CreateContactOptions $create_contact_options[, string $contentType = self::contentTypes['createContact'][0] ]) : PromiseInterface

Create a contact

Parameters
$create_contact_options : CreateContactOptions

(required)

$contentType : string = self::contentTypes['createContact'][0]

The value for the Content-Type header. Check self::contentTypes['createContact'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

createContactRequest()

Create request for operation 'createContact'

public createContactRequest(CreateContactOptions $create_contact_options[, string $contentType = self::contentTypes['createContact'][0] ]) : Request
Parameters
$create_contact_options : CreateContactOptions

(required)

$contentType : string = self::contentTypes['createContact'][0]

The value for the Content-Type header. Check self::contentTypes['createContact'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

createContactWithHttpInfo()

Operation createContactWithHttpInfo

public createContactWithHttpInfo(CreateContactOptions $create_contact_options[, string $contentType = self::contentTypes['createContact'][0] ]) : array<string|int, mixed>

Create a contact

Parameters
$create_contact_options : CreateContactOptions

(required)

$contentType : string = self::contentTypes['createContact'][0]

The value for the Content-Type header. Check self::contentTypes['createContact'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\ContactDto, HTTP status code, HTTP response headers (array of strings)

deleteContact()

Operation deleteContact

public deleteContact(string $contact_id[, string $contentType = self::contentTypes['deleteContact'][0] ]) : void

Delete contact

Parameters
$contact_id : string

contact_id (required)

$contentType : string = self::contentTypes['deleteContact'][0]

The value for the Content-Type header. Check self::contentTypes['deleteContact'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
void

deleteContactAsync()

Operation deleteContactAsync

public deleteContactAsync(string $contact_id[, string $contentType = self::contentTypes['deleteContact'][0] ]) : PromiseInterface

Delete contact

Parameters
$contact_id : string

(required)

$contentType : string = self::contentTypes['deleteContact'][0]

The value for the Content-Type header. Check self::contentTypes['deleteContact'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteContactAsyncWithHttpInfo()

Operation deleteContactAsyncWithHttpInfo

public deleteContactAsyncWithHttpInfo(string $contact_id[, string $contentType = self::contentTypes['deleteContact'][0] ]) : PromiseInterface

Delete contact

Parameters
$contact_id : string

(required)

$contentType : string = self::contentTypes['deleteContact'][0]

The value for the Content-Type header. Check self::contentTypes['deleteContact'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

deleteContactRequest()

Create request for operation 'deleteContact'

public deleteContactRequest(string $contact_id[, string $contentType = self::contentTypes['deleteContact'][0] ]) : Request
Parameters
$contact_id : string

(required)

$contentType : string = self::contentTypes['deleteContact'][0]

The value for the Content-Type header. Check self::contentTypes['deleteContact'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

deleteContactWithHttpInfo()

Operation deleteContactWithHttpInfo

public deleteContactWithHttpInfo(string $contact_id[, string $contentType = self::contentTypes['deleteContact'][0] ]) : array<string|int, mixed>

Delete contact

Parameters
$contact_id : string

(required)

$contentType : string = self::contentTypes['deleteContact'][0]

The value for the Content-Type header. Check self::contentTypes['deleteContact'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of null, HTTP status code, HTTP response headers (array of strings)

getAllContacts()

Operation getAllContacts

public getAllContacts(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllContacts'][0] ]) : PageContactProjection

Get all contacts

Parameters
$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size in list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

$contentType : string = self::contentTypes['getAllContacts'][0]

The value for the Content-Type header. Check self::contentTypes['getAllContacts'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
PageContactProjection

getAllContactsAsync()

Operation getAllContactsAsync

public getAllContactsAsync(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllContacts'][0] ]) : PromiseInterface

Get all contacts

Parameters
$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size in list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

$contentType : string = self::contentTypes['getAllContacts'][0]

The value for the Content-Type header. Check self::contentTypes['getAllContacts'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getAllContactsAsyncWithHttpInfo()

Operation getAllContactsAsyncWithHttpInfo

public getAllContactsAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllContacts'][0] ]) : PromiseInterface

Get all contacts

Parameters
$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size in list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

$contentType : string = self::contentTypes['getAllContacts'][0]

The value for the Content-Type header. Check self::contentTypes['getAllContacts'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getAllContactsRequest()

Create request for operation 'getAllContacts'

public getAllContactsRequest(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllContacts'][0] ]) : Request
Parameters
$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size in list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

$contentType : string = self::contentTypes['getAllContacts'][0]

The value for the Content-Type header. Check self::contentTypes['getAllContacts'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getAllContactsWithHttpInfo()

Operation getAllContactsWithHttpInfo

public getAllContactsWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'ASC' ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getAllContacts'][0] ]) : array<string|int, mixed>

Get all contacts

Parameters
$page : int

Optional page index in list pagination (optional, default to 0)

$size : int = 20

Optional page size in list pagination (optional, default to 20)

$sort : string = 'ASC'

Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')

$since : DateTime = null

Filter by created at after the given timestamp (optional)

$before : DateTime = null

Filter by created at before the given timestamp (optional)

$contentType : string = self::contentTypes['getAllContacts'][0]

The value for the Content-Type header. Check self::contentTypes['getAllContacts'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\PageContactProjection, HTTP status code, HTTP response headers (array of strings)

getContact()

Operation getContact

public getContact(string $contact_id[, string $contentType = self::contentTypes['getContact'][0] ]) : ContactDto

Get contact

Parameters
$contact_id : string

contact_id (required)

$contentType : string = self::contentTypes['getContact'][0]

The value for the Content-Type header. Check self::contentTypes['getContact'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
ContactDto

getContactAsync()

Operation getContactAsync

public getContactAsync(string $contact_id[, string $contentType = self::contentTypes['getContact'][0] ]) : PromiseInterface

Get contact

Parameters
$contact_id : string

(required)

$contentType : string = self::contentTypes['getContact'][0]

The value for the Content-Type header. Check self::contentTypes['getContact'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getContactAsyncWithHttpInfo()

Operation getContactAsyncWithHttpInfo

public getContactAsyncWithHttpInfo(string $contact_id[, string $contentType = self::contentTypes['getContact'][0] ]) : PromiseInterface

Get contact

Parameters
$contact_id : string

(required)

$contentType : string = self::contentTypes['getContact'][0]

The value for the Content-Type header. Check self::contentTypes['getContact'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getContactRequest()

Create request for operation 'getContact'

public getContactRequest(string $contact_id[, string $contentType = self::contentTypes['getContact'][0] ]) : Request
Parameters
$contact_id : string

(required)

$contentType : string = self::contentTypes['getContact'][0]

The value for the Content-Type header. Check self::contentTypes['getContact'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getContacts()

Operation getContacts

public getContacts([string $contentType = self::contentTypes['getContacts'][0] ]) : array<string|int, ContactProjection>

Get all contacts

Parameters
$contentType : string = self::contentTypes['getContacts'][0]

The value for the Content-Type header. Check self::contentTypes['getContacts'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, ContactProjection>

getContactsAsync()

Operation getContactsAsync

public getContactsAsync([string $contentType = self::contentTypes['getContacts'][0] ]) : PromiseInterface

Get all contacts

Parameters
$contentType : string = self::contentTypes['getContacts'][0]

The value for the Content-Type header. Check self::contentTypes['getContacts'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getContactsAsyncWithHttpInfo()

Operation getContactsAsyncWithHttpInfo

public getContactsAsyncWithHttpInfo([string $contentType = self::contentTypes['getContacts'][0] ]) : PromiseInterface

Get all contacts

Parameters
$contentType : string = self::contentTypes['getContacts'][0]

The value for the Content-Type header. Check self::contentTypes['getContacts'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getContactsRequest()

Create request for operation 'getContacts'

public getContactsRequest([string $contentType = self::contentTypes['getContacts'][0] ]) : Request
Parameters
$contentType : string = self::contentTypes['getContacts'][0]

The value for the Content-Type header. Check self::contentTypes['getContacts'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getContactsWithHttpInfo()

Operation getContactsWithHttpInfo

public getContactsWithHttpInfo([string $contentType = self::contentTypes['getContacts'][0] ]) : array<string|int, mixed>

Get all contacts

Parameters
$contentType : string = self::contentTypes['getContacts'][0]

The value for the Content-Type header. Check self::contentTypes['getContacts'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\ContactProjection[], HTTP status code, HTTP response headers (array of strings)

getContactVCard()

Operation getContactVCard

public getContactVCard(string $contact_id[, string $contentType = self::contentTypes['getContactVCard'][0] ]) : array<string|int, string>

Get contact vCard vcf file

Parameters
$contact_id : string

contact_id (required)

$contentType : string = self::contentTypes['getContactVCard'][0]

The value for the Content-Type header. Check self::contentTypes['getContactVCard'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, string>

getContactVCardAsync()

Operation getContactVCardAsync

public getContactVCardAsync(string $contact_id[, string $contentType = self::contentTypes['getContactVCard'][0] ]) : PromiseInterface

Get contact vCard vcf file

Parameters
$contact_id : string

(required)

$contentType : string = self::contentTypes['getContactVCard'][0]

The value for the Content-Type header. Check self::contentTypes['getContactVCard'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getContactVCardAsyncWithHttpInfo()

Operation getContactVCardAsyncWithHttpInfo

public getContactVCardAsyncWithHttpInfo(string $contact_id[, string $contentType = self::contentTypes['getContactVCard'][0] ]) : PromiseInterface

Get contact vCard vcf file

Parameters
$contact_id : string

(required)

$contentType : string = self::contentTypes['getContactVCard'][0]

The value for the Content-Type header. Check self::contentTypes['getContactVCard'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getContactVCardRequest()

Create request for operation 'getContactVCard'

public getContactVCardRequest(string $contact_id[, string $contentType = self::contentTypes['getContactVCard'][0] ]) : Request
Parameters
$contact_id : string

(required)

$contentType : string = self::contentTypes['getContactVCard'][0]

The value for the Content-Type header. Check self::contentTypes['getContactVCard'] to see the possible values for this operation

Tags
throws
InvalidArgumentException
Return values
Request

getContactVCardWithHttpInfo()

Operation getContactVCardWithHttpInfo

public getContactVCardWithHttpInfo(string $contact_id[, string $contentType = self::contentTypes['getContactVCard'][0] ]) : array<string|int, mixed>

Get contact vCard vcf file

Parameters
$contact_id : string

(required)

$contentType : string = self::contentTypes['getContactVCard'][0]

The value for the Content-Type header. Check self::contentTypes['getContactVCard'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of string[], HTTP status code, HTTP response headers (array of strings)

getContactWithHttpInfo()

Operation getContactWithHttpInfo

public getContactWithHttpInfo(string $contact_id[, string $contentType = self::contentTypes['getContact'][0] ]) : array<string|int, mixed>

Get contact

Parameters
$contact_id : string

(required)

$contentType : string = self::contentTypes['getContact'][0]

The value for the Content-Type header. Check self::contentTypes['getContact'] to see the possible values for this operation

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of \MailSlurp\Models\ContactDto, HTTP status code, HTTP response headers (array of strings)

getHostIndex()

Get the host index

public getHostIndex() : int
Return values
int

Host index

setHostIndex()

Set the host index

public setHostIndex(int $hostIndex) : void
Parameters
$hostIndex : int

Host index (required)

Return values
void

createHttpClientOption()

Create http client option

protected createHttpClientOption() : array<string|int, mixed>
Tags
throws
RuntimeException

on file opening failure

Return values
array<string|int, mixed>

of http client options

Search results