Module: FlowCl::Plan

Included in:
Client
Defined in:
lib/flow_cl/plan.rb

Instance Method Summary collapse

Instance Method Details

#create_plan(params:) ⇒ Object

Este servicio permite crear un nuevo Plan de Suscripción



6
7
8
9
10
 
# File 'lib/flow_cl/plan.rb', line 6

def create_plan(params:)
  path = 'api/plans/create'

  private_post(path, params)
end

#delete_plan(plan_id:) ⇒ Object

Este servicio permite eliminar un Plan de Suscripción. El eliminar un Plan significa que ya no podrá suscribir nuevos clientes al plan. Pero las suscripciones activas continuarán su ciclo de vida mientras estas no sean cancelas.



24
25
26
27
28
 
# File 'lib/flow_cl/plan.rb', line 24

def delete_plan(plan_id:)
  path = 'api/plans/delete'

  private_post(path, { planId: plan_id })
end

#edit_plan(params:) ⇒ Object

Este servicio permite editar los datos de un Plan de Suscripción. Si el plan tiene clientes suscritos, sólo se puede modificar el campo trial_period_days.



15
16
17
18
19
 
# File 'lib/flow_cl/plan.rb', line 15

def edit_plan(params:)
  path = 'api/plans/edit'

  private_post(path, params)
end

#plan(plan_id:) ⇒ Object

Este servicio permite obtener los datos de un Plan de Suscripción



31
32
33
34
35
 
# File 'lib/flow_cl/plan.rb', line 31

def plan(plan_id:)
  path = 'api/plans/get'

  private_get(path, { planId: plan_id })
end

#plans(params:) ⇒ Object

Permite obtener la lista de planes de suscripción paginada de acuerdo a los parámetros de paginación. Además, se puede definir los siguientes filtros:

filter: filtro por nombre del plan status: filtro por estado del plan



42
43
44
45
46
 
# File 'lib/flow_cl/plan.rb', line 42

def plans(params:)
  path = 'api/plans/list'

  private_get(path, params)
end