Interface IRaythaFunctionApi_V1

Namespace

Raytha.Application.Common.Interfaces

Assembly

Raytha.Application.dll

public interface IRaythaFunctionApi_V1

Methods

CreateContentItem(string, bool, string, IDictionary<string, object>)

ICommandResponseDto<ShortGuid> CreateContentItem(string contentTypeDeveloperName, bool saveAsDraft, string templateId, IDictionary<string, object> content)

Parameters

contentTypeDeveloperName string

saveAsDraft bool

templateId string

content IDictionary<string, object>

Returns

ICommandResponseDto<ShortGuid>

CreateUser(string, string, string, bool, dynamic)

ICommandResponseDto<ShortGuid> CreateUser(string emailAddress, string firstName, string lastName, bool sendEmail, dynamic userGroups)

Parameters

emailAddress string

firstName string

lastName string

sendEmail bool

userGroups dynamic

Returns

ICommandResponseDto<ShortGuid>

CreateUserGroup(string, string)

ICommandResponseDto<ShortGuid> CreateUserGroup(string developerName, string label)

Parameters

developerName string

label string

Returns

ICommandResponseDto<ShortGuid>

DeleteContentItem(string)

ICommandResponseDto<ShortGuid> DeleteContentItem(string contentItemId)

Parameters

contentItemId string

Returns

ICommandResponseDto<ShortGuid>

DeleteUser(string)

ICommandResponseDto<ShortGuid> DeleteUser(string userId)

Parameters

userId string

Returns

ICommandResponseDto<ShortGuid>

DeleteUserGroup(string)

ICommandResponseDto<ShortGuid> DeleteUserGroup(string userGroupId)

Parameters

userGroupId string

Returns

ICommandResponseDto<ShortGuid>

EditContentItem(string, bool, IDictionary<string, object>)

ICommandResponseDto<ShortGuid> EditContentItem(string contentItemId, bool saveAsDraft, IDictionary<string, object> content)

Parameters

contentItemId string

saveAsDraft bool

content IDictionary<string, object>

Returns

ICommandResponseDto<ShortGuid>

EditContentItemSettings(string, string, string)

ICommandResponseDto<ShortGuid> EditContentItemSettings(string contentItemId, string templateId, string routePath)

Parameters

contentItemId string

templateId string

routePath string

Returns

ICommandResponseDto<ShortGuid>

EditUser(string, string, string, string, dynamic)

ICommandResponseDto<ShortGuid> EditUser(string userId, string emailAddress, string firstName, string lastName, dynamic userGroups)

Parameters

userId string

emailAddress string

firstName string

lastName string

userGroups dynamic

Returns

ICommandResponseDto<ShortGuid>

EditUserGroup(string, string)

ICommandResponseDto<ShortGuid> EditUserGroup(string userGroupId, string label)

Parameters

userGroupId string

label string

Returns

ICommandResponseDto<ShortGuid>

ExecuteRaythaFunction(string, string, string, string)

ICommandResponseDto<object> ExecuteRaythaFunction(string developerName, string requestMethod, string queryJson, string payloadJson)

Parameters

developerName string

requestMethod string

queryJson string

payloadJson string

Returns

ICommandResponseDto<object>

GetContentItemById(string)

IQueryResponseDto<ContentItemDto> GetContentItemById(string contentItemId)

Parameters

contentItemId string

Returns

IQueryResponseDto<ContentItemDto>

GetContentItems(string, string, string, string, string, int, int)

IQueryResponseDto<ListResultDto<ContentItemDto>> GetContentItems(string contentTypeDeveloperName, string viewId = "", string search = "", string filter = "", string orderBy = "", int pageNumber = 1, int pageSize = 50)

Parameters

contentTypeDeveloperName string

viewId string

search string

filter string

orderBy string

pageNumber int

pageSize int

Returns

IQueryResponseDto<ListResultDto<ContentItemDto>>

GetContentTypeByDeveloperName(string)

IQueryResponseDto<ContentTypeDto> GetContentTypeByDeveloperName(string contentTypeDeveloperName)

