pike13 0.1.0.beta → 0.1.0

data/lib/pike13/api/v2/account.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Pike13
+  module API
+    module V2
+      module Account
+        # Get current authenticated account
+        #
+        # @return [Hash] Account information
+        # @example
+        #   account = Pike13::Account.me
+        #   email = account["accounts"].first["email"]
+        def self.me
+          Base.client.get("account")
+        end
+      end
+    end
+  end
+end

data/lib/pike13/api/v2/desk/booking.rb

@@ -26,6 +26,11 @@ module Pike13
               client.delete("desk/bookings/#{id}")
             end
 
+            # GET /desk/bookings/:booking_id/leases/:id
+            def find_lease(booking_id:, id:, **params)
+              client.get("desk/bookings/#{booking_id}/leases/#{id}", params)
+            end
+
             # POST /desk/bookings/:booking_id/leases
             def create_lease(booking_id, attributes)
               client.post("desk/bookings/#{booking_id}/leases", { lease: attributes })
@@ -35,6 +40,11 @@ module Pike13
             def update_lease(booking_id, id, attributes)
               client.put("desk/bookings/#{booking_id}/leases/#{id}", { lease: attributes })
             end
+
+            # DELETE /desk/bookings/:booking_id/leases/:lease_id
+            def destroy_lease(booking_id, lease_id)
+              client.delete("desk/bookings/#{booking_id}/leases/#{lease_id}")
+            end
           end
         end
       end

data/lib/pike13/api/v2/desk/business.rb

@@ -7,9 +7,10 @@ module Pike13
         class Business < Base
           class << self
             # GET /desk/business
-            def get
+            def find
               client.get("desk/business")
             end
+            alias get find
 
             # GET /desk/business/franchisees
             def franchisees

data/lib/pike13/api/v2/desk/event_occurrence.rb

@@ -7,8 +7,8 @@ module Pike13
         class EventOccurrence < Base
           class << self
             # GET /desk/event_occurrences
-            def all
-              client.get("desk/event_occurrences")
+            def all(**params)
+              client.get("desk/event_occurrences", params)
             end
 
             # GET /desk/event_occurrences/:id

data/lib/pike13/api/v2/desk/person.rb

@@ -21,9 +21,11 @@ module Pike13
               find(:me)
             end
 
-            # GET /desk/people/search?q=query
-            def search(query)
-              client.get("desk/people/search", q: query)
+            # GET /desk/people/search?q=query&fields=fields
+            def search(query, fields: nil)
+              params = { q: query }
+              params[:fields] = fields if fields
+              client.get("desk/people/search", params)
             end
 
             # POST /desk/people

data/lib/pike13/api/v2/desk/plan.rb

@@ -7,8 +7,8 @@ module Pike13
         class Plan < Base
           class << self
             # GET /desk/plans
-            def all
-              client.get("desk/plans")
+            def all(**params)
+              client.get("desk/plans", params)
             end
 
             # GET /desk/plans/:id

data/lib/pike13/api/v2/desk/plan_product.rb

@@ -7,8 +7,8 @@ module Pike13
         class PlanProduct < Base
           class << self
             # GET /desk/plan_products
-            def all
-              client.get("desk/plan_products")
+            def all(**params)
+              client.get("desk/plan_products", params)
             end
 
             # GET /desk/plan_products/:id

data/lib/pike13/api/v2/desk/service.rb

@@ -7,8 +7,8 @@ module Pike13
         class Service < Base
           class << self
             # GET /desk/services
-            def all
-              client.get("desk/services")
+            def all(**params)
+              client.get("desk/services", params)
             end
 
             # GET /desk/services/:id

data/lib/pike13/api/v2/desk/visit.rb

@@ -7,8 +7,8 @@ module Pike13
         class Visit < Base
           class << self
             # GET /desk/visits
-            def all
-              client.get("desk/visits")
+            def all(**params)
+              client.get("desk/visits", params)
             end
 
             # GET /desk/visits/:id

data/lib/pike13/api/v2/front/branding.rb

@@ -7,9 +7,10 @@ module Pike13
         class Branding < Base
           class << self
             # GET /front/branding
-            def get
+            def find
               client.get("front/branding")
             end
+            alias get find
           end
         end
       end

data/lib/pike13/api/v2/front/business.rb

@@ -7,9 +7,10 @@ module Pike13
         class Business < Base
           class << self
             # GET /front/business
-            def get
+            def find
               client.get("front/business")
             end
+            alias get find
 
             # GET /front/business/franchisees
             def franchisees

data/lib/pike13/api/v2/front/event_occurrence.rb

@@ -7,8 +7,8 @@ module Pike13
         class EventOccurrence < Base
           class << self
             # GET /front/event_occurrences
-            def all
-              client.get("front/event_occurrences")
+            def all(**params)
+              client.get("front/event_occurrences", params)
             end
 
             # GET /front/event_occurrences/:id

data/lib/pike13/api/v2/front/plan_product.rb

@@ -7,8 +7,8 @@ module Pike13
         class PlanProduct < Base
           class << self
             # GET /front/plan_products
