Class: Pike13::API::V3::Desk::PersonPlans
- Defined in:
- lib/pike13/api/v3/desk/person_plans.rb
Overview
Person Plans resource Comprehensive data about passes and plans that are available for use or on hold
Constant Summary collapse
- DETAIL_FIELDS =
Available detail fields (when not grouping)
%w[ account_manager_emails account_manager_names account_manager_phones allowed_visit_count are_visits_shared base_price business_id business_name business_subdomain canceled_at canceled_by canceled_by_account_id cancellation_fee_amount charged_cancellation_fee_amount commitment_length completed_visit_count currency_code deactivated_at email end_date exhausted_at first_name first_visit_date first_visit_day first_visit_instructor_names first_visit_time first_visit_to_next_plan franchise_id full_name grants_membership has_cancellation_fee home_location_name invoice_interval_count invoice_interval_unit is_available is_canceled is_cancellation_fee_charged is_complimentary_pass is_deactivated is_deleted is_ended is_exhausted is_first_membership is_first_plan is_last_hold_indefinite is_on_hold is_primary_participant key last_hold_by last_hold_by_account_id last_hold_end_date last_hold_start_date last_name last_usable_date last_visit_date last_visit_day last_visit_time last_visit_to_next_plan latest_invoice_autobill latest_invoice_due_date latest_invoice_item_amount latest_invoice_past_due lifetime_used_visit_count middle_name next_plan_grants_membership next_plan_id next_plan_name next_plan_revenue_category next_plan_start_date next_plan_type person_id person_plan_id plan_id plan_location_id plan_location_name plan_name plan_product_id plan_type primary_staff_name product_id product_name remaining_commitment remaining_visit_count revenue_category rollover_count start_date start_date_to_first_visit start_date_to_next_plan stop_renewing_after_commitment term_acceptance_required term_accepted used_for_initial_visit used_visit_count visit_refresh_interval_count visit_refresh_interval_unit ].freeze
- SUMMARY_FIELDS =
Available summary fields (when grouping)
%w[ avg_first_visit_to_next_plan avg_last_visit_to_next_plan avg_start_date_to_first_visit avg_start_date_to_next_plan business_id_summary business_subdomain_summary grants_membership_count has_cancellation_fee_count is_available_count is_canceled_count is_complimentary_pass_count is_first_membership_count is_first_plan_count is_on_hold_count latest_invoice_past_due_count next_plan_count next_plan_grants_membership_percent next_plan_on_visit_date_percent next_plan_out_of_visited_percent next_plan_percent next_plan_within_week_percent person_count person_plan_count plan_count total_cancellation_fee_amount total_charged_cancellation_fee_amount total_count total_latest_invoice_item_amount total_lifetime_used_visit_count total_used_for_initial_visit total_used_visit_count visited_count visited_percent ].freeze
- GROUPINGS =
Available grouping fields
%w[ are_visits_shared business_id business_name business_subdomain canceled_by canceled_by_account_id end_date first_visit_date first_visit_instructor_names first_visit_month_start_date first_visit_quarter_start_date first_visit_week_mon_start_date first_visit_week_sun_start_date first_visit_year_start_date full_name grants_membership has_cancellation_fee home_location_name is_available is_canceled is_cancellation_fee_charged is_complimentary_pass is_deleted is_first_membership is_first_plan is_last_hold_indefinite is_on_hold last_hold_by last_hold_by_account_id last_hold_end_date last_hold_start_date last_usable_date last_usable_month_start_date last_usable_quarter_start_date last_usable_week_mon_start_date last_usable_week_sun_start_date last_usable_year_start_date last_visit_date last_visit_month_start_date last_visit_quarter_start_date last_visit_week_mon_start_date last_visit_week_sun_start_date last_visit_year_start_date latest_invoice_autobill latest_invoice_due_date latest_invoice_past_due person_id plan_id plan_location_id plan_location_name plan_name plan_product_id plan_type primary_staff_name product_id product_name revenue_category start_date start_month_start_date start_quarter_start_date start_week_mon_start_date start_week_sun_start_date start_year_start_date stop_renewing_after_commitment used_for_initial_visit ].freeze
Class Method Summary collapse
-
.query(fields:, filter: nil, group: nil, sort: nil, page: nil, total_count: nil) ⇒ Hash
Execute a person plans query.
Methods inherited from Base
Class Method Details
.query(fields:, filter: nil, group: nil, sort: nil, page: nil, total_count: nil) ⇒ Hash
Execute a person plans query
45 46 47 48 49 50 51 52 53 54 |
# File 'lib/pike13/api/v3/desk/person_plans.rb', line 45 def query(fields:, filter: nil, group: nil, sort: nil, page: nil, total_count: nil) query_params = { fields: fields } query_params[:filter] = filter if filter query_params[:group] = group if group query_params[:sort] = sort if sort query_params[:page] = page if page query_params[:total_count] = total_count if total_count super("person_plans", query_params) end |