pike13 0.1.0.beta → 0.1.1

data/lib/pike13/api/v3/desk/invoices.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+module Pike13
+  module API
+    module V3
+      module Desk
+        # Invoices resource
+        # Details of invoices, their status, revenue, and payment information
+        #
+        # @example Basic query
+        #   Pike13::Reporting::Invoices.query(
+        #     fields: ['invoice_id', 'invoice_number', 'expected_amount', 'outstanding_amount']
+        #   )
+        #
+        # @example Query unpaid invoices
+        #   Pike13::Reporting::Invoices.query(
+        #     fields: ['invoice_number', 'invoice_payer_name', 'outstanding_amount', 'invoice_due_date'],
+        #     filter: ['gt', 'outstanding_amount', 0]
+        #   )
+        #
+        # @example Group by invoice state
+        #   Pike13::Reporting::Invoices.query(
+        #     fields: ['invoice_count', 'total_expected_amount', 'total_outstanding_amount'],
+        #     group: 'invoice_state'
+        #   )
+        class Invoices < Base
+          class << self
+            # Execute an invoices query
+            #
+            # @param fields [Array<String>] Fields to return (detail or summary fields)
+            # @param filter [Array, nil] Filter criteria (optional)
+            # @param group [String, nil] Grouping field (optional)
+            # @param sort [Array<String>, nil] Sort order (optional)
+            # @param page [Hash, nil] Pagination options (optional)
+            # @param total_count [Boolean] Whether to return total count (optional)
+            # @return [Hash] Query result with rows, fields, and metadata
+            #
+            # @see https://developer.pike13.com/docs/api/v3/reports/invoices
+            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("invoices", query_params)
+            end
+
+            # Available detail fields (when not grouping)
+            DETAIL_FIELDS = %w[
+              adjustments_amount
+              business_id
+              business_name
+              business_subdomain
+              closed_at
+              closed_date
+              commission_recipient_name
+              coupons_amount
+              created_by_client
+              created_by_name
+              currency_code
+              days_since_invoice_due
+              discounts_amount
+              expected_amount
+              expected_revenue_amount
+              expected_tax_amount
+              failed_transactions
+              franchise_id
+              gross_amount
+              invoice_autobill
+              invoice_due_date
+              invoice_id
+              invoice_number
+              invoice_payer_email
+              invoice_payer_home_location
+              invoice_payer_id
+              invoice_payer_name
+              invoice_payer_phone
+              invoice_payer_primary_staff_name_at_sale
+              invoice_state
+              issued_at
+              issued_date
+              key
+              net_paid_amount
+              net_paid_revenue_amount
+              net_paid_tax_amount
+              outstanding_amount
+              outstanding_revenue_amount
+              outstanding_tax_amount
+              payments_amount
+              purchase_order_number
+              purchase_request_cancel_reason
+              purchase_request_message
+              purchase_request_state
+              refunded_transactions
+              refunds_amount
+              sale_location_name
+              voided_transactions
+            ].freeze
+
+            # Available summary fields (when grouping)
+            SUMMARY_FIELDS = %w[
+              business_id_summary
+              business_subdomain_summary
+              created_by_client_count
+              invoice_autobill_count
+              invoice_count
+              total_adjustments_amount
+              total_count
+              total_coupons_amount
+              total_discounts_amount
+              total_expected_amount
+              total_expected_revenue_amount
+              total_expected_tax_amount
+              total_gross_amount
+              total_net_paid_amount
+              total_net_paid_revenue_amount
+              total_net_paid_tax_amount
+              total_outstanding_amount
+              total_outstanding_revenue_amount
+              total_outstanding_tax_amount
+              total_payments_amount
+              total_refunds_amount
+            ].freeze
+
+            # Available grouping fields
+            GROUPINGS = %w[
+              business_id
+              business_name
+              business_subdomain
+              closed_date
+              closed_month_start_date
+              closed_quarter_start_date
+              closed_week_mon_start_date
+              closed_week_sun_start_date
+              closed_year_start_date
+              commission_recipient_name
+              created_by_client
+              created_by_name
+              due_month_start_date
+              due_quarter_start_date
+              due_week_mon_start_date
+              due_week_sun_start_date
+              due_year_start_date
+              invoice_autobill
+              invoice_due_date
+              invoice_payer_home_location
+              invoice_payer_id
+              invoice_payer_name
+              invoice_payer_primary_staff_name_at_sale
+              invoice_state
+              issued_date
+              issued_month_start_date
+              issued_quarter_start_date
+              issued_week_mon_start_date
+              issued_week_sun_start_date
+              issued_year_start_date
+              purchase_request_state
+              sale_location_name
+            ].freeze
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pike13/api/v3/desk/monthly_business_metrics.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+module Pike13
+  module API
+    module V3
+      module Desk
+        # Monthly Business Metrics resource
+        # Summary of monthly transaction amounts, members, and enrollments
+        #
+        # @example Basic query
+        #   Pike13::Reporting::MonthlyBusinessMetrics.query(
+        #     fields: ['month_start_date', 'net_paid_amount', 'new_client_count']
+        #   )
+        #
+        # @example Query with filters and sorting
+        #   Pike13::Reporting::MonthlyBusinessMetrics.query(
+        #     fields: ['month_start_date', 'net_paid_amount', 'member_count'],
+        #     filter: ['btw', 'month_start_date', '2024-01-01', '2024-12-31'],
+        #     sort: ['month_start_date-']
+        #   )
+        #
+        # @example Query with grouping
+        #   Pike13::Reporting::MonthlyBusinessMetrics.query(
+        #     fields: ['total_net_paid_amount', 'total_new_client_count'],
+        #     group: 'year_start_date'
+        #   )
+        #
+        # @example Query with pagination
+        #   Pike13::Reporting::MonthlyBusinessMetrics.query(
+        #     fields: ['month_start_date', 'net_paid_amount'],
+        #     page: { limit: 50, starting_after: 'abc123' }
+        #   )
+        class MonthlyBusinessMetrics < Base
+          class << self
+            # Execute a monthly business metrics query
+            #
+            # @param fields [Array<String>] Fields to return (detail or summary fields)
+            # @param filter [Array, nil] Filter criteria (optional)
+            # @param group [String, nil] Grouping field (optional)
+            # @param sort [Array<String>, nil] Sort order (optional)
+            # @param page [Hash, nil] Pagination options (optional)
+            # @param total_count [Boolean] Whether to return total count (optional)
+            # @return [Hash] Query result with rows, fields, and metadata
+            #
+            # @see https://developer.pike13.com/docs/api/v3/reports/monthly-business-metrics
+            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("monthly_business_metrics", query_params)
+            end
+
+            # Available detail fields (when not grouping)
+            DETAIL_FIELDS = %w[
+              appointment_count
+              attendance_completed_count
+              business_id
+              business_name
+              business_subdomain
+              class_count
+              client_booked_count
+              client_completed_enrollment_count
+              client_w_plan_count
+              completed_appointment_enrollment_count
+              completed_class_enrollment_count
+              completed_course_enrollment_count
+              completed_enrollment_count
+              completed_enrollment_per_client
+              completed_unpaid_count
+              course_count
+              currency_code
+              due_invoice_count
+              enrollment_count
+              event_occurrence_count
+              event_occurrence_organizer_count
+              expected_amount
+              expired_enrollment_count
+              failed_transaction_count
+              first_visit_count
+              franchise_id
+              key
+              late_canceled_enrollment_count
+              member_count
+              membership_count
+              month_start_date
+              net_paid_amount
+              net_paid_pass_revenue_amount
+              net_paid_prepaid_revenue_amount
+              net_paid_recurring_revenue_amount
+              net_paid_retail_revenue_amount
+              net_paid_revenue_amount
+              new_client_count
+              new_client_w_plan_count
+              new_member_count
+              new_staff_count
+              noshowed_enrollment_count
+              outstanding_amount
+              pack_count
+              payments_amount
+              plan_end_count
+              plan_start_count
+              prepaid_count
+              refunds_amount
+              registered_enrollment_count
+              removed_enrollment_count
+              reserved_enrollment_count
+              waiting_enrollment_count
+            ].freeze
+
+            # Available summary fields (when grouping)
+            SUMMARY_FIELDS = %w[
+              avg_client_completed_enrollment_count
+              avg_client_w_plan_count
+              avg_member_count
+              business_id_summary
+              business_subdomain_summary
+              monthly_business_count
+              total_attendance_completed_count
+              total_completed_enrollment_count
+              total_count
+              total_enrollment_count
+              total_event_occurrence_count
+              total_first_visit_count
+              total_net_paid_amount
+              total_net_paid_revenue_amount
+              total_new_client_count
+              total_new_client_w_plan_count
+              total_new_member_count
+              total_payments_amount
+              total_refunds_amount
+            ].freeze
+
+            # Available grouping fields
+            GROUPINGS = %w[
+              business_id
+              business_name
+              business_subdomain
+              currency_code
+              quarter_start_date
+              year_start_date
+            ].freeze
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pike13/api/v3/desk/pays.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+module Pike13
+  module API
+    module V3
+      module Desk
+        # Pays resource
+        # Details of staff member pay, pay rates, services, and hours
+        #
+        # @example Basic query
+        #   Pike13::Reporting::Pays.query(
+        #     fields: ['pay_id', 'staff_name', 'pay_type', 'final_pay_amount', 'pay_state']
+        #   )
+        #
+        # @example Query by staff member
+        #   Pike13::Reporting::Pays.query(
+        #     fields: ['staff_name', 'service_name', 'service_date', 'final_pay_amount', 'service_hours'],
+        #     filter: ['eq', 'staff_id', 12345]
+        #   )
+        #
+        # @example Group by staff member
+        #   Pike13::Reporting::Pays.query(
+        #     fields: ['pay_count', 'total_final_pay_amount', 'total_service_hours'],
+        #     group: 'staff_name'
+        #   )
+        class Pays < Base
+          class << self
+            # Execute a pays query
+            #
+            # @param fields [Array<String>] Fields to return (detail or summary fields)
+            # @param filter [Array, nil] Filter criteria (optional)
+            # @param group [String, nil] Grouping field (optional)
+            # @param sort [Array<String>, nil] Sort order (optional)
+            # @param page [Hash, nil] Pagination options (optional)
+            # @param total_count [Boolean] Whether to return total count (optional)
+            # @return [Hash] Query result with rows, fields, and metadata
+            #
+            # @see https://developer.pike13.com/docs/api/v3/reports/pays
+            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("pays", query_params)
+            end
+
+            # Available detail fields (when not grouping)
+            DETAIL_FIELDS = %w[
+              base_pay_amount
+              business_id
+              business_name
+              business_subdomain
+              currency_code
+              final_pay_amount
+              franchise_id
+              key
+              pay_description
+              pay_id
+              pay_period
+              pay_period_end_date
+              pay_period_start_date
+              pay_recorded_at
+              pay_reviewed_at
+              pay_reviewed_by_id
+              pay_reviewed_by_name
+              pay_reviewed_date
+              pay_state
+              pay_type
+              per_head_pay_amount
+              revenue_category
+              service_category
+              service_date
+              service_hours
+              service_id
+              service_location_name
+              service_name
+              service_type
+              staff_home_location_name
+              staff_id
+              staff_name
+              tiered_pay_amount
+            ].freeze
+
+            # Available summary fields (when grouping)
+            SUMMARY_FIELDS = %w[
+              business_id_summary
+              business_subdomain_summary
+              pay_count
+              service_count
+              total_base_pay_amount
+              total_count
+              total_final_pay_amount
+              total_per_head_pay_amount
+              total_service_hours
+              total_tiered_pay_amount
+            ].freeze
+
+            # Available grouping fields
+            GROUPINGS = %w[
+              business_id
+              business_name
+              business_subdomain
+              pay_period
+              pay_reviewed_by_id
+              pay_reviewed_by_name
+              pay_reviewed_date
+              pay_state
+              pay_type
+              revenue_category
+              service_category
+              service_date
+              service_id
+              service_location_name
+              service_name
+              service_type
+              staff_home_location_name
+              staff_id
+              staff_name
+            ].freeze
+          end
+        end
+      end
+    end
+  end
+end