mindbody-api-v6 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (624) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +7 -0
  3. data/README.md +357 -0
  4. data/Rakefile +8 -0
  5. data/docs/AddAppointmentRequest.md +23 -0
  6. data/docs/AddAppointmentResponse.md +8 -0
  7. data/docs/AddArrivalRequest.md +9 -0
  8. data/docs/AddArrivalResponse.md +9 -0
  9. data/docs/AddClientRequest.md +61 -0
  10. data/docs/AddClientResponse.md +8 -0
  11. data/docs/AddClientToClassRequest.md +17 -0
  12. data/docs/AddClientToClassResponse.md +8 -0
  13. data/docs/AddClientToClassVisit.md +28 -0
  14. data/docs/AddClientToEnrollmentRequest.md +15 -0
  15. data/docs/AddContactLogRequest.md +16 -0
  16. data/docs/AddContactLogType.md +9 -0
  17. data/docs/Amenity.md +9 -0
  18. data/docs/Appointment.md +24 -0
  19. data/docs/AppointmentApi.md +460 -0
  20. data/docs/AppointmentOption.md +11 -0
  21. data/docs/AssignedClientIndex.md +9 -0
  22. data/docs/AutopaySchedule.md +10 -0
  23. data/docs/Availability.md +15 -0
  24. data/docs/BookingWindow.md +11 -0
  25. data/docs/CheckoutAppointmentBookingRequest.md +14 -0
  26. data/docs/CheckoutItem.md +9 -0
  27. data/docs/CheckoutItemWrapper.md +17 -0
  28. data/docs/CheckoutPaymentInfo.md +9 -0
  29. data/docs/CheckoutShoppingCartRequest.md +18 -0
  30. data/docs/ClassApi.md +589 -0
  31. data/docs/ClassDescription.md +22 -0
  32. data/docs/ClassPayrollEvent.md +10 -0
  33. data/docs/ClassSchedule.md +29 -0
  34. data/docs/Client.md +61 -0
  35. data/docs/ClientApi.md +1473 -0
  36. data/docs/ClientContract.md +16 -0
  37. data/docs/ClientCreditCard.md +17 -0
  38. data/docs/ClientDocument.md +10 -0
  39. data/docs/ClientIndex.md +13 -0
  40. data/docs/ClientIndexValue.md +10 -0
  41. data/docs/ClientMembership.md +20 -0
  42. data/docs/ClientPurchaseRecord.md +16 -0
  43. data/docs/ClientRelationship.md +10 -0
  44. data/docs/ClientService.md +18 -0
  45. data/docs/Color.md +9 -0
  46. data/docs/ContactLog.md +18 -0
  47. data/docs/ContactLogComment.md +11 -0
  48. data/docs/ContactLogSubType.md +8 -0
  49. data/docs/ContactLogType.md +9 -0
  50. data/docs/Contract.md +41 -0
  51. data/docs/ContractItem.md +14 -0
  52. data/docs/Course.md +17 -0
  53. data/docs/CreditCardInfo.md +16 -0
  54. data/docs/CrossRegionalClientAssociation.md +10 -0
  55. data/docs/CustomClientField.md +10 -0
  56. data/docs/CustomClientFieldValue.md +11 -0
  57. data/docs/CustomPaymentMethod.md +9 -0
  58. data/docs/EnrollmentApi.md +137 -0
  59. data/docs/FormulaNote.md +12 -0
  60. data/docs/GetActivationCodeResponse.md +9 -0
  61. data/docs/GetActiveClientMembershipsRequest.md +11 -0
  62. data/docs/GetActiveClientMembershipsResponse.md +9 -0
  63. data/docs/GetActiveSessionTimesRequest.md +13 -0
  64. data/docs/GetActiveSessionTimesResponse.md +9 -0
  65. data/docs/GetAppointmentOptionsResponse.md +8 -0
  66. data/docs/GetBookableItemsRequest.md +16 -0
  67. data/docs/GetBookableItemsResponse.md +9 -0
  68. data/docs/GetClassDescriptionsRequest.md +15 -0
  69. data/docs/GetClassDescriptionsResponse.md +9 -0
  70. data/docs/GetClassPayrollRequest.md +13 -0
  71. data/docs/GetClassPayrollResponse.md +9 -0
  72. data/docs/GetClassSchedulesRequest.md +16 -0
  73. data/docs/GetClassSchedulesResponse.md +9 -0
  74. data/docs/GetClassVisitsRequest.md +9 -0
  75. data/docs/GetClassVisitsResponse.md +8 -0
  76. data/docs/GetClassesRequest.md +22 -0
  77. data/docs/GetClassesResponse.md +9 -0
  78. data/docs/GetClientAccountBalancesRequest.md +12 -0
  79. data/docs/GetClientAccountBalancesResponse.md +9 -0
  80. data/docs/GetClientContractsRequest.md +12 -0
  81. data/docs/GetClientContractsResponse.md +9 -0
  82. data/docs/GetClientFormulaNotesRequest.md +11 -0
  83. data/docs/GetClientFormulaNotesResponse.md +9 -0
  84. data/docs/GetClientIndexesRequest.md +8 -0
  85. data/docs/GetClientIndexesResponse.md +8 -0
  86. data/docs/GetClientPurchasesRequest.md +13 -0
  87. data/docs/GetClientPurchasesResponse.md +9 -0
  88. data/docs/GetClientReferralTypesRequest.md +8 -0
  89. data/docs/GetClientReferralTypesResponse.md +8 -0
  90. data/docs/GetClientServicesRequest.md +20 -0
  91. data/docs/GetClientServicesResponse.md +9 -0
  92. data/docs/GetClientVisitsRequest.md +15 -0
  93. data/docs/GetClientVisitsResponse.md +9 -0
  94. data/docs/GetClientsRequest.md +13 -0
  95. data/docs/GetClientsResponse.md +9 -0
  96. data/docs/GetContactLogsRequest.md +16 -0
  97. data/docs/GetContactLogsResponse.md +9 -0
  98. data/docs/GetContractsRequest.md +13 -0
  99. data/docs/GetContractsResponse.md +9 -0
  100. data/docs/GetCrossRegionalClientAssociationsRequest.md +11 -0
  101. data/docs/GetCrossRegionalClientAssociationsResponse.md +9 -0
  102. data/docs/GetCustomClientFieldsRequest.md +9 -0
  103. data/docs/GetCustomClientFieldsResponse.md +9 -0
  104. data/docs/GetCustomPaymentMethodsRequest.md +9 -0
  105. data/docs/GetCustomPaymentMethodsResponse.md +9 -0
  106. data/docs/GetEnrollmentsRequest.md +16 -0
  107. data/docs/GetEnrollmentsResponse.md +9 -0
  108. data/docs/GetGiftCardResponse.md +9 -0
  109. data/docs/GetGiftCardsRequest.md +12 -0
  110. data/docs/GetLocationsRequest.md +9 -0
  111. data/docs/GetLocationsResponse.md +9 -0
  112. data/docs/GetPackagesRequest.md +11 -0
  113. data/docs/GetPackagesResponse.md +9 -0
  114. data/docs/GetProductsRequest.md +15 -0
  115. data/docs/GetProductsResponse.md +9 -0
  116. data/docs/GetProgramsRequest.md +11 -0
  117. data/docs/GetProgramsResponse.md +9 -0
  118. data/docs/GetRequiredClientFieldsResponse.md +8 -0
  119. data/docs/GetResourcesRequest.md +13 -0
  120. data/docs/GetResourcesResponse.md +9 -0
  121. data/docs/GetSalesRequest.md +7 -0
  122. data/docs/GetSalesResponse.md +9 -0
  123. data/docs/GetScheduleItemsRequest.md +14 -0
  124. data/docs/GetScheduleItemsResponse.md +9 -0
  125. data/docs/GetServicesRequest.md +18 -0
  126. data/docs/GetServicesResponse.md +9 -0
  127. data/docs/GetSessionTypesRequest.md +11 -0
  128. data/docs/GetSessionTypesResponse.md +9 -0
  129. data/docs/GetSitesRequest.md +10 -0
  130. data/docs/GetSitesResponse.md +9 -0
  131. data/docs/GetStaffAppointmentsRequest.md +15 -0
  132. data/docs/GetStaffAppointmentsResponse.md +9 -0
  133. data/docs/GetStaffPermissionsRequest.md +8 -0
  134. data/docs/GetStaffPermissionsResponse.md +8 -0
  135. data/docs/GetStaffRequest.md +14 -0
  136. data/docs/GetStaffResponse.md +9 -0
  137. data/docs/GetTimeClockRequest.md +13 -0
  138. data/docs/GetTimeClockResponse.md +9 -0
  139. data/docs/GetWaitlistEntriesRequest.md +14 -0
  140. data/docs/GetWaitlistEntriesResponse.md +9 -0
  141. data/docs/GiftCard.md +19 -0
  142. data/docs/GiftCardLayout.md +9 -0
  143. data/docs/IssueRequest.md +9 -0
  144. data/docs/IssueResponse.md +10 -0
  145. data/docs/Level.md +10 -0
  146. data/docs/Liability.md +10 -0
  147. data/docs/Location.md +32 -0
  148. data/docs/MembershipTypeRestriction.md +9 -0
  149. data/docs/ModelClass.md +33 -0
  150. data/docs/Package.md +13 -0
  151. data/docs/PaginationResponse.md +11 -0
  152. data/docs/PayrollApi.md +140 -0
  153. data/docs/Product.md +18 -0
  154. data/docs/Program.md +11 -0
  155. data/docs/ProspectStage.md +10 -0
  156. data/docs/PurchaseContractRequest.md +18 -0
  157. data/docs/PurchaseContractResponse.md +11 -0
  158. data/docs/PurchaseGiftCardRequest.md +19 -0
  159. data/docs/PurchaseGiftCardResponse.md +17 -0
  160. data/docs/PurchasedItem.md +9 -0
  161. data/docs/Relationship.md +10 -0
  162. data/docs/RemoveClientFromClassRequest.md +12 -0
  163. data/docs/RemoveClientFromClassResponse.md +8 -0
  164. data/docs/RemoveFromWaitlistRequest.md +8 -0
  165. data/docs/RemoveFromWaitlistResponse.md +7 -0
  166. data/docs/Resource.md +9 -0
  167. data/docs/Sale.md +15 -0
  168. data/docs/SaleApi.md +683 -0
  169. data/docs/SalePayment.md +12 -0
  170. data/docs/SalesRep.md +12 -0
  171. data/docs/SendPasswordResetEmailRequest.md +10 -0
  172. data/docs/Service.md +16 -0
  173. data/docs/SessionType.md +17 -0
  174. data/docs/Site.md +27 -0
  175. data/docs/SiteApi.md +362 -0
  176. data/docs/Size.md +9 -0
  177. data/docs/Staff.md +31 -0
  178. data/docs/StaffApi.md +131 -0
  179. data/docs/StaffPermissionGroup.md +11 -0
  180. data/docs/StoredCardInfo.md +8 -0
  181. data/docs/SubstituteClassTeacherRequest.md +13 -0
  182. data/docs/SubstituteClassTeacherResponse.md +8 -0
  183. data/docs/SubstituteTeacherClass.md +27 -0
  184. data/docs/TimeCardEvent.md +10 -0
  185. data/docs/TimeClockReport.md +13 -0
  186. data/docs/Unavailability.md +11 -0
  187. data/docs/UpcomingAutopayEvent.md +11 -0
  188. data/docs/UpdateAppointmentRequest.md +19 -0
  189. data/docs/UpdateAppointmentResponse.md +8 -0
  190. data/docs/UpdateClientRequest.md +11 -0
  191. data/docs/UpdateClientResponse.md +8 -0
  192. data/docs/UpdateClientServiceRequest.md +11 -0
  193. data/docs/UpdateClientServiceResponse.md +8 -0
  194. data/docs/UpdateClientVisitRequest.md +13 -0
  195. data/docs/UpdateClientVisitResponse.md +8 -0
  196. data/docs/UpdateContactLogComment.md +9 -0
  197. data/docs/UpdateContactLogRequest.md +16 -0
  198. data/docs/UpdateContactLogType.md +9 -0
  199. data/docs/UploadClientDocumentRequest.md +9 -0
  200. data/docs/UploadClientDocumentResponse.md +9 -0
  201. data/docs/UploadClientPhotoRequest.md +9 -0
  202. data/docs/UploadClientPhotoResponse.md +9 -0
  203. data/docs/User.md +11 -0
  204. data/docs/UserTokenApi.md +115 -0
  205. data/docs/Visit.md +25 -0
  206. data/docs/WaitlistEntry.md +16 -0
  207. data/git_push.sh +55 -0
  208. data/lib/swagger_client.rb +241 -0
  209. data/lib/swagger_client/api/appointment_api.rb +570 -0
  210. data/lib/swagger_client/api/class_api.rb +727 -0
  211. data/lib/swagger_client/api/client_api.rb +1795 -0
  212. data/lib/swagger_client/api/enrollment_api.rb +180 -0
  213. data/lib/swagger_client/api/payroll_api.rb +181 -0
  214. data/lib/swagger_client/api/sale_api.rb +829 -0
  215. data/lib/swagger_client/api/site_api.rb +433 -0
  216. data/lib/swagger_client/api/staff_api.rb +171 -0
  217. data/lib/swagger_client/api/user_token_api.rb +150 -0
  218. data/lib/swagger_client/api_client.rb +389 -0
  219. data/lib/swagger_client/api_error.rb +38 -0
  220. data/lib/swagger_client/configuration.rb +209 -0
  221. data/lib/swagger_client/models/add_appointment_request.rb +395 -0
  222. data/lib/swagger_client/models/add_appointment_response.rb +184 -0
  223. data/lib/swagger_client/models/add_arrival_request.rb +204 -0
  224. data/lib/swagger_client/models/add_arrival_response.rb +194 -0
  225. data/lib/swagger_client/models/add_client_request.rb +766 -0
  226. data/lib/swagger_client/models/add_client_response.rb +184 -0
  227. data/lib/swagger_client/models/add_client_to_class_request.rb +284 -0
  228. data/lib/swagger_client/models/add_client_to_class_response.rb +184 -0
  229. data/lib/swagger_client/models/add_client_to_class_visit.rb +442 -0
  230. data/lib/swagger_client/models/add_client_to_enrollment_request.rb +266 -0
  231. data/lib/swagger_client/models/add_contact_log_request.rb +278 -0
  232. data/lib/swagger_client/models/add_contact_log_type.rb +197 -0
  233. data/lib/swagger_client/models/amenity.rb +195 -0
  234. data/lib/swagger_client/models/appointment.rb +393 -0
  235. data/lib/swagger_client/models/appointment_option.rb +215 -0
  236. data/lib/swagger_client/models/assigned_client_index.rb +195 -0
  237. data/lib/swagger_client/models/autopay_schedule.rb +204 -0
  238. data/lib/swagger_client/models/availability.rb +257 -0
  239. data/lib/swagger_client/models/booking_window.rb +215 -0
  240. data/lib/swagger_client/models/checkout_appointment_booking_request.rb +246 -0
  241. data/lib/swagger_client/models/checkout_item.rb +196 -0
  242. data/lib/swagger_client/models/checkout_item_wrapper.rb +286 -0
  243. data/lib/swagger_client/models/checkout_payment_info.rb +196 -0
  244. data/lib/swagger_client/models/checkout_shopping_cart_request.rb +318 -0
  245. data/lib/swagger_client/models/class_description.rb +325 -0
  246. data/lib/swagger_client/models/class_payroll_event.rb +204 -0
  247. data/lib/swagger_client/models/class_schedule.rb +399 -0
  248. data/lib/swagger_client/models/client.rb +769 -0
  249. data/lib/swagger_client/models/client_contract.rb +301 -0
  250. data/lib/swagger_client/models/client_credit_card.rb +275 -0
  251. data/lib/swagger_client/models/client_document.rb +238 -0
  252. data/lib/swagger_client/models/client_index.rb +271 -0
  253. data/lib/swagger_client/models/client_index_value.rb +205 -0
  254. data/lib/swagger_client/models/client_membership.rb +340 -0
  255. data/lib/swagger_client/models/client_purchase_record.rb +265 -0
  256. data/lib/swagger_client/models/client_relationship.rb +205 -0
  257. data/lib/swagger_client/models/client_service.rb +319 -0
  258. data/lib/swagger_client/models/color.rb +195 -0
  259. data/lib/swagger_client/models/contact_log.rb +289 -0
  260. data/lib/swagger_client/models/contact_log_comment.rb +215 -0
  261. data/lib/swagger_client/models/contact_log_sub_type.rb +185 -0
  262. data/lib/swagger_client/models/contact_log_type.rb +197 -0
  263. data/lib/swagger_client/models/contract.rb +522 -0
  264. data/lib/swagger_client/models/contract_item.rb +244 -0
  265. data/lib/swagger_client/models/course.rb +275 -0
  266. data/lib/swagger_client/models/credit_card_info.rb +256 -0
  267. data/lib/swagger_client/models/cross_regional_client_association.rb +205 -0
  268. data/lib/swagger_client/models/custom_client_field.rb +205 -0
  269. data/lib/swagger_client/models/custom_client_field_value.rb +215 -0
  270. data/lib/swagger_client/models/custom_payment_method.rb +194 -0
  271. data/lib/swagger_client/models/formula_note.rb +225 -0
  272. data/lib/swagger_client/models/get_activation_code_response.rb +194 -0
  273. data/lib/swagger_client/models/get_active_client_memberships_request.rb +219 -0
  274. data/lib/swagger_client/models/get_active_client_memberships_response.rb +196 -0
  275. data/lib/swagger_client/models/get_active_session_times_request.rb +270 -0
  276. data/lib/swagger_client/models/get_active_session_times_response.rb +196 -0
  277. data/lib/swagger_client/models/get_appointment_options_response.rb +186 -0
  278. data/lib/swagger_client/models/get_bookable_items_request.rb +275 -0
  279. data/lib/swagger_client/models/get_bookable_items_response.rb +196 -0
  280. data/lib/swagger_client/models/get_class_descriptions_request.rb +256 -0
  281. data/lib/swagger_client/models/get_class_descriptions_response.rb +196 -0
  282. data/lib/swagger_client/models/get_class_payroll_request.rb +234 -0
  283. data/lib/swagger_client/models/get_class_payroll_response.rb +196 -0
  284. data/lib/swagger_client/models/get_class_schedules_request.rb +274 -0
  285. data/lib/swagger_client/models/get_class_schedules_response.rb +196 -0
  286. data/lib/swagger_client/models/get_class_visits_request.rb +194 -0
  287. data/lib/swagger_client/models/get_class_visits_response.rb +184 -0
  288. data/lib/swagger_client/models/get_classes_request.rb +338 -0
  289. data/lib/swagger_client/models/get_classes_response.rb +196 -0
  290. data/lib/swagger_client/models/get_client_account_balances_request.rb +231 -0
  291. data/lib/swagger_client/models/get_client_account_balances_response.rb +196 -0
  292. data/lib/swagger_client/models/get_client_contracts_request.rb +229 -0
  293. data/lib/swagger_client/models/get_client_contracts_response.rb +196 -0
  294. data/lib/swagger_client/models/get_client_formula_notes_request.rb +214 -0
  295. data/lib/swagger_client/models/get_client_formula_notes_response.rb +196 -0
  296. data/lib/swagger_client/models/get_client_indexes_request.rb +184 -0
  297. data/lib/swagger_client/models/get_client_indexes_response.rb +186 -0
  298. data/lib/swagger_client/models/get_client_purchases_request.rb +239 -0
  299. data/lib/swagger_client/models/get_client_purchases_response.rb +196 -0
  300. data/lib/swagger_client/models/get_client_referral_types_request.rb +184 -0
  301. data/lib/swagger_client/models/get_client_referral_types_response.rb +186 -0
  302. data/lib/swagger_client/models/get_client_services_request.rb +313 -0
  303. data/lib/swagger_client/models/get_client_services_response.rb +196 -0
  304. data/lib/swagger_client/models/get_client_visits_request.rb +259 -0
  305. data/lib/swagger_client/models/get_client_visits_response.rb +196 -0
  306. data/lib/swagger_client/models/get_clients_request.rb +236 -0
  307. data/lib/swagger_client/models/get_clients_response.rb +196 -0
  308. data/lib/swagger_client/models/get_contact_logs_request.rb +275 -0
  309. data/lib/swagger_client/models/get_contact_logs_response.rb +196 -0
  310. data/lib/swagger_client/models/get_contracts_request.rb +241 -0
  311. data/lib/swagger_client/models/get_contracts_response.rb +196 -0
  312. data/lib/swagger_client/models/get_cross_regional_client_associations_request.rb +214 -0
  313. data/lib/swagger_client/models/get_cross_regional_client_associations_response.rb +196 -0
  314. data/lib/swagger_client/models/get_custom_client_fields_request.rb +194 -0
  315. data/lib/swagger_client/models/get_custom_client_fields_response.rb +196 -0
  316. data/lib/swagger_client/models/get_custom_payment_methods_request.rb +194 -0
  317. data/lib/swagger_client/models/get_custom_payment_methods_response.rb +196 -0
  318. data/lib/swagger_client/models/get_enrollments_request.rb +274 -0
  319. data/lib/swagger_client/models/get_enrollments_response.rb +196 -0
  320. data/lib/swagger_client/models/get_gift_card_response.rb +196 -0
  321. data/lib/swagger_client/models/get_gift_cards_request.rb +226 -0
  322. data/lib/swagger_client/models/get_locations_request.rb +194 -0
  323. data/lib/swagger_client/models/get_locations_response.rb +196 -0
  324. data/lib/swagger_client/models/get_packages_request.rb +216 -0
  325. data/lib/swagger_client/models/get_packages_response.rb +196 -0
  326. data/lib/swagger_client/models/get_products_request.rb +260 -0
  327. data/lib/swagger_client/models/get_products_response.rb +196 -0
  328. data/lib/swagger_client/models/get_programs_request.rb +248 -0
  329. data/lib/swagger_client/models/get_programs_response.rb +196 -0
  330. data/lib/swagger_client/models/get_required_client_fields_response.rb +186 -0
  331. data/lib/swagger_client/models/get_resources_request.rb +236 -0
  332. data/lib/swagger_client/models/get_resources_response.rb +196 -0
  333. data/lib/swagger_client/models/get_sales_request.rb +174 -0
  334. data/lib/swagger_client/models/get_sales_response.rb +196 -0
  335. data/lib/swagger_client/models/get_schedule_items_request.rb +248 -0
  336. data/lib/swagger_client/models/get_schedule_items_response.rb +196 -0
  337. data/lib/swagger_client/models/get_services_request.rb +290 -0
  338. data/lib/swagger_client/models/get_services_response.rb +196 -0
  339. data/lib/swagger_client/models/get_session_types_request.rb +216 -0
  340. data/lib/swagger_client/models/get_session_types_response.rb +196 -0
  341. data/lib/swagger_client/models/get_sites_request.rb +206 -0
  342. data/lib/swagger_client/models/get_sites_response.rb +196 -0
  343. data/lib/swagger_client/models/get_staff_appointments_request.rb +262 -0
  344. data/lib/swagger_client/models/get_staff_appointments_response.rb +196 -0
  345. data/lib/swagger_client/models/get_staff_permissions_request.rb +189 -0
  346. data/lib/swagger_client/models/get_staff_permissions_response.rb +184 -0
  347. data/lib/swagger_client/models/get_staff_request.rb +248 -0
  348. data/lib/swagger_client/models/get_staff_response.rb +195 -0
  349. data/lib/swagger_client/models/get_time_clock_request.rb +234 -0
  350. data/lib/swagger_client/models/get_time_clock_response.rb +196 -0
  351. data/lib/swagger_client/models/get_waitlist_entries_request.rb +252 -0
  352. data/lib/swagger_client/models/get_waitlist_entries_response.rb +196 -0
  353. data/lib/swagger_client/models/gift_card.rb +300 -0
  354. data/lib/swagger_client/models/gift_card_layout.rb +195 -0
  355. data/lib/swagger_client/models/issue_request.rb +195 -0
  356. data/lib/swagger_client/models/issue_response.rb +204 -0
  357. data/lib/swagger_client/models/level.rb +205 -0
  358. data/lib/swagger_client/models/liability.rb +204 -0
  359. data/lib/swagger_client/models/location.rb +428 -0
  360. data/lib/swagger_client/models/membership_type_restriction.rb +194 -0
  361. data/lib/swagger_client/models/model_class.rb +473 -0
  362. data/lib/swagger_client/models/package.rb +238 -0
  363. data/lib/swagger_client/models/pagination_response.rb +214 -0
  364. data/lib/swagger_client/models/product.rb +284 -0
  365. data/lib/swagger_client/models/program.rb +248 -0
  366. data/lib/swagger_client/models/prospect_stage.rb +204 -0
  367. data/lib/swagger_client/models/purchase_contract_request.rb +309 -0
  368. data/lib/swagger_client/models/purchase_contract_response.rb +214 -0
  369. data/lib/swagger_client/models/purchase_gift_card_request.rb +309 -0
  370. data/lib/swagger_client/models/purchase_gift_card_response.rb +274 -0
  371. data/lib/swagger_client/models/purchased_item.rb +194 -0
  372. data/lib/swagger_client/models/relationship.rb +205 -0
  373. data/lib/swagger_client/models/remove_client_from_class_request.rb +234 -0
  374. data/lib/swagger_client/models/remove_client_from_class_response.rb +184 -0
  375. data/lib/swagger_client/models/remove_from_waitlist_request.rb +191 -0
  376. data/lib/swagger_client/models/remove_from_waitlist_response.rb +174 -0
  377. data/lib/swagger_client/models/resource.rb +195 -0
  378. data/lib/swagger_client/models/sale.rb +258 -0
  379. data/lib/swagger_client/models/sale_payment.rb +224 -0
  380. data/lib/swagger_client/models/sales_rep.rb +226 -0
  381. data/lib/swagger_client/models/send_password_reset_email_request.rb +220 -0
  382. data/lib/swagger_client/models/service.rb +264 -0
  383. data/lib/swagger_client/models/session_type.rb +308 -0
  384. data/lib/swagger_client/models/site.rb +374 -0
  385. data/lib/swagger_client/models/size.rb +194 -0
  386. data/lib/swagger_client/models/staff.rb +420 -0
  387. data/lib/swagger_client/models/staff_permission_group.rb +240 -0
  388. data/lib/swagger_client/models/stored_card_info.rb +183 -0
  389. data/lib/swagger_client/models/substitute_class_teacher_request.rb +244 -0
  390. data/lib/swagger_client/models/substitute_class_teacher_response.rb +184 -0
  391. data/lib/swagger_client/models/substitute_teacher_class.rb +375 -0
  392. data/lib/swagger_client/models/time_card_event.rb +204 -0
  393. data/lib/swagger_client/models/time_clock_report.rb +236 -0
  394. data/lib/swagger_client/models/unavailability.rb +214 -0
  395. data/lib/swagger_client/models/upcoming_autopay_event.rb +248 -0
  396. data/lib/swagger_client/models/update_appointment_request.rb +301 -0
  397. data/lib/swagger_client/models/update_appointment_response.rb +184 -0
  398. data/lib/swagger_client/models/update_client_request.rb +219 -0
  399. data/lib/swagger_client/models/update_client_response.rb +184 -0
  400. data/lib/swagger_client/models/update_client_service_request.rb +219 -0
  401. data/lib/swagger_client/models/update_client_service_response.rb +184 -0
  402. data/lib/swagger_client/models/update_client_visit_request.rb +239 -0
  403. data/lib/swagger_client/models/update_client_visit_response.rb +184 -0
  404. data/lib/swagger_client/models/update_contact_log_comment.rb +194 -0
  405. data/lib/swagger_client/models/update_contact_log_request.rb +268 -0
  406. data/lib/swagger_client/models/update_contact_log_type.rb +196 -0
  407. data/lib/swagger_client/models/upload_client_document_request.rb +204 -0
  408. data/lib/swagger_client/models/upload_client_document_response.rb +194 -0
  409. data/lib/swagger_client/models/upload_client_photo_request.rb +223 -0
  410. data/lib/swagger_client/models/upload_client_photo_response.rb +194 -0
  411. data/lib/swagger_client/models/user.rb +214 -0
  412. data/lib/swagger_client/models/visit.rb +413 -0
  413. data/lib/swagger_client/models/waitlist_entry.rb +264 -0
  414. data/lib/swagger_client/version.rb +15 -0
  415. data/mindbody-api-6.0.0.gem +0 -0
  416. data/mindbody-swagger.gem +0 -0
  417. data/spec/api/appointment_api_spec.rb +165 -0
  418. data/spec/api/class_api_spec.rb +202 -0
  419. data/spec/api/client_api_spec.rb +435 -0
  420. data/spec/api/enrollment_api_spec.rb +72 -0
  421. data/spec/api/payroll_api_spec.rb +74 -0
  422. data/spec/api/sale_api_spec.rb +222 -0
  423. data/spec/api/site_api_spec.rb +132 -0
  424. data/spec/api/staff_api_spec.rb +69 -0
  425. data/spec/api/user_token_api_spec.rb +62 -0
  426. data/spec/api_client_spec.rb +226 -0
  427. data/spec/configuration_spec.rb +42 -0
  428. data/spec/models/add_appointment_request_spec.rb +135 -0
  429. data/spec/models/add_appointment_response_spec.rb +41 -0
  430. data/spec/models/add_arrival_request_spec.rb +47 -0
  431. data/spec/models/add_arrival_response_spec.rb +47 -0
  432. data/spec/models/add_client_request_spec.rb +363 -0
  433. data/spec/models/add_client_response_spec.rb +41 -0
  434. data/spec/models/add_client_to_class_request_spec.rb +95 -0
  435. data/spec/models/add_client_to_class_response_spec.rb +41 -0
  436. data/spec/models/add_client_to_class_visit_spec.rb +173 -0
  437. data/spec/models/add_client_to_enrollment_request_spec.rb +83 -0
  438. data/spec/models/add_contact_log_request_spec.rb +89 -0
  439. data/spec/models/add_contact_log_type_spec.rb +47 -0
  440. data/spec/models/amenity_spec.rb +47 -0
  441. data/spec/models/appointment_option_spec.rb +59 -0
  442. data/spec/models/appointment_spec.rb +145 -0
  443. data/spec/models/assigned_client_index_spec.rb +47 -0
  444. data/spec/models/autopay_schedule_spec.rb +53 -0
  445. data/spec/models/availability_spec.rb +83 -0
  446. data/spec/models/booking_window_spec.rb +59 -0
  447. data/spec/models/checkout_appointment_booking_request_spec.rb +77 -0
  448. data/spec/models/checkout_item_spec.rb +47 -0
  449. data/spec/models/checkout_item_wrapper_spec.rb +95 -0
  450. data/spec/models/checkout_payment_info_spec.rb +47 -0
  451. data/spec/models/checkout_shopping_cart_request_spec.rb +101 -0
  452. data/spec/models/class_description_spec.rb +125 -0
  453. data/spec/models/class_payroll_event_spec.rb +53 -0
  454. data/spec/models/class_schedule_spec.rb +167 -0
  455. data/spec/models/client_contract_spec.rb +93 -0
  456. data/spec/models/client_credit_card_spec.rb +95 -0
  457. data/spec/models/client_document_spec.rb +53 -0
  458. data/spec/models/client_index_spec.rb +75 -0
  459. data/spec/models/client_index_value_spec.rb +53 -0
  460. data/spec/models/client_membership_spec.rb +117 -0
  461. data/spec/models/client_purchase_record_spec.rb +89 -0
  462. data/spec/models/client_relationship_spec.rb +53 -0
  463. data/spec/models/client_service_spec.rb +105 -0
  464. data/spec/models/client_spec.rb +367 -0
  465. data/spec/models/color_spec.rb +47 -0
  466. data/spec/models/contact_log_comment_spec.rb +59 -0
  467. data/spec/models/contact_log_spec.rb +101 -0
  468. data/spec/models/contact_log_sub_type_spec.rb +41 -0
  469. data/spec/models/contact_log_type_spec.rb +47 -0
  470. data/spec/models/contract_item_spec.rb +77 -0
  471. data/spec/models/contract_spec.rb +239 -0
  472. data/spec/models/course_spec.rb +95 -0
  473. data/spec/models/credit_card_info_spec.rb +89 -0
  474. data/spec/models/cross_regional_client_association_spec.rb +53 -0
  475. data/spec/models/custom_client_field_spec.rb +53 -0
  476. data/spec/models/custom_client_field_value_spec.rb +59 -0
  477. data/spec/models/custom_payment_method_spec.rb +47 -0
  478. data/spec/models/formula_note_spec.rb +65 -0
  479. data/spec/models/get_activation_code_response_spec.rb +47 -0
  480. data/spec/models/get_active_client_memberships_request_spec.rb +59 -0
  481. data/spec/models/get_active_client_memberships_response_spec.rb +47 -0
  482. data/spec/models/get_active_session_times_request_spec.rb +75 -0
  483. data/spec/models/get_active_session_times_response_spec.rb +47 -0
  484. data/spec/models/get_appointment_options_response_spec.rb +41 -0
  485. data/spec/models/get_bookable_items_request_spec.rb +89 -0
  486. data/spec/models/get_bookable_items_response_spec.rb +47 -0
  487. data/spec/models/get_class_descriptions_request_spec.rb +83 -0
  488. data/spec/models/get_class_descriptions_response_spec.rb +47 -0
  489. data/spec/models/get_class_payroll_request_spec.rb +71 -0
  490. data/spec/models/get_class_payroll_response_spec.rb +47 -0
  491. data/spec/models/get_class_schedules_request_spec.rb +89 -0
  492. data/spec/models/get_class_schedules_response_spec.rb +47 -0
  493. data/spec/models/get_class_visits_request_spec.rb +47 -0
  494. data/spec/models/get_class_visits_response_spec.rb +41 -0
  495. data/spec/models/get_classes_request_spec.rb +125 -0
  496. data/spec/models/get_classes_response_spec.rb +47 -0
  497. data/spec/models/get_client_account_balances_request_spec.rb +65 -0
  498. data/spec/models/get_client_account_balances_response_spec.rb +47 -0
  499. data/spec/models/get_client_contracts_request_spec.rb +65 -0
  500. data/spec/models/get_client_contracts_response_spec.rb +47 -0
  501. data/spec/models/get_client_formula_notes_request_spec.rb +59 -0
  502. data/spec/models/get_client_formula_notes_response_spec.rb +47 -0
  503. data/spec/models/get_client_indexes_request_spec.rb +41 -0
  504. data/spec/models/get_client_indexes_response_spec.rb +41 -0
  505. data/spec/models/get_client_purchases_request_spec.rb +71 -0
  506. data/spec/models/get_client_purchases_response_spec.rb +47 -0
  507. data/spec/models/get_client_referral_types_request_spec.rb +41 -0
  508. data/spec/models/get_client_referral_types_response_spec.rb +41 -0
  509. data/spec/models/get_client_services_request_spec.rb +113 -0
  510. data/spec/models/get_client_services_response_spec.rb +47 -0
  511. data/spec/models/get_client_visits_request_spec.rb +83 -0
  512. data/spec/models/get_client_visits_response_spec.rb +47 -0
  513. data/spec/models/get_clients_request_spec.rb +71 -0
  514. data/spec/models/get_clients_response_spec.rb +47 -0
  515. data/spec/models/get_contact_logs_request_spec.rb +89 -0
  516. data/spec/models/get_contact_logs_response_spec.rb +47 -0
  517. data/spec/models/get_contracts_request_spec.rb +71 -0
  518. data/spec/models/get_contracts_response_spec.rb +47 -0
  519. data/spec/models/get_cross_regional_client_associations_request_spec.rb +59 -0
  520. data/spec/models/get_cross_regional_client_associations_response_spec.rb +47 -0
  521. data/spec/models/get_custom_client_fields_request_spec.rb +47 -0
  522. data/spec/models/get_custom_client_fields_response_spec.rb +47 -0
  523. data/spec/models/get_custom_payment_methods_request_spec.rb +47 -0
  524. data/spec/models/get_custom_payment_methods_response_spec.rb +47 -0
  525. data/spec/models/get_enrollments_request_spec.rb +89 -0
  526. data/spec/models/get_enrollments_response_spec.rb +47 -0
  527. data/spec/models/get_gift_card_response_spec.rb +47 -0
  528. data/spec/models/get_gift_cards_request_spec.rb +65 -0
  529. data/spec/models/get_locations_request_spec.rb +47 -0
  530. data/spec/models/get_locations_response_spec.rb +47 -0
  531. data/spec/models/get_packages_request_spec.rb +59 -0
  532. data/spec/models/get_packages_response_spec.rb +47 -0
  533. data/spec/models/get_products_request_spec.rb +83 -0
  534. data/spec/models/get_products_response_spec.rb +47 -0
  535. data/spec/models/get_programs_request_spec.rb +63 -0
  536. data/spec/models/get_programs_response_spec.rb +47 -0
  537. data/spec/models/get_required_client_fields_response_spec.rb +41 -0
  538. data/spec/models/get_resources_request_spec.rb +71 -0
  539. data/spec/models/get_resources_response_spec.rb +47 -0
  540. data/spec/models/get_sales_request_spec.rb +35 -0
  541. data/spec/models/get_sales_response_spec.rb +47 -0
  542. data/spec/models/get_schedule_items_request_spec.rb +77 -0
  543. data/spec/models/get_schedule_items_response_spec.rb +47 -0
  544. data/spec/models/get_services_request_spec.rb +101 -0
  545. data/spec/models/get_services_response_spec.rb +47 -0
  546. data/spec/models/get_session_types_request_spec.rb +59 -0
  547. data/spec/models/get_session_types_response_spec.rb +47 -0
  548. data/spec/models/get_sites_request_spec.rb +53 -0
  549. data/spec/models/get_sites_response_spec.rb +47 -0
  550. data/spec/models/get_staff_appointments_request_spec.rb +83 -0
  551. data/spec/models/get_staff_appointments_response_spec.rb +47 -0
  552. data/spec/models/get_staff_permissions_request_spec.rb +41 -0
  553. data/spec/models/get_staff_permissions_response_spec.rb +41 -0
  554. data/spec/models/get_staff_request_spec.rb +77 -0
  555. data/spec/models/get_staff_response_spec.rb +47 -0
  556. data/spec/models/get_time_clock_request_spec.rb +71 -0
  557. data/spec/models/get_time_clock_response_spec.rb +47 -0
  558. data/spec/models/get_waitlist_entries_request_spec.rb +77 -0
  559. data/spec/models/get_waitlist_entries_response_spec.rb +47 -0
  560. data/spec/models/gift_card_layout_spec.rb +47 -0
  561. data/spec/models/gift_card_spec.rb +107 -0
  562. data/spec/models/issue_request_spec.rb +47 -0
  563. data/spec/models/issue_response_spec.rb +53 -0
  564. data/spec/models/level_spec.rb +53 -0
  565. data/spec/models/liability_spec.rb +53 -0
  566. data/spec/models/location_spec.rb +185 -0
  567. data/spec/models/membership_type_restriction_spec.rb +47 -0
  568. data/spec/models/model_class_spec.rb +195 -0
  569. data/spec/models/package_spec.rb +71 -0
  570. data/spec/models/pagination_response_spec.rb +59 -0
  571. data/spec/models/product_spec.rb +101 -0
  572. data/spec/models/program_spec.rb +63 -0
  573. data/spec/models/prospect_stage_spec.rb +53 -0
  574. data/spec/models/purchase_contract_request_spec.rb +101 -0
  575. data/spec/models/purchase_contract_response_spec.rb +59 -0
  576. data/spec/models/purchase_gift_card_request_spec.rb +107 -0
  577. data/spec/models/purchase_gift_card_response_spec.rb +95 -0
  578. data/spec/models/purchased_item_spec.rb +47 -0
  579. data/spec/models/relationship_spec.rb +53 -0
  580. data/spec/models/remove_client_from_class_request_spec.rb +65 -0
  581. data/spec/models/remove_client_from_class_response_spec.rb +41 -0
  582. data/spec/models/remove_from_waitlist_request_spec.rb +41 -0
  583. data/spec/models/remove_from_waitlist_response_spec.rb +35 -0
  584. data/spec/models/resource_spec.rb +47 -0
  585. data/spec/models/sale_payment_spec.rb +65 -0
  586. data/spec/models/sale_spec.rb +83 -0
  587. data/spec/models/sales_rep_spec.rb +65 -0
  588. data/spec/models/send_password_reset_email_request_spec.rb +53 -0
  589. data/spec/models/service_spec.rb +89 -0
  590. data/spec/models/session_type_spec.rb +99 -0
  591. data/spec/models/site_spec.rb +155 -0
  592. data/spec/models/size_spec.rb +47 -0
  593. data/spec/models/staff_permission_group_spec.rb +67 -0
  594. data/spec/models/staff_spec.rb +179 -0
  595. data/spec/models/stored_card_info_spec.rb +41 -0
  596. data/spec/models/substitute_class_teacher_request_spec.rb +71 -0
  597. data/spec/models/substitute_class_teacher_response_spec.rb +41 -0
  598. data/spec/models/substitute_teacher_class_spec.rb +155 -0
  599. data/spec/models/time_card_event_spec.rb +53 -0
  600. data/spec/models/time_clock_report_spec.rb +71 -0
  601. data/spec/models/unavailability_spec.rb +59 -0
  602. data/spec/models/upcoming_autopay_event_spec.rb +63 -0
  603. data/spec/models/update_appointment_request_spec.rb +107 -0
  604. data/spec/models/update_appointment_response_spec.rb +41 -0
  605. data/spec/models/update_client_request_spec.rb +59 -0
  606. data/spec/models/update_client_response_spec.rb +41 -0
  607. data/spec/models/update_client_service_request_spec.rb +59 -0
  608. data/spec/models/update_client_service_response_spec.rb +41 -0
  609. data/spec/models/update_client_visit_request_spec.rb +71 -0
  610. data/spec/models/update_client_visit_response_spec.rb +41 -0
  611. data/spec/models/update_contact_log_comment_spec.rb +47 -0
  612. data/spec/models/update_contact_log_request_spec.rb +89 -0
  613. data/spec/models/update_contact_log_type_spec.rb +47 -0
  614. data/spec/models/upload_client_document_request_spec.rb +47 -0
  615. data/spec/models/upload_client_document_response_spec.rb +47 -0
  616. data/spec/models/upload_client_photo_request_spec.rb +47 -0
  617. data/spec/models/upload_client_photo_response_spec.rb +47 -0
  618. data/spec/models/user_spec.rb +59 -0
  619. data/spec/models/visit_spec.rb +155 -0
  620. data/spec/models/waitlist_entry_spec.rb +89 -0
  621. data/spec/spec_helper.rb +111 -0
  622. data/swagger_client-1.0.0.gem +0 -0
  623. data/swagger_client.gemspec +45 -0
  624. metadata +1050 -0
