Documentation
¶
Index ¶
- type PlanManager
- func (m *PlanManager) CreatePlan(ctx context.Context, params plan_management.CreatePlanParams) middleware.Responder
- func (m *PlanManager) GetCompletePlan(ctx context.Context, params plan_management.GetCompletePlanParams) middleware.Responder
- func (m *PlanManager) GetPlan(ctx context.Context, params plan_management.GetPlanParams) middleware.Responder
- func (m *PlanManager) ListCompletePlans(ctx context.Context, params plan_management.ListCompletePlansParams) middleware.Responder
- func (m *PlanManager) ListPlans(ctx context.Context, params plan_management.ListPlansParams) middleware.Responder
- func (m *PlanManager) UpdatePlan(ctx context.Context, params plan_management.UpdatePlanParams) middleware.Responder
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type PlanManager ¶
type PlanManager struct {
// contains filtered or unexported fields
}
PlanManager is the struct defined to group and contain all the methods that interact with the plan subsystem. Parameters: - basePath: a string with the base path of the system. - db: a DbParameter reference to be able to use the DBManager methods. - monit: a StatusManager reference to be able to use the status subsystem methods.
func New ¶
func New(db *dbManager.DbParameter, monit *statusManager.StatusManager, bp string) *PlanManager
New is the function to create the struct PlanManager. Parameters: - DbParameter: reference pointing to the DbParameter that allows the interaction with the DBManager methods. - StatusParameter: reference poining to the StatusManager that allows the interaction with the StatusManager methods. - bp: a string containing the base path of the service. Returns: - PlanManager: struct to interact with PlanManager subsystem functionalities.
func (*PlanManager) CreatePlan ¶
func (m *PlanManager) CreatePlan(ctx context.Context, params plan_management.CreatePlanParams) middleware.Responder
CreatePlan (Swagger func) is the function behind the (POST) endpoint /plan Its job is to add a new plan in the system.
func (*PlanManager) GetCompletePlan ¶
func (m *PlanManager) GetCompletePlan(ctx context.Context, params plan_management.GetCompletePlanParams) middleware.Responder
GetCompletePlan (Swagger func) is the function behind the (GET) endpoint /plan/complete/{id} Its job is to retrieve the full information related to a plan provided its ID.
func (*PlanManager) GetPlan ¶
func (m *PlanManager) GetPlan(ctx context.Context, params plan_management.GetPlanParams) middleware.Responder
GetPlan (Swagger func) is the function behind the (GET) endpoint /plan/{id} Its job is to retrieve the information related to a plan provided its ID.
func (*PlanManager) ListCompletePlans ¶
func (m *PlanManager) ListCompletePlans(ctx context.Context, params plan_management.ListCompletePlansParams) middleware.Responder
ListCompletePlans (Swagger func) is the function behind the (GET) endpoint /plan/complete Its job is to retrieve the full information, including linked skus, related to a plan provided its ID.
func (*PlanManager) ListPlans ¶
func (m *PlanManager) ListPlans(ctx context.Context, params plan_management.ListPlansParams) middleware.Responder
ListPlans (Swagger func) is the function behind the (GET) endpoint /plan Its job is to retrieve the information related to a plan provided its ID.
func (*PlanManager) UpdatePlan ¶
func (m *PlanManager) UpdatePlan(ctx context.Context, params plan_management.UpdatePlanParams) middleware.Responder
UpdatePlan (Swagger func) is the function behind the (PUT) endpoint /plan/{id} Its job is to update the plan linked to the provided ID with the new plan data.
Source Files