swagger_client

SwaggerClient - the Ruby gem for the MINDBODY Public API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This SDK is automatically generated by the Swagger Codegen project:

• API version: v6
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build swagger_client.gemspec

Then either install the gem locally:

gem install ./swagger_client-1.0.0.gem

(for development, run gem install --dev ./swagger_client-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'swagger_client', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'swagger_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'swagger_client'

api_instance = SwaggerClient::AppointmentApi.new

request = SwaggerClient::AddAppointmentRequest.new # AddAppointmentRequest | 

site_id = 'site_id_example' # String | ID of the site from which to pull data.

version = 'version_example' # String | 

opts = { 
  authorization: '' # String | A staff user authorization token.
}

begin
  #Book a new appointment.
  result = api_instance.appointment_add_apppointment(request, site_id, version, opts)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling AppointmentApi->appointment_add_apppointment: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.mindbodyonline.com

Class	Method	HTTP request	Description
SwaggerClient::AppointmentApi	appointment_add_apppointment	POST /public/vversion/appointment/addappointment	Book a new appointment.
SwaggerClient::AppointmentApi	appointment_get_active_session_times	GET /public/vversion/appointment/activesessiontimes	Get active session times.
SwaggerClient::AppointmentApi	appointment_get_appointment_options	GET /public/vversion/appointment/appointmentoptions	Get appointment-related settings.
SwaggerClient::AppointmentApi	appointment_get_bookable_items	GET /public/vversion/appointment/bookableitems	Get staff appointment availability.
SwaggerClient::AppointmentApi	appointment_get_schedule_items	GET /public/vversion/appointment/scheduleitems	Get appointment schedule.
SwaggerClient::AppointmentApi	appointment_get_staff_appointments	GET /public/vversion/appointment/staffappointments	Get appointments grouped by staff member.
SwaggerClient::AppointmentApi	appointment_update_apppointment	POST /public/vversion/appointment/updateappointment	Update an existing appointment.
SwaggerClient::ClassApi	class_add_client_to_class	POST /public/vversion/class/addclienttoclass	Book a client into a class.
SwaggerClient::ClassApi	class_get_class_descriptions	GET /public/vversion/class/classdescriptions	Get class descriptions.
SwaggerClient::ClassApi	class_get_class_schedules	GET /public/vversion/class/classschedules	Get class schedules.
SwaggerClient::ClassApi	class_get_class_visits	GET /public/vversion/class/classvisits	Get information about clients booked in a class.
SwaggerClient::ClassApi	class_get_classes	GET /public/vversion/class/classes	Get scheduled classes.
SwaggerClient::ClassApi	class_get_waitlist_entries	GET /public/vversion/class/waitlistentries	Get waiting list entries.
SwaggerClient::ClassApi	class_remove_client_from_class	POST /public/vversion/class/removeclientfromclass	Remove a client from a class.
SwaggerClient::ClassApi	class_remove_from_waitlist	POST /public/vversion/class/removefromwaitlist	Remove a client from a waiting list.
SwaggerClient::ClassApi	class_substitute_class_teacher	POST /public/vversion/class/substituteclassteacher	Substitute a class teacher.
SwaggerClient::ClientApi	client_add_arrival	POST /public/vversion/client/addarrival	Add an arrival for a client.
SwaggerClient::ClientApi	client_add_client	POST /public/vversion/client/addclient	Add a client to a site.
SwaggerClient::ClientApi	client_add_contact_log	POST /public/vversion/client/addcontactlog	Add a contact log to a client's account.
SwaggerClient::ClientApi	client_get_active_client_memberships	GET /public/vversion/client/activeclientmemberships	Get a client's active memberships.
SwaggerClient::ClientApi	client_get_client_account_balances	GET /public/vversion/client/clientaccountbalances	Get account balance information for one or more client(s).
SwaggerClient::ClientApi	client_get_client_contracts	GET /public/vversion/client/clientcontracts	Get contracts that a client has purchased.
SwaggerClient::ClientApi	client_get_client_formula_notes	GET /public/vversion/client/clientformulanotes	Get a client's formula notes.
SwaggerClient::ClientApi	client_get_client_indexes	GET /public/vversion/client/clientindexes	Get a site's configured client indexes and client index values.
SwaggerClient::ClientApi	client_get_client_purchases	GET /public/vversion/client/clientpurchases	Get a client's purchase history.
SwaggerClient::ClientApi	client_get_client_referral_types	GET /public/vversion/client/clientreferraltypes	Get a site's configured client referral types.
SwaggerClient::ClientApi	client_get_client_services	GET /public/vversion/client/clientservices	Get pricing options that a client has purchased.
SwaggerClient::ClientApi	client_get_client_visits	GET /public/vversion/client/clientvisits	Get a client's visit history.
SwaggerClient::ClientApi	client_get_clients	GET /public/vversion/client/clients	Get clients.
SwaggerClient::ClientApi	client_get_contact_logs	GET /public/vversion/client/contactlogs	Get contact logs on a client's account.
SwaggerClient::ClientApi	client_get_cross_regional_client_associations	GET /public/vversion/client/crossregionalclientassociations	Get a client's cross regional site associations.
SwaggerClient::ClientApi	client_get_custom_client_fields	GET /public/vversion/client/customclientfields	Get a site's configured custom client fields.
SwaggerClient::ClientApi	client_get_required_client_fields	GET /public/vversion/client/requiredclientfields	Get client required fields for a site.
SwaggerClient::ClientApi	client_send_password_reset_email	POST /public/vversion/client/sendpasswordresetemail	Send a password reset email to a client.
SwaggerClient::ClientApi	client_update_client	POST /public/vversion/client/updateclient	Update a client at a site.
SwaggerClient::ClientApi	client_update_client_service	POST /public/vversion/client/updateclientservice	Update a client's purchase pricing option.
SwaggerClient::ClientApi	client_update_client_visit	POST /public/vversion/client/updateclientvisit	Update a client's visit.
SwaggerClient::ClientApi	client_update_contact_log	POST /public/vversion/client/updatecontactlog	Update a contact log on a client's account.
SwaggerClient::ClientApi	client_upload_client_document	POST /public/vversion/client/uploadclientdocument	Upload a document to a client's profile.
SwaggerClient::ClientApi	client_upload_client_photo	POST /public/vversion/client/uploadclientphoto	Upload a profile photo to a client's profile.
SwaggerClient::EnrollmentApi	enrollment_add_client_to_enrollment	POST /public/vversion/enrollment/addclienttoenrollment	Book a client into an enrollment.
SwaggerClient::EnrollmentApi	enrollment_get_enrollments	GET /public/vversion/enrollment/enrollments	Get enrollments scheduled at a site.
SwaggerClient::PayrollApi	payroll_get_class_payroll	GET /public/vversion/payroll/classes	Get class payroll for staff members.
SwaggerClient::PayrollApi	payroll_get_time_clock	GET /public/vversion/payroll/timeclock	Get time card payroll for staff members.
SwaggerClient::SaleApi	sale_checkout_shopping_cart	POST /public/vversion/sale/checkoutshoppingcart	Purchase pricing options, packages, retail products, or tips for a client.
SwaggerClient::SaleApi	sale_get_accepted_card_types	GET /public/vversion/sale/acceptedcardtypes	Get credit cards types that a site accepts.
SwaggerClient::SaleApi	sale_get_contracts	GET /public/vversion/sale/contracts	Get contracts available for purchase at a site.
SwaggerClient::SaleApi	sale_get_custom_payment_methods	GET /public/vversion/sale/custompaymentmethods	Get payment methods that can be used to pay for sales at a site.
SwaggerClient::SaleApi	sale_get_gift_cards	GET /public/vversion/sale/giftcards	Get gift cards available for purchase at a site.
SwaggerClient::SaleApi	sale_get_packages	GET /public/vversion/sale/packages	Get packages available for purchase at a site.
SwaggerClient::SaleApi	sale_get_products	GET /public/vversion/sale/products	Get retail products available for purchase at a site.
SwaggerClient::SaleApi	sale_get_sales	GET /public/vversion/sale/sales	Get sales completed at a site.
SwaggerClient::SaleApi	sale_get_services	GET /public/vversion/sale/services	Get pricing options available for purchase at a site
SwaggerClient::SaleApi	sale_purchase_contract	POST /public/vversion/sale/purchasecontract	Purchase a contract for a client.
SwaggerClient::SaleApi	sale_purchase_gift_card	POST /public/vversion/sale/purchasegiftcard	Purchase a gift card for a client.
SwaggerClient::SiteApi	site_get_activation_code	GET /public/vversion/site/activationcode	Get an activation code for a site.
SwaggerClient::SiteApi	site_get_locations	GET /public/vversion/site/locations	Get locations for a site.
SwaggerClient::SiteApi	site_get_programs	GET /public/vversion/site/programs	Get service categories offered at a site.
SwaggerClient::SiteApi	site_get_resources	GET /public/vversion/site/resources	Get resources used at a site.
SwaggerClient::SiteApi	site_get_session_types	GET /public/vversion/site/sessiontypes	Get the session types used at a site.
SwaggerClient::SiteApi	site_get_sites	GET /public/vversion/site/sites	Get all sites that can be accessed by an API Key.
SwaggerClient::StaffApi	staff_get_staff	GET /public/vversion/staff/staff	Get staff members at a site.
SwaggerClient::StaffApi	staff_get_staff_permissions	GET /public/vversion/staff/staffpermissions	Get configured staff permissions for a staff member.
SwaggerClient::UserTokenApi	user_token_issue	POST /public/vversion/usertoken/issue	Get a staff user token.
SwaggerClient::UserTokenApi	user_token_revoke	DELETE /public/vversion/usertoken/revoke	Revoke a user token.

Documentation for Models

• SwaggerClient::AddAppointmentRequest
• SwaggerClient::AddAppointmentResponse
• SwaggerClient::AddArrivalRequest
• SwaggerClient::AddArrivalResponse
• SwaggerClient::AddClientRequest
• SwaggerClient::AddClientResponse
• SwaggerClient::AddClientToClassRequest
• SwaggerClient::AddClientToClassResponse
• SwaggerClient::AddClientToClassVisit
• SwaggerClient::AddClientToEnrollmentRequest
• SwaggerClient::AddContactLogRequest
• SwaggerClient::AddContactLogType
• SwaggerClient::Amenity
• SwaggerClient::Appointment
• SwaggerClient::AppointmentOption
• SwaggerClient::AssignedClientIndex
• SwaggerClient::AutopaySchedule
• SwaggerClient::Availability
• SwaggerClient::BookingWindow
• SwaggerClient::CheckoutAppointmentBookingRequest
• SwaggerClient::CheckoutItem
• SwaggerClient::CheckoutItemWrapper
• SwaggerClient::CheckoutPaymentInfo
• SwaggerClient::CheckoutShoppingCartRequest
• SwaggerClient::ClassDescription
• SwaggerClient::ClassPayrollEvent
• SwaggerClient::ClassSchedule
• SwaggerClient::Client
• SwaggerClient::ClientContract
• SwaggerClient::ClientCreditCard
• SwaggerClient::ClientDocument
• SwaggerClient::ClientIndex
• SwaggerClient::ClientIndexValue
• SwaggerClient::ClientMembership
• SwaggerClient::ClientPurchaseRecord
• SwaggerClient::ClientRelationship
• SwaggerClient::ClientService
• SwaggerClient::Color
• SwaggerClient::ContactLog
• SwaggerClient::ContactLogComment
• SwaggerClient::ContactLogSubType
• SwaggerClient::ContactLogType
• SwaggerClient::Contract
• SwaggerClient::ContractItem
• SwaggerClient::Course
• SwaggerClient::CreditCardInfo
• SwaggerClient::CrossRegionalClientAssociation
• SwaggerClient::CustomClientField
• SwaggerClient::CustomClientFieldValue
• SwaggerClient::CustomPaymentMethod
• SwaggerClient::FormulaNote
• SwaggerClient::GetActivationCodeResponse
• SwaggerClient::GetActiveClientMembershipsRequest
• SwaggerClient::GetActiveClientMembershipsResponse
• SwaggerClient::GetActiveSessionTimesRequest
• SwaggerClient::GetActiveSessionTimesResponse
• SwaggerClient::GetAppointmentOptionsResponse
• SwaggerClient::GetBookableItemsRequest
• SwaggerClient::GetBookableItemsResponse
• SwaggerClient::GetClassDescriptionsRequest
• SwaggerClient::GetClassDescriptionsResponse
• SwaggerClient::GetClassPayrollRequest
• SwaggerClient::GetClassPayrollResponse
• SwaggerClient::GetClassSchedulesRequest
• SwaggerClient::GetClassSchedulesResponse
• SwaggerClient::GetClassVisitsRequest
• SwaggerClient::GetClassVisitsResponse
• SwaggerClient::GetClassesRequest
• SwaggerClient::GetClassesResponse
• SwaggerClient::GetClientAccountBalancesRequest
• SwaggerClient::GetClientAccountBalancesResponse
• SwaggerClient::GetClientContractsRequest
• SwaggerClient::GetClientContractsResponse
• SwaggerClient::GetClientFormulaNotesRequest
• SwaggerClient::GetClientFormulaNotesResponse
• SwaggerClient::GetClientIndexesRequest
• SwaggerClient::GetClientIndexesResponse
• SwaggerClient::GetClientPurchasesRequest
• SwaggerClient::GetClientPurchasesResponse
• SwaggerClient::GetClientReferralTypesRequest
• SwaggerClient::GetClientReferralTypesResponse
• SwaggerClient::GetClientServicesRequest
• SwaggerClient::GetClientServicesResponse
• SwaggerClient::GetClientVisitsRequest
• SwaggerClient::GetClientVisitsResponse
• SwaggerClient::GetClientsRequest
• SwaggerClient::GetClientsResponse
• SwaggerClient::GetContactLogsRequest
• SwaggerClient::GetContactLogsResponse
• SwaggerClient::GetContractsRequest
• SwaggerClient::GetContractsResponse
• SwaggerClient::GetCrossRegionalClientAssociationsRequest
• SwaggerClient::GetCrossRegionalClientAssociationsResponse
• SwaggerClient::GetCustomClientFieldsRequest
• SwaggerClient::GetCustomClientFieldsResponse
• SwaggerClient::GetCustomPaymentMethodsRequest
• SwaggerClient::GetCustomPaymentMethodsResponse
• SwaggerClient::GetEnrollmentsRequest
• SwaggerClient::GetEnrollmentsResponse
• SwaggerClient::GetGiftCardResponse
• SwaggerClient::GetGiftCardsRequest
• SwaggerClient::GetLocationsRequest
• SwaggerClient::GetLocationsResponse
• SwaggerClient::GetPackagesRequest
• SwaggerClient::GetPackagesResponse
• SwaggerClient::GetProductsRequest
• SwaggerClient::GetProductsResponse
• SwaggerClient::GetProgramsRequest
• SwaggerClient::GetProgramsResponse
• SwaggerClient::GetRequiredClientFieldsResponse
• SwaggerClient::GetResourcesRequest
• SwaggerClient::GetResourcesResponse
• SwaggerClient::GetSalesRequest
• SwaggerClient::GetSalesResponse
• SwaggerClient::GetScheduleItemsRequest
• SwaggerClient::GetScheduleItemsResponse
• SwaggerClient::GetServicesRequest
• SwaggerClient::GetServicesResponse
• SwaggerClient::GetSessionTypesRequest
• SwaggerClient::GetSessionTypesResponse
• SwaggerClient::GetSitesRequest
• SwaggerClient::GetSitesResponse
• SwaggerClient::GetStaffAppointmentsRequest
• SwaggerClient::GetStaffAppointmentsResponse
• SwaggerClient::GetStaffPermissionsRequest
• SwaggerClient::GetStaffPermissionsResponse
• SwaggerClient::GetStaffRequest
• SwaggerClient::GetStaffResponse
• SwaggerClient::GetTimeClockRequest
• SwaggerClient::GetTimeClockResponse
• SwaggerClient::GetWaitlistEntriesRequest
• SwaggerClient::GetWaitlistEntriesResponse
• SwaggerClient::GiftCard
• SwaggerClient::GiftCardLayout
• SwaggerClient::IssueRequest
• SwaggerClient::IssueResponse
• SwaggerClient::Level
• SwaggerClient::Liability
• SwaggerClient::Location
• SwaggerClient::MembershipTypeRestriction
• SwaggerClient::ModelClass
• SwaggerClient::Package
• SwaggerClient::PaginationResponse
• SwaggerClient::Product
• SwaggerClient::Program
• SwaggerClient::ProspectStage
• SwaggerClient::PurchaseContractRequest
• SwaggerClient::PurchaseContractResponse
• SwaggerClient::PurchaseGiftCardRequest
• SwaggerClient::PurchaseGiftCardResponse
• SwaggerClient::PurchasedItem
• SwaggerClient::Relationship
• SwaggerClient::RemoveClientFromClassRequest
• SwaggerClient::RemoveClientFromClassResponse
• SwaggerClient::RemoveFromWaitlistRequest
• SwaggerClient::RemoveFromWaitlistResponse
• SwaggerClient::Resource
• SwaggerClient::Sale
• SwaggerClient::SalePayment
• SwaggerClient::SalesRep
• SwaggerClient::SendPasswordResetEmailRequest
• SwaggerClient::Service
• SwaggerClient::SessionType
• SwaggerClient::Site
• SwaggerClient::Size
• SwaggerClient::Staff
• SwaggerClient::StaffPermissionGroup
• SwaggerClient::StoredCardInfo
• SwaggerClient::SubstituteClassTeacherRequest
• SwaggerClient::SubstituteClassTeacherResponse
• SwaggerClient::SubstituteTeacherClass
• SwaggerClient::TimeCardEvent
• SwaggerClient::TimeClockReport
• SwaggerClient::Unavailability
• SwaggerClient::UpcomingAutopayEvent
• SwaggerClient::UpdateAppointmentRequest
• SwaggerClient::UpdateAppointmentResponse
• SwaggerClient::UpdateClientRequest
• SwaggerClient::UpdateClientResponse
• SwaggerClient::UpdateClientServiceRequest
• SwaggerClient::UpdateClientServiceResponse
• SwaggerClient::UpdateClientVisitRequest
• SwaggerClient::UpdateClientVisitResponse
• SwaggerClient::UpdateContactLogComment
• SwaggerClient::UpdateContactLogRequest
• SwaggerClient::UpdateContactLogType
• SwaggerClient::UploadClientDocumentRequest
• SwaggerClient::UploadClientDocumentResponse
• SwaggerClient::UploadClientPhotoRequest
• SwaggerClient::UploadClientPhotoResponse
• SwaggerClient::User
• SwaggerClient::Visit
• SwaggerClient::WaitlistEntry

Documentation for Authorization

API-Key

• Type: API key
• API key parameter name: API-Key
• Location: HTTP header