mindbody-api-v6 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/README.md +357 -0
- data/Rakefile +8 -0
- data/docs/AddAppointmentRequest.md +23 -0
- data/docs/AddAppointmentResponse.md +8 -0
- data/docs/AddArrivalRequest.md +9 -0
- data/docs/AddArrivalResponse.md +9 -0
- data/docs/AddClientRequest.md +61 -0
- data/docs/AddClientResponse.md +8 -0
- data/docs/AddClientToClassRequest.md +17 -0
- data/docs/AddClientToClassResponse.md +8 -0
- data/docs/AddClientToClassVisit.md +28 -0
- data/docs/AddClientToEnrollmentRequest.md +15 -0
- data/docs/AddContactLogRequest.md +16 -0
- data/docs/AddContactLogType.md +9 -0
- data/docs/Amenity.md +9 -0
- data/docs/Appointment.md +24 -0
- data/docs/AppointmentApi.md +460 -0
- data/docs/AppointmentOption.md +11 -0
- data/docs/AssignedClientIndex.md +9 -0
- data/docs/AutopaySchedule.md +10 -0
- data/docs/Availability.md +15 -0
- data/docs/BookingWindow.md +11 -0
- data/docs/CheckoutAppointmentBookingRequest.md +14 -0
- data/docs/CheckoutItem.md +9 -0
- data/docs/CheckoutItemWrapper.md +17 -0
- data/docs/CheckoutPaymentInfo.md +9 -0
- data/docs/CheckoutShoppingCartRequest.md +18 -0
- data/docs/ClassApi.md +589 -0
- data/docs/ClassDescription.md +22 -0
- data/docs/ClassPayrollEvent.md +10 -0
- data/docs/ClassSchedule.md +29 -0
- data/docs/Client.md +61 -0
- data/docs/ClientApi.md +1473 -0
- data/docs/ClientContract.md +16 -0
- data/docs/ClientCreditCard.md +17 -0
- data/docs/ClientDocument.md +10 -0
- data/docs/ClientIndex.md +13 -0
- data/docs/ClientIndexValue.md +10 -0
- data/docs/ClientMembership.md +20 -0
- data/docs/ClientPurchaseRecord.md +16 -0
- data/docs/ClientRelationship.md +10 -0
- data/docs/ClientService.md +18 -0
- data/docs/Color.md +9 -0
- data/docs/ContactLog.md +18 -0
- data/docs/ContactLogComment.md +11 -0
- data/docs/ContactLogSubType.md +8 -0
- data/docs/ContactLogType.md +9 -0
- data/docs/Contract.md +41 -0
- data/docs/ContractItem.md +14 -0
- data/docs/Course.md +17 -0
- data/docs/CreditCardInfo.md +16 -0
- data/docs/CrossRegionalClientAssociation.md +10 -0
- data/docs/CustomClientField.md +10 -0
- data/docs/CustomClientFieldValue.md +11 -0
- data/docs/CustomPaymentMethod.md +9 -0
- data/docs/EnrollmentApi.md +137 -0
- data/docs/FormulaNote.md +12 -0
- data/docs/GetActivationCodeResponse.md +9 -0
- data/docs/GetActiveClientMembershipsRequest.md +11 -0
- data/docs/GetActiveClientMembershipsResponse.md +9 -0
- data/docs/GetActiveSessionTimesRequest.md +13 -0
- data/docs/GetActiveSessionTimesResponse.md +9 -0
- data/docs/GetAppointmentOptionsResponse.md +8 -0
- data/docs/GetBookableItemsRequest.md +16 -0
- data/docs/GetBookableItemsResponse.md +9 -0
- data/docs/GetClassDescriptionsRequest.md +15 -0
- data/docs/GetClassDescriptionsResponse.md +9 -0
- data/docs/GetClassPayrollRequest.md +13 -0
- data/docs/GetClassPayrollResponse.md +9 -0
- data/docs/GetClassSchedulesRequest.md +16 -0
- data/docs/GetClassSchedulesResponse.md +9 -0
- data/docs/GetClassVisitsRequest.md +9 -0
- data/docs/GetClassVisitsResponse.md +8 -0
- data/docs/GetClassesRequest.md +22 -0
- data/docs/GetClassesResponse.md +9 -0
- data/docs/GetClientAccountBalancesRequest.md +12 -0
- data/docs/GetClientAccountBalancesResponse.md +9 -0
- data/docs/GetClientContractsRequest.md +12 -0
- data/docs/GetClientContractsResponse.md +9 -0
- data/docs/GetClientFormulaNotesRequest.md +11 -0
- data/docs/GetClientFormulaNotesResponse.md +9 -0
- data/docs/GetClientIndexesRequest.md +8 -0
- data/docs/GetClientIndexesResponse.md +8 -0
- data/docs/GetClientPurchasesRequest.md +13 -0
- data/docs/GetClientPurchasesResponse.md +9 -0
- data/docs/GetClientReferralTypesRequest.md +8 -0
- data/docs/GetClientReferralTypesResponse.md +8 -0
- data/docs/GetClientServicesRequest.md +20 -0
- data/docs/GetClientServicesResponse.md +9 -0
- data/docs/GetClientVisitsRequest.md +15 -0
- data/docs/GetClientVisitsResponse.md +9 -0
- data/docs/GetClientsRequest.md +13 -0
- data/docs/GetClientsResponse.md +9 -0
- data/docs/GetContactLogsRequest.md +16 -0
- data/docs/GetContactLogsResponse.md +9 -0
- data/docs/GetContractsRequest.md +13 -0
- data/docs/GetContractsResponse.md +9 -0
- data/docs/GetCrossRegionalClientAssociationsRequest.md +11 -0
- data/docs/GetCrossRegionalClientAssociationsResponse.md +9 -0
- data/docs/GetCustomClientFieldsRequest.md +9 -0
- data/docs/GetCustomClientFieldsResponse.md +9 -0
- data/docs/GetCustomPaymentMethodsRequest.md +9 -0
- data/docs/GetCustomPaymentMethodsResponse.md +9 -0
- data/docs/GetEnrollmentsRequest.md +16 -0
- data/docs/GetEnrollmentsResponse.md +9 -0
- data/docs/GetGiftCardResponse.md +9 -0
- data/docs/GetGiftCardsRequest.md +12 -0
- data/docs/GetLocationsRequest.md +9 -0
- data/docs/GetLocationsResponse.md +9 -0
- data/docs/GetPackagesRequest.md +11 -0
- data/docs/GetPackagesResponse.md +9 -0
- data/docs/GetProductsRequest.md +15 -0
- data/docs/GetProductsResponse.md +9 -0
- data/docs/GetProgramsRequest.md +11 -0
- data/docs/GetProgramsResponse.md +9 -0
- data/docs/GetRequiredClientFieldsResponse.md +8 -0
- data/docs/GetResourcesRequest.md +13 -0
- data/docs/GetResourcesResponse.md +9 -0
- data/docs/GetSalesRequest.md +7 -0
- data/docs/GetSalesResponse.md +9 -0
- data/docs/GetScheduleItemsRequest.md +14 -0
- data/docs/GetScheduleItemsResponse.md +9 -0
- data/docs/GetServicesRequest.md +18 -0
- data/docs/GetServicesResponse.md +9 -0
- data/docs/GetSessionTypesRequest.md +11 -0
- data/docs/GetSessionTypesResponse.md +9 -0
- data/docs/GetSitesRequest.md +10 -0
- data/docs/GetSitesResponse.md +9 -0
- data/docs/GetStaffAppointmentsRequest.md +15 -0
- data/docs/GetStaffAppointmentsResponse.md +9 -0
- data/docs/GetStaffPermissionsRequest.md +8 -0
- data/docs/GetStaffPermissionsResponse.md +8 -0
- data/docs/GetStaffRequest.md +14 -0
- data/docs/GetStaffResponse.md +9 -0
- data/docs/GetTimeClockRequest.md +13 -0
- data/docs/GetTimeClockResponse.md +9 -0
- data/docs/GetWaitlistEntriesRequest.md +14 -0
- data/docs/GetWaitlistEntriesResponse.md +9 -0
- data/docs/GiftCard.md +19 -0
- data/docs/GiftCardLayout.md +9 -0
- data/docs/IssueRequest.md +9 -0
- data/docs/IssueResponse.md +10 -0
- data/docs/Level.md +10 -0
- data/docs/Liability.md +10 -0
- data/docs/Location.md +32 -0
- data/docs/MembershipTypeRestriction.md +9 -0
- data/docs/ModelClass.md +33 -0
- data/docs/Package.md +13 -0
- data/docs/PaginationResponse.md +11 -0
- data/docs/PayrollApi.md +140 -0
- data/docs/Product.md +18 -0
- data/docs/Program.md +11 -0
- data/docs/ProspectStage.md +10 -0
- data/docs/PurchaseContractRequest.md +18 -0
- data/docs/PurchaseContractResponse.md +11 -0
- data/docs/PurchaseGiftCardRequest.md +19 -0
- data/docs/PurchaseGiftCardResponse.md +17 -0
- data/docs/PurchasedItem.md +9 -0
- data/docs/Relationship.md +10 -0
- data/docs/RemoveClientFromClassRequest.md +12 -0
- data/docs/RemoveClientFromClassResponse.md +8 -0
- data/docs/RemoveFromWaitlistRequest.md +8 -0
- data/docs/RemoveFromWaitlistResponse.md +7 -0
- data/docs/Resource.md +9 -0
- data/docs/Sale.md +15 -0
- data/docs/SaleApi.md +683 -0
- data/docs/SalePayment.md +12 -0
- data/docs/SalesRep.md +12 -0
- data/docs/SendPasswordResetEmailRequest.md +10 -0
- data/docs/Service.md +16 -0
- data/docs/SessionType.md +17 -0
- data/docs/Site.md +27 -0
- data/docs/SiteApi.md +362 -0
- data/docs/Size.md +9 -0
- data/docs/Staff.md +31 -0
- data/docs/StaffApi.md +131 -0
- data/docs/StaffPermissionGroup.md +11 -0
- data/docs/StoredCardInfo.md +8 -0
- data/docs/SubstituteClassTeacherRequest.md +13 -0
- data/docs/SubstituteClassTeacherResponse.md +8 -0
- data/docs/SubstituteTeacherClass.md +27 -0
- data/docs/TimeCardEvent.md +10 -0
- data/docs/TimeClockReport.md +13 -0
- data/docs/Unavailability.md +11 -0
- data/docs/UpcomingAutopayEvent.md +11 -0
- data/docs/UpdateAppointmentRequest.md +19 -0
- data/docs/UpdateAppointmentResponse.md +8 -0
- data/docs/UpdateClientRequest.md +11 -0
- data/docs/UpdateClientResponse.md +8 -0
- data/docs/UpdateClientServiceRequest.md +11 -0
- data/docs/UpdateClientServiceResponse.md +8 -0
- data/docs/UpdateClientVisitRequest.md +13 -0
- data/docs/UpdateClientVisitResponse.md +8 -0
- data/docs/UpdateContactLogComment.md +9 -0
- data/docs/UpdateContactLogRequest.md +16 -0
- data/docs/UpdateContactLogType.md +9 -0
- data/docs/UploadClientDocumentRequest.md +9 -0
- data/docs/UploadClientDocumentResponse.md +9 -0
- data/docs/UploadClientPhotoRequest.md +9 -0
- data/docs/UploadClientPhotoResponse.md +9 -0
- data/docs/User.md +11 -0
- data/docs/UserTokenApi.md +115 -0
- data/docs/Visit.md +25 -0
- data/docs/WaitlistEntry.md +16 -0
- data/git_push.sh +55 -0
- data/lib/swagger_client.rb +241 -0
- data/lib/swagger_client/api/appointment_api.rb +570 -0
- data/lib/swagger_client/api/class_api.rb +727 -0
- data/lib/swagger_client/api/client_api.rb +1795 -0
- data/lib/swagger_client/api/enrollment_api.rb +180 -0
- data/lib/swagger_client/api/payroll_api.rb +181 -0
- data/lib/swagger_client/api/sale_api.rb +829 -0
- data/lib/swagger_client/api/site_api.rb +433 -0
- data/lib/swagger_client/api/staff_api.rb +171 -0
- data/lib/swagger_client/api/user_token_api.rb +150 -0
- data/lib/swagger_client/api_client.rb +389 -0
- data/lib/swagger_client/api_error.rb +38 -0
- data/lib/swagger_client/configuration.rb +209 -0
- data/lib/swagger_client/models/add_appointment_request.rb +395 -0
- data/lib/swagger_client/models/add_appointment_response.rb +184 -0
- data/lib/swagger_client/models/add_arrival_request.rb +204 -0
- data/lib/swagger_client/models/add_arrival_response.rb +194 -0
- data/lib/swagger_client/models/add_client_request.rb +766 -0
- data/lib/swagger_client/models/add_client_response.rb +184 -0
- data/lib/swagger_client/models/add_client_to_class_request.rb +284 -0
- data/lib/swagger_client/models/add_client_to_class_response.rb +184 -0
- data/lib/swagger_client/models/add_client_to_class_visit.rb +442 -0
- data/lib/swagger_client/models/add_client_to_enrollment_request.rb +266 -0
- data/lib/swagger_client/models/add_contact_log_request.rb +278 -0
- data/lib/swagger_client/models/add_contact_log_type.rb +197 -0
- data/lib/swagger_client/models/amenity.rb +195 -0
- data/lib/swagger_client/models/appointment.rb +393 -0
- data/lib/swagger_client/models/appointment_option.rb +215 -0
- data/lib/swagger_client/models/assigned_client_index.rb +195 -0
- data/lib/swagger_client/models/autopay_schedule.rb +204 -0
- data/lib/swagger_client/models/availability.rb +257 -0
- data/lib/swagger_client/models/booking_window.rb +215 -0
- data/lib/swagger_client/models/checkout_appointment_booking_request.rb +246 -0
- data/lib/swagger_client/models/checkout_item.rb +196 -0
- data/lib/swagger_client/models/checkout_item_wrapper.rb +286 -0
- data/lib/swagger_client/models/checkout_payment_info.rb +196 -0
- data/lib/swagger_client/models/checkout_shopping_cart_request.rb +318 -0
- data/lib/swagger_client/models/class_description.rb +325 -0
- data/lib/swagger_client/models/class_payroll_event.rb +204 -0
- data/lib/swagger_client/models/class_schedule.rb +399 -0
- data/lib/swagger_client/models/client.rb +769 -0
- data/lib/swagger_client/models/client_contract.rb +301 -0
- data/lib/swagger_client/models/client_credit_card.rb +275 -0
- data/lib/swagger_client/models/client_document.rb +238 -0
- data/lib/swagger_client/models/client_index.rb +271 -0
- data/lib/swagger_client/models/client_index_value.rb +205 -0
- data/lib/swagger_client/models/client_membership.rb +340 -0
- data/lib/swagger_client/models/client_purchase_record.rb +265 -0
- data/lib/swagger_client/models/client_relationship.rb +205 -0
- data/lib/swagger_client/models/client_service.rb +319 -0
- data/lib/swagger_client/models/color.rb +195 -0
- data/lib/swagger_client/models/contact_log.rb +289 -0
- data/lib/swagger_client/models/contact_log_comment.rb +215 -0
- data/lib/swagger_client/models/contact_log_sub_type.rb +185 -0
- data/lib/swagger_client/models/contact_log_type.rb +197 -0
- data/lib/swagger_client/models/contract.rb +522 -0
- data/lib/swagger_client/models/contract_item.rb +244 -0
- data/lib/swagger_client/models/course.rb +275 -0
- data/lib/swagger_client/models/credit_card_info.rb +256 -0
- data/lib/swagger_client/models/cross_regional_client_association.rb +205 -0
- data/lib/swagger_client/models/custom_client_field.rb +205 -0
- data/lib/swagger_client/models/custom_client_field_value.rb +215 -0
- data/lib/swagger_client/models/custom_payment_method.rb +194 -0
- data/lib/swagger_client/models/formula_note.rb +225 -0
- data/lib/swagger_client/models/get_activation_code_response.rb +194 -0
- data/lib/swagger_client/models/get_active_client_memberships_request.rb +219 -0
- data/lib/swagger_client/models/get_active_client_memberships_response.rb +196 -0
- data/lib/swagger_client/models/get_active_session_times_request.rb +270 -0
- data/lib/swagger_client/models/get_active_session_times_response.rb +196 -0
- data/lib/swagger_client/models/get_appointment_options_response.rb +186 -0
- data/lib/swagger_client/models/get_bookable_items_request.rb +275 -0
- data/lib/swagger_client/models/get_bookable_items_response.rb +196 -0
- data/lib/swagger_client/models/get_class_descriptions_request.rb +256 -0
- data/lib/swagger_client/models/get_class_descriptions_response.rb +196 -0
- data/lib/swagger_client/models/get_class_payroll_request.rb +234 -0
- data/lib/swagger_client/models/get_class_payroll_response.rb +196 -0
- data/lib/swagger_client/models/get_class_schedules_request.rb +274 -0
- data/lib/swagger_client/models/get_class_schedules_response.rb +196 -0
- data/lib/swagger_client/models/get_class_visits_request.rb +194 -0
- data/lib/swagger_client/models/get_class_visits_response.rb +184 -0
- data/lib/swagger_client/models/get_classes_request.rb +338 -0
- data/lib/swagger_client/models/get_classes_response.rb +196 -0
- data/lib/swagger_client/models/get_client_account_balances_request.rb +231 -0
- data/lib/swagger_client/models/get_client_account_balances_response.rb +196 -0
- data/lib/swagger_client/models/get_client_contracts_request.rb +229 -0
- data/lib/swagger_client/models/get_client_contracts_response.rb +196 -0
- data/lib/swagger_client/models/get_client_formula_notes_request.rb +214 -0
- data/lib/swagger_client/models/get_client_formula_notes_response.rb +196 -0
- data/lib/swagger_client/models/get_client_indexes_request.rb +184 -0
- data/lib/swagger_client/models/get_client_indexes_response.rb +186 -0
- data/lib/swagger_client/models/get_client_purchases_request.rb +239 -0
- data/lib/swagger_client/models/get_client_purchases_response.rb +196 -0
- data/lib/swagger_client/models/get_client_referral_types_request.rb +184 -0
- data/lib/swagger_client/models/get_client_referral_types_response.rb +186 -0
- data/lib/swagger_client/models/get_client_services_request.rb +313 -0
- data/lib/swagger_client/models/get_client_services_response.rb +196 -0
- data/lib/swagger_client/models/get_client_visits_request.rb +259 -0
- data/lib/swagger_client/models/get_client_visits_response.rb +196 -0
- data/lib/swagger_client/models/get_clients_request.rb +236 -0
- data/lib/swagger_client/models/get_clients_response.rb +196 -0
- data/lib/swagger_client/models/get_contact_logs_request.rb +275 -0
- data/lib/swagger_client/models/get_contact_logs_response.rb +196 -0
- data/lib/swagger_client/models/get_contracts_request.rb +241 -0
- data/lib/swagger_client/models/get_contracts_response.rb +196 -0
- data/lib/swagger_client/models/get_cross_regional_client_associations_request.rb +214 -0
- data/lib/swagger_client/models/get_cross_regional_client_associations_response.rb +196 -0
- data/lib/swagger_client/models/get_custom_client_fields_request.rb +194 -0
- data/lib/swagger_client/models/get_custom_client_fields_response.rb +196 -0
- data/lib/swagger_client/models/get_custom_payment_methods_request.rb +194 -0
- data/lib/swagger_client/models/get_custom_payment_methods_response.rb +196 -0
- data/lib/swagger_client/models/get_enrollments_request.rb +274 -0
- data/lib/swagger_client/models/get_enrollments_response.rb +196 -0
- data/lib/swagger_client/models/get_gift_card_response.rb +196 -0
- data/lib/swagger_client/models/get_gift_cards_request.rb +226 -0
- data/lib/swagger_client/models/get_locations_request.rb +194 -0
- data/lib/swagger_client/models/get_locations_response.rb +196 -0
- data/lib/swagger_client/models/get_packages_request.rb +216 -0
- data/lib/swagger_client/models/get_packages_response.rb +196 -0
- data/lib/swagger_client/models/get_products_request.rb +260 -0
- data/lib/swagger_client/models/get_products_response.rb +196 -0
- data/lib/swagger_client/models/get_programs_request.rb +248 -0
- data/lib/swagger_client/models/get_programs_response.rb +196 -0
- data/lib/swagger_client/models/get_required_client_fields_response.rb +186 -0
- data/lib/swagger_client/models/get_resources_request.rb +236 -0
- data/lib/swagger_client/models/get_resources_response.rb +196 -0
- data/lib/swagger_client/models/get_sales_request.rb +174 -0
- data/lib/swagger_client/models/get_sales_response.rb +196 -0
- data/lib/swagger_client/models/get_schedule_items_request.rb +248 -0
- data/lib/swagger_client/models/get_schedule_items_response.rb +196 -0
- data/lib/swagger_client/models/get_services_request.rb +290 -0
- data/lib/swagger_client/models/get_services_response.rb +196 -0
- data/lib/swagger_client/models/get_session_types_request.rb +216 -0
- data/lib/swagger_client/models/get_session_types_response.rb +196 -0
- data/lib/swagger_client/models/get_sites_request.rb +206 -0
- data/lib/swagger_client/models/get_sites_response.rb +196 -0
- data/lib/swagger_client/models/get_staff_appointments_request.rb +262 -0
- data/lib/swagger_client/models/get_staff_appointments_response.rb +196 -0
- data/lib/swagger_client/models/get_staff_permissions_request.rb +189 -0
- data/lib/swagger_client/models/get_staff_permissions_response.rb +184 -0
- data/lib/swagger_client/models/get_staff_request.rb +248 -0
- data/lib/swagger_client/models/get_staff_response.rb +195 -0
- data/lib/swagger_client/models/get_time_clock_request.rb +234 -0
- data/lib/swagger_client/models/get_time_clock_response.rb +196 -0
- data/lib/swagger_client/models/get_waitlist_entries_request.rb +252 -0
- data/lib/swagger_client/models/get_waitlist_entries_response.rb +196 -0
- data/lib/swagger_client/models/gift_card.rb +300 -0
- data/lib/swagger_client/models/gift_card_layout.rb +195 -0
- data/lib/swagger_client/models/issue_request.rb +195 -0
- data/lib/swagger_client/models/issue_response.rb +204 -0
- data/lib/swagger_client/models/level.rb +205 -0
- data/lib/swagger_client/models/liability.rb +204 -0
- data/lib/swagger_client/models/location.rb +428 -0
- data/lib/swagger_client/models/membership_type_restriction.rb +194 -0
- data/lib/swagger_client/models/model_class.rb +473 -0
- data/lib/swagger_client/models/package.rb +238 -0
- data/lib/swagger_client/models/pagination_response.rb +214 -0
- data/lib/swagger_client/models/product.rb +284 -0
- data/lib/swagger_client/models/program.rb +248 -0
- data/lib/swagger_client/models/prospect_stage.rb +204 -0
- data/lib/swagger_client/models/purchase_contract_request.rb +309 -0
- data/lib/swagger_client/models/purchase_contract_response.rb +214 -0
- data/lib/swagger_client/models/purchase_gift_card_request.rb +309 -0
- data/lib/swagger_client/models/purchase_gift_card_response.rb +274 -0
- data/lib/swagger_client/models/purchased_item.rb +194 -0
- data/lib/swagger_client/models/relationship.rb +205 -0
- data/lib/swagger_client/models/remove_client_from_class_request.rb +234 -0
- data/lib/swagger_client/models/remove_client_from_class_response.rb +184 -0
- data/lib/swagger_client/models/remove_from_waitlist_request.rb +191 -0
- data/lib/swagger_client/models/remove_from_waitlist_response.rb +174 -0
- data/lib/swagger_client/models/resource.rb +195 -0
- data/lib/swagger_client/models/sale.rb +258 -0
- data/lib/swagger_client/models/sale_payment.rb +224 -0
- data/lib/swagger_client/models/sales_rep.rb +226 -0
- data/lib/swagger_client/models/send_password_reset_email_request.rb +220 -0
- data/lib/swagger_client/models/service.rb +264 -0
- data/lib/swagger_client/models/session_type.rb +308 -0
- data/lib/swagger_client/models/site.rb +374 -0
- data/lib/swagger_client/models/size.rb +194 -0
- data/lib/swagger_client/models/staff.rb +420 -0
- data/lib/swagger_client/models/staff_permission_group.rb +240 -0
- data/lib/swagger_client/models/stored_card_info.rb +183 -0
- data/lib/swagger_client/models/substitute_class_teacher_request.rb +244 -0
- data/lib/swagger_client/models/substitute_class_teacher_response.rb +184 -0
- data/lib/swagger_client/models/substitute_teacher_class.rb +375 -0
- data/lib/swagger_client/models/time_card_event.rb +204 -0
- data/lib/swagger_client/models/time_clock_report.rb +236 -0
- data/lib/swagger_client/models/unavailability.rb +214 -0
- data/lib/swagger_client/models/upcoming_autopay_event.rb +248 -0
- data/lib/swagger_client/models/update_appointment_request.rb +301 -0
- data/lib/swagger_client/models/update_appointment_response.rb +184 -0
- data/lib/swagger_client/models/update_client_request.rb +219 -0
- data/lib/swagger_client/models/update_client_response.rb +184 -0
- data/lib/swagger_client/models/update_client_service_request.rb +219 -0
- data/lib/swagger_client/models/update_client_service_response.rb +184 -0
- data/lib/swagger_client/models/update_client_visit_request.rb +239 -0
- data/lib/swagger_client/models/update_client_visit_response.rb +184 -0
- data/lib/swagger_client/models/update_contact_log_comment.rb +194 -0
- data/lib/swagger_client/models/update_contact_log_request.rb +268 -0
- data/lib/swagger_client/models/update_contact_log_type.rb +196 -0
- data/lib/swagger_client/models/upload_client_document_request.rb +204 -0
- data/lib/swagger_client/models/upload_client_document_response.rb +194 -0
- data/lib/swagger_client/models/upload_client_photo_request.rb +223 -0
- data/lib/swagger_client/models/upload_client_photo_response.rb +194 -0
- data/lib/swagger_client/models/user.rb +214 -0
- data/lib/swagger_client/models/visit.rb +413 -0
- data/lib/swagger_client/models/waitlist_entry.rb +264 -0
- data/lib/swagger_client/version.rb +15 -0
- data/mindbody-api-6.0.0.gem +0 -0
- data/mindbody-swagger.gem +0 -0
- data/spec/api/appointment_api_spec.rb +165 -0
- data/spec/api/class_api_spec.rb +202 -0
- data/spec/api/client_api_spec.rb +435 -0
- data/spec/api/enrollment_api_spec.rb +72 -0
- data/spec/api/payroll_api_spec.rb +74 -0
- data/spec/api/sale_api_spec.rb +222 -0
- data/spec/api/site_api_spec.rb +132 -0
- data/spec/api/staff_api_spec.rb +69 -0
- data/spec/api/user_token_api_spec.rb +62 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/add_appointment_request_spec.rb +135 -0
- data/spec/models/add_appointment_response_spec.rb +41 -0
- data/spec/models/add_arrival_request_spec.rb +47 -0
- data/spec/models/add_arrival_response_spec.rb +47 -0
- data/spec/models/add_client_request_spec.rb +363 -0
- data/spec/models/add_client_response_spec.rb +41 -0
- data/spec/models/add_client_to_class_request_spec.rb +95 -0
- data/spec/models/add_client_to_class_response_spec.rb +41 -0
- data/spec/models/add_client_to_class_visit_spec.rb +173 -0
- data/spec/models/add_client_to_enrollment_request_spec.rb +83 -0
- data/spec/models/add_contact_log_request_spec.rb +89 -0
- data/spec/models/add_contact_log_type_spec.rb +47 -0
- data/spec/models/amenity_spec.rb +47 -0
- data/spec/models/appointment_option_spec.rb +59 -0
- data/spec/models/appointment_spec.rb +145 -0
- data/spec/models/assigned_client_index_spec.rb +47 -0
- data/spec/models/autopay_schedule_spec.rb +53 -0
- data/spec/models/availability_spec.rb +83 -0
- data/spec/models/booking_window_spec.rb +59 -0
- data/spec/models/checkout_appointment_booking_request_spec.rb +77 -0
- data/spec/models/checkout_item_spec.rb +47 -0
- data/spec/models/checkout_item_wrapper_spec.rb +95 -0
- data/spec/models/checkout_payment_info_spec.rb +47 -0
- data/spec/models/checkout_shopping_cart_request_spec.rb +101 -0
- data/spec/models/class_description_spec.rb +125 -0
- data/spec/models/class_payroll_event_spec.rb +53 -0
- data/spec/models/class_schedule_spec.rb +167 -0
- data/spec/models/client_contract_spec.rb +93 -0
- data/spec/models/client_credit_card_spec.rb +95 -0
- data/spec/models/client_document_spec.rb +53 -0
- data/spec/models/client_index_spec.rb +75 -0
- data/spec/models/client_index_value_spec.rb +53 -0
- data/spec/models/client_membership_spec.rb +117 -0
- data/spec/models/client_purchase_record_spec.rb +89 -0
- data/spec/models/client_relationship_spec.rb +53 -0
- data/spec/models/client_service_spec.rb +105 -0
- data/spec/models/client_spec.rb +367 -0
- data/spec/models/color_spec.rb +47 -0
- data/spec/models/contact_log_comment_spec.rb +59 -0
- data/spec/models/contact_log_spec.rb +101 -0
- data/spec/models/contact_log_sub_type_spec.rb +41 -0
- data/spec/models/contact_log_type_spec.rb +47 -0
- data/spec/models/contract_item_spec.rb +77 -0
- data/spec/models/contract_spec.rb +239 -0
- data/spec/models/course_spec.rb +95 -0
- data/spec/models/credit_card_info_spec.rb +89 -0
- data/spec/models/cross_regional_client_association_spec.rb +53 -0
- data/spec/models/custom_client_field_spec.rb +53 -0
- data/spec/models/custom_client_field_value_spec.rb +59 -0
- data/spec/models/custom_payment_method_spec.rb +47 -0
- data/spec/models/formula_note_spec.rb +65 -0
- data/spec/models/get_activation_code_response_spec.rb +47 -0
- data/spec/models/get_active_client_memberships_request_spec.rb +59 -0
- data/spec/models/get_active_client_memberships_response_spec.rb +47 -0
- data/spec/models/get_active_session_times_request_spec.rb +75 -0
- data/spec/models/get_active_session_times_response_spec.rb +47 -0
- data/spec/models/get_appointment_options_response_spec.rb +41 -0
- data/spec/models/get_bookable_items_request_spec.rb +89 -0
- data/spec/models/get_bookable_items_response_spec.rb +47 -0
- data/spec/models/get_class_descriptions_request_spec.rb +83 -0
- data/spec/models/get_class_descriptions_response_spec.rb +47 -0
- data/spec/models/get_class_payroll_request_spec.rb +71 -0
- data/spec/models/get_class_payroll_response_spec.rb +47 -0
- data/spec/models/get_class_schedules_request_spec.rb +89 -0
- data/spec/models/get_class_schedules_response_spec.rb +47 -0
- data/spec/models/get_class_visits_request_spec.rb +47 -0
- data/spec/models/get_class_visits_response_spec.rb +41 -0
- data/spec/models/get_classes_request_spec.rb +125 -0
- data/spec/models/get_classes_response_spec.rb +47 -0
- data/spec/models/get_client_account_balances_request_spec.rb +65 -0
- data/spec/models/get_client_account_balances_response_spec.rb +47 -0
- data/spec/models/get_client_contracts_request_spec.rb +65 -0
- data/spec/models/get_client_contracts_response_spec.rb +47 -0
- data/spec/models/get_client_formula_notes_request_spec.rb +59 -0
- data/spec/models/get_client_formula_notes_response_spec.rb +47 -0
- data/spec/models/get_client_indexes_request_spec.rb +41 -0
- data/spec/models/get_client_indexes_response_spec.rb +41 -0
- data/spec/models/get_client_purchases_request_spec.rb +71 -0
- data/spec/models/get_client_purchases_response_spec.rb +47 -0
- data/spec/models/get_client_referral_types_request_spec.rb +41 -0
- data/spec/models/get_client_referral_types_response_spec.rb +41 -0
- data/spec/models/get_client_services_request_spec.rb +113 -0
- data/spec/models/get_client_services_response_spec.rb +47 -0
- data/spec/models/get_client_visits_request_spec.rb +83 -0
- data/spec/models/get_client_visits_response_spec.rb +47 -0
- data/spec/models/get_clients_request_spec.rb +71 -0
- data/spec/models/get_clients_response_spec.rb +47 -0
- data/spec/models/get_contact_logs_request_spec.rb +89 -0
- data/spec/models/get_contact_logs_response_spec.rb +47 -0
- data/spec/models/get_contracts_request_spec.rb +71 -0
- data/spec/models/get_contracts_response_spec.rb +47 -0
- data/spec/models/get_cross_regional_client_associations_request_spec.rb +59 -0
- data/spec/models/get_cross_regional_client_associations_response_spec.rb +47 -0
- data/spec/models/get_custom_client_fields_request_spec.rb +47 -0
- data/spec/models/get_custom_client_fields_response_spec.rb +47 -0
- data/spec/models/get_custom_payment_methods_request_spec.rb +47 -0
- data/spec/models/get_custom_payment_methods_response_spec.rb +47 -0
- data/spec/models/get_enrollments_request_spec.rb +89 -0
- data/spec/models/get_enrollments_response_spec.rb +47 -0
- data/spec/models/get_gift_card_response_spec.rb +47 -0
- data/spec/models/get_gift_cards_request_spec.rb +65 -0
- data/spec/models/get_locations_request_spec.rb +47 -0
- data/spec/models/get_locations_response_spec.rb +47 -0
- data/spec/models/get_packages_request_spec.rb +59 -0
- data/spec/models/get_packages_response_spec.rb +47 -0
- data/spec/models/get_products_request_spec.rb +83 -0
- data/spec/models/get_products_response_spec.rb +47 -0
- data/spec/models/get_programs_request_spec.rb +63 -0
- data/spec/models/get_programs_response_spec.rb +47 -0
- data/spec/models/get_required_client_fields_response_spec.rb +41 -0
- data/spec/models/get_resources_request_spec.rb +71 -0
- data/spec/models/get_resources_response_spec.rb +47 -0
- data/spec/models/get_sales_request_spec.rb +35 -0
- data/spec/models/get_sales_response_spec.rb +47 -0
- data/spec/models/get_schedule_items_request_spec.rb +77 -0
- data/spec/models/get_schedule_items_response_spec.rb +47 -0
- data/spec/models/get_services_request_spec.rb +101 -0
- data/spec/models/get_services_response_spec.rb +47 -0
- data/spec/models/get_session_types_request_spec.rb +59 -0
- data/spec/models/get_session_types_response_spec.rb +47 -0
- data/spec/models/get_sites_request_spec.rb +53 -0
- data/spec/models/get_sites_response_spec.rb +47 -0
- data/spec/models/get_staff_appointments_request_spec.rb +83 -0
- data/spec/models/get_staff_appointments_response_spec.rb +47 -0
- data/spec/models/get_staff_permissions_request_spec.rb +41 -0
- data/spec/models/get_staff_permissions_response_spec.rb +41 -0
- data/spec/models/get_staff_request_spec.rb +77 -0
- data/spec/models/get_staff_response_spec.rb +47 -0
- data/spec/models/get_time_clock_request_spec.rb +71 -0
- data/spec/models/get_time_clock_response_spec.rb +47 -0
- data/spec/models/get_waitlist_entries_request_spec.rb +77 -0
- data/spec/models/get_waitlist_entries_response_spec.rb +47 -0
- data/spec/models/gift_card_layout_spec.rb +47 -0
- data/spec/models/gift_card_spec.rb +107 -0
- data/spec/models/issue_request_spec.rb +47 -0
- data/spec/models/issue_response_spec.rb +53 -0
- data/spec/models/level_spec.rb +53 -0
- data/spec/models/liability_spec.rb +53 -0
- data/spec/models/location_spec.rb +185 -0
- data/spec/models/membership_type_restriction_spec.rb +47 -0
- data/spec/models/model_class_spec.rb +195 -0
- data/spec/models/package_spec.rb +71 -0
- data/spec/models/pagination_response_spec.rb +59 -0
- data/spec/models/product_spec.rb +101 -0
- data/spec/models/program_spec.rb +63 -0
- data/spec/models/prospect_stage_spec.rb +53 -0
- data/spec/models/purchase_contract_request_spec.rb +101 -0
- data/spec/models/purchase_contract_response_spec.rb +59 -0
- data/spec/models/purchase_gift_card_request_spec.rb +107 -0
- data/spec/models/purchase_gift_card_response_spec.rb +95 -0
- data/spec/models/purchased_item_spec.rb +47 -0
- data/spec/models/relationship_spec.rb +53 -0
- data/spec/models/remove_client_from_class_request_spec.rb +65 -0
- data/spec/models/remove_client_from_class_response_spec.rb +41 -0
- data/spec/models/remove_from_waitlist_request_spec.rb +41 -0
- data/spec/models/remove_from_waitlist_response_spec.rb +35 -0
- data/spec/models/resource_spec.rb +47 -0
- data/spec/models/sale_payment_spec.rb +65 -0
- data/spec/models/sale_spec.rb +83 -0
- data/spec/models/sales_rep_spec.rb +65 -0
- data/spec/models/send_password_reset_email_request_spec.rb +53 -0
- data/spec/models/service_spec.rb +89 -0
- data/spec/models/session_type_spec.rb +99 -0
- data/spec/models/site_spec.rb +155 -0
- data/spec/models/size_spec.rb +47 -0
- data/spec/models/staff_permission_group_spec.rb +67 -0
- data/spec/models/staff_spec.rb +179 -0
- data/spec/models/stored_card_info_spec.rb +41 -0
- data/spec/models/substitute_class_teacher_request_spec.rb +71 -0
- data/spec/models/substitute_class_teacher_response_spec.rb +41 -0
- data/spec/models/substitute_teacher_class_spec.rb +155 -0
- data/spec/models/time_card_event_spec.rb +53 -0
- data/spec/models/time_clock_report_spec.rb +71 -0
- data/spec/models/unavailability_spec.rb +59 -0
- data/spec/models/upcoming_autopay_event_spec.rb +63 -0
- data/spec/models/update_appointment_request_spec.rb +107 -0
- data/spec/models/update_appointment_response_spec.rb +41 -0
- data/spec/models/update_client_request_spec.rb +59 -0
- data/spec/models/update_client_response_spec.rb +41 -0
- data/spec/models/update_client_service_request_spec.rb +59 -0
- data/spec/models/update_client_service_response_spec.rb +41 -0
- data/spec/models/update_client_visit_request_spec.rb +71 -0
- data/spec/models/update_client_visit_response_spec.rb +41 -0
- data/spec/models/update_contact_log_comment_spec.rb +47 -0
- data/spec/models/update_contact_log_request_spec.rb +89 -0
- data/spec/models/update_contact_log_type_spec.rb +47 -0
- data/spec/models/upload_client_document_request_spec.rb +47 -0
- data/spec/models/upload_client_document_response_spec.rb +47 -0
- data/spec/models/upload_client_photo_request_spec.rb +47 -0
- data/spec/models/upload_client_photo_response_spec.rb +47 -0
- data/spec/models/user_spec.rb +59 -0
- data/spec/models/visit_spec.rb +155 -0
- data/spec/models/waitlist_entry_spec.rb +89 -0
- data/spec/spec_helper.rb +111 -0
- data/swagger_client-1.0.0.gem +0 -0
- data/swagger_client.gemspec +45 -0
- metadata +1050 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: 7b5bcd57d6f7ee751ca98eabd720a97d72cec42adfa2f728aa55f5179a0fea10
|
|
4
|
+
data.tar.gz: 06ec75ff5fe125de2a596c48a8246942de9df59823fa2347a644d3eaede1e78a
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: 5dc9e402d28625a23bde2fd0eccff0636b5a320c9b030e78e8bb3cb91187dc9eeac0b7cd76e643f5cb58f359343e909b40be2ef03b571693f1c2c24cd785f47b
|
|
7
|
+
data.tar.gz: 86a06096c6f9500fa47fdec0b424ceed7535ce3563e5fd9bac36de2f532335b244d96ef0267bfcfbdf754918e3b57b5b8b2409e3ed0ccdc239396d66bf51ae8e
|
data/Gemfile
ADDED
data/README.md
ADDED
|
@@ -0,0 +1,357 @@
|
|
|
1
|
+
# swagger_client
|
|
2
|
+
|
|
3
|
+
SwaggerClient - the Ruby gem for the MINDBODY Public API
|
|
4
|
+
|
|
5
|
+
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
|
6
|
+
|
|
7
|
+
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
|
8
|
+
|
|
9
|
+
- API version: v6
|
|
10
|
+
- Package version: 1.0.0
|
|
11
|
+
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
|
12
|
+
|
|
13
|
+
## Installation
|
|
14
|
+
|
|
15
|
+
### Build a gem
|
|
16
|
+
|
|
17
|
+
To build the Ruby code into a gem:
|
|
18
|
+
|
|
19
|
+
```shell
|
|
20
|
+
gem build swagger_client.gemspec
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Then either install the gem locally:
|
|
24
|
+
|
|
25
|
+
```shell
|
|
26
|
+
gem install ./swagger_client-1.0.0.gem
|
|
27
|
+
```
|
|
28
|
+
(for development, run `gem install --dev ./swagger_client-1.0.0.gem` to install the development dependencies)
|
|
29
|
+
|
|
30
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
31
|
+
|
|
32
|
+
Finally add this to the Gemfile:
|
|
33
|
+
|
|
34
|
+
gem 'swagger_client', '~> 1.0.0'
|
|
35
|
+
|
|
36
|
+
### Install from Git
|
|
37
|
+
|
|
38
|
+
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:
|
|
39
|
+
|
|
40
|
+
gem 'swagger_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
|
41
|
+
|
|
42
|
+
### Include the Ruby code directly
|
|
43
|
+
|
|
44
|
+
Include the Ruby code directly using `-I` as follows:
|
|
45
|
+
|
|
46
|
+
```shell
|
|
47
|
+
ruby -Ilib script.rb
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Getting Started
|
|
51
|
+
|
|
52
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
|
53
|
+
```ruby
|
|
54
|
+
# Load the gem
|
|
55
|
+
require 'swagger_client'
|
|
56
|
+
|
|
57
|
+
api_instance = SwaggerClient::AppointmentApi.new
|
|
58
|
+
|
|
59
|
+
request = SwaggerClient::AddAppointmentRequest.new # AddAppointmentRequest |
|
|
60
|
+
|
|
61
|
+
site_id = 'site_id_example' # String | ID of the site from which to pull data.
|
|
62
|
+
|
|
63
|
+
version = 'version_example' # String |
|
|
64
|
+
|
|
65
|
+
opts = {
|
|
66
|
+
authorization: '' # String | A staff user authorization token.
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
begin
|
|
70
|
+
#Book a new appointment.
|
|
71
|
+
result = api_instance.appointment_add_apppointment(request, site_id, version, opts)
|
|
72
|
+
p result
|
|
73
|
+
rescue SwaggerClient::ApiError => e
|
|
74
|
+
puts "Exception when calling AppointmentApi->appointment_add_apppointment: #{e}"
|
|
75
|
+
end
|
|
76
|
+
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
## Documentation for API Endpoints
|
|
80
|
+
|
|
81
|
+
All URIs are relative to *https://api.mindbodyonline.com*
|
|
82
|
+
|
|
83
|
+
Class | Method | HTTP request | Description
|
|
84
|
+
------------ | ------------- | ------------- | -------------
|
|
85
|
+
*SwaggerClient::AppointmentApi* | [**appointment_add_apppointment**](docs/AppointmentApi.md#appointment_add_apppointment) | **POST** /public/v{version}/appointment/addappointment | Book a new appointment.
|
|
86
|
+
*SwaggerClient::AppointmentApi* | [**appointment_get_active_session_times**](docs/AppointmentApi.md#appointment_get_active_session_times) | **GET** /public/v{version}/appointment/activesessiontimes | Get active session times.
|
|
87
|
+
*SwaggerClient::AppointmentApi* | [**appointment_get_appointment_options**](docs/AppointmentApi.md#appointment_get_appointment_options) | **GET** /public/v{version}/appointment/appointmentoptions | Get appointment-related settings.
|
|
88
|
+
*SwaggerClient::AppointmentApi* | [**appointment_get_bookable_items**](docs/AppointmentApi.md#appointment_get_bookable_items) | **GET** /public/v{version}/appointment/bookableitems | Get staff appointment availability.
|
|
89
|
+
*SwaggerClient::AppointmentApi* | [**appointment_get_schedule_items**](docs/AppointmentApi.md#appointment_get_schedule_items) | **GET** /public/v{version}/appointment/scheduleitems | Get appointment schedule.
|
|
90
|
+
*SwaggerClient::AppointmentApi* | [**appointment_get_staff_appointments**](docs/AppointmentApi.md#appointment_get_staff_appointments) | **GET** /public/v{version}/appointment/staffappointments | Get appointments grouped by staff member.
|
|
91
|
+
*SwaggerClient::AppointmentApi* | [**appointment_update_apppointment**](docs/AppointmentApi.md#appointment_update_apppointment) | **POST** /public/v{version}/appointment/updateappointment | Update an existing appointment.
|
|
92
|
+
*SwaggerClient::ClassApi* | [**class_add_client_to_class**](docs/ClassApi.md#class_add_client_to_class) | **POST** /public/v{version}/class/addclienttoclass | Book a client into a class.
|
|
93
|
+
*SwaggerClient::ClassApi* | [**class_get_class_descriptions**](docs/ClassApi.md#class_get_class_descriptions) | **GET** /public/v{version}/class/classdescriptions | Get class descriptions.
|
|
94
|
+
*SwaggerClient::ClassApi* | [**class_get_class_schedules**](docs/ClassApi.md#class_get_class_schedules) | **GET** /public/v{version}/class/classschedules | Get class schedules.
|
|
95
|
+
*SwaggerClient::ClassApi* | [**class_get_class_visits**](docs/ClassApi.md#class_get_class_visits) | **GET** /public/v{version}/class/classvisits | Get information about clients booked in a class.
|
|
96
|
+
*SwaggerClient::ClassApi* | [**class_get_classes**](docs/ClassApi.md#class_get_classes) | **GET** /public/v{version}/class/classes | Get scheduled classes.
|
|
97
|
+
*SwaggerClient::ClassApi* | [**class_get_waitlist_entries**](docs/ClassApi.md#class_get_waitlist_entries) | **GET** /public/v{version}/class/waitlistentries | Get waiting list entries.
|
|
98
|
+
*SwaggerClient::ClassApi* | [**class_remove_client_from_class**](docs/ClassApi.md#class_remove_client_from_class) | **POST** /public/v{version}/class/removeclientfromclass | Remove a client from a class.
|
|
99
|
+
*SwaggerClient::ClassApi* | [**class_remove_from_waitlist**](docs/ClassApi.md#class_remove_from_waitlist) | **POST** /public/v{version}/class/removefromwaitlist | Remove a client from a waiting list.
|
|
100
|
+
*SwaggerClient::ClassApi* | [**class_substitute_class_teacher**](docs/ClassApi.md#class_substitute_class_teacher) | **POST** /public/v{version}/class/substituteclassteacher | Substitute a class teacher.
|
|
101
|
+
*SwaggerClient::ClientApi* | [**client_add_arrival**](docs/ClientApi.md#client_add_arrival) | **POST** /public/v{version}/client/addarrival | Add an arrival for a client.
|
|
102
|
+
*SwaggerClient::ClientApi* | [**client_add_client**](docs/ClientApi.md#client_add_client) | **POST** /public/v{version}/client/addclient | Add a client to a site.
|
|
103
|
+
*SwaggerClient::ClientApi* | [**client_add_contact_log**](docs/ClientApi.md#client_add_contact_log) | **POST** /public/v{version}/client/addcontactlog | Add a contact log to a client's account.
|
|
104
|
+
*SwaggerClient::ClientApi* | [**client_get_active_client_memberships**](docs/ClientApi.md#client_get_active_client_memberships) | **GET** /public/v{version}/client/activeclientmemberships | Get a client's active memberships.
|
|
105
|
+
*SwaggerClient::ClientApi* | [**client_get_client_account_balances**](docs/ClientApi.md#client_get_client_account_balances) | **GET** /public/v{version}/client/clientaccountbalances | Get account balance information for one or more client(s).
|
|
106
|
+
*SwaggerClient::ClientApi* | [**client_get_client_contracts**](docs/ClientApi.md#client_get_client_contracts) | **GET** /public/v{version}/client/clientcontracts | Get contracts that a client has purchased.
|
|
107
|
+
*SwaggerClient::ClientApi* | [**client_get_client_formula_notes**](docs/ClientApi.md#client_get_client_formula_notes) | **GET** /public/v{version}/client/clientformulanotes | Get a client's formula notes.
|
|
108
|
+
*SwaggerClient::ClientApi* | [**client_get_client_indexes**](docs/ClientApi.md#client_get_client_indexes) | **GET** /public/v{version}/client/clientindexes | Get a site's configured client indexes and client index values.
|
|
109
|
+
*SwaggerClient::ClientApi* | [**client_get_client_purchases**](docs/ClientApi.md#client_get_client_purchases) | **GET** /public/v{version}/client/clientpurchases | Get a client's purchase history.
|
|
110
|
+
*SwaggerClient::ClientApi* | [**client_get_client_referral_types**](docs/ClientApi.md#client_get_client_referral_types) | **GET** /public/v{version}/client/clientreferraltypes | Get a site's configured client referral types.
|
|
111
|
+
*SwaggerClient::ClientApi* | [**client_get_client_services**](docs/ClientApi.md#client_get_client_services) | **GET** /public/v{version}/client/clientservices | Get pricing options that a client has purchased.
|
|
112
|
+
*SwaggerClient::ClientApi* | [**client_get_client_visits**](docs/ClientApi.md#client_get_client_visits) | **GET** /public/v{version}/client/clientvisits | Get a client's visit history.
|
|
113
|
+
*SwaggerClient::ClientApi* | [**client_get_clients**](docs/ClientApi.md#client_get_clients) | **GET** /public/v{version}/client/clients | Get clients.
|
|
114
|
+
*SwaggerClient::ClientApi* | [**client_get_contact_logs**](docs/ClientApi.md#client_get_contact_logs) | **GET** /public/v{version}/client/contactlogs | Get contact logs on a client's account.
|
|
115
|
+
*SwaggerClient::ClientApi* | [**client_get_cross_regional_client_associations**](docs/ClientApi.md#client_get_cross_regional_client_associations) | **GET** /public/v{version}/client/crossregionalclientassociations | Get a client's cross regional site associations.
|
|
116
|
+
*SwaggerClient::ClientApi* | [**client_get_custom_client_fields**](docs/ClientApi.md#client_get_custom_client_fields) | **GET** /public/v{version}/client/customclientfields | Get a site's configured custom client fields.
|
|
117
|
+
*SwaggerClient::ClientApi* | [**client_get_required_client_fields**](docs/ClientApi.md#client_get_required_client_fields) | **GET** /public/v{version}/client/requiredclientfields | Get client required fields for a site.
|
|
118
|
+
*SwaggerClient::ClientApi* | [**client_send_password_reset_email**](docs/ClientApi.md#client_send_password_reset_email) | **POST** /public/v{version}/client/sendpasswordresetemail | Send a password reset email to a client.
|
|
119
|
+
*SwaggerClient::ClientApi* | [**client_update_client**](docs/ClientApi.md#client_update_client) | **POST** /public/v{version}/client/updateclient | Update a client at a site.
|
|
120
|
+
*SwaggerClient::ClientApi* | [**client_update_client_service**](docs/ClientApi.md#client_update_client_service) | **POST** /public/v{version}/client/updateclientservice | Update a client's purchase pricing option.
|
|
121
|
+
*SwaggerClient::ClientApi* | [**client_update_client_visit**](docs/ClientApi.md#client_update_client_visit) | **POST** /public/v{version}/client/updateclientvisit | Update a client's visit.
|
|
122
|
+
*SwaggerClient::ClientApi* | [**client_update_contact_log**](docs/ClientApi.md#client_update_contact_log) | **POST** /public/v{version}/client/updatecontactlog | Update a contact log on a client's account.
|
|
123
|
+
*SwaggerClient::ClientApi* | [**client_upload_client_document**](docs/ClientApi.md#client_upload_client_document) | **POST** /public/v{version}/client/uploadclientdocument | Upload a document to a client's profile.
|
|
124
|
+
*SwaggerClient::ClientApi* | [**client_upload_client_photo**](docs/ClientApi.md#client_upload_client_photo) | **POST** /public/v{version}/client/uploadclientphoto | Upload a profile photo to a client's profile.
|
|
125
|
+
*SwaggerClient::EnrollmentApi* | [**enrollment_add_client_to_enrollment**](docs/EnrollmentApi.md#enrollment_add_client_to_enrollment) | **POST** /public/v{version}/enrollment/addclienttoenrollment | Book a client into an enrollment.
|
|
126
|
+
*SwaggerClient::EnrollmentApi* | [**enrollment_get_enrollments**](docs/EnrollmentApi.md#enrollment_get_enrollments) | **GET** /public/v{version}/enrollment/enrollments | Get enrollments scheduled at a site.
|
|
127
|
+
*SwaggerClient::PayrollApi* | [**payroll_get_class_payroll**](docs/PayrollApi.md#payroll_get_class_payroll) | **GET** /public/v{version}/payroll/classes | Get class payroll for staff members.
|
|
128
|
+
*SwaggerClient::PayrollApi* | [**payroll_get_time_clock**](docs/PayrollApi.md#payroll_get_time_clock) | **GET** /public/v{version}/payroll/timeclock | Get time card payroll for staff members.
|
|
129
|
+
*SwaggerClient::SaleApi* | [**sale_checkout_shopping_cart**](docs/SaleApi.md#sale_checkout_shopping_cart) | **POST** /public/v{version}/sale/checkoutshoppingcart | Purchase pricing options, packages, retail products, or tips for a client.
|
|
130
|
+
*SwaggerClient::SaleApi* | [**sale_get_accepted_card_types**](docs/SaleApi.md#sale_get_accepted_card_types) | **GET** /public/v{version}/sale/acceptedcardtypes | Get credit cards types that a site accepts.
|
|
131
|
+
*SwaggerClient::SaleApi* | [**sale_get_contracts**](docs/SaleApi.md#sale_get_contracts) | **GET** /public/v{version}/sale/contracts | Get contracts available for purchase at a site.
|
|
132
|
+
*SwaggerClient::SaleApi* | [**sale_get_custom_payment_methods**](docs/SaleApi.md#sale_get_custom_payment_methods) | **GET** /public/v{version}/sale/custompaymentmethods | Get payment methods that can be used to pay for sales at a site.
|
|
133
|
+
*SwaggerClient::SaleApi* | [**sale_get_gift_cards**](docs/SaleApi.md#sale_get_gift_cards) | **GET** /public/v{version}/sale/giftcards | Get gift cards available for purchase at a site.
|
|
134
|
+
*SwaggerClient::SaleApi* | [**sale_get_packages**](docs/SaleApi.md#sale_get_packages) | **GET** /public/v{version}/sale/packages | Get packages available for purchase at a site.
|
|
135
|
+
*SwaggerClient::SaleApi* | [**sale_get_products**](docs/SaleApi.md#sale_get_products) | **GET** /public/v{version}/sale/products | Get retail products available for purchase at a site.
|
|
136
|
+
*SwaggerClient::SaleApi* | [**sale_get_sales**](docs/SaleApi.md#sale_get_sales) | **GET** /public/v{version}/sale/sales | Get sales completed at a site.
|
|
137
|
+
*SwaggerClient::SaleApi* | [**sale_get_services**](docs/SaleApi.md#sale_get_services) | **GET** /public/v{version}/sale/services | Get pricing options available for purchase at a site
|
|
138
|
+
*SwaggerClient::SaleApi* | [**sale_purchase_contract**](docs/SaleApi.md#sale_purchase_contract) | **POST** /public/v{version}/sale/purchasecontract | Purchase a contract for a client.
|
|
139
|
+
*SwaggerClient::SaleApi* | [**sale_purchase_gift_card**](docs/SaleApi.md#sale_purchase_gift_card) | **POST** /public/v{version}/sale/purchasegiftcard | Purchase a gift card for a client.
|
|
140
|
+
*SwaggerClient::SiteApi* | [**site_get_activation_code**](docs/SiteApi.md#site_get_activation_code) | **GET** /public/v{version}/site/activationcode | Get an activation code for a site.
|
|
141
|
+
*SwaggerClient::SiteApi* | [**site_get_locations**](docs/SiteApi.md#site_get_locations) | **GET** /public/v{version}/site/locations | Get locations for a site.
|
|
142
|
+
*SwaggerClient::SiteApi* | [**site_get_programs**](docs/SiteApi.md#site_get_programs) | **GET** /public/v{version}/site/programs | Get service categories offered at a site.
|
|
143
|
+
*SwaggerClient::SiteApi* | [**site_get_resources**](docs/SiteApi.md#site_get_resources) | **GET** /public/v{version}/site/resources | Get resources used at a site.
|
|
144
|
+
*SwaggerClient::SiteApi* | [**site_get_session_types**](docs/SiteApi.md#site_get_session_types) | **GET** /public/v{version}/site/sessiontypes | Get the session types used at a site.
|
|
145
|
+
*SwaggerClient::SiteApi* | [**site_get_sites**](docs/SiteApi.md#site_get_sites) | **GET** /public/v{version}/site/sites | Get all sites that can be accessed by an API Key.
|
|
146
|
+
*SwaggerClient::StaffApi* | [**staff_get_staff**](docs/StaffApi.md#staff_get_staff) | **GET** /public/v{version}/staff/staff | Get staff members at a site.
|
|
147
|
+
*SwaggerClient::StaffApi* | [**staff_get_staff_permissions**](docs/StaffApi.md#staff_get_staff_permissions) | **GET** /public/v{version}/staff/staffpermissions | Get configured staff permissions for a staff member.
|
|
148
|
+
*SwaggerClient::UserTokenApi* | [**user_token_issue**](docs/UserTokenApi.md#user_token_issue) | **POST** /public/v{version}/usertoken/issue | Get a staff user token.
|
|
149
|
+
*SwaggerClient::UserTokenApi* | [**user_token_revoke**](docs/UserTokenApi.md#user_token_revoke) | **DELETE** /public/v{version}/usertoken/revoke | Revoke a user token.
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
## Documentation for Models
|
|
153
|
+
|
|
154
|
+
- [SwaggerClient::AddAppointmentRequest](docs/AddAppointmentRequest.md)
|
|
155
|
+
- [SwaggerClient::AddAppointmentResponse](docs/AddAppointmentResponse.md)
|
|
156
|
+
- [SwaggerClient::AddArrivalRequest](docs/AddArrivalRequest.md)
|
|
157
|
+
- [SwaggerClient::AddArrivalResponse](docs/AddArrivalResponse.md)
|
|
158
|
+
- [SwaggerClient::AddClientRequest](docs/AddClientRequest.md)
|
|
159
|
+
- [SwaggerClient::AddClientResponse](docs/AddClientResponse.md)
|
|
160
|
+
- [SwaggerClient::AddClientToClassRequest](docs/AddClientToClassRequest.md)
|
|
161
|
+
- [SwaggerClient::AddClientToClassResponse](docs/AddClientToClassResponse.md)
|
|
162
|
+
- [SwaggerClient::AddClientToClassVisit](docs/AddClientToClassVisit.md)
|
|
163
|
+
- [SwaggerClient::AddClientToEnrollmentRequest](docs/AddClientToEnrollmentRequest.md)
|
|
164
|
+
- [SwaggerClient::AddContactLogRequest](docs/AddContactLogRequest.md)
|
|
165
|
+
- [SwaggerClient::AddContactLogType](docs/AddContactLogType.md)
|
|
166
|
+
- [SwaggerClient::Amenity](docs/Amenity.md)
|
|
167
|
+
- [SwaggerClient::Appointment](docs/Appointment.md)
|
|
168
|
+
- [SwaggerClient::AppointmentOption](docs/AppointmentOption.md)
|
|
169
|
+
- [SwaggerClient::AssignedClientIndex](docs/AssignedClientIndex.md)
|
|
170
|
+
- [SwaggerClient::AutopaySchedule](docs/AutopaySchedule.md)
|
|
171
|
+
- [SwaggerClient::Availability](docs/Availability.md)
|
|
172
|
+
- [SwaggerClient::BookingWindow](docs/BookingWindow.md)
|
|
173
|
+
- [SwaggerClient::CheckoutAppointmentBookingRequest](docs/CheckoutAppointmentBookingRequest.md)
|
|
174
|
+
- [SwaggerClient::CheckoutItem](docs/CheckoutItem.md)
|
|
175
|
+
- [SwaggerClient::CheckoutItemWrapper](docs/CheckoutItemWrapper.md)
|
|
176
|
+
- [SwaggerClient::CheckoutPaymentInfo](docs/CheckoutPaymentInfo.md)
|
|
177
|
+
- [SwaggerClient::CheckoutShoppingCartRequest](docs/CheckoutShoppingCartRequest.md)
|
|
178
|
+
- [SwaggerClient::ClassDescription](docs/ClassDescription.md)
|
|
179
|
+
- [SwaggerClient::ClassPayrollEvent](docs/ClassPayrollEvent.md)
|
|
180
|
+
- [SwaggerClient::ClassSchedule](docs/ClassSchedule.md)
|
|
181
|
+
- [SwaggerClient::Client](docs/Client.md)
|
|
182
|
+
- [SwaggerClient::ClientContract](docs/ClientContract.md)
|
|
183
|
+
- [SwaggerClient::ClientCreditCard](docs/ClientCreditCard.md)
|
|
184
|
+
- [SwaggerClient::ClientDocument](docs/ClientDocument.md)
|
|
185
|
+
- [SwaggerClient::ClientIndex](docs/ClientIndex.md)
|
|
186
|
+
- [SwaggerClient::ClientIndexValue](docs/ClientIndexValue.md)
|
|
187
|
+
- [SwaggerClient::ClientMembership](docs/ClientMembership.md)
|
|
188
|
+
- [SwaggerClient::ClientPurchaseRecord](docs/ClientPurchaseRecord.md)
|
|
189
|
+
- [SwaggerClient::ClientRelationship](docs/ClientRelationship.md)
|
|
190
|
+
- [SwaggerClient::ClientService](docs/ClientService.md)
|
|
191
|
+
- [SwaggerClient::Color](docs/Color.md)
|
|
192
|
+
- [SwaggerClient::ContactLog](docs/ContactLog.md)
|
|
193
|
+
- [SwaggerClient::ContactLogComment](docs/ContactLogComment.md)
|
|
194
|
+
- [SwaggerClient::ContactLogSubType](docs/ContactLogSubType.md)
|
|
195
|
+
- [SwaggerClient::ContactLogType](docs/ContactLogType.md)
|
|
196
|
+
- [SwaggerClient::Contract](docs/Contract.md)
|
|
197
|
+
- [SwaggerClient::ContractItem](docs/ContractItem.md)
|
|
198
|
+
- [SwaggerClient::Course](docs/Course.md)
|
|
199
|
+
- [SwaggerClient::CreditCardInfo](docs/CreditCardInfo.md)
|
|
200
|
+
- [SwaggerClient::CrossRegionalClientAssociation](docs/CrossRegionalClientAssociation.md)
|
|
201
|
+
- [SwaggerClient::CustomClientField](docs/CustomClientField.md)
|
|
202
|
+
- [SwaggerClient::CustomClientFieldValue](docs/CustomClientFieldValue.md)
|
|
203
|
+
- [SwaggerClient::CustomPaymentMethod](docs/CustomPaymentMethod.md)
|
|
204
|
+
- [SwaggerClient::FormulaNote](docs/FormulaNote.md)
|
|
205
|
+
- [SwaggerClient::GetActivationCodeResponse](docs/GetActivationCodeResponse.md)
|
|
206
|
+
- [SwaggerClient::GetActiveClientMembershipsRequest](docs/GetActiveClientMembershipsRequest.md)
|
|
207
|
+
- [SwaggerClient::GetActiveClientMembershipsResponse](docs/GetActiveClientMembershipsResponse.md)
|
|
208
|
+
- [SwaggerClient::GetActiveSessionTimesRequest](docs/GetActiveSessionTimesRequest.md)
|
|
209
|
+
- [SwaggerClient::GetActiveSessionTimesResponse](docs/GetActiveSessionTimesResponse.md)
|
|
210
|
+
- [SwaggerClient::GetAppointmentOptionsResponse](docs/GetAppointmentOptionsResponse.md)
|
|
211
|
+
- [SwaggerClient::GetBookableItemsRequest](docs/GetBookableItemsRequest.md)
|
|
212
|
+
- [SwaggerClient::GetBookableItemsResponse](docs/GetBookableItemsResponse.md)
|
|
213
|
+
- [SwaggerClient::GetClassDescriptionsRequest](docs/GetClassDescriptionsRequest.md)
|
|
214
|
+
- [SwaggerClient::GetClassDescriptionsResponse](docs/GetClassDescriptionsResponse.md)
|
|
215
|
+
- [SwaggerClient::GetClassPayrollRequest](docs/GetClassPayrollRequest.md)
|
|
216
|
+
- [SwaggerClient::GetClassPayrollResponse](docs/GetClassPayrollResponse.md)
|
|
217
|
+
- [SwaggerClient::GetClassSchedulesRequest](docs/GetClassSchedulesRequest.md)
|
|
218
|
+
- [SwaggerClient::GetClassSchedulesResponse](docs/GetClassSchedulesResponse.md)
|
|
219
|
+
- [SwaggerClient::GetClassVisitsRequest](docs/GetClassVisitsRequest.md)
|
|
220
|
+
- [SwaggerClient::GetClassVisitsResponse](docs/GetClassVisitsResponse.md)
|
|
221
|
+
- [SwaggerClient::GetClassesRequest](docs/GetClassesRequest.md)
|
|
222
|
+
- [SwaggerClient::GetClassesResponse](docs/GetClassesResponse.md)
|
|
223
|
+
- [SwaggerClient::GetClientAccountBalancesRequest](docs/GetClientAccountBalancesRequest.md)
|
|
224
|
+
- [SwaggerClient::GetClientAccountBalancesResponse](docs/GetClientAccountBalancesResponse.md)
|
|
225
|
+
- [SwaggerClient::GetClientContractsRequest](docs/GetClientContractsRequest.md)
|
|
226
|
+
- [SwaggerClient::GetClientContractsResponse](docs/GetClientContractsResponse.md)
|
|
227
|
+
- [SwaggerClient::GetClientFormulaNotesRequest](docs/GetClientFormulaNotesRequest.md)
|
|
228
|
+
- [SwaggerClient::GetClientFormulaNotesResponse](docs/GetClientFormulaNotesResponse.md)
|
|
229
|
+
- [SwaggerClient::GetClientIndexesRequest](docs/GetClientIndexesRequest.md)
|
|
230
|
+
- [SwaggerClient::GetClientIndexesResponse](docs/GetClientIndexesResponse.md)
|
|
231
|
+
- [SwaggerClient::GetClientPurchasesRequest](docs/GetClientPurchasesRequest.md)
|
|
232
|
+
- [SwaggerClient::GetClientPurchasesResponse](docs/GetClientPurchasesResponse.md)
|
|
233
|
+
- [SwaggerClient::GetClientReferralTypesRequest](docs/GetClientReferralTypesRequest.md)
|
|
234
|
+
- [SwaggerClient::GetClientReferralTypesResponse](docs/GetClientReferralTypesResponse.md)
|
|
235
|
+
- [SwaggerClient::GetClientServicesRequest](docs/GetClientServicesRequest.md)
|
|
236
|
+
- [SwaggerClient::GetClientServicesResponse](docs/GetClientServicesResponse.md)
|
|
237
|
+
- [SwaggerClient::GetClientVisitsRequest](docs/GetClientVisitsRequest.md)
|
|
238
|
+
- [SwaggerClient::GetClientVisitsResponse](docs/GetClientVisitsResponse.md)
|
|
239
|
+
- [SwaggerClient::GetClientsRequest](docs/GetClientsRequest.md)
|
|
240
|
+
- [SwaggerClient::GetClientsResponse](docs/GetClientsResponse.md)
|
|
241
|
+
- [SwaggerClient::GetContactLogsRequest](docs/GetContactLogsRequest.md)
|
|
242
|
+
- [SwaggerClient::GetContactLogsResponse](docs/GetContactLogsResponse.md)
|
|
243
|
+
- [SwaggerClient::GetContractsRequest](docs/GetContractsRequest.md)
|
|
244
|
+
- [SwaggerClient::GetContractsResponse](docs/GetContractsResponse.md)
|
|
245
|
+
- [SwaggerClient::GetCrossRegionalClientAssociationsRequest](docs/GetCrossRegionalClientAssociationsRequest.md)
|
|
246
|
+
- [SwaggerClient::GetCrossRegionalClientAssociationsResponse](docs/GetCrossRegionalClientAssociationsResponse.md)
|
|
247
|
+
- [SwaggerClient::GetCustomClientFieldsRequest](docs/GetCustomClientFieldsRequest.md)
|
|
248
|
+
- [SwaggerClient::GetCustomClientFieldsResponse](docs/GetCustomClientFieldsResponse.md)
|
|
249
|
+
- [SwaggerClient::GetCustomPaymentMethodsRequest](docs/GetCustomPaymentMethodsRequest.md)
|
|
250
|
+
- [SwaggerClient::GetCustomPaymentMethodsResponse](docs/GetCustomPaymentMethodsResponse.md)
|
|
251
|
+
- [SwaggerClient::GetEnrollmentsRequest](docs/GetEnrollmentsRequest.md)
|
|
252
|
+
- [SwaggerClient::GetEnrollmentsResponse](docs/GetEnrollmentsResponse.md)
|
|
253
|
+
- [SwaggerClient::GetGiftCardResponse](docs/GetGiftCardResponse.md)
|
|
254
|
+
- [SwaggerClient::GetGiftCardsRequest](docs/GetGiftCardsRequest.md)
|
|
255
|
+
- [SwaggerClient::GetLocationsRequest](docs/GetLocationsRequest.md)
|
|
256
|
+
- [SwaggerClient::GetLocationsResponse](docs/GetLocationsResponse.md)
|
|
257
|
+
- [SwaggerClient::GetPackagesRequest](docs/GetPackagesRequest.md)
|
|
258
|
+
- [SwaggerClient::GetPackagesResponse](docs/GetPackagesResponse.md)
|
|
259
|
+
- [SwaggerClient::GetProductsRequest](docs/GetProductsRequest.md)
|
|
260
|
+
- [SwaggerClient::GetProductsResponse](docs/GetProductsResponse.md)
|
|
261
|
+
- [SwaggerClient::GetProgramsRequest](docs/GetProgramsRequest.md)
|
|
262
|
+
- [SwaggerClient::GetProgramsResponse](docs/GetProgramsResponse.md)
|
|
263
|
+
- [SwaggerClient::GetRequiredClientFieldsResponse](docs/GetRequiredClientFieldsResponse.md)
|
|
264
|
+
- [SwaggerClient::GetResourcesRequest](docs/GetResourcesRequest.md)
|
|
265
|
+
- [SwaggerClient::GetResourcesResponse](docs/GetResourcesResponse.md)
|
|
266
|
+
- [SwaggerClient::GetSalesRequest](docs/GetSalesRequest.md)
|
|
267
|
+
- [SwaggerClient::GetSalesResponse](docs/GetSalesResponse.md)
|
|
268
|
+
- [SwaggerClient::GetScheduleItemsRequest](docs/GetScheduleItemsRequest.md)
|
|
269
|
+
- [SwaggerClient::GetScheduleItemsResponse](docs/GetScheduleItemsResponse.md)
|
|
270
|
+
- [SwaggerClient::GetServicesRequest](docs/GetServicesRequest.md)
|
|
271
|
+
- [SwaggerClient::GetServicesResponse](docs/GetServicesResponse.md)
|
|
272
|
+
- [SwaggerClient::GetSessionTypesRequest](docs/GetSessionTypesRequest.md)
|
|
273
|
+
- [SwaggerClient::GetSessionTypesResponse](docs/GetSessionTypesResponse.md)
|
|
274
|
+
- [SwaggerClient::GetSitesRequest](docs/GetSitesRequest.md)
|
|
275
|
+
- [SwaggerClient::GetSitesResponse](docs/GetSitesResponse.md)
|
|
276
|
+
- [SwaggerClient::GetStaffAppointmentsRequest](docs/GetStaffAppointmentsRequest.md)
|
|
277
|
+
- [SwaggerClient::GetStaffAppointmentsResponse](docs/GetStaffAppointmentsResponse.md)
|
|
278
|
+
- [SwaggerClient::GetStaffPermissionsRequest](docs/GetStaffPermissionsRequest.md)
|
|
279
|
+
- [SwaggerClient::GetStaffPermissionsResponse](docs/GetStaffPermissionsResponse.md)
|
|
280
|
+
- [SwaggerClient::GetStaffRequest](docs/GetStaffRequest.md)
|
|
281
|
+
- [SwaggerClient::GetStaffResponse](docs/GetStaffResponse.md)
|
|
282
|
+
- [SwaggerClient::GetTimeClockRequest](docs/GetTimeClockRequest.md)
|
|
283
|
+
- [SwaggerClient::GetTimeClockResponse](docs/GetTimeClockResponse.md)
|
|
284
|
+
- [SwaggerClient::GetWaitlistEntriesRequest](docs/GetWaitlistEntriesRequest.md)
|
|
285
|
+
- [SwaggerClient::GetWaitlistEntriesResponse](docs/GetWaitlistEntriesResponse.md)
|
|
286
|
+
- [SwaggerClient::GiftCard](docs/GiftCard.md)
|
|
287
|
+
- [SwaggerClient::GiftCardLayout](docs/GiftCardLayout.md)
|
|
288
|
+
- [SwaggerClient::IssueRequest](docs/IssueRequest.md)
|
|
289
|
+
- [SwaggerClient::IssueResponse](docs/IssueResponse.md)
|
|
290
|
+
- [SwaggerClient::Level](docs/Level.md)
|
|
291
|
+
- [SwaggerClient::Liability](docs/Liability.md)
|
|
292
|
+
- [SwaggerClient::Location](docs/Location.md)
|
|
293
|
+
- [SwaggerClient::MembershipTypeRestriction](docs/MembershipTypeRestriction.md)
|
|
294
|
+
- [SwaggerClient::ModelClass](docs/ModelClass.md)
|
|
295
|
+
- [SwaggerClient::Package](docs/Package.md)
|
|
296
|
+
- [SwaggerClient::PaginationResponse](docs/PaginationResponse.md)
|
|
297
|
+
- [SwaggerClient::Product](docs/Product.md)
|
|
298
|
+
- [SwaggerClient::Program](docs/Program.md)
|
|
299
|
+
- [SwaggerClient::ProspectStage](docs/ProspectStage.md)
|
|
300
|
+
- [SwaggerClient::PurchaseContractRequest](docs/PurchaseContractRequest.md)
|
|
301
|
+
- [SwaggerClient::PurchaseContractResponse](docs/PurchaseContractResponse.md)
|
|
302
|
+
- [SwaggerClient::PurchaseGiftCardRequest](docs/PurchaseGiftCardRequest.md)
|
|
303
|
+
- [SwaggerClient::PurchaseGiftCardResponse](docs/PurchaseGiftCardResponse.md)
|
|
304
|
+
- [SwaggerClient::PurchasedItem](docs/PurchasedItem.md)
|
|
305
|
+
- [SwaggerClient::Relationship](docs/Relationship.md)
|
|
306
|
+
- [SwaggerClient::RemoveClientFromClassRequest](docs/RemoveClientFromClassRequest.md)
|
|
307
|
+
- [SwaggerClient::RemoveClientFromClassResponse](docs/RemoveClientFromClassResponse.md)
|
|
308
|
+
- [SwaggerClient::RemoveFromWaitlistRequest](docs/RemoveFromWaitlistRequest.md)
|
|
309
|
+
- [SwaggerClient::RemoveFromWaitlistResponse](docs/RemoveFromWaitlistResponse.md)
|
|
310
|
+
- [SwaggerClient::Resource](docs/Resource.md)
|
|
311
|
+
- [SwaggerClient::Sale](docs/Sale.md)
|
|
312
|
+
- [SwaggerClient::SalePayment](docs/SalePayment.md)
|
|
313
|
+
- [SwaggerClient::SalesRep](docs/SalesRep.md)
|
|
314
|
+
- [SwaggerClient::SendPasswordResetEmailRequest](docs/SendPasswordResetEmailRequest.md)
|
|
315
|
+
- [SwaggerClient::Service](docs/Service.md)
|
|
316
|
+
- [SwaggerClient::SessionType](docs/SessionType.md)
|
|
317
|
+
- [SwaggerClient::Site](docs/Site.md)
|
|
318
|
+
- [SwaggerClient::Size](docs/Size.md)
|
|
319
|
+
- [SwaggerClient::Staff](docs/Staff.md)
|
|
320
|
+
- [SwaggerClient::StaffPermissionGroup](docs/StaffPermissionGroup.md)
|
|
321
|
+
- [SwaggerClient::StoredCardInfo](docs/StoredCardInfo.md)
|
|
322
|
+
- [SwaggerClient::SubstituteClassTeacherRequest](docs/SubstituteClassTeacherRequest.md)
|
|
323
|
+
- [SwaggerClient::SubstituteClassTeacherResponse](docs/SubstituteClassTeacherResponse.md)
|
|
324
|
+
- [SwaggerClient::SubstituteTeacherClass](docs/SubstituteTeacherClass.md)
|
|
325
|
+
- [SwaggerClient::TimeCardEvent](docs/TimeCardEvent.md)
|
|
326
|
+
- [SwaggerClient::TimeClockReport](docs/TimeClockReport.md)
|
|
327
|
+
- [SwaggerClient::Unavailability](docs/Unavailability.md)
|
|
328
|
+
- [SwaggerClient::UpcomingAutopayEvent](docs/UpcomingAutopayEvent.md)
|
|
329
|
+
- [SwaggerClient::UpdateAppointmentRequest](docs/UpdateAppointmentRequest.md)
|
|
330
|
+
- [SwaggerClient::UpdateAppointmentResponse](docs/UpdateAppointmentResponse.md)
|
|
331
|
+
- [SwaggerClient::UpdateClientRequest](docs/UpdateClientRequest.md)
|
|
332
|
+
- [SwaggerClient::UpdateClientResponse](docs/UpdateClientResponse.md)
|
|
333
|
+
- [SwaggerClient::UpdateClientServiceRequest](docs/UpdateClientServiceRequest.md)
|
|
334
|
+
- [SwaggerClient::UpdateClientServiceResponse](docs/UpdateClientServiceResponse.md)
|
|
335
|
+
- [SwaggerClient::UpdateClientVisitRequest](docs/UpdateClientVisitRequest.md)
|
|
336
|
+
- [SwaggerClient::UpdateClientVisitResponse](docs/UpdateClientVisitResponse.md)
|
|
337
|
+
- [SwaggerClient::UpdateContactLogComment](docs/UpdateContactLogComment.md)
|
|
338
|
+
- [SwaggerClient::UpdateContactLogRequest](docs/UpdateContactLogRequest.md)
|
|
339
|
+
- [SwaggerClient::UpdateContactLogType](docs/UpdateContactLogType.md)
|
|
340
|
+
- [SwaggerClient::UploadClientDocumentRequest](docs/UploadClientDocumentRequest.md)
|
|
341
|
+
- [SwaggerClient::UploadClientDocumentResponse](docs/UploadClientDocumentResponse.md)
|
|
342
|
+
- [SwaggerClient::UploadClientPhotoRequest](docs/UploadClientPhotoRequest.md)
|
|
343
|
+
- [SwaggerClient::UploadClientPhotoResponse](docs/UploadClientPhotoResponse.md)
|
|
344
|
+
- [SwaggerClient::User](docs/User.md)
|
|
345
|
+
- [SwaggerClient::Visit](docs/Visit.md)
|
|
346
|
+
- [SwaggerClient::WaitlistEntry](docs/WaitlistEntry.md)
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
## Documentation for Authorization
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
### API-Key
|
|
353
|
+
|
|
354
|
+
- **Type**: API key
|
|
355
|
+
- **API key parameter name**: API-Key
|
|
356
|
+
- **Location**: HTTP header
|
|
357
|
+
|
data/Rakefile
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# SwaggerClient::AddAppointmentRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**apply_payment** | **BOOLEAN** | When `true`, indicates that a payment should be applied to the appointment. <br />Default: **true** | [optional]
|
|
7
|
+
**client_id** | **String** | The RRSID of the client for whom the new appointment is being made. |
|
|
8
|
+
**duration** | **Integer** | The duration of the appointment. This parameter is used to change the default duration of an appointment. | [optional]
|
|
9
|
+
**execute** | **String** | The action taken to add this appointment. | [optional]
|
|
10
|
+
**end_date_time** | **DateTime** | The end date and time of the new appointment. <br /> Default: **StartDateTime**, offset by the staff member’s default appointment duration. | [optional]
|
|
11
|
+
**gender_preference** | **String** | The client’s service provider gender preference. | [optional]
|
|
12
|
+
**location_id** | **Integer** | The ID of the location where the new appointment is to take place. |
|
|
13
|
+
**notes** | **String** | Any general notes about this appointment. | [optional]
|
|
14
|
+
**provider_id** | **String** | If a user has Complementary and Alternative Medicine features enabled, this parameter assigns a provider ID to the appointment. | [optional]
|
|
15
|
+
**resource_ids** | **Array<Integer>** | A list of resource IDs to associate with the new appointment. | [optional]
|
|
16
|
+
**send_email** | **BOOLEAN** | Whether to send client an email for cancellations. An email is sent only if the client has an email address and automatic emails have been set up. <br />Default: **false** | [optional]
|
|
17
|
+
**session_type_id** | **Integer** | The session type associated with the new appointment. |
|
|
18
|
+
**staff_id** | **Integer** | The ID of the staff member who is adding the new appointment. |
|
|
19
|
+
**staff_requested** | **BOOLEAN** | When `true`, indicates that the staff member was requested specifically by the client. | [optional]
|
|
20
|
+
**start_date_time** | **DateTime** | The start date and time of the new appointment. |
|
|
21
|
+
**test** | **BOOLEAN** | When true, indicates that the method is to be validated, but no new appointment data is added. <br />Default: **false** | [optional]
|
|
22
|
+
|
|
23
|
+
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# SwaggerClient::AddAppointmentResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**appointment** | [**Appointment**](Appointment.md) | Contains information about the appointment. | [optional]
|
|
7
|
+
|
|
8
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# SwaggerClient::AddArrivalRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**client_id** | **String** | The ID of the requested client. |
|
|
7
|
+
**location_id** | **Integer** | The ID of the location for the requested arrival. |
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# SwaggerClient::AddArrivalResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**arrival_added** | **BOOLEAN** | When `true`, indicates that the arrival was added to the database. | [optional]
|
|
7
|
+
**client_service** | [**ClientService**](ClientService.md) | Contains information about the pricing option being used to pay for the client’s current service session. | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# SwaggerClient::AddClientRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**account_balance** | **Float** | The client’s current [account balance](https://mindbody-online-support.force.com/support/s/article/203262013-Adding-account-payments-video-tutorial?language=en_US). | [optional]
|
|
7
|
+
**action** | **String** | The action taken. | [optional]
|
|
8
|
+
**active** | **BOOLEAN** | When `true`, indicates that the client is active at the site.<br /> When `false`, indicates that the client is not active at the site. | [optional]
|
|
9
|
+
**address_line1** | **String** | The first line of the client’s street address. | [optional]
|
|
10
|
+
**address_line2** | **String** | The second line of the client’s street address, if needed. | [optional]
|
|
11
|
+
**appt_gender_pref_male** | **BOOLEAN** | When `true`, indicates that the client prefers services to be provided by a male service provider.<br /> When `false`, indicates that the client prefers services to be provided by a female service provider.<br /> When `null`, indicates that the client has no preference. Default: **null** | [optional]
|
|
12
|
+
**birth_date** | **DateTime** | The client’s date of birth. | [optional]
|
|
13
|
+
**city** | **String** | The client’s city. | [optional]
|
|
14
|
+
**client_credit_card** | [**ClientCreditCard**](ClientCreditCard.md) | Contains information about the client’s credit card. | [optional]
|
|
15
|
+
**client_indexes** | [**Array<AssignedClientIndex>**](AssignedClientIndex.md) | Contains a list of the indexes and client index values to be assigned to the client. | [optional]
|
|
16
|
+
**client_relationships** | [**Array<ClientRelationship>**](ClientRelationship.md) | Contains information about client relationships to be assigned to the client. | [optional]
|
|
17
|
+
**country** | **String** | The country in which the client is located. | [optional]
|
|
18
|
+
**creation_date** | **DateTime** | The date when the client was added to the business, either by the client from the online store or by a staff member at the subscriber’s business. This value always returns in the format yyyy-mm-ddThh:mm:ss:ms. | [optional]
|
|
19
|
+
**custom_client_fields** | [**Array<CustomClientFieldValue>**](CustomClientFieldValue.md) | Contains information about the custom fields to be assigned to the client. | [optional]
|
|
20
|
+
**email** | **String** | The client’s email address. | [optional]
|
|
21
|
+
**emergency_contact_info_email** | **String** | The email address of the client’s emergency contact.<br /> For more information, see [Children’s program features(emergency contact information)](https://support.mindbodyonline.com/s/article/203259283-Children-s-program-features-emergency-contact-information?language=en_US). | [optional]
|
|
22
|
+
**emergency_contact_info_name** | **String** | The name of the client’s emergency contact. | [optional]
|
|
23
|
+
**emergency_contact_info_phone** | **String** | The phone number of the client’s emergency contact. | [optional]
|
|
24
|
+
**emergency_contact_info_relationship** | **String** | The client’s relationship with the emergency contact, for example, mother or spouse. | [optional]
|
|
25
|
+
**first_appointment_date** | **DateTime** | The date of the client’s first booked appointment at the business. | [optional]
|
|
26
|
+
**first_name** | **String** | The client’s first name. You must specify a first name when you add a client. |
|
|
27
|
+
**gender** | **String** | The client’s gender. | [optional]
|
|
28
|
+
**home_location** | [**Location**](Location.md) | Sets the client’s home location to the passed location, based on its ID. | [optional]
|
|
29
|
+
**home_phone** | **String** | The client’s home phone number. | [optional]
|
|
30
|
+
**is_company** | **BOOLEAN** | When `true`, indicates that the client should be marked as a company at the business.<br /> When `false`, indicates the client is an individual and does not represent a company. | [optional]
|
|
31
|
+
**is_prospect** | **BOOLEAN** | This value is set only if the business owner allows individuals to be prospects.<br /> When `true`, indicates that the client should be marked as a prospect for the business.<br /> When `false`, indicates that the client should not be marked as a prospect for the business. | [optional]
|
|
32
|
+
**last_formula_notes** | **String** | The last [formula note](https://support.mindbodyonline.com/s/article/203259903-Appointments-Formula-notes?language=en_US) entered for the client. | [optional]
|
|
33
|
+
**last_modified_date_time** | **DateTime** | The UTC date and time when the client’s information was last modified. | [optional]
|
|
34
|
+
**last_name** | **String** | The client’s last name. You must specify a last name when you add a client. |
|
|
35
|
+
**liability** | [**Liability**](Liability.md) | Contains the client’s liability agreement information for the business. | [optional]
|
|
36
|
+
**liability_release** | **BOOLEAN** | Passing `true` sets the client’s liability information as follows: * `IsReleased` is set to `true`. * `AgreementDate` is set to the time zone of the business when the call was processed. * `ReleasedBy` is set to `null` if the call is made by the client, `0` if the call was made by the business owner, or to a specific staff member’s ID if a staff member made the call. Passing `false` sets the client’s liability information as follows: * `IsReleased` is set to `false`. * `AgreementDate` is set to `null`. * `ReleasedBy` is set to `null`. | [optional]
|
|
37
|
+
**membership_icon** | **Integer** | The ID of the membership icon displayed next to the client’s name, if the client has a membership on their account. | [optional]
|
|
38
|
+
**middle_name** | **String** | The client’s middle name. | [optional]
|
|
39
|
+
**mobile_phone** | **String** | The client’s mobile phone number. | [optional]
|
|
40
|
+
**mobile_provider** | **Integer** | The client's mobile provider. | [optional]
|
|
41
|
+
**new_id** | **String** | When passed, sets the client's ID to this value. Otherwise, the client's ID will match their `UniqueId`. | [optional]
|
|
42
|
+
**notes** | **String** | Any notes entered on the client’s account by staff members. This value should never be shown to clients unless the business owner has a specific reason for showing them. | [optional]
|
|
43
|
+
**photo_url** | **String** | The URL for the client’s photo, if one has been uploaded. | [optional]
|
|
44
|
+
**postal_code** | **String** | The client’s postal code. | [optional]
|
|
45
|
+
**prospect_stage** | [**ProspectStage**](ProspectStage.md) | Contains information about the client [prospect stage](https://support.mindbodyonline.com/s/article/206176457-Prospect-Stages?language=en_US). | [optional]
|
|
46
|
+
**red_alert** | **String** | Contains any red alert information entered by the business owner for the client. | [optional]
|
|
47
|
+
**referred_by** | **String** | Specifies how the client was referred to the business. You can get a list of possible strings using the `GET ClientReferralTypes` endpoint.<br /> For more information, see [Referral types and referral subtypes](https://support.mindbodyonline.com/s/article/203259393-Referral-types-and-referral-subtypes?language=en_US). | [optional]
|
|
48
|
+
**sales_reps** | [**Array<SalesRep>**](SalesRep.md) | Contains information about the sales representatives to be assigned to the new client. | [optional]
|
|
49
|
+
**site_id** | **Integer** | The ID of the site. | [optional]
|
|
50
|
+
**state** | **String** | The client’s state. | [optional]
|
|
51
|
+
**status** | **String** | The client’s status. | [optional]
|
|
52
|
+
**test** | **BOOLEAN** | When `true`, indicates that test mode is enabled. The method is validated, but no client data is added or updated.<br /> Default: **false** | [optional]
|
|
53
|
+
**unique_id** | **Integer** | The client’s system-generated ID at the business. This value cannot be changed by business owners and is always unique across all clients at the business. This ID is not widely used in the Public API, but can be used by your application to uniquely identify clients. | [optional]
|
|
54
|
+
**work_extension** | **String** | The client’s work phone extension number. | [optional]
|
|
55
|
+
**work_phone** | **String** | The client’s work phone number. | [optional]
|
|
56
|
+
**yellow_alert** | **String** | Contains any yellow alert information entered by the business owner for the client. | [optional]
|
|
57
|
+
**send_schedule_emails** | **BOOLEAN** | When `true`, indicates that the client opts to receive schedule emails. | [optional]
|
|
58
|
+
**send_account_emails** | **BOOLEAN** | When `true`, indicates that the client opts to receive account emails. | [optional]
|
|
59
|
+
**send_promotional_emails** | **BOOLEAN** | When `true`, indicates that the client opts to receive promotional emails. | [optional]
|
|
60
|
+
|
|
61
|
+
|