@@ -0,0 +1,22 @@
1
+ # SwaggerClient::ClassDescription
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **active** | **BOOLEAN** | When `true`, indicates that the business can assign this class description to new class schedules.<br /> When `false`, indicates that the business cannot assign this class description to new class schedules. | [optional]
7
+ **description** | **String** | The long version of the class description. | [optional]
8
+ **id** | **Integer** | The class description's ID. | [optional]
9
+ **image_url** | **String** | The class description's image URL, if any. If it does not exist, nothing is returned. | [optional]
10
+ **last_updated** | **DateTime** | The date this class description was last modified. | [optional]
11
+ **level** | [**Level**](Level.md) | The level information about this class. | [optional]
12
+ **name** | **String** | The name of this class description. | [optional]
13
+ **notes** | **String** | Any notes about the class description. | [optional]
14
+ **prereq** | **String** | Any prerequisites for the class. | [optional]
15
+ **program** | [**Program**](Program.md) | Contains information about the class description's program. | [optional]
16
+ **session_type** | [**SessionType**](SessionType.md) | Contains information about the class description's session type. | [optional]
17
+ **category** | **String** | The category of this class description. | [optional]
18
+ **category_id** | **Integer** | The category ID of this class description. | [optional]
19
+ **subcategory** | **String** | The subcategory of this class description. | [optional]
20
+ **subcategory_id** | **Integer** | The subcategory ID of this class description. | [optional]
21
+
22
+
@@ -0,0 +1,10 @@
1
+ # SwaggerClient::ClassPayrollEvent
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **staff_id** | **Integer** | The ID of the staff member who taught the class. | [optional]
7
+ **class_id** | **Integer** | The class' ID. | [optional]
8
+ **earnings** | **Float** | The total monetary amount the staff is to be paid for this class. | [optional]
9
+
10
+
@@ -0,0 +1,29 @@
1
+ # SwaggerClient::ClassSchedule
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **classes** | [**Array<ModelClass>**](ModelClass.md) | Contains information about classes. | [optional]
7
+ **clients** | [**Array<Client>**](Client.md) | Contains information about clients. | [optional]
8
+ **course** | [**Course**](Course.md) | Contains information about the course that the enrollment is a part of. | [optional]
9
+ **semester_id** | **Integer** | The semester ID for the enrollment (if any). | [optional]
10
+ **is_available** | **BOOLEAN** | When `true`, indicates that the enrollment shows in consumer mode, has not started yet, and there is room in each class of the enrollment.<br /> When `false`, indicates that either the enrollment does not show in consumer mode, has already started, or there is no room in some classes of the enrollment. | [optional]
11
+ **id** | **Integer** | The unique ID of the class schedule. | [optional]
12
+ **class_description** | [**ClassDescription**](ClassDescription.md) | Contains information about the class. | [optional]
13
+ **day_sunday** | **BOOLEAN** | When `true`, indicates that this schedule occurs on Sundays. | [optional]
14
+ **day_monday** | **BOOLEAN** | When `true`, indicates that this schedule occurs on Mondays. | [optional]
15
+ **day_tuesday** | **BOOLEAN** | When `true`, indicates that this schedule occurs on Tuesdays. | [optional]
16
+ **day_wednesday** | **BOOLEAN** | When `true`, indicates that this schedule occurs on Wednesdays. | [optional]
17
+ **day_thursday** | **BOOLEAN** | When `true`, indicates that this schedule occurs on Thursdays. | [optional]
18
+ **day_friday** | **BOOLEAN** | When `true`, indicates that this schedule occurs on Fridays. | [optional]
19
+ **day_saturday** | **BOOLEAN** | When `true`, indicates that this schedule occurs on Saturdays. | [optional]
20
+ **allow_open_enrollment** | **BOOLEAN** | When `true`, indicates that the enrollment allows booking after the enrollment has started. | [optional]
21
+ **allow_date_forward_enrollment** | **BOOLEAN** | When `true`, indicates that this the enrollment shows in consumer mode, the enrollment has not started yet, and there is room in each class of the enrollment. | [optional]
22
+ **start_time** | **DateTime** | The time this class schedule starts. | [optional]
23
+ **end_time** | **DateTime** | The time this class schedule ends. | [optional]
24
+ **start_date** | **DateTime** | The date this class schedule starts. | [optional]
25
+ **end_date** | **DateTime** | The date this class schedule ends. | [optional]
26
+ **staff** | [**Staff**](Staff.md) | Contains information about the staff member who is regularly scheduled to teach the class. | [optional]
27
+ **location** | [**Location**](Location.md) | Contains information about the regularly scheduled location of this class. | [optional]
28
+
29
+
data/docs/Client.md ADDED
@@ -0,0 +1,61 @@
1
+ # SwaggerClient::Client
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **appointment_gender_preference** | **String** | The gender of staff member with whom the client prefers to book appointments. | [optional]
7
+ **birth_date** | **DateTime** | The client’s date of birth. | [optional]
8
+ **country** | **String** | The client’s country. | [optional]
9
+ **creation_date** | **DateTime** | The date the client’s profile was created and added to the business, either by the client from the online store, or by a staff member. This value always returns in the format `yyyy-mm-ddThh:mm:ss:ms`. | [optional]
10
+ **custom_client_fields** | [**Array<CustomClientFieldValue>**](CustomClientFieldValue.md) | Contains information about the custom client fields assigned to the client. | [optional]
11
+ **client_credit_card** | [**ClientCreditCard**](ClientCreditCard.md) | Contains information about the client’s credit card. | [optional]
12
+ **client_indexes** | [**Array<AssignedClientIndex>**](AssignedClientIndex.md) | Contains the IDs of the client’s assigned ClientIndexes and ClientIndexValues. | [optional]
13
+ **client_relationships** | [**Array<ClientRelationship>**](ClientRelationship.md) | Contains information about the relationship between two clients. | [optional]
14
+ **first_appointment_date** | **DateTime** | The date of the client’s first booked appointment at the business. | [optional]
15
+ **first_name** | **String** | The client’s first name. | [optional]
16
+ **id** | **String** | The client’s ID, as configured by the business owner. This is the client’s barcode ID if the business owner assigns barcodes to clients. This ID is used throughout the Public API for client-related Public API calls. When used in a POST `UpdateClient` request, the `Id` is used to identify the client for the update. | [optional]
17
+ **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]
18
+ **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]
19
+ **last_name** | **String** | The client’s last name. | [optional]
20
+ **liability** | [**Liability**](Liability.md) | Contains the client’s liability agreement information for the business. | [optional]
21
+ **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]
22
+ **membership_icon** | **Integer** | The ID of the [membership icon](https://support.mindbodyonline.com/s/article/203259703-Membership-Setup-screen?language=en_US) displayed next to the client’s name, if the client has a membership on their account. | [optional]
23
+ **mobile_provider** | **Integer** | The client’s mobile provider. | [optional]
24
+ **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]
25
+ **state** | **String** | The client’s state. | [optional]
26
+ **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]
27
+ **last_modified_date_time** | **DateTime** | The UTC date and time when the client’s information was last modified. | [optional]
28
+ **red_alert** | **String** | Contains any red alert information entered by the business owner for the client. | [optional]
29
+ **yellow_alert** | **String** | Contains any yellow alert information entered by the business owner for the client. | [optional]
30
+ **middle_name** | **String** | The client’s middle name. | [optional]
31
+ **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]
32
+ **email** | **String** | The client’s email address. | [optional]
33
+ **mobile_phone** | **String** | The client’s mobile phone number. | [optional]
34
+ **home_phone** | **String** | The client’s home phone number. | [optional]
35
+ **work_phone** | **String** | The client’s work phone number. | [optional]
36
+ **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]
37
+ **address_line1** | **String** | The first line of the client’s street address. | [optional]
38
+ **address_line2** | **String** | The second line of the client’s street address, if needed. | [optional]
39
+ **city** | **String** | The client’s city. | [optional]
40
+ **postal_code** | **String** | The client’s postal code. | [optional]
41
+ **work_extension** | **String** | The client’s work phone extension number. | [optional]
42
+ **referred_by** | **String** | Specifies how the client was referred to the business. You can get a list of possible strings using the `GetClientReferralTypes` endpoint. | [optional]
43
+ **photo_url** | **String** | The URL of the client’s photo for the client profile. | [optional]
44
+ **emergency_contact_info_name** | **String** | The name of the client’s emergency contact. | [optional]
45
+ **emergency_contact_info_email** | **String** | The email address of the client’s emergency contact. | [optional]
46
+ **emergency_contact_info_phone** | **String** | The phone number of the client’s emergency contact. | [optional]
47
+ **emergency_contact_info_relationship** | **String** | The client’s relationship with the emergency contact. | [optional]
48
+ **gender** | **String** | The gender of the client. | [optional]
49
+ **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]
50
+ **active** | **BOOLEAN** | When `true`, indicates that the client’s profile is marked as active on the site.<br /> When `false`, the client’s profile is inactive. | [optional]
51
+ **sales_reps** | [**Array<SalesRep>**](SalesRep.md) | A list of sales representatives. | [optional]
52
+ **status** | **String** | The status of the client in the business. Possible values are: * Declined * Non-Member * Active * Expired * Suspended * Terminated | [optional]
53
+ **action** | **String** | The action taken. | [optional]
54
+ **send_account_emails** | **BOOLEAN** | When `true`, indicates that the client has opted to receive general account notifications by email. This property is editable. <br />Default: **false** | [optional]
55
+ **send_account_texts** | **BOOLEAN** | When `true`, indicates that the client has opted to receive general account notifications by text message. This parameter cannot be updated by developers. If included in a request, it is ignored. | [optional]
56
+ **send_promotional_emails** | **BOOLEAN** | When `true`, indicates that the client has opted to receive promotional notifications by email. This property is editable. <br />Default: **false** | [optional]
57
+ **send_promotional_texts** | **BOOLEAN** | When `true`, indicates that the client has opted to receive promotional notifications by text message. This parameter cannot be updated by developers. If included in a request, it is ignored. | [optional]
58
+ **send_schedule_emails** | **BOOLEAN** | When `true`, indicates that the client has opted to receive schedule notifications by email. This property is editable. <br />Default: **false** | [optional]
59
+ **send_schedule_texts** | **BOOLEAN** | When `true`, indicates that the client has opted to receive schedule notifications by text message. This parameter cannot be updated by developers. If included in a request, it is ignored. | [optional]
60
+
61
+
data/docs/ClientApi.md ADDED
@@ -0,0 +1,1473 @@
1
+ # SwaggerClient::ClientApi
2
+
3
+ All URIs are relative to *https://api.mindbodyonline.com*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**client_add_arrival**](ClientApi.md#client_add_arrival) | **POST** /public/v{version}/client/addarrival | Add an arrival for a client.
8
+ [**client_add_client**](ClientApi.md#client_add_client) | **POST** /public/v{version}/client/addclient | Add a client to a site.
9
+ [**client_add_contact_log**](ClientApi.md#client_add_contact_log) | **POST** /public/v{version}/client/addcontactlog | Add a contact log to a client's account.
10
+ [**client_get_active_client_memberships**](ClientApi.md#client_get_active_client_memberships) | **GET** /public/v{version}/client/activeclientmemberships | Get a client's active memberships.
11
+ [**client_get_client_account_balances**](ClientApi.md#client_get_client_account_balances) | **GET** /public/v{version}/client/clientaccountbalances | Get account balance information for one or more client(s).
12
+ [**client_get_client_contracts**](ClientApi.md#client_get_client_contracts) | **GET** /public/v{version}/client/clientcontracts | Get contracts that a client has purchased.
13
+ [**client_get_client_formula_notes**](ClientApi.md#client_get_client_formula_notes) | **GET** /public/v{version}/client/clientformulanotes | Get a client's formula notes.
14
+ [**client_get_client_indexes**](ClientApi.md#client_get_client_indexes) | **GET** /public/v{version}/client/clientindexes | Get a site's configured client indexes and client index values.
15
+ [**client_get_client_purchases**](ClientApi.md#client_get_client_purchases) | **GET** /public/v{version}/client/clientpurchases | Get a client's purchase history.
16
+ [**client_get_client_referral_types**](ClientApi.md#client_get_client_referral_types) | **GET** /public/v{version}/client/clientreferraltypes | Get a site's configured client referral types.
17
+ [**client_get_client_services**](ClientApi.md#client_get_client_services) | **GET** /public/v{version}/client/clientservices | Get pricing options that a client has purchased.
18
+ [**client_get_client_visits**](ClientApi.md#client_get_client_visits) | **GET** /public/v{version}/client/clientvisits | Get a client's visit history.
19
+ [**client_get_clients**](ClientApi.md#client_get_clients) | **GET** /public/v{version}/client/clients | Get clients.
20
+ [**client_get_contact_logs**](ClientApi.md#client_get_contact_logs) | **GET** /public/v{version}/client/contactlogs | Get contact logs on a client's account.
21
+ [**client_get_cross_regional_client_associations**](ClientApi.md#client_get_cross_regional_client_associations) | **GET** /public/v{version}/client/crossregionalclientassociations | Get a client's cross regional site associations.
22
+ [**client_get_custom_client_fields**](ClientApi.md#client_get_custom_client_fields) | **GET** /public/v{version}/client/customclientfields | Get a site's configured custom client fields.
23
+ [**client_get_required_client_fields**](ClientApi.md#client_get_required_client_fields) | **GET** /public/v{version}/client/requiredclientfields | Get client required fields for a site.
24
+ [**client_send_password_reset_email**](ClientApi.md#client_send_password_reset_email) | **POST** /public/v{version}/client/sendpasswordresetemail | Send a password reset email to a client.
25
+ [**client_update_client**](ClientApi.md#client_update_client) | **POST** /public/v{version}/client/updateclient | Update a client at a site.
26
+ [**client_update_client_service**](ClientApi.md#client_update_client_service) | **POST** /public/v{version}/client/updateclientservice | Update a client's purchase pricing option.
27
+ [**client_update_client_visit**](ClientApi.md#client_update_client_visit) | **POST** /public/v{version}/client/updateclientvisit | Update a client's visit.
28
+ [**client_update_contact_log**](ClientApi.md#client_update_contact_log) | **POST** /public/v{version}/client/updatecontactlog | Update a contact log on a client's account.
29
+ [**client_upload_client_document**](ClientApi.md#client_upload_client_document) | **POST** /public/v{version}/client/uploadclientdocument | Upload a document to a client's profile.
30
+ [**client_upload_client_photo**](ClientApi.md#client_upload_client_photo) | **POST** /public/v{version}/client/uploadclientphoto | Upload a profile photo to a client's profile.
31
+
32
+
33
+ # **client_add_arrival**
34
+ > AddArrivalResponse client_add_arrival(request, site_id, version, opts)
35
+
36
+ Add an arrival for a client.
37
+
38
+ ### Example
39
+ ```ruby
40
+ # load the gem
41
+ require 'swagger_client'
42
+
43
+ api_instance = SwaggerClient::ClientApi.new
44
+
45
+ request = SwaggerClient::AddArrivalRequest.new # AddArrivalRequest |
46
+
47
+ site_id = 'site_id_example' # String | ID of the site from which to pull data.
48
+
49
+ version = 'version_example' # String |
50
+
51
+ opts = {
52
+ authorization: '' # String | A staff user authorization token.
53
+ }
54
+
55
+ begin
56
+ #Add an arrival for a client.
57
+ result = api_instance.client_add_arrival(request, site_id, version, opts)
58
+ p result
59
+ rescue SwaggerClient::ApiError => e
60
+ puts "Exception when calling ClientApi->client_add_arrival: #{e}"
61
+ end
62
+ ```
63
+
64
+ ### Parameters
65
+
66
+ Name | Type | Description | Notes
67
+ ------------- | ------------- | ------------- | -------------
68
+ **request** | [**AddArrivalRequest**](AddArrivalRequest.md)| |
69
+ **site_id** | **String**| ID of the site from which to pull data. |
70
+ **version** | **String**| |
71
+ **authorization** | **String**| A staff user authorization token. | [optional] [default to ]
72
+
73
+ ### Return type
74
+
75
+ [**AddArrivalResponse**](AddArrivalResponse.md)
76
+
77
+ ### Authorization
78
+
79
+ No authorization required
80
+
81
+ ### HTTP request headers
82
+
83
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, multipart/form-data
84
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
85
+
86
+
87
+
88
+ # **client_add_client**
89
+ > AddClientResponse client_add_client(request, site_id, version, opts)
90
+
91
+ Add a client to a site.
92
+
93
+ The `FirstName` and `LastName` parameters are always required in this request. All other parameters are optional, but note that any of the optional parameters could be required by a particular business, depending on how the business has configured the site settings. Use after calling the `GetRequiredClientFields` endpoint to make sure you are collecting all required pieces of information.
94
+
95
+ ### Example
96
+ ```ruby
97
+ # load the gem
98
+ require 'swagger_client'
99
+
100
+ api_instance = SwaggerClient::ClientApi.new
101
+
102
+ request = SwaggerClient::AddClientRequest.new # AddClientRequest |
103
+
104
+ site_id = 'site_id_example' # String | ID of the site from which to pull data.
105
+
106
+ version = 'version_example' # String |
107
+
108
+ opts = {
109
+ authorization: '' # String | A staff user authorization token.
110
+ }
111
+
112
+ begin
113
+ #Add a client to a site.
114
+ result = api_instance.client_add_client(request, site_id, version, opts)
115
+ p result
116
+ rescue SwaggerClient::ApiError => e
117
+ puts "Exception when calling ClientApi->client_add_client: #{e}"
118
+ end
119
+ ```
120
+
121
+ ### Parameters
122
+
123
+ Name | Type | Description | Notes
124
+ ------------- | ------------- | ------------- | -------------
125
+ **request** | [**AddClientRequest**](AddClientRequest.md)| |
126
+ **site_id** | **String**| ID of the site from which to pull data. |
127
+ **version** | **String**| |
128
+ **authorization** | **String**| A staff user authorization token. | [optional] [default to ]
129
+
130
+ ### Return type
131
+
132
+ [**AddClientResponse**](AddClientResponse.md)
133
+
134
+ ### Authorization
135
+
136
+ No authorization required
137
+
138
+ ### HTTP request headers
139
+
140
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, multipart/form-data
141
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
142
+
143
+
144
+
145
+ # **client_add_contact_log**
146
+ > ContactLog client_add_contact_log(request, site_id, version, opts)
147
+
148
+ Add a contact log to a client's account.
149
+
150
+ ### Example
151
+ ```ruby
152
+ # load the gem
153
+ require 'swagger_client'
154
+
155
+ api_instance = SwaggerClient::ClientApi.new
156
+
157
+ request = SwaggerClient::AddContactLogRequest.new # AddContactLogRequest |
158
+
159
+ site_id = 'site_id_example' # String | ID of the site from which to pull data.
160
+
161
+ version = 'version_example' # String |
162
+
163
+ opts = {
164
+ authorization: '' # String | A staff user authorization token.
165
+ }
166
+
167
+ begin
168
+ #Add a contact log to a client's account.
169
+ result = api_instance.client_add_contact_log(request, site_id, version, opts)
170
+ p result
171
+ rescue SwaggerClient::ApiError => e
172
+ puts "Exception when calling ClientApi->client_add_contact_log: #{e}"
173
+ end
174
+ ```
175
+
176
+ ### Parameters
177
+
178
+ Name | Type | Description | Notes
179
+ ------------- | ------------- | ------------- | -------------
180
+ **request** | [**AddContactLogRequest**](AddContactLogRequest.md)| |
181
+ **site_id** | **String**| ID of the site from which to pull data. |
182
+ **version** | **String**| |
183
+ **authorization** | **String**| A staff user authorization token. | [optional] [default to ]
184
+
185
+ ### Return type
186
+
187
+ [**ContactLog**](ContactLog.md)
188
+
189
+ ### Authorization
190
+
191
+ No authorization required
192
+
193
+ ### HTTP request headers
194
+
195
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, multipart/form-data
196
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
197
+
198
+
199
+
200
+ # **client_get_active_client_memberships**
201
+ > GetActiveClientMembershipsResponse client_get_active_client_memberships(request_client_id, site_id, version, opts)
202
+
203
+ Get a client's active memberships.
204
+
205
+ ### Example
206
+ ```ruby
207
+ # load the gem
208
+ require 'swagger_client'
209
+
210
+ api_instance = SwaggerClient::ClientApi.new
211
+
212
+ request_client_id = 'request_client_id_example' # String | The ID of the client whose membership was requested.
213
+
214
+ site_id = 'site_id_example' # String | ID of the site from which to pull data.
215
+
216
+ version = 'version_example' # String |
217
+
218
+ opts = {
219
+ authorization: '', # String | A staff user authorization token.
220
+ request_limit: 56, # Integer | Number of results to include, defaults to 100
221
+ request_location_id: 56, # Integer | The ID of the location where the requested membership was created.
222
+ request_offset: 56 # Integer | Page offset, defaults to 0.
223
+ }
224
+
225
+ begin
226
+ #Get a client's active memberships.
227
+ result = api_instance.client_get_active_client_memberships(request_client_id, site_id, version, opts)
228
+ p result
229
+ rescue SwaggerClient::ApiError => e
230
+ puts "Exception when calling ClientApi->client_get_active_client_memberships: #{e}"
231
+ end
232
+ ```
233
+
234
+ ### Parameters
235
+
236
+ Name | Type | Description | Notes
237
+ ------------- | ------------- | ------------- | -------------
238
+ **request_client_id** | **String**| The ID of the client whose membership was requested. |
239
+ **site_id** | **String**| ID of the site from which to pull data. |
240
+ **version** | **String**| |
241
+ **authorization** | **String**| A staff user authorization token. | [optional] [default to ]
242
+ **request_limit** | **Integer**| Number of results to include, defaults to 100 | [optional]
243
+ **request_location_id** | **Integer**| The ID of the location where the requested membership was created. | [optional]
244
+ **request_offset** | **Integer**| Page offset, defaults to 0. | [optional]
245
+
246
+ ### Return type
247
+
248
+ [**GetActiveClientMembershipsResponse**](GetActiveClientMembershipsResponse.md)
249
+
250
+ ### Authorization
251
+
252
+ No authorization required
253
+
254
+ ### HTTP request headers
255
+
256
+ - **Content-Type**: Not defined
257
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
258
+
259
+
260
+
261
+ # **client_get_client_account_balances**
262
+ > GetClientAccountBalancesResponse client_get_client_account_balances(request_client_ids, site_id, version, opts)
263
+
264
+ Get account balance information for one or more client(s).
265
+
266
+ ### Example
267
+ ```ruby
268
+ # load the gem
269
+ require 'swagger_client'
270
+
271
+ api_instance = SwaggerClient::ClientApi.new
272
+
273
+ request_client_ids = ['request_client_ids_example'] # Array<String> | The list of clients IDs for which you want account balances.
274
+
275
+ site_id = 'site_id_example' # String | ID of the site from which to pull data.
276
+
277
+ version = 'version_example' # String |
278
+
279
+ opts = {
280
+ authorization: '', # String | A staff user authorization token.
281
+ request_balance_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | The date you want a balance relative to. Default: **the current date**
282
+ request_class_id: 56, # Integer | The class ID of the event for which you want a balance.
283
+ request_limit: 56, # Integer | Number of results to include, defaults to 100
284
+ request_offset: 56 # Integer | Page offset, defaults to 0.
285
+ }
286
+
287
+ begin
288
+ #Get account balance information for one or more client(s).
289
+ result = api_instance.client_get_client_account_balances(request_client_ids, site_id, version, opts)
290
+ p result
291
+ rescue SwaggerClient::ApiError => e
292
+ puts "Exception when calling ClientApi->client_get_client_account_balances: #{e}"
293
+ end
294
+ ```
295
+
296
+ ### Parameters
297
+
298
+ Name | Type | Description | Notes
299
+ ------------- | ------------- | ------------- | -------------
300
+ **request_client_ids** | [**Array&lt;String&gt;**](String.md)| The list of clients IDs for which you want account balances. |
301
+ **site_id** | **String**| ID of the site from which to pull data. |
302
+ **version** | **String**| |
303
+ **authorization** | **String**| A staff user authorization token. | [optional] [default to ]
304
+ **request_balance_date** | **DateTime**| The date you want a balance relative to. Default: **the current date** | [optional]
305
+ **request_class_id** | **Integer**| The class ID of the event for which you want a balance. | [optional]
306
+ **request_limit** | **Integer**| Number of results to include, defaults to 100 | [optional]
307
+ **request_offset** | **Integer**| Page offset, defaults to 0. | [optional]
308
+
309
+ ### Return type
310
+
311
+ [**GetClientAccountBalancesResponse**](GetClientAccountBalancesResponse.md)
312
+
313
+ ### Authorization
314
+
315
+ No authorization required
316
+
317
+ ### HTTP request headers
318
+
319
+ - **Content-Type**: Not defined
320
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
321
+
322
+
323
+
324
+ # **client_get_client_contracts**
325
+ > GetClientContractsResponse client_get_client_contracts(request_client_id, site_id, version, opts)
326
+
327
+ Get contracts that a client has purchased.
328
+
329
+ ### Example
330
+ ```ruby
331
+ # load the gem
332
+ require 'swagger_client'
333
+
334
+ api_instance = SwaggerClient::ClientApi.new
335
+
336
+ request_client_id = 'request_client_id_example' # String | The ID of the client.
337
+
338
+ site_id = 'site_id_example' # String | ID of the site from which to pull data.
339
+
340
+ version = 'version_example' # String |
341
+
342
+ opts = {
343
+ authorization: '', # String | A staff user authorization token.
344
+ request_client_associated_sites_offset: 56, # Integer | Determines how many sites are skipped over when retrieving a client’s cross regional contracts. Used when a client ID is linked to more than ten sites in an organization. Only a maximum of ten site databases are queried when this call is made and `CrossRegionalLookup` is set to `true`. To change which sites are queried, change this offset value. Default: **0**
345
+ request_cross_regional_lookup: true, # BOOLEAN | When `true`, indicates that the requesting client’s cross regional contracts are returned, if any.<br /> When `false`, indicates that cross regional contracts are not returned.
346
+ request_limit: 56, # Integer | Number of results to include, defaults to 100
347
+ request_offset: 56 # Integer | Page offset, defaults to 0.
348
+ }
349
+
350
+ begin
351
+ #Get contracts that a client has purchased.
352
+ result = api_instance.client_get_client_contracts(request_client_id, site_id, version, opts)
353
+ p result
354
+ rescue SwaggerClient::ApiError => e
355
+ puts "Exception when calling ClientApi->client_get_client_contracts: #{e}"
356
+ end
357
+ ```
358
+
359
+ ### Parameters
360
+
361
+ Name | Type | Description | Notes
362
+ ------------- | ------------- | ------------- | -------------
363
+ **request_client_id** | **String**| The ID of the client. |
364
+ **site_id** | **String**| ID of the site from which to pull data. |
365
+ **version** | **String**| |
366
+ **authorization** | **String**| A staff user authorization token. | [optional] [default to ]
367
+ **request_client_associated_sites_offset** | **Integer**| Determines how many sites are skipped over when retrieving a client’s cross regional contracts. Used when a client ID is linked to more than ten sites in an organization. Only a maximum of ten site databases are queried when this call is made and &#x60;CrossRegionalLookup&#x60; is set to &#x60;true&#x60;. To change which sites are queried, change this offset value. Default: **0** | [optional]
368
+ **request_cross_regional_lookup** | **BOOLEAN**| When &#x60;true&#x60;, indicates that the requesting client’s cross regional contracts are returned, if any.&lt;br /&gt; When &#x60;false&#x60;, indicates that cross regional contracts are not returned. | [optional]
369
+ **request_limit** | **Integer**| Number of results to include, defaults to 100 | [optional]
370
+ **request_offset** | **Integer**| Page offset, defaults to 0. | [optional]
371
+
372
+ ### Return type
373
+
374
+ [**GetClientContractsResponse**](GetClientContractsResponse.md)
375
+
376
+ ### Authorization
377
+
378
+ No authorization required
379
+
380
+ ### HTTP request headers
381
+
382
+ - **Content-Type**: Not defined
383
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
384
+
385
+
386
+
387
+ # **client_get_client_formula_notes**
388
+ > GetClientFormulaNotesResponse client_get_client_formula_notes(site_id, version, opts)
389
+
390
+ Get a client's formula notes.
391
+
392
+ ### Example
393
+ ```ruby
394
+ # load the gem
395
+ require 'swagger_client'
396
+
397
+ api_instance = SwaggerClient::ClientApi.new
398
+
399
+ site_id = 'site_id_example' # String | ID of the site from which to pull data.
400
+
401
+ version = 'version_example' # String |
402
+
403
+ opts = {
404
+ authorization: '', # String | A staff user authorization token.
405
+ request_appointment_id: 789, # Integer | The appointment ID of the appointment that the formula notes are related to.
406
+ request_client_id: 'request_client_id_example', # String | The client ID of the client whose formula notes are being requested.
407
+ request_limit: 56, # Integer | Number of results to include, defaults to 100
408
+ request_offset: 56 # Integer | Page offset, defaults to 0.
409
+ }
410
+
411
+ begin
412
+ #Get a client's formula notes.
413
+ result = api_instance.client_get_client_formula_notes(site_id, version, opts)
414
+ p result
415
+ rescue SwaggerClient::ApiError => e
416
+ puts "Exception when calling ClientApi->client_get_client_formula_notes: #{e}"
417
+ end
418
+ ```
419
+
420
+ ### Parameters
421
+
422
+ Name | Type | Description | Notes
423
+ ------------- | ------------- | ------------- | -------------
424
+ **site_id** | **String**| ID of the site from which to pull data. |
425
+ **version** | **String**| |
426
+ **authorization** | **String**| A staff user authorization token. | [optional] [default to ]
427
+ **request_appointment_id** | **Integer**| The appointment ID of the appointment that the formula notes are related to. | [optional]
428
+ **request_client_id** | **String**| The client ID of the client whose formula notes are being requested. | [optional]
429
+ **request_limit** | **Integer**| Number of results to include, defaults to 100 | [optional]
430
+ **request_offset** | **Integer**| Page offset, defaults to 0. | [optional]
431
+
432
+ ### Return type
433
+
434
+ [**GetClientFormulaNotesResponse**](GetClientFormulaNotesResponse.md)
435
+
436
+ ### Authorization
437
+
438
+ No authorization required
439
+
440
+ ### HTTP request headers
441
+
442
+ - **Content-Type**: Not defined
443
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
444
+
445
+
446
+
447
+ # **client_get_client_indexes**
448
+ > GetClientIndexesResponse client_get_client_indexes(site_id, version, opts)
449
+
450
+ Get a site's configured client indexes and client index values.
451
+
452
+ Client indexes are used to analyze client demographics. A business owner can set up different categories with sets of values which they can assign to each client. Client indexes are used in client searches, for tagging clients so that the owner can send mass emails to similar groups, and for many reports. For more information, see Client Indexes and [Client Index Values (video tutorial)](https://support.mindbodyonline.com/s/article/203261653-Client-indexes-and-client-index-values-video-tutorial?language=en_USclient).
453
+
454
+ ### Example
455
+ ```ruby
456
+ # load the gem
457
+ require 'swagger_client'
458
+
459
+ api_instance = SwaggerClient::ClientApi.new
460
+
461
+ site_id = 'site_id_example' # String | ID of the site from which to pull data.
462
+
463
+ version = 'version_example' # String |
464
+
465
+ opts = {
466
+ authorization: '', # String | A staff user authorization token.
467
+ request_required_only: true # BOOLEAN | When `true`, filters the results to only indexes that are required on creation.<br /> When `false` or omitted, returns all of the client indexes.
468
+ }
469
+
470
+ begin
471
+ #Get a site's configured client indexes and client index values.
472
+ result = api_instance.client_get_client_indexes(site_id, version, opts)
473
+ p result
474
+ rescue SwaggerClient::ApiError => e
475
+ puts "Exception when calling ClientApi->client_get_client_indexes: #{e}"
476
+ end
477
+ ```
478
+
479
+ ### Parameters
480
+
481
+ Name | Type | Description | Notes
482
+ ------------- | ------------- | ------------- | -------------
483
+ **site_id** | **String**| ID of the site from which to pull data. |
484
+ **version** | **String**| |
485
+ **authorization** | **String**| A staff user authorization token. | [optional] [default to ]
486
+ **request_required_only** | **BOOLEAN**| When &#x60;true&#x60;, filters the results to only indexes that are required on creation.&lt;br /&gt; When &#x60;false&#x60; or omitted, returns all of the client indexes. | [optional]
487
+
488
+ ### Return type
489
+
490
+ [**GetClientIndexesResponse**](GetClientIndexesResponse.md)
491
+
492
+ ### Authorization
493
+
494
+ No authorization required
495
+
496
+ ### HTTP request headers
497
+
498
+ - **Content-Type**: Not defined
499
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
500
+
501
+
502
+
503
+ # **client_get_client_purchases**
504
+ > GetClientPurchasesResponse client_get_client_purchases(request_client_id, site_id, version, opts)
505
+
506
+ Get a client's purchase history.
507
+
508
+ ### Example
509
+ ```ruby
510
+ # load the gem
511
+ require 'swagger_client'
512
+
513
+ api_instance = SwaggerClient::ClientApi.new
514
+
515
+ request_client_id = 'request_client_id_example' # String | The ID of the client you are querying for purchases.
516
+
517
+ site_id = 'site_id_example' # String | ID of the site from which to pull data.
518
+
519
+ version = 'version_example' # String |
520
+
521
+ opts = {
522
+ authorization: '', # String | A staff user authorization token.
523
+ request_end_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filters results to purchases made before this timestamp.<br /> Default: **end of today**
524
+ request_limit: 56, # Integer | Number of results to include, defaults to 100
525
+ request_offset: 56, # Integer | Page offset, defaults to 0.
526
+ request_sale_id: 56, # Integer | Filters results to the single record associated with this ID.
527
+ request_start_date: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Filters results to purchases made on or after this timestamp.<br /> Default: **now**
528
+ }
529
+
530
+ begin
531
+ #Get a client's purchase history.
532
+ result = api_instance.client_get_client_purchases(request_client_id, site_id, version, opts)
533
+ p result
534
+ rescue SwaggerClient::ApiError => e
535
+ puts "Exception when calling ClientApi->client_get_client_purchases: #{e}"
536
+ end
537
+ ```
538
+
539
+ ### Parameters
540
+
541
+ Name | Type | Description | Notes
542
+ ------------- | ------------- | ------------- | -------------
543
+ **request_client_id** | **String**| The ID of the client you are querying for purchases. |
544
+ **site_id** | **String**| ID of the site from which to pull data. |
545
+ **version** | **String**| |
546
+ **authorization** | **String**| A staff user authorization token. | [optional] [default to ]
547
+ **request_end_date** | **DateTime**| Filters results to purchases made before this timestamp.&lt;br /&gt; Default: **end of today** | [optional]
548
+ **request_limit** | **Integer**| Number of results to include, defaults to 100 | [optional]
549
+ **request_offset** | **Integer**| Page offset, defaults to 0. | [optional]
550
+ **request_sale_id** | **Integer**| Filters results to the single record associated with this ID. | [optional]
551
+ **request_start_date** | **DateTime**| Filters results to purchases made on or after this timestamp.&lt;br /&gt; Default: **now** | [optional]
552
+
553
+ ### Return type
554
+
555
+ [**GetClientPurchasesResponse**](GetClientPurchasesResponse.md)
556
+
557
+ ### Authorization
558
+
559
+ No authorization required
560
+
561
+ ### HTTP request headers
562
+
563
+ - **Content-Type**: Not defined
564
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
565
+
566
+
567
+
568
+ # **client_get_client_referral_types**
569
+ > GetClientReferralTypesResponse client_get_client_referral_types(site_id, version, opts)
570
+
571
+ Get a site's configured client referral types.
572
+
573
+ Gets a list of referral types. Referral types are options that new clients can choose to identify how they learned about the business. Referral types are typically used for the sign-up process.
574
+
575
+ ### Example
576
+ ```ruby
577
+ # load the gem
578
+ require 'swagger_client'
579
+
580
+ api_instance = SwaggerClient::ClientApi.new
581
+
582
+ site_id = 'site_id_example' # String | ID of the site from which to pull data.
583
+
584
+ version = 'version_example' # String |
585
+
586
+ opts = {
587
+ authorization: '', # String | A staff user authorization token.
588
+ request_include_inactive: true # BOOLEAN | When `true`, filters the results to include subtypes and inactive referral types.<br /> When `false`, includes no subtypes and only active types.
589
+ }
590
+
591
+ begin
592
+ #Get a site's configured client referral types.
593
+ result = api_instance.client_get_client_referral_types(site_id, version, opts)
594
+ p result
595
+ rescue SwaggerClient::ApiError => e
596
+ puts "Exception when calling ClientApi->client_get_client_referral_types: #{e}"
597
+ end
598
+ ```
599
+
600
+ ### Parameters
601
+
602
+ Name | Type | Description | Notes
603
+ ------------- | ------------- | ------------- | -------------
604
+ **site_id** | **String**| ID of the site from which to pull data. |
605
+ **version** | **String**| |
606
+ **authorization** | **String**| A staff user authorization token. | [optional] [default to ]
607
+ **request_include_inactive** | **BOOLEAN**| When &#x60;true&#x60;, filters the results to include subtypes and inactive referral types.&lt;br /&gt; When &#x60;false&#x60;, includes no subtypes and only active types. | [optional]
608
+
609
+ ### Return type
610
+
611
+ [**GetClientReferralTypesResponse**](GetClientReferralTypesResponse.md)
612
+
613
+ ### Authorization
614
+
615
+ No authorization required
616
+
617
+ ### HTTP request headers
618
+
619
+ - **Content-Type**: Not defined
620
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
621
+
622
+
623
+
624
+ # **client_get_client_services**
625
+ > GetClientServicesResponse client_get_client_services(request_client_id, site_id, version, opts)
626
+
627
+ Get pricing options that a client has purchased.
628
+
629
+ ### Example
630
+ ```ruby
631
+ # load the gem
632
+ require 'swagger_client'
633
+
634
+ api_instance = SwaggerClient::ClientApi.new
635
+
636
+ request_client_id = 'request_client_id_example' # String | The ID of the client to query. The results are a list of pricing options that the client has purchased. Note that “service” and “pricing option” are synonymous in this section of the documentation.
637
+
638
+ site_id = 'site_id_example' # String | ID of the site from which to pull data.
639
+
640
+ version = 'version_example' # String |
641
+
642
+ opts = {
643
+ authorization: '', # String | A staff user authorization token.
644
+ request_class_id: 56, # Integer | Filters results to only those pricing options that can be used to pay for this class.
645
+ request_client_associated_sites_offset: 56, # Integer | Used to retrieve a client’s pricing options from multiple sites within an organization when the client is associated with more than ten sites. To change which ten sites are searched, change this offset value. A value of 0 means that no sites are skipped and the first ten sites are returned. You can use the `CrossRegionalClientAssociations` value from `GET CrossRegionalClientAssociations` to determine how many sites the client is associated with. Note that you must always have `CrossRegionalLookup` set to `true` to use this parameter.<br /> Default: **0** For example, if a client is associated with 25 sites, you need to call `GetClientServices` three times, as follows: * Use `GET CrossRegionalClientAssociations` to determine how many sites a client is associated with, which tells you how many additional calls you need to make. * Either omit `ClientAssociatedSitesOffset` or set it to 0 to return the client’s services (pricing options) from sites 1-10. * Set `ClientAssociatedSitesOffset` to 10 to return the client pricing options from sites 11-20 * Set `ClientAssociatedSitesOffset` to 20 to return the client pricing options from sites 21-25
646
+ request_cross_regional_lookup: true, # BOOLEAN | Used to retrieve a client’s pricing options from multiple sites within an organization. When included and set to `true`, it searches a maximum of ten sites with which this client is associated. When a client is associated with more than ten sites, use `ClientAssociatedSitesOffset` as many times as needed to search the additional sites with which the client is associated. You can use the `CrossRegionalClientAssociations` value from `GET CrossRegionalClientAssociations` to determine how many sites the client is associated with. Note that a `SiteID` is returned and populated in the `ClientServices` response when `CrossRegionalLookup` is set to `true`. Default: **false**
647
+ request_end_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filters results to pricing options that are valid on or before this date.
648
+ request_limit: 56, # Integer | Number of results to include, defaults to 100
649
+ request_location_ids: [56], # Array<Integer> | Filters results to pricing options that can be used at the listed location IDs.
650
+ request_offset: 56, # Integer | Page offset, defaults to 0.
651
+ request_program_ids: [56], # Array<Integer> | Filters results to pricing options that belong to one of the given program IDs.
652
+ request_session_type_id: 56, # Integer | Filters results to pricing options that will pay for the given session type ID. Use this to find pricing options that will pay for a specific appointment type.
653
+ request_show_active_only: true, # BOOLEAN | When `true`, includes active services only. Default: **false**
654
+ request_start_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filters results to pricing options that are valid on or after this date.
655
+ request_visit_count: 56 # Integer | A filter on the minimum number of visits a service can pay for.
656
+ }
657
+
658
+ begin
659
+ #Get pricing options that a client has purchased.
660
+ result = api_instance.client_get_client_services(request_client_id, site_id, version, opts)
661
+ p result
662
+ rescue SwaggerClient::ApiError => e
663
+ puts "Exception when calling ClientApi->client_get_client_services: #{e}"
664
+ end
665
+ ```
666
+
667
+ ### Parameters
668
+
669
+ Name | Type | Description | Notes
670
+ ------------- | ------------- | ------------- | -------------
671
+ **request_client_id** | **String**| The ID of the client to query. The results are a list of pricing options that the client has purchased. Note that “service” and “pricing option” are synonymous in this section of the documentation. |
672
+ **site_id** | **String**| ID of the site from which to pull data. |
673
+ **version** | **String**| |
674
+ **authorization** | **String**| A staff user authorization token. | [optional] [default to ]
675
+ **request_class_id** | **Integer**| Filters results to only those pricing options that can be used to pay for this class. | [optional]
676
+ **request_client_associated_sites_offset** | **Integer**| Used to retrieve a client’s pricing options from multiple sites within an organization when the client is associated with more than ten sites. To change which ten sites are searched, change this offset value. A value of 0 means that no sites are skipped and the first ten sites are returned. You can use the &#x60;CrossRegionalClientAssociations&#x60; value from &#x60;GET CrossRegionalClientAssociations&#x60; to determine how many sites the client is associated with. Note that you must always have &#x60;CrossRegionalLookup&#x60; set to &#x60;true&#x60; to use this parameter.&lt;br /&gt; Default: **0** For example, if a client is associated with 25 sites, you need to call &#x60;GetClientServices&#x60; three times, as follows: * Use &#x60;GET CrossRegionalClientAssociations&#x60; to determine how many sites a client is associated with, which tells you how many additional calls you need to make. * Either omit &#x60;ClientAssociatedSitesOffset&#x60; or set it to 0 to return the client’s services (pricing options) from sites 1-10. * Set &#x60;ClientAssociatedSitesOffset&#x60; to 10 to return the client pricing options from sites 11-20 * Set &#x60;ClientAssociatedSitesOffset&#x60; to 20 to return the client pricing options from sites 21-25 | [optional]
677
+ **request_cross_regional_lookup** | **BOOLEAN**| Used to retrieve a client’s pricing options from multiple sites within an organization. When included and set to &#x60;true&#x60;, it searches a maximum of ten sites with which this client is associated. When a client is associated with more than ten sites, use &#x60;ClientAssociatedSitesOffset&#x60; as many times as needed to search the additional sites with which the client is associated. You can use the &#x60;CrossRegionalClientAssociations&#x60; value from &#x60;GET CrossRegionalClientAssociations&#x60; to determine how many sites the client is associated with. Note that a &#x60;SiteID&#x60; is returned and populated in the &#x60;ClientServices&#x60; response when &#x60;CrossRegionalLookup&#x60; is set to &#x60;true&#x60;. Default: **false** | [optional]
678
+ **request_end_date** | **DateTime**| Filters results to pricing options that are valid on or before this date. | [optional]
679
+ **request_limit** | **Integer**| Number of results to include, defaults to 100 | [optional]
680
+ **request_location_ids** | [**Array&lt;Integer&gt;**](Integer.md)| Filters results to pricing options that can be used at the listed location IDs. | [optional]
681
+ **request_offset** | **Integer**| Page offset, defaults to 0. | [optional]
682
+ **request_program_ids** | [**Array&lt;Integer&gt;**](Integer.md)| Filters results to pricing options that belong to one of the given program IDs. | [optional]
683
+ **request_session_type_id** | **Integer**| Filters results to pricing options that will pay for the given session type ID. Use this to find pricing options that will pay for a specific appointment type. | [optional]
684
+ **request_show_active_only** | **BOOLEAN**| When &#x60;true&#x60;, includes active services only. Default: **false** | [optional]
685
+ **request_start_date** | **DateTime**| Filters results to pricing options that are valid on or after this date. | [optional]
686
+ **request_visit_count** | **Integer**| A filter on the minimum number of visits a service can pay for. | [optional]
687
+
688
+ ### Return type
689
+
690
+ [**GetClientServicesResponse**](GetClientServicesResponse.md)
691
+
692
+ ### Authorization
693
+
694
+ No authorization required
695
+
696
+ ### HTTP request headers
697
+
698
+ - **Content-Type**: Not defined
699
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
700
+
701
+
702
+
703
+ # **client_get_client_visits**
704
+ > GetClientVisitsResponse client_get_client_visits(request_client_id, site_id, version, opts)
705
+
706
+ Get a client's visit history.
707
+
708
+ ### Example
709
+ ```ruby
710
+ # load the gem
711
+ require 'swagger_client'
712
+
713
+ api_instance = SwaggerClient::ClientApi.new
714
+
715
+ request_client_id = 'request_client_id_example' # String | The ID of the requested client.
716
+
717
+ site_id = 'site_id_example' # String | ID of the site from which to pull data.
718
+
719
+ version = 'version_example' # String |
720
+
721
+ opts = {
722
+ authorization: '', # String | A staff user authorization token.
723
+ request_client_associated_sites_offset: 56, # Integer | The number of sites to skip when returning the site associated with a client.
724
+ request_cross_regional_lookup: true, # BOOLEAN | When `true`, indicates that past and scheduled client visits across all sites in the region are returned.<br /> When `false`, indicates that only visits at the current site are returned.
725
+ request_end_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | The date past which class visits are not returned. Default: **today’s date**
726
+ request_limit: 56, # Integer | Number of results to include, defaults to 100
727
+ request_offset: 56, # Integer | Page offset, defaults to 0.
728
+ request_start_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | The date before which class visits are not returned. Default: **the end date**
729
+ request_unpaids_only: true # BOOLEAN | When `true`, indicates that only visits that have not been paid for are returned.<br /> When `false`, indicates that all visits are returned, regardless of whether they have been paid for.<br /> Default: **false**
730
+ }
731
+
732
+ begin
733
+ #Get a client's visit history.
734
+ result = api_instance.client_get_client_visits(request_client_id, site_id, version, opts)
735
+ p result
736
+ rescue SwaggerClient::ApiError => e
737
+ puts "Exception when calling ClientApi->client_get_client_visits: #{e}"
738
+ end
739
+ ```
740
+
741
+ ### Parameters
742
+
743
+ Name | Type | Description | Notes
744
+ ------------- | ------------- | ------------- | -------------
745
+ **request_client_id** | **String**| The ID of the requested client. |
746
+ **site_id** | **String**| ID of the site from which to pull data. |
747
+ **version** | **String**| |
748
+ **authorization** | **String**| A staff user authorization token. | [optional] [default to ]
749
+ **request_client_associated_sites_offset** | **Integer**| The number of sites to skip when returning the site associated with a client. | [optional]
750
+ **request_cross_regional_lookup** | **BOOLEAN**| When &#x60;true&#x60;, indicates that past and scheduled client visits across all sites in the region are returned.&lt;br /&gt; When &#x60;false&#x60;, indicates that only visits at the current site are returned. | [optional]
751
+ **request_end_date** | **DateTime**| The date past which class visits are not returned. Default: **today’s date** | [optional]
752
+ **request_limit** | **Integer**| Number of results to include, defaults to 100 | [optional]
753
+ **request_offset** | **Integer**| Page offset, defaults to 0. | [optional]
754
+ **request_start_date** | **DateTime**| The date before which class visits are not returned. Default: **the end date** | [optional]
755
+ **request_unpaids_only** | **BOOLEAN**| When &#x60;true&#x60;, indicates that only visits that have not been paid for are returned.&lt;br /&gt; When &#x60;false&#x60;, indicates that all visits are returned, regardless of whether they have been paid for.&lt;br /&gt; Default: **false** | [optional]
756
+
757
+ ### Return type
758
+
759
+ [**GetClientVisitsResponse**](GetClientVisitsResponse.md)
760
+
761
+ ### Authorization
762
+
763
+ No authorization required
764
+
765
+ ### HTTP request headers
766
+
767
+ - **Content-Type**: Not defined
768
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
769
+
770
+
771
+
772
+ # **client_get_clients**
773
+ > GetClientsResponse client_get_clients(site_id, version, opts)
774
+
775
+ Get clients.
776
+
777
+ ### Example
778
+ ```ruby
779
+ # load the gem
780
+ require 'swagger_client'
781
+
782
+ api_instance = SwaggerClient::ClientApi.new
783
+
784
+ site_id = 'site_id_example' # String | ID of the site from which to pull data.
785
+
786
+ version = 'version_example' # String |
787
+
788
+ opts = {
789
+ authorization: '', # String | A staff user authorization token.
790
+ request_client_i_ds: ['request_client_i_ds_example'], # Array<String> | The requested client IDs. Default: **all IDs** that the authenticated user’s access level allows.
791
+ request_is_prospect: true, # BOOLEAN | When `true`, filters the results to include only those clients marked as prospects for the business.<br /> When `false`, indicates that only those clients who are not marked prospects should be returned.
792
+ request_last_modified_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filters the results to include only the clients that have been modified on or after this date.
793
+ request_limit: 56, # Integer | Number of results to include, defaults to 100
794
+ request_offset: 56, # Integer | Page offset, defaults to 0.
795
+ request_search_text: 'request_search_text_example' # String | Text to use in the search. Can include FirstName, LastName, and Email. Note that user credentials must be provided.
796
+ }
797
+
798
+ begin
799
+ #Get clients.
800
+ result = api_instance.client_get_clients(site_id, version, opts)
801
+ p result
802
+ rescue SwaggerClient::ApiError => e
803
+ puts "Exception when calling ClientApi->client_get_clients: #{e}"
804
+ end
805
+ ```
806
+
807
+ ### Parameters
808
+
809
+ Name | Type | Description | Notes
810
+ ------------- | ------------- | ------------- | -------------
811
+ **site_id** | **String**| ID of the site from which to pull data. |
812
+ **version** | **String**| |
813
+ **authorization** | **String**| A staff user authorization token. | [optional] [default to ]
814
+ **request_client_i_ds** | [**Array&lt;String&gt;**](String.md)| The requested client IDs. Default: **all IDs** that the authenticated user’s access level allows. | [optional]
815
+ **request_is_prospect** | **BOOLEAN**| When &#x60;true&#x60;, filters the results to include only those clients marked as prospects for the business.&lt;br /&gt; When &#x60;false&#x60;, indicates that only those clients who are not marked prospects should be returned. | [optional]
816
+ **request_last_modified_date** | **DateTime**| Filters the results to include only the clients that have been modified on or after this date. | [optional]
817
+ **request_limit** | **Integer**| Number of results to include, defaults to 100 | [optional]
818
+ **request_offset** | **Integer**| Page offset, defaults to 0. | [optional]
819
+ **request_search_text** | **String**| Text to use in the search. Can include FirstName, LastName, and Email. Note that user credentials must be provided. | [optional]
820
+
821
+ ### Return type
822
+
823
+ [**GetClientsResponse**](GetClientsResponse.md)
824
+
825
+ ### Authorization
826
+
827
+ No authorization required
828
+
829
+ ### HTTP request headers
830
+
831
+ - **Content-Type**: Not defined
832
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
833
+
834
+
835
+
836
+ # **client_get_contact_logs**
837
+ > GetContactLogsResponse client_get_contact_logs(request_client_id, site_id, version, opts)
838
+
839
+ Get contact logs on a client's account.
840
+
841
+ This endpoint contains a variety of filters that can return not just all contact logs, but also system-generated contact logs, contact logs assigned to specific staff members, and contact logs of specific types or subtypes.
842
+
843
+ ### Example
844
+ ```ruby
845
+ # load the gem
846
+ require 'swagger_client'
847
+
848
+ api_instance = SwaggerClient::ClientApi.new
849
+
850
+ request_client_id = 'request_client_id_example' # String | The ID of the client whose contact logs are being requested.
851
+
852
+ site_id = 'site_id_example' # String | ID of the site from which to pull data.
853
+
854
+ version = 'version_example' # String |
855
+
856
+ opts = {
857
+ authorization: '', # String | A staff user authorization token.
858
+ request_end_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filters the results to contact logs created before this date.<br /> Default: **the start date**
859
+ request_limit: 56, # Integer | Number of results to include, defaults to 100
860
+ request_offset: 56, # Integer | Page offset, defaults to 0.
861
+ request_show_system_generated: true, # BOOLEAN | When `true`, system-generated contact logs are returned in the results.<br /> Default: **false**
862
+ request_staff_ids: [56], # Array<Integer> | Filters the results to return contact logs assigned to one or more staff IDs.
863
+ request_start_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filters the results to contact logs created on or after this date.<br /> Default: **the current date**
864
+ request_subtype_ids: [56], # Array<Integer> | Filters the results to contact logs assigned one or more of these subtype IDs.
865
+ request_type_ids: [56] # Array<Integer> | Filters the results to contact logs assigned one or more of these type IDs.
866
+ }
867
+
868
+ begin
869
+ #Get contact logs on a client's account.
870
+ result = api_instance.client_get_contact_logs(request_client_id, site_id, version, opts)
871
+ p result
872
+ rescue SwaggerClient::ApiError => e
873
+ puts "Exception when calling ClientApi->client_get_contact_logs: #{e}"
874
+ end
875
+ ```
876
+
877
+ ### Parameters
878
+
879
+ Name | Type | Description | Notes
880
+ ------------- | ------------- | ------------- | -------------
881
+ **request_client_id** | **String**| The ID of the client whose contact logs are being requested. |
882
+ **site_id** | **String**| ID of the site from which to pull data. |
883
+ **version** | **String**| |
884
+ **authorization** | **String**| A staff user authorization token. | [optional] [default to ]
885
+ **request_end_date** | **DateTime**| Filters the results to contact logs created before this date.&lt;br /&gt; Default: **the start date** | [optional]
886
+ **request_limit** | **Integer**| Number of results to include, defaults to 100 | [optional]
887
+ **request_offset** | **Integer**| Page offset, defaults to 0. | [optional]
888
+ **request_show_system_generated** | **BOOLEAN**| When &#x60;true&#x60;, system-generated contact logs are returned in the results.&lt;br /&gt; Default: **false** | [optional]
889
+ **request_staff_ids** | [**Array&lt;Integer&gt;**](Integer.md)| Filters the results to return contact logs assigned to one or more staff IDs. | [optional]
890
+ **request_start_date** | **DateTime**| Filters the results to contact logs created on or after this date.&lt;br /&gt; Default: **the current date** | [optional]
891
+ **request_subtype_ids** | [**Array&lt;Integer&gt;**](Integer.md)| Filters the results to contact logs assigned one or more of these subtype IDs. | [optional]
892
+ **request_type_ids** | [**Array&lt;Integer&gt;**](Integer.md)| Filters the results to contact logs assigned one or more of these type IDs. | [optional]
893
+
894
+ ### Return type
895
+
896
+ [**GetContactLogsResponse**](GetContactLogsResponse.md)
897
+
898
+ ### Authorization
899
+
900
+ No authorization required
901
+
902
+ ### HTTP request headers
903
+
904
+ - **Content-Type**: Not defined
905
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
906
+
907
+
908
+
909
+ # **client_get_cross_regional_client_associations**
910
+ > GetCrossRegionalClientAssociationsResponse client_get_cross_regional_client_associations(site_id, version, opts)
911
+
912
+ Get a client's cross regional site associations.
913
+
914
+ Returns a list of sites that a particular client ID (also referred to as an RSSID) or a client email address is associated with in a cross-regional organization. Either the `ClientID` or `Email` parameter is required. If both are provided, the `ClientID` is used. Use this endpoint to retrieve information for other Public API endpoints, about the same client at multiple sites within an organization. To use this endpoint, your developer account must have been granted permission to the site’s entire organization. Note that this endpoint does not work on the Developer Sandbox site, as it is not set up for cross-regional use cases.
915
+
916
+ ### Example
917
+ ```ruby
918
+ # load the gem
919
+ require 'swagger_client'
920
+
921
+ api_instance = SwaggerClient::ClientApi.new
922
+
923
+ site_id = 'site_id_example' # String | ID of the site from which to pull data.
924
+
925
+ version = 'version_example' # String |
926
+
927
+ opts = {
928
+ authorization: '', # String | A staff user authorization token.
929
+ request_client_id: 'request_client_id_example', # String | Looks up the cross regional associations by the client’s ID. Either `ClientId` or `Email` must be provided. If both are provided, the `ClientId` is used by default.
930
+ request_email: 'request_email_example', # String | Looks up the cross regional associations by the client’s email address. Either `ClientId` or `Email` must be provided. If both are provided, the `ClientId` is used by default.
931
+ request_limit: 56, # Integer | Number of results to include, defaults to 100
932
+ request_offset: 56 # Integer | Page offset, defaults to 0.
933
+ }
934
+
935
+ begin
936
+ #Get a client's cross regional site associations.
937
+ result = api_instance.client_get_cross_regional_client_associations(site_id, version, opts)
938
+ p result
939
+ rescue SwaggerClient::ApiError => e
940
+ puts "Exception when calling ClientApi->client_get_cross_regional_client_associations: #{e}"
941
+ end
942
+ ```
943
+
944
+ ### Parameters
945
+
946
+ Name | Type | Description | Notes
947
+ ------------- | ------------- | ------------- | -------------
948
+ **site_id** | **String**| ID of the site from which to pull data. |
949
+ **version** | **String**| |
950
+ **authorization** | **String**| A staff user authorization token. | [optional] [default to ]
951
+ **request_client_id** | **String**| Looks up the cross regional associations by the client’s ID. Either &#x60;ClientId&#x60; or &#x60;Email&#x60; must be provided. If both are provided, the &#x60;ClientId&#x60; is used by default. | [optional]
952
+ **request_email** | **String**| Looks up the cross regional associations by the client’s email address. Either &#x60;ClientId&#x60; or &#x60;Email&#x60; must be provided. If both are provided, the &#x60;ClientId&#x60; is used by default. | [optional]
953
+ **request_limit** | **Integer**| Number of results to include, defaults to 100 | [optional]
954
+ **request_offset** | **Integer**| Page offset, defaults to 0. | [optional]
955
+
956
+ ### Return type
957
+
958
+ [**GetCrossRegionalClientAssociationsResponse**](GetCrossRegionalClientAssociationsResponse.md)
959
+
960
+ ### Authorization
961
+
962
+ No authorization required
963
+
964
+ ### HTTP request headers
965
+
966
+ - **Content-Type**: Not defined
967
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
968
+
969
+
970
+
971
+ # **client_get_custom_client_fields**
972
+ > GetCustomClientFieldsResponse client_get_custom_client_fields(site_id, version, opts)
973
+
974
+ Get a site's configured custom client fields.
975
+
976
+ ### Example
977
+ ```ruby
978
+ # load the gem
979
+ require 'swagger_client'
980
+
981
+ api_instance = SwaggerClient::ClientApi.new
982
+
983
+ site_id = 'site_id_example' # String | ID of the site from which to pull data.
984
+
985
+ version = 'version_example' # String |
986
+
987
+ opts = {
988
+ authorization: '', # String | A staff user authorization token.
989
+ request_limit: 56, # Integer | Number of results to include, defaults to 100
990
+ request_offset: 56 # Integer | Page offset, defaults to 0.
991
+ }
992
+
993
+ begin
994
+ #Get a site's configured custom client fields.
995
+ result = api_instance.client_get_custom_client_fields(site_id, version, opts)
996
+ p result
997
+ rescue SwaggerClient::ApiError => e
998
+ puts "Exception when calling ClientApi->client_get_custom_client_fields: #{e}"
999
+ end
1000
+ ```
1001
+
1002
+ ### Parameters
1003
+
1004
+ Name | Type | Description | Notes
1005
+ ------------- | ------------- | ------------- | -------------
1006
+ **site_id** | **String**| ID of the site from which to pull data. |
1007
+ **version** | **String**| |
1008
+ **authorization** | **String**| A staff user authorization token. | [optional] [default to ]
1009
+ **request_limit** | **Integer**| Number of results to include, defaults to 100 | [optional]
1010
+ **request_offset** | **Integer**| Page offset, defaults to 0. | [optional]
1011
+
1012
+ ### Return type
1013
+
1014
+ [**GetCustomClientFieldsResponse**](GetCustomClientFieldsResponse.md)
1015
+
1016
+ ### Authorization
1017
+
1018
+ No authorization required
1019
+
1020
+ ### HTTP request headers
1021
+
1022
+ - **Content-Type**: Not defined
1023
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
1024
+
1025
+
1026
+
1027
+ # **client_get_required_client_fields**
1028
+ > GetRequiredClientFieldsResponse client_get_required_client_fields(site_id, version, opts)
1029
+
1030
+ Get client required fields for a site.
1031
+
1032
+ Gets the list of fields that a new client has to fill out in business mode, specifically for the sign-up process. `AddClient` and `UpdateClient` validate against these fields. This endpoint has no query parameters.
1033
+
1034
+ ### Example
1035
+ ```ruby
1036
+ # load the gem
1037
+ require 'swagger_client'
1038
+
1039
+ api_instance = SwaggerClient::ClientApi.new
1040
+
1041
+ site_id = 'site_id_example' # String | ID of the site from which to pull data.
1042
+
1043
+ version = 'version_example' # String |
1044
+
1045
+ opts = {
1046
+ authorization: '' # String | A staff user authorization token.
1047
+ }
1048
+
1049
+ begin
1050
+ #Get client required fields for a site.
1051
+ result = api_instance.client_get_required_client_fields(site_id, version, opts)
1052
+ p result
1053
+ rescue SwaggerClient::ApiError => e
1054
+ puts "Exception when calling ClientApi->client_get_required_client_fields: #{e}"
1055
+ end
1056
+ ```
1057
+
1058
+ ### Parameters
1059
+
1060
+ Name | Type | Description | Notes
1061
+ ------------- | ------------- | ------------- | -------------
1062
+ **site_id** | **String**| ID of the site from which to pull data. |
1063
+ **version** | **String**| |
1064
+ **authorization** | **String**| A staff user authorization token. | [optional] [default to ]
1065
+
1066
+ ### Return type
1067
+
1068
+ [**GetRequiredClientFieldsResponse**](GetRequiredClientFieldsResponse.md)
1069
+
1070
+ ### Authorization
1071
+
1072
+ No authorization required
1073
+
1074
+ ### HTTP request headers
1075
+
1076
+ - **Content-Type**: Not defined
1077
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
1078
+
1079
+
1080
+
1081
+ # **client_send_password_reset_email**
1082
+ > Object client_send_password_reset_email(request, site_id, version, opts)
1083
+
1084
+ Send a password reset email to a client.
1085
+
1086
+ ### Example
1087
+ ```ruby
1088
+ # load the gem
1089
+ require 'swagger_client'
1090
+
1091
+ api_instance = SwaggerClient::ClientApi.new
1092
+
1093
+ request = SwaggerClient::SendPasswordResetEmailRequest.new # SendPasswordResetEmailRequest |
1094
+
1095
+ site_id = 'site_id_example' # String | ID of the site from which to pull data.
1096
+
1097
+ version = 'version_example' # String |
1098
+
1099
+ opts = {
1100
+ authorization: '' # String | A staff user authorization token.
1101
+ }
1102
+
1103
+ begin
1104
+ #Send a password reset email to a client.
1105
+ result = api_instance.client_send_password_reset_email(request, site_id, version, opts)
1106
+ p result
1107
+ rescue SwaggerClient::ApiError => e
1108
+ puts "Exception when calling ClientApi->client_send_password_reset_email: #{e}"
1109
+ end
1110
+ ```
1111
+
1112
+ ### Parameters
1113
+
1114
+ Name | Type | Description | Notes
1115
+ ------------- | ------------- | ------------- | -------------
1116
+ **request** | [**SendPasswordResetEmailRequest**](SendPasswordResetEmailRequest.md)| |
1117
+ **site_id** | **String**| ID of the site from which to pull data. |
1118
+ **version** | **String**| |
1119
+ **authorization** | **String**| A staff user authorization token. | [optional] [default to ]
1120
+
1121
+ ### Return type
1122
+
1123
+ **Object**
1124
+
1125
+ ### Authorization
1126
+
1127
+ No authorization required
1128
+
1129
+ ### HTTP request headers
1130
+
1131
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, multipart/form-data
1132
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
1133
+
1134
+
1135
+
1136
+ # **client_update_client**
1137
+ > UpdateClientResponse client_update_client(request, site_id, version, opts)
1138
+
1139
+ Update a client at a site.
1140
+
1141
+ Updates an existing client for a specific subscriber. Use this endpoint as follows: * If you need to update the `ReferredBy` parameter, use this endpoint after calling `GET ClientReferralTypes`. * When updating a client’s home location, use after calling `GET Locations`. * If you are updating a client’s stored credit card, use after calling `GET AcceptedCardTypes` so that you can make sure the card is a type that is accepted at the subscriber. If this endpoint is used on a cross-regional site, passing in a client’s RSSID and email address creates a cross-regional link. This means that the client is created in cross-regional sites where the client does not exist and `GET CrossRegionalClientAssociations` returns all appropriate cross-regional sites. When `CrossRegionalUpdate` is omitted or set to `true`, the client’s updated information is propagated to all of the region’s sites. If `CrossRegionalUpdate` is set to `false`, only the local client is updated. Note that the following items cannot be updated for a cross-regional client: * `ClientIndexes` * `ClientRelationships` * `CustomClientFields` * `SalesReps` * `SendAccountEmails` * `SendAccountTexts` * `SendPromotionalEmails` * `SendPromotionalTexts` * `SendScheduleEmails` * `SendScheduleTexts`
1142
+
1143
+ ### Example
1144
+ ```ruby
1145
+ # load the gem
1146
+ require 'swagger_client'
1147
+
1148
+ api_instance = SwaggerClient::ClientApi.new
1149
+
1150
+ request = SwaggerClient::UpdateClientRequest.new # UpdateClientRequest |
1151
+
1152
+ site_id = 'site_id_example' # String | ID of the site from which to pull data.
1153
+
1154
+ version = 'version_example' # String |
1155
+
1156
+ opts = {
1157
+ authorization: '' # String | A staff user authorization token.
1158
+ }
1159
+
1160
+ begin
1161
+ #Update a client at a site.
1162
+ result = api_instance.client_update_client(request, site_id, version, opts)
1163
+ p result
1164
+ rescue SwaggerClient::ApiError => e
1165
+ puts "Exception when calling ClientApi->client_update_client: #{e}"
1166
+ end
1167
+ ```
1168
+
1169
+ ### Parameters
1170
+
1171
+ Name | Type | Description | Notes
1172
+ ------------- | ------------- | ------------- | -------------
1173
+ **request** | [**UpdateClientRequest**](UpdateClientRequest.md)| |
1174
+ **site_id** | **String**| ID of the site from which to pull data. |
1175
+ **version** | **String**| |
1176
+ **authorization** | **String**| A staff user authorization token. | [optional] [default to ]
1177
+
1178
+ ### Return type
1179
+
1180
+ [**UpdateClientResponse**](UpdateClientResponse.md)
1181
+
1182
+ ### Authorization
1183
+
1184
+ No authorization required
1185
+
1186
+ ### HTTP request headers
1187
+
1188
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, multipart/form-data
1189
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
1190
+
1191
+
1192
+
1193
+ # **client_update_client_service**
1194
+ > UpdateClientServiceResponse client_update_client_service(request, site_id, version, opts)
1195
+
1196
+ Update a client's purchase pricing option.
1197
+
1198
+ Updates the active date and/or expiration date of a client pricing option. This request requires staff user credentials. If the active date is modified, the expiration date is also modified accordingly. If the expiration date is modified, the active date is unchanged.
1199
+
1200
+ ### Example
1201
+ ```ruby
1202
+ # load the gem
1203
+ require 'swagger_client'
1204
+
1205
+ api_instance = SwaggerClient::ClientApi.new
1206
+
1207
+ request = SwaggerClient::UpdateClientServiceRequest.new # UpdateClientServiceRequest |
1208
+
1209
+ site_id = 'site_id_example' # String | ID of the site from which to pull data.
1210
+
1211
+ version = 'version_example' # String |
1212
+
1213
+ opts = {
1214
+ authorization: '' # String | A staff user authorization token.
1215
+ }
1216
+
1217
+ begin
1218
+ #Update a client's purchase pricing option.
1219
+ result = api_instance.client_update_client_service(request, site_id, version, opts)
1220
+ p result
1221
+ rescue SwaggerClient::ApiError => e
1222
+ puts "Exception when calling ClientApi->client_update_client_service: #{e}"
1223
+ end
1224
+ ```
1225
+
1226
+ ### Parameters
1227
+
1228
+ Name | Type | Description | Notes
1229
+ ------------- | ------------- | ------------- | -------------
1230
+ **request** | [**UpdateClientServiceRequest**](UpdateClientServiceRequest.md)| |
1231
+ **site_id** | **String**| ID of the site from which to pull data. |
1232
+ **version** | **String**| |
1233
+ **authorization** | **String**| A staff user authorization token. | [optional] [default to ]
1234
+
1235
+ ### Return type
1236
+
1237
+ [**UpdateClientServiceResponse**](UpdateClientServiceResponse.md)
1238
+
1239
+ ### Authorization
1240
+
1241
+ No authorization required
1242
+
1243
+ ### HTTP request headers
1244
+
1245
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, multipart/form-data
1246
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
1247
+
1248
+
1249
+
1250
+ # **client_update_client_visit**
1251
+ > UpdateClientVisitResponse client_update_client_visit(request, site_id, version, opts)
1252
+
1253
+ Update a client's visit.
1254
+
1255
+ ### Example
1256
+ ```ruby
1257
+ # load the gem
1258
+ require 'swagger_client'
1259
+
1260
+ api_instance = SwaggerClient::ClientApi.new
1261
+
1262
+ request = SwaggerClient::UpdateClientVisitRequest.new # UpdateClientVisitRequest |
1263
+
1264
+ site_id = 'site_id_example' # String | ID of the site from which to pull data.
1265
+
1266
+ version = 'version_example' # String |
1267
+
1268
+ opts = {
1269
+ authorization: '' # String | A staff user authorization token.
1270
+ }
1271
+
1272
+ begin
1273
+ #Update a client's visit.
1274
+ result = api_instance.client_update_client_visit(request, site_id, version, opts)
1275
+ p result
1276
+ rescue SwaggerClient::ApiError => e
1277
+ puts "Exception when calling ClientApi->client_update_client_visit: #{e}"
1278
+ end
1279
+ ```
1280
+
1281
+ ### Parameters
1282
+
1283
+ Name | Type | Description | Notes
1284
+ ------------- | ------------- | ------------- | -------------
1285
+ **request** | [**UpdateClientVisitRequest**](UpdateClientVisitRequest.md)| |
1286
+ **site_id** | **String**| ID of the site from which to pull data. |
1287
+ **version** | **String**| |
1288
+ **authorization** | **String**| A staff user authorization token. | [optional] [default to ]
1289
+
1290
+ ### Return type
1291
+
1292
+ [**UpdateClientVisitResponse**](UpdateClientVisitResponse.md)
1293
+
1294
+ ### Authorization
1295
+
1296
+ No authorization required
1297
+
1298
+ ### HTTP request headers
1299
+
1300
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, multipart/form-data
1301
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
1302
+
1303
+
1304
+
1305
+ # **client_update_contact_log**
1306
+ > ContactLog client_update_contact_log(request, site_id, version, opts)
1307
+
1308
+ Update a contact log on a client's account.
1309
+
1310
+ ### Example
1311
+ ```ruby
1312
+ # load the gem
1313
+ require 'swagger_client'
1314
+
1315
+ api_instance = SwaggerClient::ClientApi.new
1316
+
1317
+ request = SwaggerClient::UpdateContactLogRequest.new # UpdateContactLogRequest |
1318
+
1319
+ site_id = 'site_id_example' # String | ID of the site from which to pull data.
1320
+
1321
+ version = 'version_example' # String |
1322
+
1323
+ opts = {
1324
+ authorization: '' # String | A staff user authorization token.
1325
+ }
1326
+
1327
+ begin
1328
+ #Update a contact log on a client's account.
1329
+ result = api_instance.client_update_contact_log(request, site_id, version, opts)
1330
+ p result
1331
+ rescue SwaggerClient::ApiError => e
1332
+ puts "Exception when calling ClientApi->client_update_contact_log: #{e}"
1333
+ end
1334
+ ```
1335
+
1336
+ ### Parameters
1337
+
1338
+ Name | Type | Description | Notes
1339
+ ------------- | ------------- | ------------- | -------------
1340
+ **request** | [**UpdateContactLogRequest**](UpdateContactLogRequest.md)| |
1341
+ **site_id** | **String**| ID of the site from which to pull data. |
1342
+ **version** | **String**| |
1343
+ **authorization** | **String**| A staff user authorization token. | [optional] [default to ]
1344
+
1345
+ ### Return type
1346
+
1347
+ [**ContactLog**](ContactLog.md)
1348
+
1349
+ ### Authorization
1350
+
1351
+ No authorization required
1352
+
1353
+ ### HTTP request headers
1354
+
1355
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, multipart/form-data
1356
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
1357
+
1358
+
1359
+
1360
+ # **client_upload_client_document**
1361
+ > UploadClientDocumentResponse client_upload_client_document(request, site_id, version, opts)
1362
+
1363
+ Upload a document to a client's profile.
1364
+
1365
+ Returns a string representation of the image byte array. The maximum document size is 1MB. The maximum size file that can be uploaded is 4 MB.
1366
+
1367
+ ### Example
1368
+ ```ruby
1369
+ # load the gem
1370
+ require 'swagger_client'
1371
+
1372
+ api_instance = SwaggerClient::ClientApi.new
1373
+
1374
+ request = SwaggerClient::UploadClientDocumentRequest.new # UploadClientDocumentRequest |
1375
+
1376
+ site_id = 'site_id_example' # String | ID of the site from which to pull data.
1377
+
1378
+ version = 'version_example' # String |
1379
+
1380
+ opts = {
1381
+ authorization: '' # String | A staff user authorization token.
1382
+ }
1383
+
1384
+ begin
1385
+ #Upload a document to a client's profile.
1386
+ result = api_instance.client_upload_client_document(request, site_id, version, opts)
1387
+ p result
1388
+ rescue SwaggerClient::ApiError => e
1389
+ puts "Exception when calling ClientApi->client_upload_client_document: #{e}"
1390
+ end
1391
+ ```
1392
+
1393
+ ### Parameters
1394
+
1395
+ Name | Type | Description | Notes
1396
+ ------------- | ------------- | ------------- | -------------
1397
+ **request** | [**UploadClientDocumentRequest**](UploadClientDocumentRequest.md)| |
1398
+ **site_id** | **String**| ID of the site from which to pull data. |
1399
+ **version** | **String**| |
1400
+ **authorization** | **String**| A staff user authorization token. | [optional] [default to ]
1401
+
1402
+ ### Return type
1403
+
1404
+ [**UploadClientDocumentResponse**](UploadClientDocumentResponse.md)
1405
+
1406
+ ### Authorization
1407
+
1408
+ No authorization required
1409
+
1410
+ ### HTTP request headers
1411
+
1412
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, multipart/form-data
1413
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
1414
+
1415
+
1416
+
1417
+ # **client_upload_client_photo**
1418
+ > UploadClientPhotoResponse client_upload_client_photo(request, site_id, version, opts)
1419
+
1420
+ Upload a profile photo to a client's profile.
1421
+
1422
+ The maximum file size is 4 MB and acceptable file types are: * bmp * jpeg * gif * tiff * png
1423
+
1424
+ ### Example
1425
+ ```ruby
1426
+ # load the gem
1427
+ require 'swagger_client'
1428
+
1429
+ api_instance = SwaggerClient::ClientApi.new
1430
+
1431
+ request = SwaggerClient::UploadClientPhotoRequest.new # UploadClientPhotoRequest |
1432
+
1433
+ site_id = 'site_id_example' # String | ID of the site from which to pull data.
1434
+
1435
+ version = 'version_example' # String |
1436
+
1437
+ opts = {
1438
+ authorization: '' # String | A staff user authorization token.
1439
+ }
1440
+
1441
+ begin
1442
+ #Upload a profile photo to a client's profile.
1443
+ result = api_instance.client_upload_client_photo(request, site_id, version, opts)
1444
+ p result
1445
+ rescue SwaggerClient::ApiError => e
1446
+ puts "Exception when calling ClientApi->client_upload_client_photo: #{e}"
1447
+ end
1448
+ ```
1449
+
1450
+ ### Parameters
1451
+
1452
+ Name | Type | Description | Notes
1453
+ ------------- | ------------- | ------------- | -------------
1454
+ **request** | [**UploadClientPhotoRequest**](UploadClientPhotoRequest.md)| |
1455
+ **site_id** | **String**| ID of the site from which to pull data. |
1456
+ **version** | **String**| |
1457
+ **authorization** | **String**| A staff user authorization token. | [optional] [default to ]
1458
+
1459
+ ### Return type
1460
+
1461
+ [**UploadClientPhotoResponse**](UploadClientPhotoResponse.md)
1462
+
1463
+ ### Authorization
1464
+
1465
+ No authorization required
1466
+
1467
+ ### HTTP request headers
1468
+
1469
+ - **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, multipart/form-data
1470
+ - **Accept**: application/json, text/json, application/xml, text/xml, multipart/form-data
1471
+
1472
+
1473
+