Parameters

contentTypeDeveloperName string

Returns

IQueryResponseDto<ContentTypeDto>

GetContentTypes(string, string, int, int)

IQueryResponseDto<ListResultDto<ContentTypeDto>> GetContentTypes(string search = "", string orderBy = "", int pageNumber = 1, int pageSize = 50)

Parameters

search string

orderBy string

pageNumber int

pageSize int

Returns

IQueryResponseDto<ListResultDto<ContentTypeDto>>

GetDeletedContentItems(string, string, string, int, int)

IQueryResponseDto<ListResultDto<DeletedContentItemDto>> GetDeletedContentItems(string contentTypeDeveloperName, string search = "", string orderBy = "", int pageNumber = 1, int pageSize = 50)

Parameters

contentTypeDeveloperName string

search string

orderBy string

pageNumber int

pageSize int

Returns

IQueryResponseDto<ListResultDto<DeletedContentItemDto>>

GetMediaItemUrlByObjectKey(string)

IQueryResponseDto<string> GetMediaItemUrlByObjectKey(string objectKey)

Parameters

objectKey string

Returns

IQueryResponseDto<string>

GetMediaItems(string, string, int, int)

IQueryResponseDto<ListResultDto<MediaItemDto>> GetMediaItems(string search = "", string orderBy = "", int pageNumber = 1, int pageSize = 50)

Parameters

search string

orderBy string

pageNumber int

pageSize int

Returns

IQueryResponseDto<ListResultDto<MediaItemDto>>

GetRouteByPath(string)

IQueryResponseDto<RouteDto> GetRouteByPath(string routePath)

Parameters

routePath string

Returns

IQueryResponseDto<RouteDto>

GetUserById(string)

IQueryResponseDto<UserDto> GetUserById(string userId)

Parameters

userId string

Returns

IQueryResponseDto<UserDto>

GetUserGroupById(string)

IQueryResponseDto<UserGroupDto> GetUserGroupById(string userGroupId)

Parameters

userGroupId string

Returns

IQueryResponseDto<UserGroupDto>

GetUserGroups(string, string, int, int)

IQueryResponseDto<ListResultDto<UserGroupDto>> GetUserGroups(string search = "", string orderBy = "", int pageNumber = 1, int pageSize = 50)

Parameters

search string

orderBy string

pageNumber int

pageSize int

Returns

IQueryResponseDto<ListResultDto<UserGroupDto>>

GetUsers(string, string, int, int)

IQueryResponseDto<ListResultDto<UserDto>> GetUsers(string search = "", string orderBy = "", int pageNumber = 1, int pageSize = 50)

Parameters

search string

orderBy string

pageNumber int

pageSize int

Returns

IQueryResponseDto<ListResultDto<UserDto>>

GetWebTemplateById(string)

IQueryResponseDto<WebTemplateDto> GetWebTemplateById(string webTemplateId)

Parameters

webTemplateId string

Returns

IQueryResponseDto<WebTemplateDto>

GetWebTemplates(string, string, int, int)

IQueryResponseDto<ListResultDto<WebTemplateDto>> GetWebTemplates(string search = "", string orderBy = "", int pageNumber = 1, int pageSize = 50)

Parameters

search string

orderBy string

pageNumber int

pageSize int

Returns

IQueryResponseDto<ListResultDto<WebTemplateDto>>

ResetPassword(string, bool, string)

ICommandResponseDto<ShortGuid> ResetPassword(string userId, bool sendEmail, string newPassword)

Parameters

userId string

sendEmail bool

newPassword string

Returns

ICommandResponseDto<ShortGuid>

SetIsActive(string, bool)

ICommandResponseDto<ShortGuid> SetIsActive(string userId, bool isActive)

Parameters

userId string

isActive bool

Returns

ICommandResponseDto<ShortGuid>

UnpublishContentItem(string)

ICommandResponseDto<ShortGuid> UnpublishContentItem(string contentItemId)

Parameters

contentItemId string

Returns

ICommandResponseDto<ShortGuid>