Module: Pike13

Defined in:

lib/pike13.rb,
lib/pike13/errors.rb,
lib/pike13/version.rb,
lib/pike13/validators.rb,
lib/pike13/http_client.rb,
lib/pike13/configuration.rb,
lib/pike13/api/v2/account.rb,
lib/pike13/http_client_v3.rb,
lib/pike13/api/v2/desk/base.rb,
lib/pike13/api/v2/desk/note.rb,
lib/pike13/api/v2/desk/pack.rb,
lib/pike13/api/v2/desk/plan.rb,
lib/pike13/api/v3/desk/base.rb,
lib/pike13/api/v3/desk/pays.rb,
lib/pike13/api/v2/desk/event.rb,
lib/pike13/api/v2/desk/punch.rb,
lib/pike13/api/v2/desk/visit.rb,
lib/pike13/api/v2/front/base.rb,
lib/pike13/api/v2/front/note.rb,
lib/pike13/api/v2/front/plan.rb,
lib/pike13/api/v2/desk/person.rb,
lib/pike13/api/v2/desk/refund.rb,
lib/pike13/api/v2/front/event.rb,
lib/pike13/api/v2/front/visit.rb,
lib/pike13/api/v2/account/base.rb,
lib/pike13/api/v2/desk/booking.rb,
lib/pike13/api/v2/desk/invoice.rb,
lib/pike13/api/v2/desk/make_up.rb,
lib/pike13/api/v2/desk/payment.rb,
lib/pike13/api/v2/desk/service.rb,
lib/pike13/api/v2/front/person.rb,
lib/pike13/api/v3/desk/clients.rb,
lib/pike13/api/v2/desk/business.rb,
lib/pike13/api/v2/desk/location.rb,
lib/pike13/api/v2/front/booking.rb,
lib/pike13/api/v2/front/invoice.rb,
lib/pike13/api/v2/front/payment.rb,
lib/pike13/api/v2/front/service.rb,
lib/pike13/api/v3/desk/invoices.rb,
lib/pike13/api/v2/account/person.rb,
lib/pike13/api/v2/desk/sales_tax.rb,
lib/pike13/api/v2/front/branding.rb,
lib/pike13/api/v2/front/business.rb,
lib/pike13/api/v2/front/location.rb,
lib/pike13/api/v2/account/business.rb,
lib/pike13/api/v2/account/password.rb,
lib/pike13/api/v2/desk/appointment.rb,
lib/pike13/api/v2/desk/person_plan.rb,
lib/pike13/api/v2/front/plan_terms.rb,
lib/pike13/api/v3/desk/enrollments.rb,
lib/pike13/api/v2/desk/custom_field.rb,
lib/pike13/api/v2/desk/pack_product.rb,
lib/pike13/api/v2/desk/person_visit.rb,
lib/pike13/api/v2/desk/plan_product.rb,
lib/pike13/api/v2/desk/staff_member.rb,
lib/pike13/api/v2/front/appointment.rb,
lib/pike13/api/v2/front/person_plan.rb,
lib/pike13/api/v3/desk/person_plans.rb,
lib/pike13/api/v3/desk/transactions.rb,
lib/pike13/api/v2/desk/person_waiver.rb,
lib/pike13/api/v2/front/person_visit.rb,
lib/pike13/api/v2/front/plan_product.rb,
lib/pike13/api/v2/front/staff_member.rb,
lib/pike13/api/v3/desk/invoice_items.rb,
lib/pike13/api/v3/desk/staff_members.rb,
lib/pike13/api/v2/desk/waitlist_entry.rb,
lib/pike13/api/v2/front/person_waiver.rb,
lib/pike13/api/v2/account/confirmation.rb,
lib/pike13/api/v2/desk/form_of_payment.rb,
lib/pike13/api/v2/front/waitlist_entry.rb,
lib/pike13/api/v2/desk/event_occurrence.rb,
lib/pike13/api/v2/desk/revenue_category.rb,
lib/pike13/api/v2/front/form_of_payment.rb,
lib/pike13/api/v2/front/event_occurrence.rb,
lib/pike13/api/v3/desk/event_occurrences.rb,
lib/pike13/api/v2/desk/event_occurrence_note.rb,
lib/pike13/api/v2/desk/person_waitlist_entry.rb,
lib/pike13/api/v2/desk/event_occurrence_visit.rb,
lib/pike13/api/v2/front/event_occurrence_note.rb,
lib/pike13/api/v2/front/person_waitlist_entry.rb,
lib/pike13/api/v3/desk/monthly_business_metrics.rb,
lib/pike13/api/v3/desk/invoice_item_transactions.rb,
lib/pike13/api/v3/desk/event_occurrence_staff_members.rb,
lib/pike13/api/v2/desk/event_occurrence_waitlist_entry.rb,
lib/pike13/api/v2/front/event_occurrence_waitlist_eligibility.rb

Overview

Pike13 Ruby Client

A Ruby gem for interacting with the Pike13 API.

Examples:

Configuration

Pike13.configure do |config|
  config.access_token = "your_access_token"
  config.base_url = "mybusiness.pike13.com"
end

# Then use models directly
person = Pike13::API::V2::Desk::Person.find(123)
people = Pike13::API::V2::Desk::Person.all

Using different namespaces

# Account namespace (not scoped to business subdomain)
account = Pike13::Account.me
businesses = Pike13::Account::Business.all

# Desk namespace (staff interface)
people = Pike13::Desk::Person.all
events = Pike13::Desk::Event.all

# Front namespace (client interface)
locations = Pike13::Front::Location.all
branding = Pike13::Front::Branding.all.first

Defined Under Namespace

Modules: API, Validators Classes: APIError, AuthenticationError, BadRequestError, Configuration, ConfigurationError, ConnectionError, Error, HTTPClient, HTTPClientV3, NotFoundError, RateLimitError, ServerError, ValidationError

Constant Summary

Account =

Simplified namespace aliases

API::V2::Account

Desk =

API::V2::Desk

Front =

API::V2::Front

Reporting =

API::V3::Desk

UnauthorizedError =

Alias for backward compatibility

AuthenticationError

VERSION =

"0.1.4"

Class Attribute Summary

• .configuration ⇒ Configuration

  Returns the global configuration object.

Class Method Summary

• .configure {|Configuration| ... } ⇒ Object

  Configure Pike13 globally.

• .reset! ⇒ Configuration

  Reset configuration (mainly for testing).

Class Attribute Details

.configuration ⇒ Configuration

Returns the global configuration object

Returns:

• (Configuration)

# File 'lib/pike13.rb', line 137

def configuration
  @configuration ||= Configuration.new
end

Class Method Details

.configure {|Configuration| ... } ⇒ Object

Configure Pike13 globally

Automatically applies configuration to all API Base classes.

Examples:

Pike13.configure do |config|
  config.access_token = "your_access_token"
  config.base_url = "mybusiness.pike13.com"
end

# Then use models directly
person = Pike13::API::V2::Desk::Person.find(123)

Yields:

• (Configuration) —

  Global configuration object

# File 'lib/pike13.rb', line 155

def configure
  yield(configuration)
  configuration.validate!
  apply_configuration!
end

.reset! ⇒ Configuration

Reset configuration (mainly for testing)

Returns:

• (Configuration) —

  New configuration object

# File 'lib/pike13.rb', line 164

def reset!
  @configuration = Configuration.new
end