Interface IUserControllerApiSync

Represents a collection of functions to interact with the API endpoints

Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public interface IUserControllerApiSync : IApiAccessor

Methods

View Source

GetEntityAutomations(int?, int?, string, DateTime?, DateTime?, Guid?, Guid?, string, int)

Declaration
PageEntityAutomationItems GetEntityAutomations(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, Guid? inboxId = null, Guid? phoneId = null, string filter = null, int operationIndex = 0)
Parameters
Type Name Description
int? page

Optional page index (optional, default to 0)
int? size

Optional page size (optional, default to 20)
string sort

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

Filter by created at after the given timestamp (optional)
DateTime? before

Filter by created at before the given timestamp (optional)
Guid? inboxId

Optional inbox ID (optional)
Guid? phoneId

Optional phone ID (optional)
string filter

Optional automation type filter (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
PageEntityAutomationItems

PageEntityAutomationItems
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEntityAutomationsWithHttpInfo(int?, int?, string, DateTime?, DateTime?, Guid?, Guid?, string, int)

Declaration
ApiResponse<PageEntityAutomationItems> GetEntityAutomationsWithHttpInfo(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, Guid? inboxId = null, Guid? phoneId = null, string filter = null, int operationIndex = 0)
Parameters
Type Name Description
int? page

Optional page index (optional, default to 0)
int? size

Optional page size (optional, default to 20)
string sort

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

Filter by created at after the given timestamp (optional)
DateTime? before

Filter by created at before the given timestamp (optional)
Guid? inboxId

Optional inbox ID (optional)
Guid? phoneId

Optional phone ID (optional)
string filter

Optional automation type filter (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<PageEntityAutomationItems>

ApiResponse of PageEntityAutomationItems
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEntityEvents(int?, int?, string, DateTime?, DateTime?, Guid?, Guid?, Guid?, Guid?, Guid?, string, int)

Declaration
PageEntityEventItems GetEntityEvents(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, Guid? inboxId = null, Guid? emailId = null, Guid? phoneId = null, Guid? smsId = null, Guid? attachmentId = null, string filter = null, int operationIndex = 0)
Parameters
Type Name Description
int? page

Optional page index (optional, default to 0)
int? size

Optional page size (optional, default to 20)
string sort

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

Filter by created at after the given timestamp (optional)
DateTime? before

Filter by created at before the given timestamp (optional)
Guid? inboxId

Optional inbox ID (optional)
Guid? emailId

Optional email ID (optional)
Guid? phoneId

Optional phone ID (optional)
Guid? smsId

Optional SMS ID (optional)
Guid? attachmentId

Optional attachment ID (optional)
string filter

Optional type filter (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
PageEntityEventItems

PageEntityEventItems
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEntityEventsWithHttpInfo(int?, int?, string, DateTime?, DateTime?, Guid?, Guid?, Guid?, Guid?, Guid?, string, int)

Declaration
ApiResponse<PageEntityEventItems> GetEntityEventsWithHttpInfo(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, Guid? inboxId = null, Guid? emailId = null, Guid? phoneId = null, Guid? smsId = null, Guid? attachmentId = null, string filter = null, int operationIndex = 0)
Parameters
Type Name Description
int? page

Optional page index (optional, default to 0)
int? size

Optional page size (optional, default to 20)
string sort

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

Filter by created at after the given timestamp (optional)
DateTime? before

Filter by created at before the given timestamp (optional)
Guid? inboxId

Optional inbox ID (optional)
Guid? emailId

Optional email ID (optional)
Guid? phoneId

Optional phone ID (optional)
Guid? smsId

Optional SMS ID (optional)
Guid? attachmentId

Optional attachment ID (optional)
string filter

Optional type filter (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<PageEntityEventItems>

ApiResponse of PageEntityEventItems
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEntityFavorites(int?, int?, string, DateTime?, DateTime?, string, int)

Declaration
PageEntityFavouriteItems GetEntityFavorites(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, string filter = null, int operationIndex = 0)
Parameters
Type Name Description
int? page

Optional page index (optional, default to 0)
int? size

Optional page size (optional, default to 20)
string sort

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

Filter by created at after the given timestamp (optional)
DateTime? before

Filter by created at before the given timestamp (optional)
string filter

Optional type filter (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
PageEntityFavouriteItems

PageEntityFavouriteItems
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEntityFavoritesWithHttpInfo(int?, int?, string, DateTime?, DateTime?, string, int)

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

Optional page index (optional, default to 0)
int? size

Optional page size (optional, default to 20)
string sort

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

Filter by created at after the given timestamp (optional)
DateTime? before

Filter by created at before the given timestamp (optional)
string filter

Optional type filter (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<PageEntityFavouriteItems>

ApiResponse of PageEntityFavouriteItems
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetJsonPropertyAsString(string, object, int)

Declaration
string GetJsonPropertyAsString(string property, object body, int operationIndex = 0)
Parameters
Type Name Description
string property

JSON property name or dot separated path selector such as a.b.c
object body
int operationIndex

Index associated with the operation.
Returns
Type Description
string

string
Remarks

Utility function to extract properties from JSON objects in language where this is cumbersome.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetJsonPropertyAsStringWithHttpInfo(string, object, int)

Declaration
ApiResponse<string> GetJsonPropertyAsStringWithHttpInfo(string property, object body, int operationIndex = 0)
Parameters
Type Name Description
string property

JSON property name or dot separated path selector such as a.b.c
object body
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<string>

ApiResponse of string
Remarks

Utility function to extract properties from JSON objects in language where this is cumbersome.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetUserInfo(int)

Declaration
UserInfoDto GetUserInfo(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
UserInfoDto

UserInfoDto
Remarks

Get account information for your user

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetUserInfoWithHttpInfo(int)

Declaration
ApiResponse<UserInfoDto> GetUserInfoWithHttpInfo(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<UserInfoDto>

ApiResponse of UserInfoDto
Remarks

Get account information for your user

Exceptions
Type Condition
ApiException

Thrown when fails to make API call