MailSlurp\ContactControllerApi
All URIs are relative to https://golang.api.mailslurp.com
Method | HTTP request | Description |
---|---|---|
CreateContact | Post /contacts | Create a contact |
DeleteContact | Delete /contacts/{contactId} | Delete contact |
GetAllContacts | Get /contacts/paginated | Get all contacts |
GetContact | Get /contacts/{contactId} | Get contact |
GetContactVCard | Get /contacts/{contactId}/download | Get contact vCard vcf file |
GetContacts | Get /contacts | Get all contacts |
CreateContact
ContactDto CreateContact(ctx, createContactOptions)
Create a contact
Required Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
createContactOptions | CreateContactOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
DeleteContact
DeleteContact(ctx, contactId)
Delete contact
Required Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
contactId | string |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to ]
GetAllContacts
PageContactProjection GetAllContacts(ctx, optional)
Get all contacts
Required Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
optional | *GetAllContactsOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a GetAllContactsOpts struct
Name | Type | Description | Notes |
---|---|---|---|
page | optional.Int32 | Optional page in list pagination | [default to 0] |
size | optional.Int32 | Optional page size in list pagination | [default to 20] |
sort | optional.String | Optional createdAt sort direction ASC or DESC | [default to ASC] |
since | optional.Time | Filter by created at after the given timestamp | |
before | optional.Time | Filter by created at before the given timestamp |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
GetContact
ContactDto GetContact(ctx, contactId)
Get contact
Required Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
contactId | string |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
GetContactVCard
[]string GetContactVCard(ctx, contactId)
Get contact vCard vcf file
Required Parameters
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
contactId | string |
Return type
[]string
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
GetContacts
[]ContactProjection GetContacts(ctx, )
Get all contacts
Required Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]