Package co.novu.api.organizations

Interface OrganizationApi

public interface OrganizationApi

Field Summary

Fields

Modifier and Type	Field	Description
static String	ENDPOINT

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<OrganizationResponse>	createOrganization(CreateOrganizationRequest request)
retrofit2.Call<FetchOrganizationResponse>	fetchAllOrganizations()
retrofit2.Call<OrganizationResponse>	fetchCurrentOrganization()
retrofit2.Call<FetchMembersResponse>	fetchMembersOfOrganization()
retrofit2.Call<MemberResponse>	removeMemberWithId(String memberId)
retrofit2.Call<MemberResponse>	updateMemberRole(String memberId, UpdateMemberRoleRequest request)
retrofit2.Call<UpdateOrganizationBrandResponse>	updateOrganizationBrand(UpdateOrganizationBrandRequest request)
retrofit2.Call<UpdateOrganizationNameResponse>	updateOrganizationName(UpdateOrganizationNameRequest request)

Field Detail

ENDPOINT

static final String ENDPOINT

See Also:

Constant Field Values

Method Detail

createOrganization

@POST("organizations")
retrofit2.Call<OrganizationResponse> createOrganization(@Body
                                                        CreateOrganizationRequest request)

fetchAllOrganizations

@GET("organizations")
retrofit2.Call<FetchOrganizationResponse> fetchAllOrganizations()

updateOrganizationName

@PATCH("organizations")
retrofit2.Call<UpdateOrganizationNameResponse> updateOrganizationName(@Body
                                                                      UpdateOrganizationNameRequest request)

fetchCurrentOrganization

@GET("organizations/me")
retrofit2.Call<OrganizationResponse> fetchCurrentOrganization()

removeMemberWithId

@DELETE("organizations/members/{memberId}")
retrofit2.Call<MemberResponse> removeMemberWithId(@Path("memberId")
                                                  String memberId)

updateMemberRole

@PUT("organizations/members/{memberId}/roles")
retrofit2.Call<MemberResponse> updateMemberRole(@Path("memberId")
                                                String memberId,
                                                @Body
                                                UpdateMemberRoleRequest request)

fetchMembersOfOrganization

@GET("organizations/members")
retrofit2.Call<FetchMembersResponse> fetchMembersOfOrganization()

updateOrganizationBrand

@PUT("organizations/branding")
retrofit2.Call<UpdateOrganizationBrandResponse> updateOrganizationBrand(@Body
                                                                        UpdateOrganizationBrandRequest request)