-            def all
-              client.get("front/plan_products")
+            def all(**params)
+              client.get("front/plan_products", params)
             end
 
             # GET /front/plan_products/:id

data/lib/pike13/api/v2/front/service.rb

@@ -7,8 +7,8 @@ module Pike13
         class Service < Base
           class << self
             # GET /front/services
-            def all
-              client.get("front/services")
+            def all(**params)
+              client.get("front/services", params)
             end
 
             # GET /front/services/:id

data/lib/pike13/api/v2/front/visit.rb

@@ -7,8 +7,8 @@ module Pike13
         class Visit < Base
           class << self
             # GET /front/visits
-            def all
-              client.get("front/visits")
+            def all(**params)
+              client.get("front/visits", params)
             end
 
             # GET /front/visits/:id

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Pike13
+  module API
+    module V3
+      module Desk
+        # Base class for all V3 Desk reporting resources
+        # V3 Reporting API uses POST requests to /desk/api/v3/reports/{resource}/queries
+        class Base
+          class << self
+            def configure(config)
+              @client = Pike13::HTTPClientV3.new(
+                base_url: config.full_url,
+                access_token: config.access_token
+              )
+            end
+
+            def client
+              # Return this class's client if set, otherwise traverse up to Base
+              return @client if instance_variable_defined?(:@client) && @client
+              return superclass.client if superclass.respond_to?(:client) && superclass != Object
+
+              raise "Client not configured. Call Pike13.configure first."
+            end
+
+            # Execute a reporting query
+            #
+            # @param resource [String] The resource name (e.g., 'monthly_business_metrics')
+            # @param query_params [Hash] Query parameters including fields, filters, etc.
+            # @return [Hash] Query result with rows, fields, and metadata
+            def query(resource, query_params)
+              data = {
+                data: {
+                  type: "queries",
+                  attributes: query_params
+                }
+              }
+
+              client.post("desk/api/v3/reports/#{resource}/queries", data)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+module Pike13
+  module API
+    module V3
+      module Desk
+        # Clients resource
+        # All client data — from tenure and unpaid bills to birthdays and passes held
+        #
+        # @example Basic query
+        #   Pike13::Reporting::Clients.query(
+        #     fields: ['person_id', 'full_name', 'email', 'client_since_date']
+        #   )
+        #
+        # @example Query with filters
+        #   Pike13::Reporting::Clients.query(
+        #     fields: ['full_name', 'email', 'tenure', 'has_membership'],
+        #     filter: ['eq', 'has_membership', true]
+        #   )
+        #
+        # @example Query with grouping
+        #   Pike13::Reporting::Clients.query(
+        #     fields: ['person_count', 'has_membership_count'],
+        #     group: 'tenure_group'
+        #   )
+        class Clients < Base
+          class << self
+            # Execute a clients 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/clients
+            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("clients", query_params)
+            end
+
+            # Available detail fields (when not grouping)
+            DETAIL_FIELDS = %w[
+              account_claim_date
+              account_credit_amount
+              account_manager_emails
+              account_manager_names
+              account_manager_phones
+              address
+              street_address
+              street_address2
+              city
+              state_code
+              postal_code
+              country_code
+              age
+              also_staff
+              birthdate
+              business_id
+              business_name
+              business_subdomain
+              client_since_date
+              completed_visits
+              currency_code
+              current_plan_revenue_category
+              current_plan_types
+              current_plans
+              custom_fields
+              days_since_last_visit
+              days_until_birthday
+              dependent_names
+              email
+              first_name
+              first_visit_date
+              franchise_id
+              full_name
+              future_visits
+              guardian_email
+              guardian_name
+              has_membership
+              has_payment_on_file
+              has_plan_on_hold
+              has_signed_waiver
+              home_location_name
+              is_schedulable
+              key
+              last_email_bounced
+              last_invoice_amount
+              last_invoice_date
+              last_invoice_id
+              last_invoice_unpaid
+              last_membership_end_date
+              last_name
+              last_signed_waiver_name
+              last_site_access_date
+              last_visit_date
+              last_visit_id
+              last_visit_service
+              middle_name
+              net_paid_amount
+              next_pass_plan_end_date
+              person_id
+              person_state
+              phone
+              primary_staff_name
+              revenue_amount
+              source_name
+              staff_member_who_added
+              tenure
+              tenure_group
+              unpaid_visits
+            ].freeze
+
+            # Available summary fields (when grouping)
+            SUMMARY_FIELDS = %w[
+              account_claim_count
+              also_staff_count
+              business_id_summary
+              business_subdomain_summary
+              has_membership_count
+              has_payment_on_file_count
+              has_plan_on_hold_count
+              has_signed_waiver_count
+              is_schedulable_count
+              last_email_bounced_count
+              last_invoice_unpaid_count
+              person_count
+              total_account_credit_amount
+              total_completed_visits
+              total_count
+              total_future_visits
+              total_net_paid_amount
+              total_revenue_amount
+              total_unpaid_visits
+              visited_site_count
+            ].freeze
+
+            # Available grouping fields
+            GROUPINGS = %w[
+              account_claim_date
+              account_manager_names
+              age
+              also_staff
+              business_id
+              business_name
+              business_subdomain
+              client_since_date
+              client_since_month_start_date
+              client_since_quarter_start_date
+              client_since_week_mon_start_date
+              client_since_week_sun_start_date
+              client_since_year_start_date
+              has_membership
+              has_payment_on_file
+              has_plan_on_hold
+              has_signed_waiver
+              home_location_name
+              is_schedulable
+              last_email_bounced
+              last_invoice_unpaid
+              person_state
+              primary_staff_name
+              source_name
+              staff_member_who_added
+              tenure_group
+            ].freeze
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,203 @@
+# frozen_string_literal: true
+
+module Pike13
+  module API
+    module V3
+      module Desk
+        # Enrollments resource
+        # Data about visit and waitlist history, behavior, and trends
+        #
+        # @example Basic query
+        #   Pike13::Reporting::Enrollments.query(
+        #     fields: ['visit_id', 'full_name', 'service_name', 'state', 'service_date']
+        #   )
+        #
+        # @example Query completed visits
+        #   Pike13::Reporting::Enrollments.query(
+        #     fields: ['full_name', 'service_name', 'service_date', 'estimated_amount'],
+        #     filter: ['eq', 'state', 'completed']
+        #   )
+        #
+        # @example Group by service
+        #   Pike13::Reporting::Enrollments.query(
+        #     fields: ['completed_enrollment_count', 'total_visits_amount'],
+        #     group: 'service_name'
+        #   )
+        class Enrollments < Base
+          class << self
+            # Execute an enrollments 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/enrollments
+            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("enrollments", query_params)
+            end
+
+            # Available detail fields (when not grouping)
+            DETAIL_FIELDS = %w[
+              account_manager_emails
+              account_manager_names
+              account_manager_phones
+              address
+              available_plans
+              birthdate
+              bulk_enrolled
+              business_id
+              business_name
+              business_subdomain
+              cancelled_at
+              cancelled_to_start
+              client_booked
+              completed_at
+              consider_member
+              currency_code
+              duration_in_hours
+              duration_in_minutes
+              email
+              end_at
+              estimated_amount
+              event_id
+              event_name
+              event_occurrence_id
+              first_visit
+              franchise_id
+              full_name
+              home_location_name
+              instructor_names
+              is_paid
+              is_rollover
+              is_waitlist
+              key
+              make_up_issued
+              noshow_at
+              paid_with
+              paid_with_complimentary_pass
+              paid_with_type
+              person_id
+              phone
+              plan_id
+              plan_product_id
+              primary_staff_name
+              punch_id
+              punchcard_id
+              registered_at
+              service_category
+              service_date
+              service_day
+              service_id
+              service_location_id
+              service_location_name
+              service_name
+              service_state
+              service_time
+              service_type
+              start_at
+              state
+              visit_id
+              waitlist_id
+              waitlisted_at
+            ].freeze
+
+            # Available summary fields (when grouping)
+            SUMMARY_FIELDS = %w[
+              avg_per_visit_amount
+              business_id_summary
+              business_subdomain_summary
+              client_booked_count
+              completed_enrollment_count
+              consider_member_count
+              enrollment_count
+              event_count
+              event_occurrence_count
+              expired_enrollment_count
+              first_visit_count
+              is_paid_count
+              is_rollover_count
+              is_waitlist_count
+              late_canceled_enrollment_count
+              noshowed_enrollment_count
+              person_count
+              registered_enrollment_count
+              removed_enrollment_count
+              reserved_enrollment_count
+              service_count
+              total_count
+              total_duration_in_hours
+              total_duration_in_minutes
+              total_visits_amount
+              unpaid_visit_count
+              unpaid_visit_percent
+              visit_count
+              waiting_enrollment_count
+              weekday_0_enrollment_count
+              weekday_1_enrollment_count
+              weekday_2_enrollment_count
+              weekday_3_enrollment_count
+              weekday_4_enrollment_count
+              weekday_5_enrollment_count
+              weekday_6_enrollment_count
+            ].freeze
+
+            # Available grouping fields
+            GROUPINGS = %w[
+              business_id
+              business_name
+              business_subdomain
+              client_booked
+              consider_member
+              event_id
+              event_name
+              event_occurrence_id
+              first_visit
+              full_name
+              home_location_name
+              instructor_names
+              is_paid
+              is_rollover
+              is_waitlist
+              paid_with
+              paid_with_complimentary_pass
+              paid_with_type
+              person_id
+              plan_id
+              plan_product_id
+              primary_staff_name
+              punch_id
+              punchcard_id
+              service_category
+              service_date
+              service_day
+              service_id
+              service_location_id
+              service_location_name
+              service_month_start_date
+              service_name
+              service_quarter_start_date
+              service_state
+              service_time
+              service_type
+              service_week_mon_start_date
+              service_week_sun_start_date
+              service_year_start_date
+              state
+            ].freeze
+          end
+        end
+      end
+    end
+  end
+end