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,1795 @@
1
+ =begin
2
+ #MINDBODY Public API
3
+
4
+ #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
5
+
6
+ OpenAPI spec version: v6
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.6
10
+
11
+ =end
12
+
13
+ require 'uri'
14
+
15
+ module SwaggerClient
16
+ class ClientApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Add an arrival for a client.
23
+ # @param request
24
+ # @param site_id ID of the site from which to pull data.
25
+ # @param version
26
+ # @param [Hash] opts the optional parameters
27
+ # @option opts [String] :authorization A staff user authorization token. (default to )
28
+ # @return [AddArrivalResponse]
29
+ def client_add_arrival(request, site_id, version, opts = {})
30
+ data, _status_code, _headers = client_add_arrival_with_http_info(request, site_id, version, opts)
31
+ data
32
+ end
33
+
34
+ # Add an arrival for a client.
35
+ # @param request
36
+ # @param site_id ID of the site from which to pull data.
37
+ # @param version
38
+ # @param [Hash] opts the optional parameters
39
+ # @option opts [String] :authorization A staff user authorization token.
40
+ # @return [Array<(AddArrivalResponse, Fixnum, Hash)>] AddArrivalResponse data, response status code and response headers
41
+ def client_add_arrival_with_http_info(request, site_id, version, opts = {})
42
+ if @api_client.config.debugging
43
+ @api_client.config.logger.debug 'Calling API: ClientApi.client_add_arrival ...'
44
+ end
45
+ # verify the required parameter 'request' is set
46
+ if @api_client.config.client_side_validation && request.nil?
47
+ fail ArgumentError, "Missing the required parameter 'request' when calling ClientApi.client_add_arrival"
48
+ end
49
+ # verify the required parameter 'site_id' is set
50
+ if @api_client.config.client_side_validation && site_id.nil?
51
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling ClientApi.client_add_arrival"
52
+ end
53
+ # verify the required parameter 'version' is set
54
+ if @api_client.config.client_side_validation && version.nil?
55
+ fail ArgumentError, "Missing the required parameter 'version' when calling ClientApi.client_add_arrival"
56
+ end
57
+ # resource path
58
+ local_var_path = '/public/v{version}/client/addarrival'.sub('{' + 'version' + '}', version.to_s)
59
+
60
+ # query parameters
61
+ query_params = {}
62
+
63
+ # header parameters
64
+ header_params = {}
65
+ # HTTP header 'Accept' (if needed)
66
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
67
+ # HTTP header 'Content-Type'
68
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded', 'multipart/form-data'])
69
+ header_params[:'siteId'] = site_id
70
+ header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
71
+
72
+ # form parameters
73
+ form_params = {}
74
+
75
+ # http body (model)
76
+ post_body = @api_client.object_to_http_body(request)
77
+ auth_names = []
78
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
79
+ :header_params => header_params,
80
+ :query_params => query_params,
81
+ :form_params => form_params,
82
+ :body => post_body,
83
+ :auth_names => auth_names,
84
+ :return_type => 'AddArrivalResponse')
85
+ if @api_client.config.debugging
86
+ @api_client.config.logger.debug "API called: ClientApi#client_add_arrival\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
87
+ end
88
+ return data, status_code, headers
89
+ end
90
+ # Add a client to a site.
91
+ # 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.
92
+ # @param request
93
+ # @param site_id ID of the site from which to pull data.
94
+ # @param version
95
+ # @param [Hash] opts the optional parameters
96
+ # @option opts [String] :authorization A staff user authorization token. (default to )
97
+ # @return [AddClientResponse]
98
+ def client_add_client(request, site_id, version, opts = {})
99
+ data, _status_code, _headers = client_add_client_with_http_info(request, site_id, version, opts)
100
+ data
101
+ end
102
+
103
+ # Add a client to a site.
104
+ # The &#x60;FirstName&#x60; and &#x60;LastName&#x60; 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 &#x60;GetRequiredClientFields&#x60; endpoint to make sure you are collecting all required pieces of information.
105
+ # @param request
106
+ # @param site_id ID of the site from which to pull data.
107
+ # @param version
108
+ # @param [Hash] opts the optional parameters
109
+ # @option opts [String] :authorization A staff user authorization token.
110
+ # @return [Array<(AddClientResponse, Fixnum, Hash)>] AddClientResponse data, response status code and response headers
111
+ def client_add_client_with_http_info(request, site_id, version, opts = {})
112
+ if @api_client.config.debugging
113
+ @api_client.config.logger.debug 'Calling API: ClientApi.client_add_client ...'
114
+ end
115
+ # verify the required parameter 'request' is set
116
+ if @api_client.config.client_side_validation && request.nil?
117
+ fail ArgumentError, "Missing the required parameter 'request' when calling ClientApi.client_add_client"
118
+ end
119
+ # verify the required parameter 'site_id' is set
120
+ if @api_client.config.client_side_validation && site_id.nil?
121
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling ClientApi.client_add_client"
122
+ end
123
+ # verify the required parameter 'version' is set
124
+ if @api_client.config.client_side_validation && version.nil?
125
+ fail ArgumentError, "Missing the required parameter 'version' when calling ClientApi.client_add_client"
126
+ end
127
+ # resource path
128
+ local_var_path = '/public/v{version}/client/addclient'.sub('{' + 'version' + '}', version.to_s)
129
+
130
+ # query parameters
131
+ query_params = {}
132
+
133
+ # header parameters
134
+ header_params = {}
135
+ # HTTP header 'Accept' (if needed)
136
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
137
+ # HTTP header 'Content-Type'
138
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded', 'multipart/form-data'])
139
+ header_params[:'siteId'] = site_id
140
+ header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
141
+
142
+ # form parameters
143
+ form_params = {}
144
+
145
+ # http body (model)
146
+ post_body = @api_client.object_to_http_body(request)
147
+ auth_names = []
148
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
149
+ :header_params => header_params,
150
+ :query_params => query_params,
151
+ :form_params => form_params,
152
+ :body => post_body,
153
+ :auth_names => auth_names,
154
+ :return_type => 'AddClientResponse')
155
+ if @api_client.config.debugging
156
+ @api_client.config.logger.debug "API called: ClientApi#client_add_client\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
157
+ end
158
+ return data, status_code, headers
159
+ end
160
+ # Add a contact log to a client's account.
161
+ # @param request
162
+ # @param site_id ID of the site from which to pull data.
163
+ # @param version
164
+ # @param [Hash] opts the optional parameters
165
+ # @option opts [String] :authorization A staff user authorization token. (default to )
166
+ # @return [ContactLog]
167
+ def client_add_contact_log(request, site_id, version, opts = {})
168
+ data, _status_code, _headers = client_add_contact_log_with_http_info(request, site_id, version, opts)
169
+ data
170
+ end
171
+
172
+ # Add a contact log to a client&#39;s account.
173
+ # @param request
174
+ # @param site_id ID of the site from which to pull data.
175
+ # @param version
176
+ # @param [Hash] opts the optional parameters
177
+ # @option opts [String] :authorization A staff user authorization token.
178
+ # @return [Array<(ContactLog, Fixnum, Hash)>] ContactLog data, response status code and response headers
179
+ def client_add_contact_log_with_http_info(request, site_id, version, opts = {})
180
+ if @api_client.config.debugging
181
+ @api_client.config.logger.debug 'Calling API: ClientApi.client_add_contact_log ...'
182
+ end
183
+ # verify the required parameter 'request' is set
184
+ if @api_client.config.client_side_validation && request.nil?
185
+ fail ArgumentError, "Missing the required parameter 'request' when calling ClientApi.client_add_contact_log"
186
+ end
187
+ # verify the required parameter 'site_id' is set
188
+ if @api_client.config.client_side_validation && site_id.nil?
189
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling ClientApi.client_add_contact_log"
190
+ end
191
+ # verify the required parameter 'version' is set
192
+ if @api_client.config.client_side_validation && version.nil?
193
+ fail ArgumentError, "Missing the required parameter 'version' when calling ClientApi.client_add_contact_log"
194
+ end
195
+ # resource path
196
+ local_var_path = '/public/v{version}/client/addcontactlog'.sub('{' + 'version' + '}', version.to_s)
197
+
198
+ # query parameters
199
+ query_params = {}
200
+
201
+ # header parameters
202
+ header_params = {}
203
+ # HTTP header 'Accept' (if needed)
204
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
205
+ # HTTP header 'Content-Type'
206
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded', 'multipart/form-data'])
207
+ header_params[:'siteId'] = site_id
208
+ header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
209
+
210
+ # form parameters
211
+ form_params = {}
212
+
213
+ # http body (model)
214
+ post_body = @api_client.object_to_http_body(request)
215
+ auth_names = []
216
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
217
+ :header_params => header_params,
218
+ :query_params => query_params,
219
+ :form_params => form_params,
220
+ :body => post_body,
221
+ :auth_names => auth_names,
222
+ :return_type => 'ContactLog')
223
+ if @api_client.config.debugging
224
+ @api_client.config.logger.debug "API called: ClientApi#client_add_contact_log\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
225
+ end
226
+ return data, status_code, headers
227
+ end
228
+ # Get a client's active memberships.
229
+ # @param request_client_id The ID of the client whose membership was requested.
230
+ # @param site_id ID of the site from which to pull data.
231
+ # @param version
232
+ # @param [Hash] opts the optional parameters
233
+ # @option opts [String] :authorization A staff user authorization token. (default to )
234
+ # @option opts [Integer] :request_limit Number of results to include, defaults to 100
235
+ # @option opts [Integer] :request_location_id The ID of the location where the requested membership was created.
236
+ # @option opts [Integer] :request_offset Page offset, defaults to 0.
237
+ # @return [GetActiveClientMembershipsResponse]
238
+ def client_get_active_client_memberships(request_client_id, site_id, version, opts = {})
239
+ data, _status_code, _headers = client_get_active_client_memberships_with_http_info(request_client_id, site_id, version, opts)
240
+ data
241
+ end
242
+
243
+ # Get a client&#39;s active memberships.
244
+ # @param request_client_id The ID of the client whose membership was requested.
245
+ # @param site_id ID of the site from which to pull data.
246
+ # @param version
247
+ # @param [Hash] opts the optional parameters
248
+ # @option opts [String] :authorization A staff user authorization token.
249
+ # @option opts [Integer] :request_limit Number of results to include, defaults to 100
250
+ # @option opts [Integer] :request_location_id The ID of the location where the requested membership was created.
251
+ # @option opts [Integer] :request_offset Page offset, defaults to 0.
252
+ # @return [Array<(GetActiveClientMembershipsResponse, Fixnum, Hash)>] GetActiveClientMembershipsResponse data, response status code and response headers
253
+ def client_get_active_client_memberships_with_http_info(request_client_id, site_id, version, opts = {})
254
+ if @api_client.config.debugging
255
+ @api_client.config.logger.debug 'Calling API: ClientApi.client_get_active_client_memberships ...'
256
+ end
257
+ # verify the required parameter 'request_client_id' is set
258
+ if @api_client.config.client_side_validation && request_client_id.nil?
259
+ fail ArgumentError, "Missing the required parameter 'request_client_id' when calling ClientApi.client_get_active_client_memberships"
260
+ end
261
+ # verify the required parameter 'site_id' is set
262
+ if @api_client.config.client_side_validation && site_id.nil?
263
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling ClientApi.client_get_active_client_memberships"
264
+ end
265
+ # verify the required parameter 'version' is set
266
+ if @api_client.config.client_side_validation && version.nil?
267
+ fail ArgumentError, "Missing the required parameter 'version' when calling ClientApi.client_get_active_client_memberships"
268
+ end
269
+ # resource path
270
+ local_var_path = '/public/v{version}/client/activeclientmemberships'.sub('{' + 'version' + '}', version.to_s)
271
+
272
+ # query parameters
273
+ query_params = {}
274
+ query_params[:'request.clientId'] = request_client_id
275
+ query_params[:'request.limit'] = opts[:'request_limit'] if !opts[:'request_limit'].nil?
276
+ query_params[:'request.locationId'] = opts[:'request_location_id'] if !opts[:'request_location_id'].nil?
277
+ query_params[:'request.offset'] = opts[:'request_offset'] if !opts[:'request_offset'].nil?
278
+
279
+ # header parameters
280
+ header_params = {}
281
+ # HTTP header 'Accept' (if needed)
282
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
283
+ header_params[:'siteId'] = site_id
284
+ header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
285
+
286
+ # form parameters
287
+ form_params = {}
288
+
289
+ # http body (model)
290
+ post_body = nil
291
+ auth_names = []
292
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
293
+ :header_params => header_params,
294
+ :query_params => query_params,
295
+ :form_params => form_params,
296
+ :body => post_body,
297
+ :auth_names => auth_names,
298
+ :return_type => 'GetActiveClientMembershipsResponse')
299
+ if @api_client.config.debugging
300
+ @api_client.config.logger.debug "API called: ClientApi#client_get_active_client_memberships\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
301
+ end
302
+ return data, status_code, headers
303
+ end
304
+ # Get account balance information for one or more client(s).
305
+ # @param request_client_ids The list of clients IDs for which you want account balances.
306
+ # @param site_id ID of the site from which to pull data.
307
+ # @param version
308
+ # @param [Hash] opts the optional parameters
309
+ # @option opts [String] :authorization A staff user authorization token. (default to )
310
+ # @option opts [DateTime] :request_balance_date The date you want a balance relative to. Default: **the current date**
311
+ # @option opts [Integer] :request_class_id The class ID of the event for which you want a balance.
312
+ # @option opts [Integer] :request_limit Number of results to include, defaults to 100
313
+ # @option opts [Integer] :request_offset Page offset, defaults to 0.
314
+ # @return [GetClientAccountBalancesResponse]
315
+ def client_get_client_account_balances(request_client_ids, site_id, version, opts = {})
316
+ data, _status_code, _headers = client_get_client_account_balances_with_http_info(request_client_ids, site_id, version, opts)
317
+ data
318
+ end
319
+
320
+ # Get account balance information for one or more client(s).
321
+ # @param request_client_ids The list of clients IDs for which you want account balances.
322
+ # @param site_id ID of the site from which to pull data.
323
+ # @param version
324
+ # @param [Hash] opts the optional parameters
325
+ # @option opts [String] :authorization A staff user authorization token.
326
+ # @option opts [DateTime] :request_balance_date The date you want a balance relative to. Default: **the current date**
327
+ # @option opts [Integer] :request_class_id The class ID of the event for which you want a balance.
328
+ # @option opts [Integer] :request_limit Number of results to include, defaults to 100
329
+ # @option opts [Integer] :request_offset Page offset, defaults to 0.
330
+ # @return [Array<(GetClientAccountBalancesResponse, Fixnum, Hash)>] GetClientAccountBalancesResponse data, response status code and response headers
331
+ def client_get_client_account_balances_with_http_info(request_client_ids, site_id, version, opts = {})
332
+ if @api_client.config.debugging
333
+ @api_client.config.logger.debug 'Calling API: ClientApi.client_get_client_account_balances ...'
334
+ end
335
+ # verify the required parameter 'request_client_ids' is set
336
+ if @api_client.config.client_side_validation && request_client_ids.nil?
337
+ fail ArgumentError, "Missing the required parameter 'request_client_ids' when calling ClientApi.client_get_client_account_balances"
338
+ end
339
+ # verify the required parameter 'site_id' is set
340
+ if @api_client.config.client_side_validation && site_id.nil?
341
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling ClientApi.client_get_client_account_balances"
342
+ end
343
+ # verify the required parameter 'version' is set
344
+ if @api_client.config.client_side_validation && version.nil?
345
+ fail ArgumentError, "Missing the required parameter 'version' when calling ClientApi.client_get_client_account_balances"
346
+ end
347
+ # resource path
348
+ local_var_path = '/public/v{version}/client/clientaccountbalances'.sub('{' + 'version' + '}', version.to_s)
349
+
350
+ # query parameters
351
+ query_params = {}
352
+ query_params[:'request.clientIds'] = @api_client.build_collection_param(request_client_ids, :multi)
353
+ query_params[:'request.balanceDate'] = opts[:'request_balance_date'] if !opts[:'request_balance_date'].nil?
354
+ query_params[:'request.classId'] = opts[:'request_class_id'] if !opts[:'request_class_id'].nil?
355
+ query_params[:'request.limit'] = opts[:'request_limit'] if !opts[:'request_limit'].nil?
356
+ query_params[:'request.offset'] = opts[:'request_offset'] if !opts[:'request_offset'].nil?
357
+
358
+ # header parameters
359
+ header_params = {}
360
+ # HTTP header 'Accept' (if needed)
361
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
362
+ header_params[:'siteId'] = site_id
363
+ header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
364
+
365
+ # form parameters
366
+ form_params = {}
367
+
368
+ # http body (model)
369
+ post_body = nil
370
+ auth_names = []
371
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
372
+ :header_params => header_params,
373
+ :query_params => query_params,
374
+ :form_params => form_params,
375
+ :body => post_body,
376
+ :auth_names => auth_names,
377
+ :return_type => 'GetClientAccountBalancesResponse')
378
+ if @api_client.config.debugging
379
+ @api_client.config.logger.debug "API called: ClientApi#client_get_client_account_balances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
380
+ end
381
+ return data, status_code, headers
382
+ end
383
+ # Get contracts that a client has purchased.
384
+ # @param request_client_id The ID of the client.
385
+ # @param site_id ID of the site from which to pull data.
386
+ # @param version
387
+ # @param [Hash] opts the optional parameters
388
+ # @option opts [String] :authorization A staff user authorization token. (default to )
389
+ # @option opts [Integer] :request_client_associated_sites_offset 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**
390
+ # @option opts [BOOLEAN] :request_cross_regional_lookup 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.
391
+ # @option opts [Integer] :request_limit Number of results to include, defaults to 100
392
+ # @option opts [Integer] :request_offset Page offset, defaults to 0.
393
+ # @return [GetClientContractsResponse]
394
+ def client_get_client_contracts(request_client_id, site_id, version, opts = {})
395
+ data, _status_code, _headers = client_get_client_contracts_with_http_info(request_client_id, site_id, version, opts)
396
+ data
397
+ end
398
+
399
+ # Get contracts that a client has purchased.
400
+ # @param request_client_id The ID of the client.
401
+ # @param site_id ID of the site from which to pull data.
402
+ # @param version
403
+ # @param [Hash] opts the optional parameters
404
+ # @option opts [String] :authorization A staff user authorization token.
405
+ # @option opts [Integer] :request_client_associated_sites_offset 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**
406
+ # @option opts [BOOLEAN] :request_cross_regional_lookup 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.
407
+ # @option opts [Integer] :request_limit Number of results to include, defaults to 100
408
+ # @option opts [Integer] :request_offset Page offset, defaults to 0.
409
+ # @return [Array<(GetClientContractsResponse, Fixnum, Hash)>] GetClientContractsResponse data, response status code and response headers
410
+ def client_get_client_contracts_with_http_info(request_client_id, site_id, version, opts = {})
411
+ if @api_client.config.debugging
412
+ @api_client.config.logger.debug 'Calling API: ClientApi.client_get_client_contracts ...'
413
+ end
414
+ # verify the required parameter 'request_client_id' is set
415
+ if @api_client.config.client_side_validation && request_client_id.nil?
416
+ fail ArgumentError, "Missing the required parameter 'request_client_id' when calling ClientApi.client_get_client_contracts"
417
+ end
418
+ # verify the required parameter 'site_id' is set
419
+ if @api_client.config.client_side_validation && site_id.nil?
420
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling ClientApi.client_get_client_contracts"
421
+ end
422
+ # verify the required parameter 'version' is set
423
+ if @api_client.config.client_side_validation && version.nil?
424
+ fail ArgumentError, "Missing the required parameter 'version' when calling ClientApi.client_get_client_contracts"
425
+ end
426
+ # resource path
427
+ local_var_path = '/public/v{version}/client/clientcontracts'.sub('{' + 'version' + '}', version.to_s)
428
+
429
+ # query parameters
430
+ query_params = {}
431
+ query_params[:'request.clientId'] = request_client_id
432
+ query_params[:'request.clientAssociatedSitesOffset'] = opts[:'request_client_associated_sites_offset'] if !opts[:'request_client_associated_sites_offset'].nil?
433
+ query_params[:'request.crossRegionalLookup'] = opts[:'request_cross_regional_lookup'] if !opts[:'request_cross_regional_lookup'].nil?
434
+ query_params[:'request.limit'] = opts[:'request_limit'] if !opts[:'request_limit'].nil?
435
+ query_params[:'request.offset'] = opts[:'request_offset'] if !opts[:'request_offset'].nil?
436
+
437
+ # header parameters
438
+ header_params = {}
439
+ # HTTP header 'Accept' (if needed)
440
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
441
+ header_params[:'siteId'] = site_id
442
+ header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
443
+
444
+ # form parameters
445
+ form_params = {}
446
+
447
+ # http body (model)
448
+ post_body = nil
449
+ auth_names = []
450
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
451
+ :header_params => header_params,
452
+ :query_params => query_params,
453
+ :form_params => form_params,
454
+ :body => post_body,
455
+ :auth_names => auth_names,
456
+ :return_type => 'GetClientContractsResponse')
457
+ if @api_client.config.debugging
458
+ @api_client.config.logger.debug "API called: ClientApi#client_get_client_contracts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
459
+ end
460
+ return data, status_code, headers
461
+ end
462
+ # Get a client's formula notes.
463
+ # @param site_id ID of the site from which to pull data.
464
+ # @param version
465
+ # @param [Hash] opts the optional parameters
466
+ # @option opts [String] :authorization A staff user authorization token. (default to )
467
+ # @option opts [Integer] :request_appointment_id The appointment ID of the appointment that the formula notes are related to.
468
+ # @option opts [String] :request_client_id The client ID of the client whose formula notes are being requested.
469
+ # @option opts [Integer] :request_limit Number of results to include, defaults to 100
470
+ # @option opts [Integer] :request_offset Page offset, defaults to 0.
471
+ # @return [GetClientFormulaNotesResponse]
472
+ def client_get_client_formula_notes(site_id, version, opts = {})
473
+ data, _status_code, _headers = client_get_client_formula_notes_with_http_info(site_id, version, opts)
474
+ data
475
+ end
476
+
477
+ # Get a client&#39;s formula notes.
478
+ # @param site_id ID of the site from which to pull data.
479
+ # @param version
480
+ # @param [Hash] opts the optional parameters
481
+ # @option opts [String] :authorization A staff user authorization token.
482
+ # @option opts [Integer] :request_appointment_id The appointment ID of the appointment that the formula notes are related to.
483
+ # @option opts [String] :request_client_id The client ID of the client whose formula notes are being requested.
484
+ # @option opts [Integer] :request_limit Number of results to include, defaults to 100
485
+ # @option opts [Integer] :request_offset Page offset, defaults to 0.
486
+ # @return [Array<(GetClientFormulaNotesResponse, Fixnum, Hash)>] GetClientFormulaNotesResponse data, response status code and response headers
487
+ def client_get_client_formula_notes_with_http_info(site_id, version, opts = {})
488
+ if @api_client.config.debugging
489
+ @api_client.config.logger.debug 'Calling API: ClientApi.client_get_client_formula_notes ...'
490
+ end
491
+ # verify the required parameter 'site_id' is set
492
+ if @api_client.config.client_side_validation && site_id.nil?
493
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling ClientApi.client_get_client_formula_notes"
494
+ end
495
+ # verify the required parameter 'version' is set
496
+ if @api_client.config.client_side_validation && version.nil?
497
+ fail ArgumentError, "Missing the required parameter 'version' when calling ClientApi.client_get_client_formula_notes"
498
+ end
499
+ # resource path
500
+ local_var_path = '/public/v{version}/client/clientformulanotes'.sub('{' + 'version' + '}', version.to_s)
501
+
502
+ # query parameters
503
+ query_params = {}
504
+ query_params[:'request.appointmentId'] = opts[:'request_appointment_id'] if !opts[:'request_appointment_id'].nil?
505
+ query_params[:'request.clientId'] = opts[:'request_client_id'] if !opts[:'request_client_id'].nil?
506
+ query_params[:'request.limit'] = opts[:'request_limit'] if !opts[:'request_limit'].nil?
507
+ query_params[:'request.offset'] = opts[:'request_offset'] if !opts[:'request_offset'].nil?
508
+
509
+ # header parameters
510
+ header_params = {}
511
+ # HTTP header 'Accept' (if needed)
512
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
513
+ header_params[:'siteId'] = site_id
514
+ header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
515
+
516
+ # form parameters
517
+ form_params = {}
518
+
519
+ # http body (model)
520
+ post_body = nil
521
+ auth_names = []
522
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
523
+ :header_params => header_params,
524
+ :query_params => query_params,
525
+ :form_params => form_params,
526
+ :body => post_body,
527
+ :auth_names => auth_names,
528
+ :return_type => 'GetClientFormulaNotesResponse')
529
+ if @api_client.config.debugging
530
+ @api_client.config.logger.debug "API called: ClientApi#client_get_client_formula_notes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
531
+ end
532
+ return data, status_code, headers
533
+ end
534
+ # Get a site's configured client indexes and client index values.
535
+ # 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).
536
+ # @param site_id ID of the site from which to pull data.
537
+ # @param version
538
+ # @param [Hash] opts the optional parameters
539
+ # @option opts [String] :authorization A staff user authorization token. (default to )
540
+ # @option opts [BOOLEAN] :request_required_only 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.
541
+ # @return [GetClientIndexesResponse]
542
+ def client_get_client_indexes(site_id, version, opts = {})
543
+ data, _status_code, _headers = client_get_client_indexes_with_http_info(site_id, version, opts)
544
+ data
545
+ end
546
+
547
+ # Get a site&#39;s configured client indexes and client index values.
548
+ # 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&#x3D;en_USclient).
549
+ # @param site_id ID of the site from which to pull data.
550
+ # @param version
551
+ # @param [Hash] opts the optional parameters
552
+ # @option opts [String] :authorization A staff user authorization token.
553
+ # @option opts [BOOLEAN] :request_required_only 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.
554
+ # @return [Array<(GetClientIndexesResponse, Fixnum, Hash)>] GetClientIndexesResponse data, response status code and response headers
555
+ def client_get_client_indexes_with_http_info(site_id, version, opts = {})
556
+ if @api_client.config.debugging
557
+ @api_client.config.logger.debug 'Calling API: ClientApi.client_get_client_indexes ...'
558
+ end
559
+ # verify the required parameter 'site_id' is set
560
+ if @api_client.config.client_side_validation && site_id.nil?
561
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling ClientApi.client_get_client_indexes"
562
+ end
563
+ # verify the required parameter 'version' is set
564
+ if @api_client.config.client_side_validation && version.nil?
565
+ fail ArgumentError, "Missing the required parameter 'version' when calling ClientApi.client_get_client_indexes"
566
+ end
567
+ # resource path
568
+ local_var_path = '/public/v{version}/client/clientindexes'.sub('{' + 'version' + '}', version.to_s)
569
+
570
+ # query parameters
571
+ query_params = {}
572
+ query_params[:'request.requiredOnly'] = opts[:'request_required_only'] if !opts[:'request_required_only'].nil?
573
+
574
+ # header parameters
575
+ header_params = {}
576
+ # HTTP header 'Accept' (if needed)
577
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
578
+ header_params[:'siteId'] = site_id
579
+ header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
580
+
581
+ # form parameters
582
+ form_params = {}
583
+
584
+ # http body (model)
585
+ post_body = nil
586
+ auth_names = []
587
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
588
+ :header_params => header_params,
589
+ :query_params => query_params,
590
+ :form_params => form_params,
591
+ :body => post_body,
592
+ :auth_names => auth_names,
593
+ :return_type => 'GetClientIndexesResponse')
594
+ if @api_client.config.debugging
595
+ @api_client.config.logger.debug "API called: ClientApi#client_get_client_indexes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
596
+ end
597
+ return data, status_code, headers
598
+ end
599
+ # Get a client's purchase history.
600
+ # @param request_client_id The ID of the client you are querying for purchases.
601
+ # @param site_id ID of the site from which to pull data.
602
+ # @param version
603
+ # @param [Hash] opts the optional parameters
604
+ # @option opts [String] :authorization A staff user authorization token. (default to )
605
+ # @option opts [DateTime] :request_end_date Filters results to purchases made before this timestamp.&lt;br /&gt; Default: **end of today**
606
+ # @option opts [Integer] :request_limit Number of results to include, defaults to 100
607
+ # @option opts [Integer] :request_offset Page offset, defaults to 0.
608
+ # @option opts [Integer] :request_sale_id Filters results to the single record associated with this ID.
609
+ # @option opts [DateTime] :request_start_date Filters results to purchases made on or after this timestamp.&lt;br /&gt; Default: **now**
610
+ # @return [GetClientPurchasesResponse]
611
+ def client_get_client_purchases(request_client_id, site_id, version, opts = {})
612
+ data, _status_code, _headers = client_get_client_purchases_with_http_info(request_client_id, site_id, version, opts)
613
+ data
614
+ end
615
+
616
+ # Get a client&#39;s purchase history.
617
+ # @param request_client_id The ID of the client you are querying for purchases.
618
+ # @param site_id ID of the site from which to pull data.
619
+ # @param version
620
+ # @param [Hash] opts the optional parameters
621
+ # @option opts [String] :authorization A staff user authorization token.
622
+ # @option opts [DateTime] :request_end_date Filters results to purchases made before this timestamp.&lt;br /&gt; Default: **end of today**
623
+ # @option opts [Integer] :request_limit Number of results to include, defaults to 100
624
+ # @option opts [Integer] :request_offset Page offset, defaults to 0.
625
+ # @option opts [Integer] :request_sale_id Filters results to the single record associated with this ID.
626
+ # @option opts [DateTime] :request_start_date Filters results to purchases made on or after this timestamp.&lt;br /&gt; Default: **now**
627
+ # @return [Array<(GetClientPurchasesResponse, Fixnum, Hash)>] GetClientPurchasesResponse data, response status code and response headers
628
+ def client_get_client_purchases_with_http_info(request_client_id, site_id, version, opts = {})
629
+ if @api_client.config.debugging
630
+ @api_client.config.logger.debug 'Calling API: ClientApi.client_get_client_purchases ...'
631
+ end
632
+ # verify the required parameter 'request_client_id' is set
633
+ if @api_client.config.client_side_validation && request_client_id.nil?
634
+ fail ArgumentError, "Missing the required parameter 'request_client_id' when calling ClientApi.client_get_client_purchases"
635
+ end
636
+ # verify the required parameter 'site_id' is set
637
+ if @api_client.config.client_side_validation && site_id.nil?
638
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling ClientApi.client_get_client_purchases"
639
+ end
640
+ # verify the required parameter 'version' is set
641
+ if @api_client.config.client_side_validation && version.nil?
642
+ fail ArgumentError, "Missing the required parameter 'version' when calling ClientApi.client_get_client_purchases"
643
+ end
644
+ # resource path
645
+ local_var_path = '/public/v{version}/client/clientpurchases'.sub('{' + 'version' + '}', version.to_s)
646
+
647
+ # query parameters
648
+ query_params = {}
649
+ query_params[:'request.clientId'] = request_client_id
650
+ query_params[:'request.endDate'] = opts[:'request_end_date'] if !opts[:'request_end_date'].nil?
651
+ query_params[:'request.limit'] = opts[:'request_limit'] if !opts[:'request_limit'].nil?
652
+ query_params[:'request.offset'] = opts[:'request_offset'] if !opts[:'request_offset'].nil?
653
+ query_params[:'request.saleId'] = opts[:'request_sale_id'] if !opts[:'request_sale_id'].nil?
654
+ query_params[:'request.startDate'] = opts[:'request_start_date'] if !opts[:'request_start_date'].nil?
655
+
656
+ # header parameters
657
+ header_params = {}
658
+ # HTTP header 'Accept' (if needed)
659
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
660
+ header_params[:'siteId'] = site_id
661
+ header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
662
+
663
+ # form parameters
664
+ form_params = {}
665
+
666
+ # http body (model)
667
+ post_body = nil
668
+ auth_names = []
669
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
670
+ :header_params => header_params,
671
+ :query_params => query_params,
672
+ :form_params => form_params,
673
+ :body => post_body,
674
+ :auth_names => auth_names,
675
+ :return_type => 'GetClientPurchasesResponse')
676
+ if @api_client.config.debugging
677
+ @api_client.config.logger.debug "API called: ClientApi#client_get_client_purchases\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
678
+ end
679
+ return data, status_code, headers
680
+ end
681
+ # Get a site's configured client referral types.
682
+ # 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.
683
+ # @param site_id ID of the site from which to pull data.
684
+ # @param version
685
+ # @param [Hash] opts the optional parameters
686
+ # @option opts [String] :authorization A staff user authorization token. (default to )
687
+ # @option opts [BOOLEAN] :request_include_inactive 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.
688
+ # @return [GetClientReferralTypesResponse]
689
+ def client_get_client_referral_types(site_id, version, opts = {})
690
+ data, _status_code, _headers = client_get_client_referral_types_with_http_info(site_id, version, opts)
691
+ data
692
+ end
693
+
694
+ # Get a site&#39;s configured client referral types.
695
+ # 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.
696
+ # @param site_id ID of the site from which to pull data.
697
+ # @param version
698
+ # @param [Hash] opts the optional parameters
699
+ # @option opts [String] :authorization A staff user authorization token.
700
+ # @option opts [BOOLEAN] :request_include_inactive 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.
701
+ # @return [Array<(GetClientReferralTypesResponse, Fixnum, Hash)>] GetClientReferralTypesResponse data, response status code and response headers
702
+ def client_get_client_referral_types_with_http_info(site_id, version, opts = {})
703
+ if @api_client.config.debugging
704
+ @api_client.config.logger.debug 'Calling API: ClientApi.client_get_client_referral_types ...'
705
+ end
706
+ # verify the required parameter 'site_id' is set
707
+ if @api_client.config.client_side_validation && site_id.nil?
708
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling ClientApi.client_get_client_referral_types"
709
+ end
710
+ # verify the required parameter 'version' is set
711
+ if @api_client.config.client_side_validation && version.nil?
712
+ fail ArgumentError, "Missing the required parameter 'version' when calling ClientApi.client_get_client_referral_types"
713
+ end
714
+ # resource path
715
+ local_var_path = '/public/v{version}/client/clientreferraltypes'.sub('{' + 'version' + '}', version.to_s)
716
+
717
+ # query parameters
718
+ query_params = {}
719
+ query_params[:'request.includeInactive'] = opts[:'request_include_inactive'] if !opts[:'request_include_inactive'].nil?
720
+
721
+ # header parameters
722
+ header_params = {}
723
+ # HTTP header 'Accept' (if needed)
724
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
725
+ header_params[:'siteId'] = site_id
726
+ header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
727
+
728
+ # form parameters
729
+ form_params = {}
730
+
731
+ # http body (model)
732
+ post_body = nil
733
+ auth_names = []
734
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
735
+ :header_params => header_params,
736
+ :query_params => query_params,
737
+ :form_params => form_params,
738
+ :body => post_body,
739
+ :auth_names => auth_names,
740
+ :return_type => 'GetClientReferralTypesResponse')
741
+ if @api_client.config.debugging
742
+ @api_client.config.logger.debug "API called: ClientApi#client_get_client_referral_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
743
+ end
744
+ return data, status_code, headers
745
+ end
746
+ # Get pricing options that a client has purchased.
747
+ # @param request_client_id 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.
748
+ # @param site_id ID of the site from which to pull data.
749
+ # @param version
750
+ # @param [Hash] opts the optional parameters
751
+ # @option opts [String] :authorization A staff user authorization token. (default to )
752
+ # @option opts [Integer] :request_class_id Filters results to only those pricing options that can be used to pay for this class.
753
+ # @option opts [Integer] :request_client_associated_sites_offset 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
754
+ # @option opts [BOOLEAN] :request_cross_regional_lookup 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**
755
+ # @option opts [DateTime] :request_end_date Filters results to pricing options that are valid on or before this date.
756
+ # @option opts [Integer] :request_limit Number of results to include, defaults to 100
757
+ # @option opts [Array<Integer>] :request_location_ids Filters results to pricing options that can be used at the listed location IDs.
758
+ # @option opts [Integer] :request_offset Page offset, defaults to 0.
759
+ # @option opts [Array<Integer>] :request_program_ids Filters results to pricing options that belong to one of the given program IDs.
760
+ # @option opts [Integer] :request_session_type_id 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.
761
+ # @option opts [BOOLEAN] :request_show_active_only When &#x60;true&#x60;, includes active services only. Default: **false**
762
+ # @option opts [DateTime] :request_start_date Filters results to pricing options that are valid on or after this date.
763
+ # @option opts [Integer] :request_visit_count A filter on the minimum number of visits a service can pay for.
764
+ # @return [GetClientServicesResponse]
765
+ def client_get_client_services(request_client_id, site_id, version, opts = {})
766
+ data, _status_code, _headers = client_get_client_services_with_http_info(request_client_id, site_id, version, opts)
767
+ data
768
+ end
769
+
770
+ # Get pricing options that a client has purchased.
771
+ # @param request_client_id 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.
772
+ # @param site_id ID of the site from which to pull data.
773
+ # @param version
774
+ # @param [Hash] opts the optional parameters
775
+ # @option opts [String] :authorization A staff user authorization token.
776
+ # @option opts [Integer] :request_class_id Filters results to only those pricing options that can be used to pay for this class.
777
+ # @option opts [Integer] :request_client_associated_sites_offset 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
778
+ # @option opts [BOOLEAN] :request_cross_regional_lookup 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**
779
+ # @option opts [DateTime] :request_end_date Filters results to pricing options that are valid on or before this date.
780
+ # @option opts [Integer] :request_limit Number of results to include, defaults to 100
781
+ # @option opts [Array<Integer>] :request_location_ids Filters results to pricing options that can be used at the listed location IDs.
782
+ # @option opts [Integer] :request_offset Page offset, defaults to 0.
783
+ # @option opts [Array<Integer>] :request_program_ids Filters results to pricing options that belong to one of the given program IDs.
784
+ # @option opts [Integer] :request_session_type_id 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.
785
+ # @option opts [BOOLEAN] :request_show_active_only When &#x60;true&#x60;, includes active services only. Default: **false**
786
+ # @option opts [DateTime] :request_start_date Filters results to pricing options that are valid on or after this date.
787
+ # @option opts [Integer] :request_visit_count A filter on the minimum number of visits a service can pay for.
788
+ # @return [Array<(GetClientServicesResponse, Fixnum, Hash)>] GetClientServicesResponse data, response status code and response headers
789
+ def client_get_client_services_with_http_info(request_client_id, site_id, version, opts = {})
790
+ if @api_client.config.debugging
791
+ @api_client.config.logger.debug 'Calling API: ClientApi.client_get_client_services ...'
792
+ end
793
+ # verify the required parameter 'request_client_id' is set
794
+ if @api_client.config.client_side_validation && request_client_id.nil?
795
+ fail ArgumentError, "Missing the required parameter 'request_client_id' when calling ClientApi.client_get_client_services"
796
+ end
797
+ # verify the required parameter 'site_id' is set
798
+ if @api_client.config.client_side_validation && site_id.nil?
799
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling ClientApi.client_get_client_services"
800
+ end
801
+ # verify the required parameter 'version' is set
802
+ if @api_client.config.client_side_validation && version.nil?
803
+ fail ArgumentError, "Missing the required parameter 'version' when calling ClientApi.client_get_client_services"
804
+ end
805
+ # resource path
806
+ local_var_path = '/public/v{version}/client/clientservices'.sub('{' + 'version' + '}', version.to_s)
807
+
808
+ # query parameters
809
+ query_params = {}
810
+ query_params[:'request.clientId'] = request_client_id
811
+ query_params[:'request.classId'] = opts[:'request_class_id'] if !opts[:'request_class_id'].nil?
812
+ query_params[:'request.clientAssociatedSitesOffset'] = opts[:'request_client_associated_sites_offset'] if !opts[:'request_client_associated_sites_offset'].nil?
813
+ query_params[:'request.crossRegionalLookup'] = opts[:'request_cross_regional_lookup'] if !opts[:'request_cross_regional_lookup'].nil?
814
+ query_params[:'request.endDate'] = opts[:'request_end_date'] if !opts[:'request_end_date'].nil?
815
+ query_params[:'request.limit'] = opts[:'request_limit'] if !opts[:'request_limit'].nil?
816
+ query_params[:'request.locationIds'] = @api_client.build_collection_param(opts[:'request_location_ids'], :multi) if !opts[:'request_location_ids'].nil?
817
+ query_params[:'request.offset'] = opts[:'request_offset'] if !opts[:'request_offset'].nil?
818
+ query_params[:'request.programIds'] = @api_client.build_collection_param(opts[:'request_program_ids'], :multi) if !opts[:'request_program_ids'].nil?
819
+ query_params[:'request.sessionTypeId'] = opts[:'request_session_type_id'] if !opts[:'request_session_type_id'].nil?
820
+ query_params[:'request.showActiveOnly'] = opts[:'request_show_active_only'] if !opts[:'request_show_active_only'].nil?
821
+ query_params[:'request.startDate'] = opts[:'request_start_date'] if !opts[:'request_start_date'].nil?
822
+ query_params[:'request.visitCount'] = opts[:'request_visit_count'] if !opts[:'request_visit_count'].nil?
823
+
824
+ # header parameters
825
+ header_params = {}
826
+ # HTTP header 'Accept' (if needed)
827
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
828
+ header_params[:'siteId'] = site_id
829
+ header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
830
+
831
+ # form parameters
832
+ form_params = {}
833
+
834
+ # http body (model)
835
+ post_body = nil
836
+ auth_names = []
837
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
838
+ :header_params => header_params,
839
+ :query_params => query_params,
840
+ :form_params => form_params,
841
+ :body => post_body,
842
+ :auth_names => auth_names,
843
+ :return_type => 'GetClientServicesResponse')
844
+ if @api_client.config.debugging
845
+ @api_client.config.logger.debug "API called: ClientApi#client_get_client_services\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
846
+ end
847
+ return data, status_code, headers
848
+ end
849
+ # Get a client's visit history.
850
+ # @param request_client_id The ID of the requested client.
851
+ # @param site_id ID of the site from which to pull data.
852
+ # @param version
853
+ # @param [Hash] opts the optional parameters
854
+ # @option opts [String] :authorization A staff user authorization token. (default to )
855
+ # @option opts [Integer] :request_client_associated_sites_offset The number of sites to skip when returning the site associated with a client.
856
+ # @option opts [BOOLEAN] :request_cross_regional_lookup 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.
857
+ # @option opts [DateTime] :request_end_date The date past which class visits are not returned. Default: **today’s date**
858
+ # @option opts [Integer] :request_limit Number of results to include, defaults to 100
859
+ # @option opts [Integer] :request_offset Page offset, defaults to 0.
860
+ # @option opts [DateTime] :request_start_date The date before which class visits are not returned. Default: **the end date**
861
+ # @option opts [BOOLEAN] :request_unpaids_only 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**
862
+ # @return [GetClientVisitsResponse]
863
+ def client_get_client_visits(request_client_id, site_id, version, opts = {})
864
+ data, _status_code, _headers = client_get_client_visits_with_http_info(request_client_id, site_id, version, opts)
865
+ data
866
+ end
867
+
868
+ # Get a client&#39;s visit history.
869
+ # @param request_client_id The ID of the requested client.
870
+ # @param site_id ID of the site from which to pull data.
871
+ # @param version
872
+ # @param [Hash] opts the optional parameters
873
+ # @option opts [String] :authorization A staff user authorization token.
874
+ # @option opts [Integer] :request_client_associated_sites_offset The number of sites to skip when returning the site associated with a client.
875
+ # @option opts [BOOLEAN] :request_cross_regional_lookup 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.
876
+ # @option opts [DateTime] :request_end_date The date past which class visits are not returned. Default: **today’s date**
877
+ # @option opts [Integer] :request_limit Number of results to include, defaults to 100
878
+ # @option opts [Integer] :request_offset Page offset, defaults to 0.
879
+ # @option opts [DateTime] :request_start_date The date before which class visits are not returned. Default: **the end date**
880
+ # @option opts [BOOLEAN] :request_unpaids_only 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**
881
+ # @return [Array<(GetClientVisitsResponse, Fixnum, Hash)>] GetClientVisitsResponse data, response status code and response headers
882
+ def client_get_client_visits_with_http_info(request_client_id, site_id, version, opts = {})
883
+ if @api_client.config.debugging
884
+ @api_client.config.logger.debug 'Calling API: ClientApi.client_get_client_visits ...'
885
+ end
886
+ # verify the required parameter 'request_client_id' is set
887
+ if @api_client.config.client_side_validation && request_client_id.nil?
888
+ fail ArgumentError, "Missing the required parameter 'request_client_id' when calling ClientApi.client_get_client_visits"
889
+ end
890
+ # verify the required parameter 'site_id' is set
891
+ if @api_client.config.client_side_validation && site_id.nil?
892
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling ClientApi.client_get_client_visits"
893
+ end
894
+ # verify the required parameter 'version' is set
895
+ if @api_client.config.client_side_validation && version.nil?
896
+ fail ArgumentError, "Missing the required parameter 'version' when calling ClientApi.client_get_client_visits"
897
+ end
898
+ # resource path
899
+ local_var_path = '/public/v{version}/client/clientvisits'.sub('{' + 'version' + '}', version.to_s)
900
+
901
+ # query parameters
902
+ query_params = {}
903
+ query_params[:'request.clientId'] = request_client_id
904
+ query_params[:'request.clientAssociatedSitesOffset'] = opts[:'request_client_associated_sites_offset'] if !opts[:'request_client_associated_sites_offset'].nil?
905
+ query_params[:'request.crossRegionalLookup'] = opts[:'request_cross_regional_lookup'] if !opts[:'request_cross_regional_lookup'].nil?
906
+ query_params[:'request.endDate'] = opts[:'request_end_date'] if !opts[:'request_end_date'].nil?
907
+ query_params[:'request.limit'] = opts[:'request_limit'] if !opts[:'request_limit'].nil?
908
+ query_params[:'request.offset'] = opts[:'request_offset'] if !opts[:'request_offset'].nil?
909
+ query_params[:'request.startDate'] = opts[:'request_start_date'] if !opts[:'request_start_date'].nil?
910
+ query_params[:'request.unpaidsOnly'] = opts[:'request_unpaids_only'] if !opts[:'request_unpaids_only'].nil?
911
+
912
+ # header parameters
913
+ header_params = {}
914
+ # HTTP header 'Accept' (if needed)
915
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
916
+ header_params[:'siteId'] = site_id
917
+ header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
918
+
919
+ # form parameters
920
+ form_params = {}
921
+
922
+ # http body (model)
923
+ post_body = nil
924
+ auth_names = []
925
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
926
+ :header_params => header_params,
927
+ :query_params => query_params,
928
+ :form_params => form_params,
929
+ :body => post_body,
930
+ :auth_names => auth_names,
931
+ :return_type => 'GetClientVisitsResponse')
932
+ if @api_client.config.debugging
933
+ @api_client.config.logger.debug "API called: ClientApi#client_get_client_visits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
934
+ end
935
+ return data, status_code, headers
936
+ end
937
+ # Get clients.
938
+ # @param site_id ID of the site from which to pull data.
939
+ # @param version
940
+ # @param [Hash] opts the optional parameters
941
+ # @option opts [String] :authorization A staff user authorization token. (default to )
942
+ # @option opts [Array<String>] :request_client_i_ds The requested client IDs. Default: **all IDs** that the authenticated user’s access level allows.
943
+ # @option opts [BOOLEAN] :request_is_prospect 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.
944
+ # @option opts [DateTime] :request_last_modified_date Filters the results to include only the clients that have been modified on or after this date.
945
+ # @option opts [Integer] :request_limit Number of results to include, defaults to 100
946
+ # @option opts [Integer] :request_offset Page offset, defaults to 0.
947
+ # @option opts [String] :request_search_text Text to use in the search. Can include FirstName, LastName, and Email. Note that user credentials must be provided.
948
+ # @return [GetClientsResponse]
949
+ def client_get_clients(site_id, version, opts = {})
950
+ data, _status_code, _headers = client_get_clients_with_http_info(site_id, version, opts)
951
+ data
952
+ end
953
+
954
+ # Get clients.
955
+ # @param site_id ID of the site from which to pull data.
956
+ # @param version
957
+ # @param [Hash] opts the optional parameters
958
+ # @option opts [String] :authorization A staff user authorization token.
959
+ # @option opts [Array<String>] :request_client_i_ds The requested client IDs. Default: **all IDs** that the authenticated user’s access level allows.
960
+ # @option opts [BOOLEAN] :request_is_prospect 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.
961
+ # @option opts [DateTime] :request_last_modified_date Filters the results to include only the clients that have been modified on or after this date.
962
+ # @option opts [Integer] :request_limit Number of results to include, defaults to 100
963
+ # @option opts [Integer] :request_offset Page offset, defaults to 0.
964
+ # @option opts [String] :request_search_text Text to use in the search. Can include FirstName, LastName, and Email. Note that user credentials must be provided.
965
+ # @return [Array<(GetClientsResponse, Fixnum, Hash)>] GetClientsResponse data, response status code and response headers
966
+ def client_get_clients_with_http_info(site_id, version, opts = {})
967
+ if @api_client.config.debugging
968
+ @api_client.config.logger.debug 'Calling API: ClientApi.client_get_clients ...'
969
+ end
970
+ # verify the required parameter 'site_id' is set
971
+ if @api_client.config.client_side_validation && site_id.nil?
972
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling ClientApi.client_get_clients"
973
+ end
974
+ # verify the required parameter 'version' is set
975
+ if @api_client.config.client_side_validation && version.nil?
976
+ fail ArgumentError, "Missing the required parameter 'version' when calling ClientApi.client_get_clients"
977
+ end
978
+ # resource path
979
+ local_var_path = '/public/v{version}/client/clients'.sub('{' + 'version' + '}', version.to_s)
980
+
981
+ # query parameters
982
+ query_params = {}
983
+ query_params[:'request.clientIDs'] = @api_client.build_collection_param(opts[:'request_client_i_ds'], :multi) if !opts[:'request_client_i_ds'].nil?
984
+ query_params[:'request.isProspect'] = opts[:'request_is_prospect'] if !opts[:'request_is_prospect'].nil?
985
+ query_params[:'request.lastModifiedDate'] = opts[:'request_last_modified_date'] if !opts[:'request_last_modified_date'].nil?
986
+ query_params[:'request.limit'] = opts[:'request_limit'] if !opts[:'request_limit'].nil?
987
+ query_params[:'request.offset'] = opts[:'request_offset'] if !opts[:'request_offset'].nil?
988
+ query_params[:'request.searchText'] = opts[:'request_search_text'] if !opts[:'request_search_text'].nil?
989
+
990
+ # header parameters
991
+ header_params = {}
992
+ # HTTP header 'Accept' (if needed)
993
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
994
+ header_params[:'siteId'] = site_id
995
+ header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
996
+
997
+ # form parameters
998
+ form_params = {}
999
+
1000
+ # http body (model)
1001
+ post_body = nil
1002
+ auth_names = []
1003
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1004
+ :header_params => header_params,
1005
+ :query_params => query_params,
1006
+ :form_params => form_params,
1007
+ :body => post_body,
1008
+ :auth_names => auth_names,
1009
+ :return_type => 'GetClientsResponse')
1010
+ if @api_client.config.debugging
1011
+ @api_client.config.logger.debug "API called: ClientApi#client_get_clients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1012
+ end
1013
+ return data, status_code, headers
1014
+ end
1015
+ # Get contact logs on a client's account.
1016
+ # 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.
1017
+ # @param request_client_id The ID of the client whose contact logs are being requested.
1018
+ # @param site_id ID of the site from which to pull data.
1019
+ # @param version
1020
+ # @param [Hash] opts the optional parameters
1021
+ # @option opts [String] :authorization A staff user authorization token. (default to )
1022
+ # @option opts [DateTime] :request_end_date Filters the results to contact logs created before this date.&lt;br /&gt; Default: **the start date**
1023
+ # @option opts [Integer] :request_limit Number of results to include, defaults to 100
1024
+ # @option opts [Integer] :request_offset Page offset, defaults to 0.
1025
+ # @option opts [BOOLEAN] :request_show_system_generated When &#x60;true&#x60;, system-generated contact logs are returned in the results.&lt;br /&gt; Default: **false**
1026
+ # @option opts [Array<Integer>] :request_staff_ids Filters the results to return contact logs assigned to one or more staff IDs.
1027
+ # @option opts [DateTime] :request_start_date Filters the results to contact logs created on or after this date.&lt;br /&gt; Default: **the current date**
1028
+ # @option opts [Array<Integer>] :request_subtype_ids Filters the results to contact logs assigned one or more of these subtype IDs.
1029
+ # @option opts [Array<Integer>] :request_type_ids Filters the results to contact logs assigned one or more of these type IDs.
1030
+ # @return [GetContactLogsResponse]
1031
+ def client_get_contact_logs(request_client_id, site_id, version, opts = {})
1032
+ data, _status_code, _headers = client_get_contact_logs_with_http_info(request_client_id, site_id, version, opts)
1033
+ data
1034
+ end
1035
+
1036
+ # Get contact logs on a client&#39;s account.
1037
+ # 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.
1038
+ # @param request_client_id The ID of the client whose contact logs are being requested.
1039
+ # @param site_id ID of the site from which to pull data.
1040
+ # @param version
1041
+ # @param [Hash] opts the optional parameters
1042
+ # @option opts [String] :authorization A staff user authorization token.
1043
+ # @option opts [DateTime] :request_end_date Filters the results to contact logs created before this date.&lt;br /&gt; Default: **the start date**
1044
+ # @option opts [Integer] :request_limit Number of results to include, defaults to 100
1045
+ # @option opts [Integer] :request_offset Page offset, defaults to 0.
1046
+ # @option opts [BOOLEAN] :request_show_system_generated When &#x60;true&#x60;, system-generated contact logs are returned in the results.&lt;br /&gt; Default: **false**
1047
+ # @option opts [Array<Integer>] :request_staff_ids Filters the results to return contact logs assigned to one or more staff IDs.
1048
+ # @option opts [DateTime] :request_start_date Filters the results to contact logs created on or after this date.&lt;br /&gt; Default: **the current date**
1049
+ # @option opts [Array<Integer>] :request_subtype_ids Filters the results to contact logs assigned one or more of these subtype IDs.
1050
+ # @option opts [Array<Integer>] :request_type_ids Filters the results to contact logs assigned one or more of these type IDs.
1051
+ # @return [Array<(GetContactLogsResponse, Fixnum, Hash)>] GetContactLogsResponse data, response status code and response headers
1052
+ def client_get_contact_logs_with_http_info(request_client_id, site_id, version, opts = {})
1053
+ if @api_client.config.debugging
1054
+ @api_client.config.logger.debug 'Calling API: ClientApi.client_get_contact_logs ...'
1055
+ end
1056
+ # verify the required parameter 'request_client_id' is set
1057
+ if @api_client.config.client_side_validation && request_client_id.nil?
1058
+ fail ArgumentError, "Missing the required parameter 'request_client_id' when calling ClientApi.client_get_contact_logs"
1059
+ end
1060
+ # verify the required parameter 'site_id' is set
1061
+ if @api_client.config.client_side_validation && site_id.nil?
1062
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling ClientApi.client_get_contact_logs"
1063
+ end
1064
+ # verify the required parameter 'version' is set
1065
+ if @api_client.config.client_side_validation && version.nil?
1066
+ fail ArgumentError, "Missing the required parameter 'version' when calling ClientApi.client_get_contact_logs"
1067
+ end
1068
+ # resource path
1069
+ local_var_path = '/public/v{version}/client/contactlogs'.sub('{' + 'version' + '}', version.to_s)
1070
+
1071
+ # query parameters
1072
+ query_params = {}
1073
+ query_params[:'request.clientId'] = request_client_id
1074
+ query_params[:'request.endDate'] = opts[:'request_end_date'] if !opts[:'request_end_date'].nil?
1075
+ query_params[:'request.limit'] = opts[:'request_limit'] if !opts[:'request_limit'].nil?
1076
+ query_params[:'request.offset'] = opts[:'request_offset'] if !opts[:'request_offset'].nil?
1077
+ query_params[:'request.showSystemGenerated'] = opts[:'request_show_system_generated'] if !opts[:'request_show_system_generated'].nil?
1078
+ query_params[:'request.staffIds'] = @api_client.build_collection_param(opts[:'request_staff_ids'], :multi) if !opts[:'request_staff_ids'].nil?
1079
+ query_params[:'request.startDate'] = opts[:'request_start_date'] if !opts[:'request_start_date'].nil?
1080
+ query_params[:'request.subtypeIds'] = @api_client.build_collection_param(opts[:'request_subtype_ids'], :multi) if !opts[:'request_subtype_ids'].nil?
1081
+ query_params[:'request.typeIds'] = @api_client.build_collection_param(opts[:'request_type_ids'], :multi) if !opts[:'request_type_ids'].nil?
1082
+
1083
+ # header parameters
1084
+ header_params = {}
1085
+ # HTTP header 'Accept' (if needed)
1086
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
1087
+ header_params[:'siteId'] = site_id
1088
+ header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
1089
+
1090
+ # form parameters
1091
+ form_params = {}
1092
+
1093
+ # http body (model)
1094
+ post_body = nil
1095
+ auth_names = []
1096
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1097
+ :header_params => header_params,
1098
+ :query_params => query_params,
1099
+ :form_params => form_params,
1100
+ :body => post_body,
1101
+ :auth_names => auth_names,
1102
+ :return_type => 'GetContactLogsResponse')
1103
+ if @api_client.config.debugging
1104
+ @api_client.config.logger.debug "API called: ClientApi#client_get_contact_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1105
+ end
1106
+ return data, status_code, headers
1107
+ end
1108
+ # Get a client's cross regional site associations.
1109
+ # 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.
1110
+ # @param site_id ID of the site from which to pull data.
1111
+ # @param version
1112
+ # @param [Hash] opts the optional parameters
1113
+ # @option opts [String] :authorization A staff user authorization token. (default to )
1114
+ # @option opts [String] :request_client_id 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.
1115
+ # @option opts [String] :request_email 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.
1116
+ # @option opts [Integer] :request_limit Number of results to include, defaults to 100
1117
+ # @option opts [Integer] :request_offset Page offset, defaults to 0.
1118
+ # @return [GetCrossRegionalClientAssociationsResponse]
1119
+ def client_get_cross_regional_client_associations(site_id, version, opts = {})
1120
+ data, _status_code, _headers = client_get_cross_regional_client_associations_with_http_info(site_id, version, opts)
1121
+ data
1122
+ end
1123
+
1124
+ # Get a client&#39;s cross regional site associations.
1125
+ # 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 &#x60;ClientID&#x60; or &#x60;Email&#x60; parameter is required. If both are provided, the &#x60;ClientID&#x60; 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.
1126
+ # @param site_id ID of the site from which to pull data.
1127
+ # @param version
1128
+ # @param [Hash] opts the optional parameters
1129
+ # @option opts [String] :authorization A staff user authorization token.
1130
+ # @option opts [String] :request_client_id 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.
1131
+ # @option opts [String] :request_email 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.
1132
+ # @option opts [Integer] :request_limit Number of results to include, defaults to 100
1133
+ # @option opts [Integer] :request_offset Page offset, defaults to 0.
1134
+ # @return [Array<(GetCrossRegionalClientAssociationsResponse, Fixnum, Hash)>] GetCrossRegionalClientAssociationsResponse data, response status code and response headers
1135
+ def client_get_cross_regional_client_associations_with_http_info(site_id, version, opts = {})
1136
+ if @api_client.config.debugging
1137
+ @api_client.config.logger.debug 'Calling API: ClientApi.client_get_cross_regional_client_associations ...'
1138
+ end
1139
+ # verify the required parameter 'site_id' is set
1140
+ if @api_client.config.client_side_validation && site_id.nil?
1141
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling ClientApi.client_get_cross_regional_client_associations"
1142
+ end
1143
+ # verify the required parameter 'version' is set
1144
+ if @api_client.config.client_side_validation && version.nil?
1145
+ fail ArgumentError, "Missing the required parameter 'version' when calling ClientApi.client_get_cross_regional_client_associations"
1146
+ end
1147
+ # resource path
1148
+ local_var_path = '/public/v{version}/client/crossregionalclientassociations'.sub('{' + 'version' + '}', version.to_s)
1149
+
1150
+ # query parameters
1151
+ query_params = {}
1152
+ query_params[:'request.clientId'] = opts[:'request_client_id'] if !opts[:'request_client_id'].nil?
1153
+ query_params[:'request.email'] = opts[:'request_email'] if !opts[:'request_email'].nil?
1154
+ query_params[:'request.limit'] = opts[:'request_limit'] if !opts[:'request_limit'].nil?
1155
+ query_params[:'request.offset'] = opts[:'request_offset'] if !opts[:'request_offset'].nil?
1156
+
1157
+ # header parameters
1158
+ header_params = {}
1159
+ # HTTP header 'Accept' (if needed)
1160
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
1161
+ header_params[:'siteId'] = site_id
1162
+ header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
1163
+
1164
+ # form parameters
1165
+ form_params = {}
1166
+
1167
+ # http body (model)
1168
+ post_body = nil
1169
+ auth_names = []
1170
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1171
+ :header_params => header_params,
1172
+ :query_params => query_params,
1173
+ :form_params => form_params,
1174
+ :body => post_body,
1175
+ :auth_names => auth_names,
1176
+ :return_type => 'GetCrossRegionalClientAssociationsResponse')
1177
+ if @api_client.config.debugging
1178
+ @api_client.config.logger.debug "API called: ClientApi#client_get_cross_regional_client_associations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1179
+ end
1180
+ return data, status_code, headers
1181
+ end
1182
+ # Get a site's configured custom client fields.
1183
+ # @param site_id ID of the site from which to pull data.
1184
+ # @param version
1185
+ # @param [Hash] opts the optional parameters
1186
+ # @option opts [String] :authorization A staff user authorization token. (default to )
1187
+ # @option opts [Integer] :request_limit Number of results to include, defaults to 100
1188
+ # @option opts [Integer] :request_offset Page offset, defaults to 0.
1189
+ # @return [GetCustomClientFieldsResponse]
1190
+ def client_get_custom_client_fields(site_id, version, opts = {})
1191
+ data, _status_code, _headers = client_get_custom_client_fields_with_http_info(site_id, version, opts)
1192
+ data
1193
+ end
1194
+
1195
+ # Get a site&#39;s configured custom client fields.
1196
+ # @param site_id ID of the site from which to pull data.
1197
+ # @param version
1198
+ # @param [Hash] opts the optional parameters
1199
+ # @option opts [String] :authorization A staff user authorization token.
1200
+ # @option opts [Integer] :request_limit Number of results to include, defaults to 100
1201
+ # @option opts [Integer] :request_offset Page offset, defaults to 0.
1202
+ # @return [Array<(GetCustomClientFieldsResponse, Fixnum, Hash)>] GetCustomClientFieldsResponse data, response status code and response headers
1203
+ def client_get_custom_client_fields_with_http_info(site_id, version, opts = {})
1204
+ if @api_client.config.debugging
1205
+ @api_client.config.logger.debug 'Calling API: ClientApi.client_get_custom_client_fields ...'
1206
+ end
1207
+ # verify the required parameter 'site_id' is set
1208
+ if @api_client.config.client_side_validation && site_id.nil?
1209
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling ClientApi.client_get_custom_client_fields"
1210
+ end
1211
+ # verify the required parameter 'version' is set
1212
+ if @api_client.config.client_side_validation && version.nil?
1213
+ fail ArgumentError, "Missing the required parameter 'version' when calling ClientApi.client_get_custom_client_fields"
1214
+ end
1215
+ # resource path
1216
+ local_var_path = '/public/v{version}/client/customclientfields'.sub('{' + 'version' + '}', version.to_s)
1217
+
1218
+ # query parameters
1219
+ query_params = {}
1220
+ query_params[:'request.limit'] = opts[:'request_limit'] if !opts[:'request_limit'].nil?
1221
+ query_params[:'request.offset'] = opts[:'request_offset'] if !opts[:'request_offset'].nil?
1222
+
1223
+ # header parameters
1224
+ header_params = {}
1225
+ # HTTP header 'Accept' (if needed)
1226
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
1227
+ header_params[:'siteId'] = site_id
1228
+ header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
1229
+
1230
+ # form parameters
1231
+ form_params = {}
1232
+
1233
+ # http body (model)
1234
+ post_body = nil
1235
+ auth_names = []
1236
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1237
+ :header_params => header_params,
1238
+ :query_params => query_params,
1239
+ :form_params => form_params,
1240
+ :body => post_body,
1241
+ :auth_names => auth_names,
1242
+ :return_type => 'GetCustomClientFieldsResponse')
1243
+ if @api_client.config.debugging
1244
+ @api_client.config.logger.debug "API called: ClientApi#client_get_custom_client_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1245
+ end
1246
+ return data, status_code, headers
1247
+ end
1248
+ # Get client required fields for a site.
1249
+ # 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.
1250
+ # @param site_id ID of the site from which to pull data.
1251
+ # @param version
1252
+ # @param [Hash] opts the optional parameters
1253
+ # @option opts [String] :authorization A staff user authorization token. (default to )
1254
+ # @return [GetRequiredClientFieldsResponse]
1255
+ def client_get_required_client_fields(site_id, version, opts = {})
1256
+ data, _status_code, _headers = client_get_required_client_fields_with_http_info(site_id, version, opts)
1257
+ data
1258
+ end
1259
+
1260
+ # Get client required fields for a site.
1261
+ # Gets the list of fields that a new client has to fill out in business mode, specifically for the sign-up process. &#x60;AddClient&#x60; and &#x60;UpdateClient&#x60; validate against these fields. This endpoint has no query parameters.
1262
+ # @param site_id ID of the site from which to pull data.
1263
+ # @param version
1264
+ # @param [Hash] opts the optional parameters
1265
+ # @option opts [String] :authorization A staff user authorization token.
1266
+ # @return [Array<(GetRequiredClientFieldsResponse, Fixnum, Hash)>] GetRequiredClientFieldsResponse data, response status code and response headers
1267
+ def client_get_required_client_fields_with_http_info(site_id, version, opts = {})
1268
+ if @api_client.config.debugging
1269
+ @api_client.config.logger.debug 'Calling API: ClientApi.client_get_required_client_fields ...'
1270
+ end
1271
+ # verify the required parameter 'site_id' is set
1272
+ if @api_client.config.client_side_validation && site_id.nil?
1273
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling ClientApi.client_get_required_client_fields"
1274
+ end
1275
+ # verify the required parameter 'version' is set
1276
+ if @api_client.config.client_side_validation && version.nil?
1277
+ fail ArgumentError, "Missing the required parameter 'version' when calling ClientApi.client_get_required_client_fields"
1278
+ end
1279
+ # resource path
1280
+ local_var_path = '/public/v{version}/client/requiredclientfields'.sub('{' + 'version' + '}', version.to_s)
1281
+
1282
+ # query parameters
1283
+ query_params = {}
1284
+
1285
+ # header parameters
1286
+ header_params = {}
1287
+ # HTTP header 'Accept' (if needed)
1288
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
1289
+ header_params[:'siteId'] = site_id
1290
+ header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
1291
+
1292
+ # form parameters
1293
+ form_params = {}
1294
+
1295
+ # http body (model)
1296
+ post_body = nil
1297
+ auth_names = []
1298
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1299
+ :header_params => header_params,
1300
+ :query_params => query_params,
1301
+ :form_params => form_params,
1302
+ :body => post_body,
1303
+ :auth_names => auth_names,
1304
+ :return_type => 'GetRequiredClientFieldsResponse')
1305
+ if @api_client.config.debugging
1306
+ @api_client.config.logger.debug "API called: ClientApi#client_get_required_client_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1307
+ end
1308
+ return data, status_code, headers
1309
+ end
1310
+ # Send a password reset email to a client.
1311
+ # @param request
1312
+ # @param site_id ID of the site from which to pull data.
1313
+ # @param version
1314
+ # @param [Hash] opts the optional parameters
1315
+ # @option opts [String] :authorization A staff user authorization token. (default to )
1316
+ # @return [Object]
1317
+ def client_send_password_reset_email(request, site_id, version, opts = {})
1318
+ data, _status_code, _headers = client_send_password_reset_email_with_http_info(request, site_id, version, opts)
1319
+ data
1320
+ end
1321
+
1322
+ # Send a password reset email to a client.
1323
+ # @param request
1324
+ # @param site_id ID of the site from which to pull data.
1325
+ # @param version
1326
+ # @param [Hash] opts the optional parameters
1327
+ # @option opts [String] :authorization A staff user authorization token.
1328
+ # @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
1329
+ def client_send_password_reset_email_with_http_info(request, site_id, version, opts = {})
1330
+ if @api_client.config.debugging
1331
+ @api_client.config.logger.debug 'Calling API: ClientApi.client_send_password_reset_email ...'
1332
+ end
1333
+ # verify the required parameter 'request' is set
1334
+ if @api_client.config.client_side_validation && request.nil?
1335
+ fail ArgumentError, "Missing the required parameter 'request' when calling ClientApi.client_send_password_reset_email"
1336
+ end
1337
+ # verify the required parameter 'site_id' is set
1338
+ if @api_client.config.client_side_validation && site_id.nil?
1339
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling ClientApi.client_send_password_reset_email"
1340
+ end
1341
+ # verify the required parameter 'version' is set
1342
+ if @api_client.config.client_side_validation && version.nil?
1343
+ fail ArgumentError, "Missing the required parameter 'version' when calling ClientApi.client_send_password_reset_email"
1344
+ end
1345
+ # resource path
1346
+ local_var_path = '/public/v{version}/client/sendpasswordresetemail'.sub('{' + 'version' + '}', version.to_s)
1347
+
1348
+ # query parameters
1349
+ query_params = {}
1350
+
1351
+ # header parameters
1352
+ header_params = {}
1353
+ # HTTP header 'Accept' (if needed)
1354
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
1355
+ # HTTP header 'Content-Type'
1356
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded', 'multipart/form-data'])
1357
+ header_params[:'siteId'] = site_id
1358
+ header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
1359
+
1360
+ # form parameters
1361
+ form_params = {}
1362
+
1363
+ # http body (model)
1364
+ post_body = @api_client.object_to_http_body(request)
1365
+ auth_names = []
1366
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1367
+ :header_params => header_params,
1368
+ :query_params => query_params,
1369
+ :form_params => form_params,
1370
+ :body => post_body,
1371
+ :auth_names => auth_names,
1372
+ :return_type => 'Object')
1373
+ if @api_client.config.debugging
1374
+ @api_client.config.logger.debug "API called: ClientApi#client_send_password_reset_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1375
+ end
1376
+ return data, status_code, headers
1377
+ end
1378
+ # Update a client at a site.
1379
+ # 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`
1380
+ # @param request
1381
+ # @param site_id ID of the site from which to pull data.
1382
+ # @param version
1383
+ # @param [Hash] opts the optional parameters
1384
+ # @option opts [String] :authorization A staff user authorization token. (default to )
1385
+ # @return [UpdateClientResponse]
1386
+ def client_update_client(request, site_id, version, opts = {})
1387
+ data, _status_code, _headers = client_update_client_with_http_info(request, site_id, version, opts)
1388
+ data
1389
+ end
1390
+
1391
+ # Update a client at a site.
1392
+ # Updates an existing client for a specific subscriber. Use this endpoint as follows: * If you need to update the &#x60;ReferredBy&#x60; parameter, use this endpoint after calling &#x60;GET ClientReferralTypes&#x60;. * When updating a client’s home location, use after calling &#x60;GET Locations&#x60;. * If you are updating a client’s stored credit card, use after calling &#x60;GET AcceptedCardTypes&#x60; 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 &#x60;GET CrossRegionalClientAssociations&#x60; returns all appropriate cross-regional sites. When &#x60;CrossRegionalUpdate&#x60; is omitted or set to &#x60;true&#x60;, the client’s updated information is propagated to all of the region’s sites. If &#x60;CrossRegionalUpdate&#x60; is set to &#x60;false&#x60;, only the local client is updated. Note that the following items cannot be updated for a cross-regional client: * &#x60;ClientIndexes&#x60; * &#x60;ClientRelationships&#x60; * &#x60;CustomClientFields&#x60; * &#x60;SalesReps&#x60; * &#x60;SendAccountEmails&#x60; * &#x60;SendAccountTexts&#x60; * &#x60;SendPromotionalEmails&#x60; * &#x60;SendPromotionalTexts&#x60; * &#x60;SendScheduleEmails&#x60; * &#x60;SendScheduleTexts&#x60;
1393
+ # @param request
1394
+ # @param site_id ID of the site from which to pull data.
1395
+ # @param version
1396
+ # @param [Hash] opts the optional parameters
1397
+ # @option opts [String] :authorization A staff user authorization token.
1398
+ # @return [Array<(UpdateClientResponse, Fixnum, Hash)>] UpdateClientResponse data, response status code and response headers
1399
+ def client_update_client_with_http_info(request, site_id, version, opts = {})
1400
+ if @api_client.config.debugging
1401
+ @api_client.config.logger.debug 'Calling API: ClientApi.client_update_client ...'
1402
+ end
1403
+ # verify the required parameter 'request' is set
1404
+ if @api_client.config.client_side_validation && request.nil?
1405
+ fail ArgumentError, "Missing the required parameter 'request' when calling ClientApi.client_update_client"
1406
+ end
1407
+ # verify the required parameter 'site_id' is set
1408
+ if @api_client.config.client_side_validation && site_id.nil?
1409
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling ClientApi.client_update_client"
1410
+ end
1411
+ # verify the required parameter 'version' is set
1412
+ if @api_client.config.client_side_validation && version.nil?
1413
+ fail ArgumentError, "Missing the required parameter 'version' when calling ClientApi.client_update_client"
1414
+ end
1415
+ # resource path
1416
+ local_var_path = '/public/v{version}/client/updateclient'.sub('{' + 'version' + '}', version.to_s)
1417
+
1418
+ # query parameters
1419
+ query_params = {}
1420
+
1421
+ # header parameters
1422
+ header_params = {}
1423
+ # HTTP header 'Accept' (if needed)
1424
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
1425
+ # HTTP header 'Content-Type'
1426
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded', 'multipart/form-data'])
1427
+ header_params[:'siteId'] = site_id
1428
+ header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
1429
+
1430
+ # form parameters
1431
+ form_params = {}
1432
+
1433
+ # http body (model)
1434
+ post_body = @api_client.object_to_http_body(request)
1435
+ auth_names = []
1436
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1437
+ :header_params => header_params,
1438
+ :query_params => query_params,
1439
+ :form_params => form_params,
1440
+ :body => post_body,
1441
+ :auth_names => auth_names,
1442
+ :return_type => 'UpdateClientResponse')
1443
+ if @api_client.config.debugging
1444
+ @api_client.config.logger.debug "API called: ClientApi#client_update_client\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1445
+ end
1446
+ return data, status_code, headers
1447
+ end
1448
+ # Update a client's purchase pricing option.
1449
+ # 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.
1450
+ # @param request
1451
+ # @param site_id ID of the site from which to pull data.
1452
+ # @param version
1453
+ # @param [Hash] opts the optional parameters
1454
+ # @option opts [String] :authorization A staff user authorization token. (default to )
1455
+ # @return [UpdateClientServiceResponse]
1456
+ def client_update_client_service(request, site_id, version, opts = {})
1457
+ data, _status_code, _headers = client_update_client_service_with_http_info(request, site_id, version, opts)
1458
+ data
1459
+ end
1460
+
1461
+ # Update a client&#39;s purchase pricing option.
1462
+ # 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.
1463
+ # @param request
1464
+ # @param site_id ID of the site from which to pull data.
1465
+ # @param version
1466
+ # @param [Hash] opts the optional parameters
1467
+ # @option opts [String] :authorization A staff user authorization token.
1468
+ # @return [Array<(UpdateClientServiceResponse, Fixnum, Hash)>] UpdateClientServiceResponse data, response status code and response headers
1469
+ def client_update_client_service_with_http_info(request, site_id, version, opts = {})
1470
+ if @api_client.config.debugging
1471
+ @api_client.config.logger.debug 'Calling API: ClientApi.client_update_client_service ...'
1472
+ end
1473
+ # verify the required parameter 'request' is set
1474
+ if @api_client.config.client_side_validation && request.nil?
1475
+ fail ArgumentError, "Missing the required parameter 'request' when calling ClientApi.client_update_client_service"
1476
+ end
1477
+ # verify the required parameter 'site_id' is set
1478
+ if @api_client.config.client_side_validation && site_id.nil?
1479
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling ClientApi.client_update_client_service"
1480
+ end
1481
+ # verify the required parameter 'version' is set
1482
+ if @api_client.config.client_side_validation && version.nil?
1483
+ fail ArgumentError, "Missing the required parameter 'version' when calling ClientApi.client_update_client_service"
1484
+ end
1485
+ # resource path
1486
+ local_var_path = '/public/v{version}/client/updateclientservice'.sub('{' + 'version' + '}', version.to_s)
1487
+
1488
+ # query parameters
1489
+ query_params = {}
1490
+
1491
+ # header parameters
1492
+ header_params = {}
1493
+ # HTTP header 'Accept' (if needed)
1494
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
1495
+ # HTTP header 'Content-Type'
1496
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded', 'multipart/form-data'])
1497
+ header_params[:'siteId'] = site_id
1498
+ header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
1499
+
1500
+ # form parameters
1501
+ form_params = {}
1502
+
1503
+ # http body (model)
1504
+ post_body = @api_client.object_to_http_body(request)
1505
+ auth_names = []
1506
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1507
+ :header_params => header_params,
1508
+ :query_params => query_params,
1509
+ :form_params => form_params,
1510
+ :body => post_body,
1511
+ :auth_names => auth_names,
1512
+ :return_type => 'UpdateClientServiceResponse')
1513
+ if @api_client.config.debugging
1514
+ @api_client.config.logger.debug "API called: ClientApi#client_update_client_service\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1515
+ end
1516
+ return data, status_code, headers
1517
+ end
1518
+ # Update a client's visit.
1519
+ # @param request
1520
+ # @param site_id ID of the site from which to pull data.
1521
+ # @param version
1522
+ # @param [Hash] opts the optional parameters
1523
+ # @option opts [String] :authorization A staff user authorization token. (default to )
1524
+ # @return [UpdateClientVisitResponse]
1525
+ def client_update_client_visit(request, site_id, version, opts = {})
1526
+ data, _status_code, _headers = client_update_client_visit_with_http_info(request, site_id, version, opts)
1527
+ data
1528
+ end
1529
+
1530
+ # Update a client&#39;s visit.
1531
+ # @param request
1532
+ # @param site_id ID of the site from which to pull data.
1533
+ # @param version
1534
+ # @param [Hash] opts the optional parameters
1535
+ # @option opts [String] :authorization A staff user authorization token.
1536
+ # @return [Array<(UpdateClientVisitResponse, Fixnum, Hash)>] UpdateClientVisitResponse data, response status code and response headers
1537
+ def client_update_client_visit_with_http_info(request, site_id, version, opts = {})
1538
+ if @api_client.config.debugging
1539
+ @api_client.config.logger.debug 'Calling API: ClientApi.client_update_client_visit ...'
1540
+ end
1541
+ # verify the required parameter 'request' is set
1542
+ if @api_client.config.client_side_validation && request.nil?
1543
+ fail ArgumentError, "Missing the required parameter 'request' when calling ClientApi.client_update_client_visit"
1544
+ end
1545
+ # verify the required parameter 'site_id' is set
1546
+ if @api_client.config.client_side_validation && site_id.nil?
1547
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling ClientApi.client_update_client_visit"
1548
+ end
1549
+ # verify the required parameter 'version' is set
1550
+ if @api_client.config.client_side_validation && version.nil?
1551
+ fail ArgumentError, "Missing the required parameter 'version' when calling ClientApi.client_update_client_visit"
1552
+ end
1553
+ # resource path
1554
+ local_var_path = '/public/v{version}/client/updateclientvisit'.sub('{' + 'version' + '}', version.to_s)
1555
+
1556
+ # query parameters
1557
+ query_params = {}
1558
+
1559
+ # header parameters
1560
+ header_params = {}
1561
+ # HTTP header 'Accept' (if needed)
1562
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
1563
+ # HTTP header 'Content-Type'
1564
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded', 'multipart/form-data'])
1565
+ header_params[:'siteId'] = site_id
1566
+ header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
1567
+
1568
+ # form parameters
1569
+ form_params = {}
1570
+
1571
+ # http body (model)
1572
+ post_body = @api_client.object_to_http_body(request)
1573
+ auth_names = []
1574
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1575
+ :header_params => header_params,
1576
+ :query_params => query_params,
1577
+ :form_params => form_params,
1578
+ :body => post_body,
1579
+ :auth_names => auth_names,
1580
+ :return_type => 'UpdateClientVisitResponse')
1581
+ if @api_client.config.debugging
1582
+ @api_client.config.logger.debug "API called: ClientApi#client_update_client_visit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1583
+ end
1584
+ return data, status_code, headers
1585
+ end
1586
+ # Update a contact log on a client's account.
1587
+ # @param request
1588
+ # @param site_id ID of the site from which to pull data.
1589
+ # @param version
1590
+ # @param [Hash] opts the optional parameters
1591
+ # @option opts [String] :authorization A staff user authorization token. (default to )
1592
+ # @return [ContactLog]
1593
+ def client_update_contact_log(request, site_id, version, opts = {})
1594
+ data, _status_code, _headers = client_update_contact_log_with_http_info(request, site_id, version, opts)
1595
+ data
1596
+ end
1597
+
1598
+ # Update a contact log on a client&#39;s account.
1599
+ # @param request
1600
+ # @param site_id ID of the site from which to pull data.
1601
+ # @param version
1602
+ # @param [Hash] opts the optional parameters
1603
+ # @option opts [String] :authorization A staff user authorization token.
1604
+ # @return [Array<(ContactLog, Fixnum, Hash)>] ContactLog data, response status code and response headers
1605
+ def client_update_contact_log_with_http_info(request, site_id, version, opts = {})
1606
+ if @api_client.config.debugging
1607
+ @api_client.config.logger.debug 'Calling API: ClientApi.client_update_contact_log ...'
1608
+ end
1609
+ # verify the required parameter 'request' is set
1610
+ if @api_client.config.client_side_validation && request.nil?
1611
+ fail ArgumentError, "Missing the required parameter 'request' when calling ClientApi.client_update_contact_log"
1612
+ end
1613
+ # verify the required parameter 'site_id' is set
1614
+ if @api_client.config.client_side_validation && site_id.nil?
1615
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling ClientApi.client_update_contact_log"
1616
+ end
1617
+ # verify the required parameter 'version' is set
1618
+ if @api_client.config.client_side_validation && version.nil?
1619
+ fail ArgumentError, "Missing the required parameter 'version' when calling ClientApi.client_update_contact_log"
1620
+ end
1621
+ # resource path
1622
+ local_var_path = '/public/v{version}/client/updatecontactlog'.sub('{' + 'version' + '}', version.to_s)
1623
+
1624
+ # query parameters
1625
+ query_params = {}
1626
+
1627
+ # header parameters
1628
+ header_params = {}
1629
+ # HTTP header 'Accept' (if needed)
1630
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
1631
+ # HTTP header 'Content-Type'
1632
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded', 'multipart/form-data'])
1633
+ header_params[:'siteId'] = site_id
1634
+ header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
1635
+
1636
+ # form parameters
1637
+ form_params = {}
1638
+
1639
+ # http body (model)
1640
+ post_body = @api_client.object_to_http_body(request)
1641
+ auth_names = []
1642
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1643
+ :header_params => header_params,
1644
+ :query_params => query_params,
1645
+ :form_params => form_params,
1646
+ :body => post_body,
1647
+ :auth_names => auth_names,
1648
+ :return_type => 'ContactLog')
1649
+ if @api_client.config.debugging
1650
+ @api_client.config.logger.debug "API called: ClientApi#client_update_contact_log\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1651
+ end
1652
+ return data, status_code, headers
1653
+ end
1654
+ # Upload a document to a client's profile.
1655
+ # 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.
1656
+ # @param request
1657
+ # @param site_id ID of the site from which to pull data.
1658
+ # @param version
1659
+ # @param [Hash] opts the optional parameters
1660
+ # @option opts [String] :authorization A staff user authorization token. (default to )
1661
+ # @return [UploadClientDocumentResponse]
1662
+ def client_upload_client_document(request, site_id, version, opts = {})
1663
+ data, _status_code, _headers = client_upload_client_document_with_http_info(request, site_id, version, opts)
1664
+ data
1665
+ end
1666
+
1667
+ # Upload a document to a client&#39;s profile.
1668
+ # 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.
1669
+ # @param request
1670
+ # @param site_id ID of the site from which to pull data.
1671
+ # @param version
1672
+ # @param [Hash] opts the optional parameters
1673
+ # @option opts [String] :authorization A staff user authorization token.
1674
+ # @return [Array<(UploadClientDocumentResponse, Fixnum, Hash)>] UploadClientDocumentResponse data, response status code and response headers
1675
+ def client_upload_client_document_with_http_info(request, site_id, version, opts = {})
1676
+ if @api_client.config.debugging
1677
+ @api_client.config.logger.debug 'Calling API: ClientApi.client_upload_client_document ...'
1678
+ end
1679
+ # verify the required parameter 'request' is set
1680
+ if @api_client.config.client_side_validation && request.nil?
1681
+ fail ArgumentError, "Missing the required parameter 'request' when calling ClientApi.client_upload_client_document"
1682
+ end
1683
+ # verify the required parameter 'site_id' is set
1684
+ if @api_client.config.client_side_validation && site_id.nil?
1685
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling ClientApi.client_upload_client_document"
1686
+ end
1687
+ # verify the required parameter 'version' is set
1688
+ if @api_client.config.client_side_validation && version.nil?
1689
+ fail ArgumentError, "Missing the required parameter 'version' when calling ClientApi.client_upload_client_document"
1690
+ end
1691
+ # resource path
1692
+ local_var_path = '/public/v{version}/client/uploadclientdocument'.sub('{' + 'version' + '}', version.to_s)
1693
+
1694
+ # query parameters
1695
+ query_params = {}
1696
+
1697
+ # header parameters
1698
+ header_params = {}
1699
+ # HTTP header 'Accept' (if needed)
1700
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
1701
+ # HTTP header 'Content-Type'
1702
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded', 'multipart/form-data'])
1703
+ header_params[:'siteId'] = site_id
1704
+ header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
1705
+
1706
+ # form parameters
1707
+ form_params = {}
1708
+
1709
+ # http body (model)
1710
+ post_body = @api_client.object_to_http_body(request)
1711
+ auth_names = []
1712
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1713
+ :header_params => header_params,
1714
+ :query_params => query_params,
1715
+ :form_params => form_params,
1716
+ :body => post_body,
1717
+ :auth_names => auth_names,
1718
+ :return_type => 'UploadClientDocumentResponse')
1719
+ if @api_client.config.debugging
1720
+ @api_client.config.logger.debug "API called: ClientApi#client_upload_client_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1721
+ end
1722
+ return data, status_code, headers
1723
+ end
1724
+ # Upload a profile photo to a client's profile.
1725
+ # The maximum file size is 4 MB and acceptable file types are: * bmp * jpeg * gif * tiff * png
1726
+ # @param request
1727
+ # @param site_id ID of the site from which to pull data.
1728
+ # @param version
1729
+ # @param [Hash] opts the optional parameters
1730
+ # @option opts [String] :authorization A staff user authorization token. (default to )
1731
+ # @return [UploadClientPhotoResponse]
1732
+ def client_upload_client_photo(request, site_id, version, opts = {})
1733
+ data, _status_code, _headers = client_upload_client_photo_with_http_info(request, site_id, version, opts)
1734
+ data
1735
+ end
1736
+
1737
+ # Upload a profile photo to a client&#39;s profile.
1738
+ # The maximum file size is 4 MB and acceptable file types are: * bmp * jpeg * gif * tiff * png
1739
+ # @param request
1740
+ # @param site_id ID of the site from which to pull data.
1741
+ # @param version
1742
+ # @param [Hash] opts the optional parameters
1743
+ # @option opts [String] :authorization A staff user authorization token.
1744
+ # @return [Array<(UploadClientPhotoResponse, Fixnum, Hash)>] UploadClientPhotoResponse data, response status code and response headers
1745
+ def client_upload_client_photo_with_http_info(request, site_id, version, opts = {})
1746
+ if @api_client.config.debugging
1747
+ @api_client.config.logger.debug 'Calling API: ClientApi.client_upload_client_photo ...'
1748
+ end
1749
+ # verify the required parameter 'request' is set
1750
+ if @api_client.config.client_side_validation && request.nil?
1751
+ fail ArgumentError, "Missing the required parameter 'request' when calling ClientApi.client_upload_client_photo"
1752
+ end
1753
+ # verify the required parameter 'site_id' is set
1754
+ if @api_client.config.client_side_validation && site_id.nil?
1755
+ fail ArgumentError, "Missing the required parameter 'site_id' when calling ClientApi.client_upload_client_photo"
1756
+ end
1757
+ # verify the required parameter 'version' is set
1758
+ if @api_client.config.client_side_validation && version.nil?
1759
+ fail ArgumentError, "Missing the required parameter 'version' when calling ClientApi.client_upload_client_photo"
1760
+ end
1761
+ # resource path
1762
+ local_var_path = '/public/v{version}/client/uploadclientphoto'.sub('{' + 'version' + '}', version.to_s)
1763
+
1764
+ # query parameters
1765
+ query_params = {}
1766
+
1767
+ # header parameters
1768
+ header_params = {}
1769
+ # HTTP header 'Accept' (if needed)
1770
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml', 'multipart/form-data'])
1771
+ # HTTP header 'Content-Type'
1772
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded', 'multipart/form-data'])
1773
+ header_params[:'siteId'] = site_id
1774
+ header_params[:'authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
1775
+
1776
+ # form parameters
1777
+ form_params = {}
1778
+
1779
+ # http body (model)
1780
+ post_body = @api_client.object_to_http_body(request)
1781
+ auth_names = []
1782
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1783
+ :header_params => header_params,
1784
+ :query_params => query_params,
1785
+ :form_params => form_params,
1786
+ :body => post_body,
1787
+ :auth_names => auth_names,
1788
+ :return_type => 'UploadClientPhotoResponse')
1789
+ if @api_client.config.debugging
1790
+ @api_client.config.logger.debug "API called: ClientApi#client_upload_client_photo\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1791
+ end
1792
+ return data, status_code, headers
1793
+ end
1794
+ end
1795
+ end