business

type BusinessContract interface {
	// CreateTenant creates a new tenant.
	// ctx: Mandatory The reference to the context
	// request: Mandatory. The request to create a new tenant
	// Returns either the result of creating new tenant or error if something goes wrong.
	CreateTenant(
		ctx context.Context,
		request *CreateTenantRequest) (*CreateTenantResponse, error)

	// ReadTenant read an existing tenant
	// ctx: Mandatory The reference to the context
	// request: Mandatory. The request to read an existing tenant
	// Returns either the result of reading an exiting tenant or error if something goes wrong.
	ReadTenant(
		ctx context.Context,
		request *ReadTenantRequest) (*ReadTenantResponse, error)

	// UpdateTenant update an existing tenant
	// ctx: Mandatory The reference to the context
	// request: Mandatory. The request to update an existing tenant
	// Returns either the result of updateing an exiting tenant or error if something goes wrong.
	UpdateTenant(
		ctx context.Context,
		request *UpdateTenantRequest) (*UpdateTenantResponse, error)

	// DeleteTenant delete an existing tenant
	// ctx: Mandatory The reference to the context
	// request: Mandatory. The request to delete an existing tenant
	// Returns either the result of deleting an exiting tenant or error if something goes wrong.
	DeleteTenant(
		ctx context.Context,
		request *DeleteTenantRequest) (*DeleteTenantResponse, error)

	// Search returns the list of tenants that matched the criteria
	// ctx: Mandatory The reference to the context
	// request: Mandatory. The request contains the search criteria
	// Returns the list of tenants that matched the criteria
	Search(
		ctx context.Context,
		request *SearchRequest) (*SearchResponse, error)
}

type CreateTenantRequest struct {
	Tenant models.Tenant
}

type CreateTenantResponse struct {
	Err      error
	TenantID string
	Tenant   models.Tenant
	Cursor   string
}

type DeleteTenantRequest struct {
	TenantID string
}

type DeleteTenantResponse struct {
	Err error
}

type ReadTenantRequest struct {
	TenantID string
}

type ReadTenantResponse struct {
	Err    error
	Tenant models.Tenant
}

type SearchRequest struct {
	Pagination     common.Pagination
	SortingOptions []common.SortingOptionPair
	TenantIDs      []string
}

type SearchResponse struct {
	Err             error
	HasPreviousPage bool
	HasNextPage     bool
	TotalCount      int64
	Tenants         []models.TenantWithCursor
}

type TenantAlreadyExistsError struct {
	Err error
}

type TenantNotFoundError struct {
	TenantID string
	Err      error
}

type UnknownError struct {
	Message string
	Err     error
}

type UpdateTenantRequest struct {
	TenantID string
	Tenant   models.Tenant
}

type UpdateTenantResponse struct {
	Err    error
	Tenant models.Tenant
	Cursor string
}