Search Results for

    Show / Hide Table of Contents

    Interface IContactControllerApiSync

    Represents a collection of functions to interact with the API endpoints

    Inherited Members
    IApiAccessor.Configuration
    IApiAccessor.GetBasePath()
    IApiAccessor.ExceptionFactory
    Namespace: mailslurp.Api
    Assembly: mailslurp.dll
    Syntax
    public interface IContactControllerApiSync : IApiAccessor

    Methods

    View Source

    CreateContact(CreateContactOptions, int)

    Create a contact

    Declaration
    ContactDto CreateContact(CreateContactOptions createContactOptions, int operationIndex = 0)
    Parameters
    Type Name Description
    CreateContactOptions createContactOptions
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ContactDto

    ContactDto

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    CreateContactWithHttpInfo(CreateContactOptions, int)

    Create a contact

    Declaration
    ApiResponse<ContactDto> CreateContactWithHttpInfo(CreateContactOptions createContactOptions, int operationIndex = 0)
    Parameters
    Type Name Description
    CreateContactOptions createContactOptions
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<ContactDto>

    ApiResponse of ContactDto

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    DeleteContact(Guid, int)

    Delete contact

    Declaration
    void DeleteContact(Guid contactId, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid contactId
    int operationIndex

    Index associated with the operation.

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    DeleteContactWithHttpInfo(Guid, int)

    Delete contact

    Declaration
    ApiResponse<object> DeleteContactWithHttpInfo(Guid contactId, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid contactId
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<object>

    ApiResponse of Object(void)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetAllContacts(int?, int?, string, DateTime?, DateTime?, string, int)

    Get all contacts

    Declaration
    PageContactProjection GetAllContacts(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, string search = null, int operationIndex = 0)
    Parameters
    Type Name Description
    int? page

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

    int? size

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

    string sort

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

    DateTime? since

    Filter by created at after the given timestamp (optional)

    DateTime? before

    Filter by created at before the given timestamp (optional)

    string search

    Search terms (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    PageContactProjection

    PageContactProjection

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetAllContactsWithHttpInfo(int?, int?, string, DateTime?, DateTime?, string, int)

    Get all contacts

    Declaration
    ApiResponse<PageContactProjection> GetAllContactsWithHttpInfo(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, string search = null, int operationIndex = 0)
    Parameters
    Type Name Description
    int? page

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

    int? size

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

    string sort

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

    DateTime? since

    Filter by created at after the given timestamp (optional)

    DateTime? before

    Filter by created at before the given timestamp (optional)

    string search

    Search terms (optional)

    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<PageContactProjection>

    ApiResponse of PageContactProjection

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetContact(Guid, int)

    Get contact

    Declaration
    ContactDto GetContact(Guid contactId, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid contactId
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ContactDto

    ContactDto

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetContacts(int)

    Get all contacts

    Declaration
    List<ContactProjection> GetContacts(int operationIndex = 0)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    System.Collections.Generic.List<T><ContactProjection>

    List<ContactProjection>

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetContactsWithHttpInfo(int)

    Get all contacts

    Declaration
    ApiResponse<List<ContactProjection>> GetContactsWithHttpInfo(int operationIndex = 0)
    Parameters
    Type Name Description
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<System.Collections.Generic.List<T><ContactProjection>>

    ApiResponse of List<ContactProjection>

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetContactVCard(Guid, int)

    Get contact vCard vcf file

    Declaration
    [Obsolete]
    void GetContactVCard(Guid contactId, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid contactId
    int operationIndex

    Index associated with the operation.

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetContactVCardWithHttpInfo(Guid, int)

    Get contact vCard vcf file

    Declaration
    [Obsolete]
    ApiResponse<object> GetContactVCardWithHttpInfo(Guid contactId, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid contactId
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<object>

    ApiResponse of Object(void)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    View Source

    GetContactWithHttpInfo(Guid, int)

    Get contact

    Declaration
    ApiResponse<ContactDto> GetContactWithHttpInfo(Guid contactId, int operationIndex = 0)
    Parameters
    Type Name Description
    System.Guid contactId
    int operationIndex

    Index associated with the operation.

    Returns
    Type Description
    ApiResponse<ContactDto>

    ApiResponse of ContactDto

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    • View Source
    In This Article
    Back to top See MailSlurp website for more information.