zsgf_client 1.0.25 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (562) hide show
  1. checksums.yaml +4 -4
  2. data/docs/AccessTokenApi.md +1 -1
  3. data/docs/AlipayApi.md +25 -25
  4. data/docs/AppApi.md +1 -655
  5. data/docs/DingTalkApi.md +1 -1
  6. data/docs/ExternalAccountApi.md +373 -0
  7. data/docs/{OAuthAccountBindRequest.md → ExternalAccountBindRequest.md} +2 -2
  8. data/docs/{OAuthAccountPutBindRequest.md → ExternalAccountPutRequest.md} +2 -2
  9. data/docs/{OAuthAccountSignInRequest.md → ExternalAccountSignInRequest.md} +2 -2
  10. data/docs/FileApi.md +15 -15
  11. data/docs/OAuthApi.md +17 -17
  12. data/docs/OrderApi.md +1 -1
  13. data/docs/StorageApi.md +87 -917
  14. data/docs/TapPayInfo.md +5 -1
  15. data/docs/UserApi.md +105 -2459
  16. data/docs/UserCurrencyApi.md +1 -1
  17. data/docs/UserFriendsApi.md +795 -0
  18. data/docs/UserLocationApi.md +387 -0
  19. data/docs/WechatApi.md +343 -47
  20. data/lib/zsgf_client/api/access_token_api.rb +1 -1
  21. data/lib/zsgf_client/api/alipay_api.rb +13 -13
  22. data/lib/zsgf_client/api/app_api.rb +1 -588
  23. data/lib/zsgf_client/api/ding_talk_api.rb +1 -1
  24. data/lib/zsgf_client/api/{authorize_policy_api.rb → external_account_api.rb} +108 -113
  25. data/lib/zsgf_client/api/file_api.rb +11 -11
  26. data/lib/zsgf_client/api/o_auth_api.rb +9 -9
  27. data/lib/zsgf_client/api/order_api.rb +1 -1
  28. data/lib/zsgf_client/api/storage_api.rb +23 -894
  29. data/lib/zsgf_client/api/user_api.rb +112 -2374
  30. data/lib/zsgf_client/api/user_currency_api.rb +1 -1
  31. data/lib/zsgf_client/api/user_friends_api.rb +787 -0
  32. data/lib/zsgf_client/api/{user_setting_api.rb → user_location_api.rb} +106 -94
  33. data/lib/zsgf_client/api/wechat_api.rb +305 -25
  34. data/lib/zsgf_client/api_client.rb +1 -1
  35. data/lib/zsgf_client/api_error.rb +1 -1
  36. data/lib/zsgf_client/configuration.rb +4 -4
  37. data/lib/zsgf_client/models/access_token_list_result.rb +1 -1
  38. data/lib/zsgf_client/models/access_token_list_result_api_response.rb +1 -1
  39. data/lib/zsgf_client/models/access_token_post_request.rb +1 -1
  40. data/lib/zsgf_client/models/access_token_put_request.rb +1 -1
  41. data/lib/zsgf_client/models/alipay_create_order_page_pay_request.rb +1 -1
  42. data/lib/zsgf_client/models/alipay_create_order_request.rb +1 -1
  43. data/lib/zsgf_client/models/alipay_create_order_wap_pay_request.rb +1 -1
  44. data/lib/zsgf_client/models/alipay_trade_query_response.rb +1 -1
  45. data/lib/zsgf_client/models/alipay_trade_query_response_api_response.rb +1 -1
  46. data/lib/zsgf_client/models/alipay_trade_refund_response.rb +1 -1
  47. data/lib/zsgf_client/models/alipay_trade_refund_response_api_response.rb +1 -1
  48. data/lib/zsgf_client/models/app_info_item.rb +1 -1
  49. data/lib/zsgf_client/models/app_info_result.rb +1 -1
  50. data/lib/zsgf_client/models/app_info_result_api_response.rb +1 -1
  51. data/lib/zsgf_client/models/app_property.rb +1 -1
  52. data/lib/zsgf_client/models/app_user_consent_model.rb +1 -1
  53. data/lib/zsgf_client/models/app_user_consent_model_list_api_response.rb +1 -1
  54. data/lib/zsgf_client/models/app_user_reset_email_request.rb +1 -1
  55. data/lib/zsgf_client/models/app_user_reset_phone_request.rb +1 -1
  56. data/lib/zsgf_client/models/app_user_reset_pwd_request.rb +1 -1
  57. data/lib/zsgf_client/models/authorize_result.rb +1 -1
  58. data/lib/zsgf_client/models/authorize_result_api_response.rb +1 -1
  59. data/lib/zsgf_client/models/bk_agent_resp_info.rb +1 -1
  60. data/lib/zsgf_client/models/boolean_api_response.rb +1 -1
  61. data/lib/zsgf_client/models/charge_info.rb +1 -1
  62. data/lib/zsgf_client/models/common_friend_model.rb +1 -1
  63. data/lib/zsgf_client/models/contribute_detail.rb +1 -1
  64. data/lib/zsgf_client/models/create_order_request.rb +1 -1
  65. data/lib/zsgf_client/models/create_order_result.rb +1 -1
  66. data/lib/zsgf_client/models/create_order_result_api_response.rb +1 -1
  67. data/lib/zsgf_client/models/currency_consume_request.rb +1 -1
  68. data/lib/zsgf_client/models/currency_transaction.rb +1 -1
  69. data/lib/zsgf_client/models/directory_item.rb +1 -1
  70. data/lib/zsgf_client/models/email_sign_in_request.rb +1 -1
  71. data/lib/zsgf_client/models/email_sign_up_request.rb +1 -1
  72. data/lib/zsgf_client/models/enterprise_pay_info.rb +1 -1
  73. data/lib/zsgf_client/models/exchange_currency_request.rb +1 -1
  74. data/lib/zsgf_client/models/{o_auth_account_bind_request.rb → external_account_bind_request.rb} +4 -4
  75. data/lib/zsgf_client/models/{o_auth_account_put_bind_request.rb → external_account_put_request.rb} +4 -4
  76. data/lib/zsgf_client/models/{o_auth_account_sign_in_request.rb → external_account_sign_in_request.rb} +4 -4
  77. data/lib/zsgf_client/models/file_item.rb +1 -1
  78. data/lib/zsgf_client/models/file_list_result.rb +1 -1
  79. data/lib/zsgf_client/models/file_list_result_api_response.rb +1 -1
  80. data/lib/zsgf_client/models/follower_model.rb +1 -1
  81. data/lib/zsgf_client/models/follower_put_model.rb +1 -1
  82. data/lib/zsgf_client/models/fulfillment_detail.rb +1 -1
  83. data/lib/zsgf_client/models/geo_location.rb +1 -1
  84. data/lib/zsgf_client/models/geo_location_model.rb +1 -1
  85. data/lib/zsgf_client/models/geo_location_model_api_response.rb +1 -1
  86. data/lib/zsgf_client/models/geo_location_response_model.rb +1 -1
  87. data/lib/zsgf_client/models/get_user_profile_result.rb +1 -1
  88. data/lib/zsgf_client/models/get_user_profile_result_api_response.rb +1 -1
  89. data/lib/zsgf_client/models/goods_detail.rb +1 -1
  90. data/lib/zsgf_client/models/grant_request.rb +1 -1
  91. data/lib/zsgf_client/models/grant_result.rb +1 -1
  92. data/lib/zsgf_client/models/grant_result_api_response.rb +1 -1
  93. data/lib/zsgf_client/models/hb_fq_pay_info.rb +1 -1
  94. data/lib/zsgf_client/models/int64_api_response.rb +1 -1
  95. data/lib/zsgf_client/models/intact_charge_info.rb +1 -1
  96. data/lib/zsgf_client/models/my_sql_geometry.rb +1 -1
  97. data/lib/zsgf_client/models/object_api_response.rb +1 -1
  98. data/lib/zsgf_client/models/object_list_api_response.rb +1 -1
  99. data/lib/zsgf_client/models/order.rb +1 -1
  100. data/lib/zsgf_client/models/order_api_response.rb +1 -1
  101. data/lib/zsgf_client/models/order_list_result.rb +1 -1
  102. data/lib/zsgf_client/models/order_list_result_api_response.rb +1 -1
  103. data/lib/zsgf_client/models/payment_info_with_id.rb +1 -1
  104. data/lib/zsgf_client/models/phone_sign_in_request.rb +1 -1
  105. data/lib/zsgf_client/models/phone_sign_up_request.rb +1 -1
  106. data/lib/zsgf_client/models/preset_pay_tool_info.rb +1 -1
  107. data/lib/zsgf_client/models/profile_result.rb +1 -1
  108. data/lib/zsgf_client/models/profile_result_api_response.rb +1 -1
  109. data/lib/zsgf_client/models/qr_code_pre_sign_in_request.rb +1 -1
  110. data/lib/zsgf_client/models/qr_code_scan_request.rb +1 -1
  111. data/lib/zsgf_client/models/qr_code_sign_in_request.rb +1 -1
  112. data/lib/zsgf_client/models/qr_code_sign_up_request.rb +1 -1
  113. data/lib/zsgf_client/models/recharge_point_request.rb +1 -1
  114. data/lib/zsgf_client/models/recommend_friend.rb +1 -1
  115. data/lib/zsgf_client/models/refund_charge_info.rb +1 -1
  116. data/lib/zsgf_client/models/refund_sub_fee.rb +1 -1
  117. data/lib/zsgf_client/models/return_page_notify_request.rb +1 -1
  118. data/lib/zsgf_client/models/send_email_code_request.rb +1 -1
  119. data/lib/zsgf_client/models/send_sms_code_request.rb +1 -1
  120. data/lib/zsgf_client/models/setup_code.rb +1 -1
  121. data/lib/zsgf_client/models/setup_code_api_response.rb +1 -1
  122. data/lib/zsgf_client/models/sign_in_request.rb +1 -1
  123. data/lib/zsgf_client/models/sign_up_request.rb +1 -1
  124. data/lib/zsgf_client/models/storage_list_result.rb +1 -1
  125. data/lib/zsgf_client/models/storage_list_result_api_response.rb +1 -1
  126. data/lib/zsgf_client/models/string_api_response.rb +1 -1
  127. data/lib/zsgf_client/models/sub_fee.rb +1 -1
  128. data/lib/zsgf_client/models/tap_pay_info.rb +26 -6
  129. data/lib/zsgf_client/models/token_model.rb +1 -1
  130. data/lib/zsgf_client/models/token_model_api_response.rb +1 -1
  131. data/lib/zsgf_client/models/trade_fund_bill.rb +1 -1
  132. data/lib/zsgf_client/models/trade_settle_detail.rb +1 -1
  133. data/lib/zsgf_client/models/trade_settle_info.rb +1 -1
  134. data/lib/zsgf_client/models/union_id_sign_in_request.rb +1 -1
  135. data/lib/zsgf_client/models/union_id_sign_up_request.rb +1 -1
  136. data/lib/zsgf_client/models/update_profile_request.rb +1 -1
  137. data/lib/zsgf_client/models/user.rb +1 -1
  138. data/lib/zsgf_client/models/user_access_token.rb +1 -1
  139. data/lib/zsgf_client/models/user_common_interests_result.rb +1 -1
  140. data/lib/zsgf_client/models/user_common_interests_result_api_response.rb +1 -1
  141. data/lib/zsgf_client/models/user_currency.rb +1 -1
  142. data/lib/zsgf_client/models/user_currency_currency_trans_result.rb +1 -1
  143. data/lib/zsgf_client/models/user_currency_currency_trans_result_api_response.rb +1 -1
  144. data/lib/zsgf_client/models/user_currency_list_api_response.rb +1 -1
  145. data/lib/zsgf_client/models/user_followers_result.rb +1 -1
  146. data/lib/zsgf_client/models/user_followers_result_api_response.rb +1 -1
  147. data/lib/zsgf_client/models/user_friends_near_by_result.rb +1 -1
  148. data/lib/zsgf_client/models/user_friends_near_by_result_api_response.rb +1 -1
  149. data/lib/zsgf_client/models/user_location_post_result.rb +1 -1
  150. data/lib/zsgf_client/models/user_location_post_result_api_response.rb +1 -1
  151. data/lib/zsgf_client/models/user_locations_result.rb +1 -1
  152. data/lib/zsgf_client/models/user_locations_result_api_response.rb +1 -1
  153. data/lib/zsgf_client/models/user_logins.rb +1 -1
  154. data/lib/zsgf_client/models/user_logins_list_api_response.rb +1 -1
  155. data/lib/zsgf_client/models/user_mutual_followers_result.rb +1 -1
  156. data/lib/zsgf_client/models/user_mutual_followers_result_api_response.rb +1 -1
  157. data/lib/zsgf_client/models/user_mutual_followings_result.rb +1 -1
  158. data/lib/zsgf_client/models/user_mutual_followings_result_api_response.rb +1 -1
  159. data/lib/zsgf_client/models/user_profile_result.rb +1 -1
  160. data/lib/zsgf_client/models/user_profile_result_api_response.rb +1 -1
  161. data/lib/zsgf_client/models/user_qr_code_scan_result.rb +1 -1
  162. data/lib/zsgf_client/models/user_qr_code_scan_result_api_response.rb +1 -1
  163. data/lib/zsgf_client/models/voucher_detail.rb +1 -1
  164. data/lib/zsgf_client/models/wechat_js_config_result.rb +1 -1
  165. data/lib/zsgf_client/models/wechat_js_config_result_api_response.rb +1 -1
  166. data/lib/zsgf_client/version.rb +2 -2
  167. data/lib/zsgf_client.rb +7 -88
  168. data/spec/api/access_token_api_spec.rb +1 -1
  169. data/spec/api/alipay_api_spec.rb +7 -7
  170. data/spec/api/app_api_spec.rb +1 -115
  171. data/spec/api/ding_talk_api_spec.rb +1 -1
  172. data/spec/api/{user_setting_api_spec.rb → external_account_api_spec.rb} +35 -38
  173. data/spec/api/file_api_spec.rb +6 -6
  174. data/spec/api/o_auth_api_spec.rb +5 -5
  175. data/spec/api/order_api_spec.rb +1 -1
  176. data/spec/api/storage_api_spec.rb +1 -156
  177. data/spec/api/user_api_spec.rb +5 -449
  178. data/spec/api/user_currency_api_spec.rb +1 -1
  179. data/spec/api/user_friends_api_spec.rb +192 -0
  180. data/spec/api/user_location_api_spec.rb +107 -0
  181. data/spec/api/wechat_api_spec.rb +64 -12
  182. data/spec/models/access_token_list_result_api_response_spec.rb +1 -1
  183. data/spec/models/access_token_list_result_spec.rb +1 -1
  184. data/spec/models/access_token_post_request_spec.rb +1 -1
  185. data/spec/models/access_token_put_request_spec.rb +1 -1
  186. data/spec/models/alipay_create_order_page_pay_request_spec.rb +1 -1
  187. data/spec/models/alipay_create_order_request_spec.rb +1 -1
  188. data/spec/models/alipay_create_order_wap_pay_request_spec.rb +1 -1
  189. data/spec/models/alipay_trade_query_response_api_response_spec.rb +1 -1
  190. data/spec/models/alipay_trade_query_response_spec.rb +1 -1
  191. data/spec/models/alipay_trade_refund_response_api_response_spec.rb +1 -1
  192. data/spec/models/alipay_trade_refund_response_spec.rb +1 -1
  193. data/spec/models/app_info_item_spec.rb +1 -1
  194. data/spec/models/app_info_result_api_response_spec.rb +1 -1
  195. data/spec/models/app_info_result_spec.rb +1 -1
  196. data/spec/models/app_property_spec.rb +1 -1
  197. data/spec/models/app_user_consent_model_list_api_response_spec.rb +1 -1
  198. data/spec/models/app_user_consent_model_spec.rb +1 -1
  199. data/spec/models/app_user_reset_email_request_spec.rb +1 -1
  200. data/spec/models/app_user_reset_phone_request_spec.rb +1 -1
  201. data/spec/models/app_user_reset_pwd_request_spec.rb +1 -1
  202. data/spec/models/authorize_result_api_response_spec.rb +1 -1
  203. data/spec/models/authorize_result_spec.rb +1 -1
  204. data/spec/models/bk_agent_resp_info_spec.rb +1 -1
  205. data/spec/models/boolean_api_response_spec.rb +1 -1
  206. data/spec/models/charge_info_spec.rb +1 -1
  207. data/spec/models/common_friend_model_spec.rb +1 -1
  208. data/spec/models/contribute_detail_spec.rb +1 -1
  209. data/spec/models/create_order_request_spec.rb +1 -1
  210. data/spec/models/create_order_result_api_response_spec.rb +1 -1
  211. data/spec/models/create_order_result_spec.rb +1 -1
  212. data/spec/models/currency_consume_request_spec.rb +1 -1
  213. data/spec/models/currency_transaction_spec.rb +1 -1
  214. data/spec/models/directory_item_spec.rb +1 -1
  215. data/spec/models/email_sign_in_request_spec.rb +1 -1
  216. data/spec/models/email_sign_up_request_spec.rb +1 -1
  217. data/spec/models/enterprise_pay_info_spec.rb +1 -1
  218. data/spec/models/exchange_currency_request_spec.rb +1 -1
  219. data/spec/models/{o_auth_account_bind_request_spec.rb → external_account_bind_request_spec.rb} +7 -7
  220. data/spec/models/{o_auth_account_put_bind_request_spec.rb → external_account_put_request_spec.rb} +7 -7
  221. data/spec/models/{o_auth_account_sign_in_request_spec.rb → external_account_sign_in_request_spec.rb} +7 -7
  222. data/spec/models/file_item_spec.rb +1 -1
  223. data/spec/models/file_list_result_api_response_spec.rb +1 -1
  224. data/spec/models/file_list_result_spec.rb +1 -1
  225. data/spec/models/follower_model_spec.rb +1 -1
  226. data/spec/models/follower_put_model_spec.rb +1 -1
  227. data/spec/models/fulfillment_detail_spec.rb +1 -1
  228. data/spec/models/geo_location_model_api_response_spec.rb +1 -1
  229. data/spec/models/geo_location_model_spec.rb +1 -1
  230. data/spec/models/geo_location_response_model_spec.rb +1 -1
  231. data/spec/models/geo_location_spec.rb +1 -1
  232. data/spec/models/get_user_profile_result_api_response_spec.rb +1 -1
  233. data/spec/models/get_user_profile_result_spec.rb +1 -1
  234. data/spec/models/goods_detail_spec.rb +1 -1
  235. data/spec/models/grant_request_spec.rb +1 -1
  236. data/spec/models/grant_result_api_response_spec.rb +1 -1
  237. data/spec/models/grant_result_spec.rb +1 -1
  238. data/spec/models/hb_fq_pay_info_spec.rb +1 -1
  239. data/spec/models/int64_api_response_spec.rb +1 -1
  240. data/spec/models/intact_charge_info_spec.rb +1 -1
  241. data/spec/models/my_sql_geometry_spec.rb +1 -1
  242. data/spec/models/object_api_response_spec.rb +1 -1
  243. data/spec/models/object_list_api_response_spec.rb +1 -1
  244. data/spec/models/order_api_response_spec.rb +1 -1
  245. data/spec/models/order_list_result_api_response_spec.rb +1 -1
  246. data/spec/models/order_list_result_spec.rb +1 -1
  247. data/spec/models/order_spec.rb +1 -1
  248. data/spec/models/payment_info_with_id_spec.rb +1 -1
  249. data/spec/models/phone_sign_in_request_spec.rb +1 -1
  250. data/spec/models/phone_sign_up_request_spec.rb +1 -1
  251. data/spec/models/preset_pay_tool_info_spec.rb +1 -1
  252. data/spec/models/profile_result_api_response_spec.rb +1 -1
  253. data/spec/models/profile_result_spec.rb +1 -1
  254. data/spec/models/qr_code_pre_sign_in_request_spec.rb +1 -1
  255. data/spec/models/qr_code_scan_request_spec.rb +1 -1
  256. data/spec/models/qr_code_sign_in_request_spec.rb +1 -1
  257. data/spec/models/qr_code_sign_up_request_spec.rb +1 -1
  258. data/spec/models/recharge_point_request_spec.rb +1 -1
  259. data/spec/models/recommend_friend_spec.rb +1 -1
  260. data/spec/models/refund_charge_info_spec.rb +1 -1
  261. data/spec/models/refund_sub_fee_spec.rb +1 -1
  262. data/spec/models/return_page_notify_request_spec.rb +1 -1
  263. data/spec/models/send_email_code_request_spec.rb +1 -1
  264. data/spec/models/send_sms_code_request_spec.rb +1 -1
  265. data/spec/models/setup_code_api_response_spec.rb +1 -1
  266. data/spec/models/setup_code_spec.rb +1 -1
  267. data/spec/models/sign_in_request_spec.rb +1 -1
  268. data/spec/models/sign_up_request_spec.rb +1 -1
  269. data/spec/models/storage_list_result_api_response_spec.rb +1 -1
  270. data/spec/models/storage_list_result_spec.rb +1 -1
  271. data/spec/models/string_api_response_spec.rb +1 -1
  272. data/spec/models/sub_fee_spec.rb +1 -1
  273. data/spec/models/tap_pay_info_spec.rb +13 -1
  274. data/spec/models/token_model_api_response_spec.rb +1 -1
  275. data/spec/models/token_model_spec.rb +1 -1
  276. data/spec/models/trade_fund_bill_spec.rb +1 -1
  277. data/spec/models/trade_settle_detail_spec.rb +1 -1
  278. data/spec/models/trade_settle_info_spec.rb +1 -1
  279. data/spec/models/union_id_sign_in_request_spec.rb +1 -1
  280. data/spec/models/union_id_sign_up_request_spec.rb +1 -1
  281. data/spec/models/update_profile_request_spec.rb +1 -1
  282. data/spec/models/user_access_token_spec.rb +1 -1
  283. data/spec/models/user_common_interests_result_api_response_spec.rb +1 -1
  284. data/spec/models/user_common_interests_result_spec.rb +1 -1
  285. data/spec/models/user_currency_currency_trans_result_api_response_spec.rb +1 -1
  286. data/spec/models/user_currency_currency_trans_result_spec.rb +1 -1
  287. data/spec/models/user_currency_list_api_response_spec.rb +1 -1
  288. data/spec/models/user_currency_spec.rb +1 -1
  289. data/spec/models/user_followers_result_api_response_spec.rb +1 -1
  290. data/spec/models/user_followers_result_spec.rb +1 -1
  291. data/spec/models/user_friends_near_by_result_api_response_spec.rb +1 -1
  292. data/spec/models/user_friends_near_by_result_spec.rb +1 -1
  293. data/spec/models/user_location_post_result_api_response_spec.rb +1 -1
  294. data/spec/models/user_location_post_result_spec.rb +1 -1
  295. data/spec/models/user_locations_result_api_response_spec.rb +1 -1
  296. data/spec/models/user_locations_result_spec.rb +1 -1
  297. data/spec/models/user_logins_list_api_response_spec.rb +1 -1
  298. data/spec/models/user_logins_spec.rb +1 -1
  299. data/spec/models/user_mutual_followers_result_api_response_spec.rb +1 -1
  300. data/spec/models/user_mutual_followers_result_spec.rb +1 -1
  301. data/spec/models/user_mutual_followings_result_api_response_spec.rb +1 -1
  302. data/spec/models/user_mutual_followings_result_spec.rb +1 -1
  303. data/spec/models/user_profile_result_api_response_spec.rb +1 -1
  304. data/spec/models/user_profile_result_spec.rb +1 -1
  305. data/spec/models/user_qr_code_scan_result_api_response_spec.rb +1 -1
  306. data/spec/models/user_qr_code_scan_result_spec.rb +1 -1
  307. data/spec/models/user_spec.rb +1 -1
  308. data/spec/models/voucher_detail_spec.rb +1 -1
  309. data/spec/models/wechat_js_config_result_api_response_spec.rb +1 -1
  310. data/spec/models/wechat_js_config_result_spec.rb +1 -1
  311. data/spec/spec_helper.rb +1 -1
  312. data/zsgf_client.gemspec +1 -1
  313. metadata +140 -464
  314. data/docs/App.md +0 -50
  315. data/docs/AppApiResponse.md +0 -22
  316. data/docs/AppCheckVersionResult.md +0 -20
  317. data/docs/AppCheckVersionResultApiResponse.md +0 -22
  318. data/docs/AppListResult.md +0 -20
  319. data/docs/AppListResultApiResponse.md +0 -22
  320. data/docs/AppPostResult.md +0 -20
  321. data/docs/AppPostResultApiResponse.md +0 -22
  322. data/docs/AppSetting.md +0 -36
  323. data/docs/AppSettingApi.md +0 -1495
  324. data/docs/AppSettingApiResponse.md +0 -22
  325. data/docs/AppSettingGroupPostResult.md +0 -18
  326. data/docs/AppSettingGroupPostResultApiResponse.md +0 -22
  327. data/docs/AppSettingItemPostResult.md +0 -18
  328. data/docs/AppSettingItemPostResultApiResponse.md +0 -22
  329. data/docs/AppSettingListApiResponse.md +0 -22
  330. data/docs/AppSettingProviderPostResult.md +0 -18
  331. data/docs/AppSettingProviderPostResultApiResponse.md +0 -22
  332. data/docs/AppSettingSettingPostResult.md +0 -18
  333. data/docs/AppSettingSettingPostResultApiResponse.md +0 -22
  334. data/docs/AppUserListResponse.md +0 -40
  335. data/docs/AuthorizePolicy.md +0 -28
  336. data/docs/AuthorizePolicyApi.md +0 -377
  337. data/docs/AuthorizePolicyApiResponse.md +0 -22
  338. data/docs/AuthorizePolicyListApiResponse.md +0 -22
  339. data/docs/CreatePostResult.md +0 -18
  340. data/docs/CreatePostResultApiResponse.md +0 -22
  341. data/docs/Currency.md +0 -48
  342. data/docs/CurrencyApi.md +0 -677
  343. data/docs/CurrencyApiResponse.md +0 -22
  344. data/docs/CurrencyExchangeRate.md +0 -30
  345. data/docs/CurrencyExchangeRateApiResponse.md +0 -22
  346. data/docs/CurrencyListApiResponse.md +0 -22
  347. data/docs/CurrencyTransactionListApiResponse.md +0 -22
  348. data/docs/ExchangeRatePutRequest.md +0 -22
  349. data/docs/ExecuteFunctionRequest.md +0 -18
  350. data/docs/ListResponseItem.md +0 -36
  351. data/docs/ListResponseItemListApiResponse.md +0 -22
  352. data/docs/PostIndexRequest.md +0 -20
  353. data/docs/PostResult.md +0 -18
  354. data/docs/PostResultApiResponse.md +0 -22
  355. data/docs/Project.md +0 -34
  356. data/docs/ProjectApi.md +0 -367
  357. data/docs/ProjectApiResponse.md +0 -22
  358. data/docs/ProjectListResult.md +0 -20
  359. data/docs/ProjectListResultApiResponse.md +0 -22
  360. data/docs/ServiceGroup.md +0 -36
  361. data/docs/ServiceGroupApiResponse.md +0 -22
  362. data/docs/ServiceGroupListApiResponse.md +0 -22
  363. data/docs/ServiceItem.md +0 -48
  364. data/docs/ServiceItemApiResponse.md +0 -22
  365. data/docs/ServiceItemListApiResponse.md +0 -22
  366. data/docs/ServiceProvider.md +0 -38
  367. data/docs/ServiceProviderApiResponse.md +0 -22
  368. data/docs/ServiceProviderListApiResponse.md +0 -22
  369. data/docs/ServiceSettingApi.md +0 -1459
  370. data/docs/ServiceSettingGroupPostResult.md +0 -18
  371. data/docs/ServiceSettingGroupPostResultApiResponse.md +0 -22
  372. data/docs/ServiceSettingItemPostResult.md +0 -18
  373. data/docs/ServiceSettingItemPostResultApiResponse.md +0 -22
  374. data/docs/ServiceSettingProviderPostResult.md +0 -18
  375. data/docs/ServiceSettingProviderPostResultApiResponse.md +0 -22
  376. data/docs/ServiceSettingSettingPostResult.md +0 -18
  377. data/docs/ServiceSettingSettingPostResultApiResponse.md +0 -22
  378. data/docs/Settings.md +0 -40
  379. data/docs/SettingsApiResponse.md +0 -22
  380. data/docs/SettingsListApiResponse.md +0 -22
  381. data/docs/StringListApiResponse.md +0 -22
  382. data/docs/SystemDirectoryItem.md +0 -24
  383. data/docs/SystemFileApi.md +0 -371
  384. data/docs/SystemFileItem.md +0 -24
  385. data/docs/SystemFileListResult.md +0 -22
  386. data/docs/SystemFileListResultApiResponse.md +0 -22
  387. data/docs/Team.md +0 -36
  388. data/docs/TeamApi.md +0 -297
  389. data/docs/UserApiResponse.md +0 -22
  390. data/docs/UserListResult.md +0 -20
  391. data/docs/UserListResultApiResponse.md +0 -22
  392. data/docs/UserSetting.md +0 -38
  393. data/docs/UserSettingApi.md +0 -379
  394. data/docs/UserSettingApiResponse.md +0 -22
  395. data/docs/UserSettingListApiResponse.md +0 -22
  396. data/docs/UserSettingPostResult.md +0 -18
  397. data/docs/UserSettingPostResultApiResponse.md +0 -22
  398. data/lib/zsgf_client/api/app_setting_api.rb +0 -1446
  399. data/lib/zsgf_client/api/currency_api.rb +0 -667
  400. data/lib/zsgf_client/api/project_api.rb +0 -345
  401. data/lib/zsgf_client/api/service_setting_api.rb +0 -1340
  402. data/lib/zsgf_client/api/system_file_api.rb +0 -333
  403. data/lib/zsgf_client/api/team_api.rb +0 -282
  404. data/lib/zsgf_client/models/app.rb +0 -583
  405. data/lib/zsgf_client/models/app_api_response.rb +0 -245
  406. data/lib/zsgf_client/models/app_check_version_result.rb +0 -235
  407. data/lib/zsgf_client/models/app_check_version_result_api_response.rb +0 -245
  408. data/lib/zsgf_client/models/app_list_result.rb +0 -232
  409. data/lib/zsgf_client/models/app_list_result_api_response.rb +0 -245
  410. data/lib/zsgf_client/models/app_post_result.rb +0 -230
  411. data/lib/zsgf_client/models/app_post_result_api_response.rb +0 -245
  412. data/lib/zsgf_client/models/app_setting.rb +0 -437
  413. data/lib/zsgf_client/models/app_setting_api_response.rb +0 -245
  414. data/lib/zsgf_client/models/app_setting_group_post_result.rb +0 -220
  415. data/lib/zsgf_client/models/app_setting_group_post_result_api_response.rb +0 -245
  416. data/lib/zsgf_client/models/app_setting_item_post_result.rb +0 -220
  417. data/lib/zsgf_client/models/app_setting_item_post_result_api_response.rb +0 -245
  418. data/lib/zsgf_client/models/app_setting_list_api_response.rb +0 -249
  419. data/lib/zsgf_client/models/app_setting_provider_post_result.rb +0 -220
  420. data/lib/zsgf_client/models/app_setting_provider_post_result_api_response.rb +0 -245
  421. data/lib/zsgf_client/models/app_setting_setting_post_result.rb +0 -220
  422. data/lib/zsgf_client/models/app_setting_setting_post_result_api_response.rb +0 -245
  423. data/lib/zsgf_client/models/app_user_list_response.rb +0 -339
  424. data/lib/zsgf_client/models/authorize_policy.rb +0 -290
  425. data/lib/zsgf_client/models/authorize_policy_api_response.rb +0 -245
  426. data/lib/zsgf_client/models/authorize_policy_list_api_response.rb +0 -249
  427. data/lib/zsgf_client/models/create_post_result.rb +0 -220
  428. data/lib/zsgf_client/models/create_post_result_api_response.rb +0 -245
  429. data/lib/zsgf_client/models/currency.rb +0 -484
  430. data/lib/zsgf_client/models/currency_api_response.rb +0 -245
  431. data/lib/zsgf_client/models/currency_exchange_rate.rb +0 -330
  432. data/lib/zsgf_client/models/currency_exchange_rate_api_response.rb +0 -245
  433. data/lib/zsgf_client/models/currency_list_api_response.rb +0 -249
  434. data/lib/zsgf_client/models/currency_transaction_list_api_response.rb +0 -249
  435. data/lib/zsgf_client/models/exchange_rate_put_request.rb +0 -240
  436. data/lib/zsgf_client/models/execute_function_request.rb +0 -222
  437. data/lib/zsgf_client/models/list_response_item.rb +0 -308
  438. data/lib/zsgf_client/models/list_response_item_list_api_response.rb +0 -249
  439. data/lib/zsgf_client/models/post_index_request.rb +0 -251
  440. data/lib/zsgf_client/models/post_result.rb +0 -220
  441. data/lib/zsgf_client/models/post_result_api_response.rb +0 -245
  442. data/lib/zsgf_client/models/project.rb +0 -353
  443. data/lib/zsgf_client/models/project_api_response.rb +0 -245
  444. data/lib/zsgf_client/models/project_list_result.rb +0 -232
  445. data/lib/zsgf_client/models/project_list_result_api_response.rb +0 -245
  446. data/lib/zsgf_client/models/service_group.rb +0 -361
  447. data/lib/zsgf_client/models/service_group_api_response.rb +0 -245
  448. data/lib/zsgf_client/models/service_group_list_api_response.rb +0 -249
  449. data/lib/zsgf_client/models/service_item.rb +0 -502
  450. data/lib/zsgf_client/models/service_item_api_response.rb +0 -245
  451. data/lib/zsgf_client/models/service_item_list_api_response.rb +0 -249
  452. data/lib/zsgf_client/models/service_provider.rb +0 -403
  453. data/lib/zsgf_client/models/service_provider_api_response.rb +0 -245
  454. data/lib/zsgf_client/models/service_provider_list_api_response.rb +0 -249
  455. data/lib/zsgf_client/models/service_setting_group_post_result.rb +0 -220
  456. data/lib/zsgf_client/models/service_setting_group_post_result_api_response.rb +0 -245
  457. data/lib/zsgf_client/models/service_setting_item_post_result.rb +0 -220
  458. data/lib/zsgf_client/models/service_setting_item_post_result_api_response.rb +0 -245
  459. data/lib/zsgf_client/models/service_setting_provider_post_result.rb +0 -220
  460. data/lib/zsgf_client/models/service_setting_provider_post_result_api_response.rb +0 -245
  461. data/lib/zsgf_client/models/service_setting_setting_post_result.rb +0 -220
  462. data/lib/zsgf_client/models/service_setting_setting_post_result_api_response.rb +0 -245
  463. data/lib/zsgf_client/models/settings.rb +0 -445
  464. data/lib/zsgf_client/models/settings_api_response.rb +0 -245
  465. data/lib/zsgf_client/models/settings_list_api_response.rb +0 -249
  466. data/lib/zsgf_client/models/string_list_api_response.rb +0 -249
  467. data/lib/zsgf_client/models/system_directory_item.rb +0 -249
  468. data/lib/zsgf_client/models/system_file_item.rb +0 -249
  469. data/lib/zsgf_client/models/system_file_list_result.rb +0 -244
  470. data/lib/zsgf_client/models/system_file_list_result_api_response.rb +0 -245
  471. data/lib/zsgf_client/models/team.rb +0 -376
  472. data/lib/zsgf_client/models/user_api_response.rb +0 -245
  473. data/lib/zsgf_client/models/user_list_result.rb +0 -232
  474. data/lib/zsgf_client/models/user_list_result_api_response.rb +0 -245
  475. data/lib/zsgf_client/models/user_setting.rb +0 -464
  476. data/lib/zsgf_client/models/user_setting_api_response.rb +0 -245
  477. data/lib/zsgf_client/models/user_setting_list_api_response.rb +0 -249
  478. data/lib/zsgf_client/models/user_setting_post_result.rb +0 -220
  479. data/lib/zsgf_client/models/user_setting_post_result_api_response.rb +0 -245
  480. data/spec/api/app_setting_api_spec.rb +0 -307
  481. data/spec/api/authorize_policy_api_spec.rb +0 -102
  482. data/spec/api/currency_api_spec.rb +0 -159
  483. data/spec/api/project_api_spec.rb +0 -97
  484. data/spec/api/service_setting_api_spec.rb +0 -289
  485. data/spec/api/system_file_api_spec.rb +0 -97
  486. data/spec/api/team_api_spec.rb +0 -85
  487. data/spec/models/app_api_response_spec.rb +0 -48
  488. data/spec/models/app_check_version_result_api_response_spec.rb +0 -48
  489. data/spec/models/app_check_version_result_spec.rb +0 -42
  490. data/spec/models/app_list_result_api_response_spec.rb +0 -48
  491. data/spec/models/app_list_result_spec.rb +0 -42
  492. data/spec/models/app_post_result_api_response_spec.rb +0 -48
  493. data/spec/models/app_post_result_spec.rb +0 -42
  494. data/spec/models/app_setting_api_response_spec.rb +0 -48
  495. data/spec/models/app_setting_group_post_result_api_response_spec.rb +0 -48
  496. data/spec/models/app_setting_group_post_result_spec.rb +0 -36
  497. data/spec/models/app_setting_item_post_result_api_response_spec.rb +0 -48
  498. data/spec/models/app_setting_item_post_result_spec.rb +0 -36
  499. data/spec/models/app_setting_list_api_response_spec.rb +0 -48
  500. data/spec/models/app_setting_provider_post_result_api_response_spec.rb +0 -48
  501. data/spec/models/app_setting_provider_post_result_spec.rb +0 -36
  502. data/spec/models/app_setting_setting_post_result_api_response_spec.rb +0 -48
  503. data/spec/models/app_setting_setting_post_result_spec.rb +0 -36
  504. data/spec/models/app_setting_spec.rb +0 -90
  505. data/spec/models/app_spec.rb +0 -132
  506. data/spec/models/app_user_list_response_spec.rb +0 -102
  507. data/spec/models/authorize_policy_api_response_spec.rb +0 -48
  508. data/spec/models/authorize_policy_list_api_response_spec.rb +0 -48
  509. data/spec/models/authorize_policy_spec.rb +0 -66
  510. data/spec/models/create_post_result_api_response_spec.rb +0 -48
  511. data/spec/models/create_post_result_spec.rb +0 -36
  512. data/spec/models/currency_api_response_spec.rb +0 -48
  513. data/spec/models/currency_exchange_rate_api_response_spec.rb +0 -48
  514. data/spec/models/currency_exchange_rate_spec.rb +0 -72
  515. data/spec/models/currency_list_api_response_spec.rb +0 -48
  516. data/spec/models/currency_spec.rb +0 -126
  517. data/spec/models/currency_transaction_list_api_response_spec.rb +0 -48
  518. data/spec/models/exchange_rate_put_request_spec.rb +0 -48
  519. data/spec/models/execute_function_request_spec.rb +0 -36
  520. data/spec/models/list_response_item_list_api_response_spec.rb +0 -48
  521. data/spec/models/list_response_item_spec.rb +0 -90
  522. data/spec/models/post_index_request_spec.rb +0 -42
  523. data/spec/models/post_result_api_response_spec.rb +0 -48
  524. data/spec/models/post_result_spec.rb +0 -36
  525. data/spec/models/project_api_response_spec.rb +0 -48
  526. data/spec/models/project_list_result_api_response_spec.rb +0 -48
  527. data/spec/models/project_list_result_spec.rb +0 -42
  528. data/spec/models/project_spec.rb +0 -84
  529. data/spec/models/service_group_api_response_spec.rb +0 -48
  530. data/spec/models/service_group_list_api_response_spec.rb +0 -48
  531. data/spec/models/service_group_spec.rb +0 -90
  532. data/spec/models/service_item_api_response_spec.rb +0 -48
  533. data/spec/models/service_item_list_api_response_spec.rb +0 -48
  534. data/spec/models/service_item_spec.rb +0 -126
  535. data/spec/models/service_provider_api_response_spec.rb +0 -48
  536. data/spec/models/service_provider_list_api_response_spec.rb +0 -48
  537. data/spec/models/service_provider_spec.rb +0 -96
  538. data/spec/models/service_setting_group_post_result_api_response_spec.rb +0 -48
  539. data/spec/models/service_setting_group_post_result_spec.rb +0 -36
  540. data/spec/models/service_setting_item_post_result_api_response_spec.rb +0 -48
  541. data/spec/models/service_setting_item_post_result_spec.rb +0 -36
  542. data/spec/models/service_setting_provider_post_result_api_response_spec.rb +0 -48
  543. data/spec/models/service_setting_provider_post_result_spec.rb +0 -36
  544. data/spec/models/service_setting_setting_post_result_api_response_spec.rb +0 -48
  545. data/spec/models/service_setting_setting_post_result_spec.rb +0 -36
  546. data/spec/models/settings_api_response_spec.rb +0 -48
  547. data/spec/models/settings_list_api_response_spec.rb +0 -48
  548. data/spec/models/settings_spec.rb +0 -102
  549. data/spec/models/string_list_api_response_spec.rb +0 -48
  550. data/spec/models/system_directory_item_spec.rb +0 -54
  551. data/spec/models/system_file_item_spec.rb +0 -54
  552. data/spec/models/system_file_list_result_api_response_spec.rb +0 -48
  553. data/spec/models/system_file_list_result_spec.rb +0 -48
  554. data/spec/models/team_spec.rb +0 -90
  555. data/spec/models/user_api_response_spec.rb +0 -48
  556. data/spec/models/user_list_result_api_response_spec.rb +0 -48
  557. data/spec/models/user_list_result_spec.rb +0 -42
  558. data/spec/models/user_setting_api_response_spec.rb +0 -48
  559. data/spec/models/user_setting_list_api_response_spec.rb +0 -48
  560. data/spec/models/user_setting_post_result_api_response_spec.rb +0 -48
  561. data/spec/models/user_setting_post_result_spec.rb +0 -36
  562. data/spec/models/user_setting_spec.rb +0 -96
data/docs/UserApi.md CHANGED
@@ -1,2223 +1,35 @@
1
1
  # ZSGFClient::UserApi
2
2
 
3
- All URIs are relative to *https://api.zashigaofa.cn*
3
+ All URIs are relative to *https://api-dev.zashigaofa.cn*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**user**](UserApi.md#user) | **GET** /User/{appKey}/{id} | 获取用户详情 |
8
- | [**user_clear**](UserApi.md#user_clear) | **DELETE** /User/{appKey}/Clear | 清空用户数据 |
9
- | [**user_common_interests**](UserApi.md#user_common_interests) | **GET** /User/{appKey}/Friends/CommonInterests | 有共同爱好的用户推荐 |
10
7
  | [**user_deactivate_hard**](UserApi.md#user_deactivate_hard) | **DELETE** /User/{appKey}/DeactivateHard | 注销账号 |
11
- | [**user_delete**](UserApi.md#user_delete) | **DELETE** /User/{appKey}/{id} | 删除用户 |
12
8
  | [**user_email_sign_in**](UserApi.md#user_email_sign_in) | **POST** /User/{appKey}/EmailSignIn | 邮箱登录 |
13
9
  | [**user_email_sign_up**](UserApi.md#user_email_sign_up) | **POST** /User/{appKey}/EmailSignUp | 邮箱注册 |
14
- | [**user_export**](UserApi.md#user_export) | **GET** /User/{appKey}/Export | 导出用户数据 |
15
- | [**user_follow_user**](UserApi.md#user_follow_user) | **POST** /User/{appKey}/Follower/{userId} | 关注用户 |
16
- | [**user_follower_put**](UserApi.md#user_follower_put) | **PUT** /User/{appKey}/Follower/{id} | 更新粉丝 |
17
- | [**user_followers**](UserApi.md#user_followers) | **GET** /User/{appKey}/Followers | 获取我的粉丝列表 |
18
- | [**user_following**](UserApi.md#user_following) | **GET** /User/{appKey}/Following | 获取当前用户的关注列表,或者判断是否关注某个特定用户。 |
19
- | [**user_friends_near_by**](UserApi.md#user_friends_near_by) | **GET** /User/{appKey}/Friends/NearBy | 获取附近的用户推荐列表 |
20
- | [**user_import**](UserApi.md#user_import) | **POST** /User/{appKey}/Import | 导入用户数据 |
21
- | [**user_location**](UserApi.md#user_location) | **GET** /User/{appKey}/Location/{id} | 获取位置详情 |
22
- | [**user_location_delete**](UserApi.md#user_location_delete) | **DELETE** /User/{appKey}/Location/{id} | 删除位置 |
23
- | [**user_location_post**](UserApi.md#user_location_post) | **POST** /User/{appKey}/Location | 添加位置 |
24
- | [**user_location_put**](UserApi.md#user_location_put) | **PUT** /User/{appKey}/Location/{id} | 更新位置 |
25
- | [**user_locations**](UserApi.md#user_locations) | **GET** /User/{appKey}/Locations | 获取位置列表 |
26
- | [**user_mutual_followers**](UserApi.md#user_mutual_followers) | **GET** /User/{appKey}/Friends/MutualFollowers | 有共同粉丝的用户推荐 |
27
- | [**user_mutual_followings**](UserApi.md#user_mutual_followings) | **GET** /User/{appKey}/Friends/MutualFollowings | 有共同关注的用户推荐 |
28
- | [**user_o_auth_account_bind**](UserApi.md#user_o_auth_account_bind) | **POST** /User/{appKey}/OAuthAccountBind | 外部账号 绑定,如果已存在绑定则直接返回成功 |
29
- | [**user_o_auth_account_sign_in**](UserApi.md#user_o_auth_account_sign_in) | **POST** /User/{appKey}/OAuthAccountSignIn | 外部账号 登录 |
30
- | [**user_o_auth_accounts**](UserApi.md#user_o_auth_accounts) | **GET** /User/{appKey}/OAuthAccounts | 外部账号 绑定列表 |
31
- | [**user_o_auth_accounts_put_bind**](UserApi.md#user_o_auth_accounts_put_bind) | **PUT** /User/{appKey}/OAuthAccounts/{id} | 外部账号 更新绑定 |
32
- | [**user_o_auth_accounts_un_bind**](UserApi.md#user_o_auth_accounts_un_bind) | **DELETE** /User/{appKey}/OAuthAccounts/{id} | 外部账号 删除绑定 |
33
10
  | [**user_phone_sign_in**](UserApi.md#user_phone_sign_in) | **POST** /User/{appKey}/PhoneSignIn | 手机登录 |
34
11
  | [**user_phone_sign_up**](UserApi.md#user_phone_sign_up) | **POST** /User/{appKey}/PhoneSignUp | 手机注册 |
35
12
  | [**user_profile**](UserApi.md#user_profile) | **GET** /User/{appKey}/Profile | 获取个人资料 |
36
- | [**user_profile_by_id**](UserApi.md#user_profile_by_id) | **GET** /User/{appKey}/Profile/{userId} | 获取指定用户资料 |
37
- | [**user_put**](UserApi.md#user_put) | **PUT** /User/{appKey}/{id} | 更新用户信息 |
38
- | [**user_qr_code_pre_sign_in**](UserApi.md#user_qr_code_pre_sign_in) | **POST** /User/{appKey}/QRCodePreSignIn | 微信小程序 - 预登陆 |
39
- | [**user_qr_code_scan**](UserApi.md#user_qr_code_scan) | **POST** /User/{appKey}/QRCodeScan | 微信小程序 - 扫码 |
40
- | [**user_qr_code_sign_in**](UserApi.md#user_qr_code_sign_in) | **POST** /User/{appKey}/QRCodeSignIn | 微信小程序 - 网页登录 |
41
- | [**user_qr_code_sign_up**](UserApi.md#user_qr_code_sign_up) | **POST** /User/{appKey}/QRCodeSignUp | 微信小程序 - 注册 |
42
13
  | [**user_reset_email**](UserApi.md#user_reset_email) | **PUT** /User/{appKey}/ResetEmail | 重置邮箱 |
43
14
  | [**user_reset_phone**](UserApi.md#user_reset_phone) | **PUT** /User/{appKey}/ResetPhone | 重置手机号 |
44
15
  | [**user_reset_pwd**](UserApi.md#user_reset_pwd) | **POST** /User/{appKey}/ResetPwd | 重置密码 |
45
16
  | [**user_send_email_code**](UserApi.md#user_send_email_code) | **POST** /User/{appKey}/SendEmailCode | 发送邮箱验证码 |
46
17
  | [**user_send_sms_code**](UserApi.md#user_send_sms_code) | **POST** /User/{appKey}/SendSMSCode | 发送手机验证码 |
47
- | [**user_sign_in**](UserApi.md#user_sign_in) | **POST** /User/{appKey}/SignIn | 账号密码 登录 |
48
- | [**user_sign_up**](UserApi.md#user_sign_up) | **POST** /User/{appKey}/SignUp | 账号密码 注册 |
49
- | [**user_two_factor_auth**](UserApi.md#user_two_factor_auth) | **GET** /User/{appKey}/TwoFactorAuth | 双因素验证 |
50
- | [**user_unfollow_user**](UserApi.md#user_unfollow_user) | **DELETE** /User/{appKey}/Follower/{userId} | 取消关注 |
18
+ | [**user_sign_in**](UserApi.md#user_sign_in) | **POST** /User/{appKey}/SignIn | 密码登录 |
19
+ | [**user_sign_up**](UserApi.md#user_sign_up) | **POST** /User/{appKey}/SignUp | 账号注册 |
20
+ | [**user_two_factor_auth**](UserApi.md#user_two_factor_auth) | **GET** /User/{appKey}/TwoFactorAuth | 二次验证 |
51
21
  | [**user_union_id_sign_in**](UserApi.md#user_union_id_sign_in) | **POST** /User/{appKey}/UnionIDSignIn | UnionID登录 |
52
22
  | [**user_union_id_sign_up**](UserApi.md#user_union_id_sign_up) | **POST** /User/{appKey}/UnionIDSignUp | UnionID注册 |
53
23
  | [**user_update_profile**](UserApi.md#user_update_profile) | **PUT** /User/{appKey}/Profile | 更新个人资料 |
54
- | [**users**](UserApi.md#users) | **GET** /User/{appKey} | 获取用户列表 |
55
24
 
56
25
 
57
- ## user
58
-
59
- > <UserApiResponse> user(id, app_key)
60
-
61
- 获取用户详情
62
-
63
- 根据用户ID获取用户详情
64
-
65
- ### Examples
66
-
67
- ```ruby
68
- require 'time'
69
- require 'zsgf_client'
70
- # setup authorization
71
- ZSGFClient.configure do |config|
72
- # Configure Bearer authorization: Bearer
73
- config.access_token = 'YOUR_BEARER_TOKEN'
74
- end
75
-
76
- api_instance = ZSGFClient::UserApi.new
77
- id = 789 # Integer | 用户ID
78
- app_key = 'app_key_example' # String |
79
-
80
- begin
81
- # 获取用户详情
82
- result = api_instance.user(id, app_key)
83
- p result
84
- rescue ZSGFClient::ApiError => e
85
- puts "Error when calling UserApi->user: #{e}"
86
- end
87
- ```
88
-
89
- #### Using the user_with_http_info variant
90
-
91
- This returns an Array which contains the response data, status code and headers.
92
-
93
- > <Array(<UserApiResponse>, Integer, Hash)> user_with_http_info(id, app_key)
94
-
95
- ```ruby
96
- begin
97
- # 获取用户详情
98
- data, status_code, headers = api_instance.user_with_http_info(id, app_key)
99
- p status_code # => 2xx
100
- p headers # => { ... }
101
- p data # => <UserApiResponse>
102
- rescue ZSGFClient::ApiError => e
103
- puts "Error when calling UserApi->user_with_http_info: #{e}"
104
- end
105
- ```
106
-
107
- ### Parameters
108
-
109
- | Name | Type | Description | Notes |
110
- | ---- | ---- | ----------- | ----- |
111
- | **id** | **Integer** | 用户ID | |
112
- | **app_key** | **String** | | |
113
-
114
- ### Return type
115
-
116
- [**UserApiResponse**](UserApiResponse.md)
117
-
118
- ### Authorization
119
-
120
- [Bearer](../README.md#Bearer)
121
-
122
- ### HTTP request headers
123
-
124
- - **Content-Type**: Not defined
125
- - **Accept**: application/json
126
-
127
-
128
- ## user_clear
129
-
130
- > <BooleanApiResponse> user_clear(app_key)
131
-
132
- 清空用户数据
133
-
134
- 清空用户数据
135
-
136
- ### Examples
137
-
138
- ```ruby
139
- require 'time'
140
- require 'zsgf_client'
141
- # setup authorization
142
- ZSGFClient.configure do |config|
143
- # Configure Bearer authorization: Bearer
144
- config.access_token = 'YOUR_BEARER_TOKEN'
145
- end
146
-
147
- api_instance = ZSGFClient::UserApi.new
148
- app_key = 'app_key_example' # String |
149
-
150
- begin
151
- # 清空用户数据
152
- result = api_instance.user_clear(app_key)
153
- p result
154
- rescue ZSGFClient::ApiError => e
155
- puts "Error when calling UserApi->user_clear: #{e}"
156
- end
157
- ```
158
-
159
- #### Using the user_clear_with_http_info variant
160
-
161
- This returns an Array which contains the response data, status code and headers.
162
-
163
- > <Array(<BooleanApiResponse>, Integer, Hash)> user_clear_with_http_info(app_key)
164
-
165
- ```ruby
166
- begin
167
- # 清空用户数据
168
- data, status_code, headers = api_instance.user_clear_with_http_info(app_key)
169
- p status_code # => 2xx
170
- p headers # => { ... }
171
- p data # => <BooleanApiResponse>
172
- rescue ZSGFClient::ApiError => e
173
- puts "Error when calling UserApi->user_clear_with_http_info: #{e}"
174
- end
175
- ```
176
-
177
- ### Parameters
178
-
179
- | Name | Type | Description | Notes |
180
- | ---- | ---- | ----------- | ----- |
181
- | **app_key** | **String** | | |
182
-
183
- ### Return type
184
-
185
- [**BooleanApiResponse**](BooleanApiResponse.md)
186
-
187
- ### Authorization
188
-
189
- [Bearer](../README.md#Bearer)
190
-
191
- ### HTTP request headers
192
-
193
- - **Content-Type**: Not defined
194
- - **Accept**: application/json
195
-
196
-
197
- ## user_common_interests
198
-
199
- > <UserCommonInterestsResultApiResponse> user_common_interests(app_key, opts)
200
-
201
- 有共同爱好的用户推荐
202
-
203
- 推荐有共同爱好的用户
204
-
205
- ### Examples
206
-
207
- ```ruby
208
- require 'time'
209
- require 'zsgf_client'
210
- # setup authorization
211
- ZSGFClient.configure do |config|
212
- # Configure Bearer authorization: Bearer
213
- config.access_token = 'YOUR_BEARER_TOKEN'
214
- end
215
-
216
- api_instance = ZSGFClient::UserApi.new
217
- app_key = 'app_key_example' # String |
218
- opts = {
219
- tag: 'tag_example', # String | 兴趣标签
220
- skip: 56, # Integer | 跳过的记录数
221
- take: 56 # Integer | 获取的记录数
222
- }
223
-
224
- begin
225
- # 有共同爱好的用户推荐
226
- result = api_instance.user_common_interests(app_key, opts)
227
- p result
228
- rescue ZSGFClient::ApiError => e
229
- puts "Error when calling UserApi->user_common_interests: #{e}"
230
- end
231
- ```
232
-
233
- #### Using the user_common_interests_with_http_info variant
234
-
235
- This returns an Array which contains the response data, status code and headers.
236
-
237
- > <Array(<UserCommonInterestsResultApiResponse>, Integer, Hash)> user_common_interests_with_http_info(app_key, opts)
238
-
239
- ```ruby
240
- begin
241
- # 有共同爱好的用户推荐
242
- data, status_code, headers = api_instance.user_common_interests_with_http_info(app_key, opts)
243
- p status_code # => 2xx
244
- p headers # => { ... }
245
- p data # => <UserCommonInterestsResultApiResponse>
246
- rescue ZSGFClient::ApiError => e
247
- puts "Error when calling UserApi->user_common_interests_with_http_info: #{e}"
248
- end
249
- ```
250
-
251
- ### Parameters
252
-
253
- | Name | Type | Description | Notes |
254
- | ---- | ---- | ----------- | ----- |
255
- | **app_key** | **String** | | |
256
- | **tag** | **String** | 兴趣标签 | [optional] |
257
- | **skip** | **Integer** | 跳过的记录数 | [optional][default to 0] |
258
- | **take** | **Integer** | 获取的记录数 | [optional][default to 10] |
259
-
260
- ### Return type
261
-
262
- [**UserCommonInterestsResultApiResponse**](UserCommonInterestsResultApiResponse.md)
263
-
264
- ### Authorization
265
-
266
- [Bearer](../README.md#Bearer)
267
-
268
- ### HTTP request headers
269
-
270
- - **Content-Type**: Not defined
271
- - **Accept**: application/json
272
-
273
-
274
- ## user_deactivate_hard
275
-
276
- > <BooleanApiResponse> user_deactivate_hard(app_key)
277
-
278
- 注销账号
279
-
280
- 清除用户所有附属数据,并注销账号
281
-
282
- ### Examples
283
-
284
- ```ruby
285
- require 'time'
286
- require 'zsgf_client'
287
- # setup authorization
288
- ZSGFClient.configure do |config|
289
- # Configure Bearer authorization: Bearer
290
- config.access_token = 'YOUR_BEARER_TOKEN'
291
- end
292
-
293
- api_instance = ZSGFClient::UserApi.new
294
- app_key = 'app_key_example' # String |
295
-
296
- begin
297
- # 注销账号
298
- result = api_instance.user_deactivate_hard(app_key)
299
- p result
300
- rescue ZSGFClient::ApiError => e
301
- puts "Error when calling UserApi->user_deactivate_hard: #{e}"
302
- end
303
- ```
304
-
305
- #### Using the user_deactivate_hard_with_http_info variant
306
-
307
- This returns an Array which contains the response data, status code and headers.
308
-
309
- > <Array(<BooleanApiResponse>, Integer, Hash)> user_deactivate_hard_with_http_info(app_key)
310
-
311
- ```ruby
312
- begin
313
- # 注销账号
314
- data, status_code, headers = api_instance.user_deactivate_hard_with_http_info(app_key)
315
- p status_code # => 2xx
316
- p headers # => { ... }
317
- p data # => <BooleanApiResponse>
318
- rescue ZSGFClient::ApiError => e
319
- puts "Error when calling UserApi->user_deactivate_hard_with_http_info: #{e}"
320
- end
321
- ```
322
-
323
- ### Parameters
324
-
325
- | Name | Type | Description | Notes |
326
- | ---- | ---- | ----------- | ----- |
327
- | **app_key** | **String** | | |
328
-
329
- ### Return type
330
-
331
- [**BooleanApiResponse**](BooleanApiResponse.md)
332
-
333
- ### Authorization
334
-
335
- [Bearer](../README.md#Bearer)
336
-
337
- ### HTTP request headers
338
-
339
- - **Content-Type**: Not defined
340
- - **Accept**: application/json
341
-
342
-
343
- ## user_delete
344
-
345
- > <BooleanApiResponse> user_delete(id, app_key)
346
-
347
- 删除用户
348
-
349
- 根据用户ID删除用户
350
-
351
- ### Examples
352
-
353
- ```ruby
354
- require 'time'
355
- require 'zsgf_client'
356
- # setup authorization
357
- ZSGFClient.configure do |config|
358
- # Configure Bearer authorization: Bearer
359
- config.access_token = 'YOUR_BEARER_TOKEN'
360
- end
361
-
362
- api_instance = ZSGFClient::UserApi.new
363
- id = 789 # Integer | 用户ID
364
- app_key = 'app_key_example' # String |
365
-
366
- begin
367
- # 删除用户
368
- result = api_instance.user_delete(id, app_key)
369
- p result
370
- rescue ZSGFClient::ApiError => e
371
- puts "Error when calling UserApi->user_delete: #{e}"
372
- end
373
- ```
374
-
375
- #### Using the user_delete_with_http_info variant
376
-
377
- This returns an Array which contains the response data, status code and headers.
378
-
379
- > <Array(<BooleanApiResponse>, Integer, Hash)> user_delete_with_http_info(id, app_key)
380
-
381
- ```ruby
382
- begin
383
- # 删除用户
384
- data, status_code, headers = api_instance.user_delete_with_http_info(id, app_key)
385
- p status_code # => 2xx
386
- p headers # => { ... }
387
- p data # => <BooleanApiResponse>
388
- rescue ZSGFClient::ApiError => e
389
- puts "Error when calling UserApi->user_delete_with_http_info: #{e}"
390
- end
391
- ```
392
-
393
- ### Parameters
394
-
395
- | Name | Type | Description | Notes |
396
- | ---- | ---- | ----------- | ----- |
397
- | **id** | **Integer** | 用户ID | |
398
- | **app_key** | **String** | | |
399
-
400
- ### Return type
401
-
402
- [**BooleanApiResponse**](BooleanApiResponse.md)
403
-
404
- ### Authorization
405
-
406
- [Bearer](../README.md#Bearer)
407
-
408
- ### HTTP request headers
409
-
410
- - **Content-Type**: Not defined
411
- - **Accept**: application/json
412
-
413
-
414
- ## user_email_sign_in
415
-
416
- > <TokenModelApiResponse> user_email_sign_in(app_key, opts)
417
-
418
- 邮箱登录
419
-
420
- 使用邮箱进行登录
421
-
422
- ### Examples
423
-
424
- ```ruby
425
- require 'time'
426
- require 'zsgf_client'
427
- # setup authorization
428
- ZSGFClient.configure do |config|
429
- # Configure Bearer authorization: Bearer
430
- config.access_token = 'YOUR_BEARER_TOKEN'
431
- end
432
-
433
- api_instance = ZSGFClient::UserApi.new
434
- app_key = 'app_key_example' # String |
435
- opts = {
436
- email_sign_in_request: ZSGFClient::EmailSignInRequest.new({email: 'email_example', verify_code: 'verify_code_example'}) # EmailSignInRequest | 登录请求参数
437
- }
438
-
439
- begin
440
- # 邮箱登录
441
- result = api_instance.user_email_sign_in(app_key, opts)
442
- p result
443
- rescue ZSGFClient::ApiError => e
444
- puts "Error when calling UserApi->user_email_sign_in: #{e}"
445
- end
446
- ```
447
-
448
- #### Using the user_email_sign_in_with_http_info variant
449
-
450
- This returns an Array which contains the response data, status code and headers.
451
-
452
- > <Array(<TokenModelApiResponse>, Integer, Hash)> user_email_sign_in_with_http_info(app_key, opts)
453
-
454
- ```ruby
455
- begin
456
- # 邮箱登录
457
- data, status_code, headers = api_instance.user_email_sign_in_with_http_info(app_key, opts)
458
- p status_code # => 2xx
459
- p headers # => { ... }
460
- p data # => <TokenModelApiResponse>
461
- rescue ZSGFClient::ApiError => e
462
- puts "Error when calling UserApi->user_email_sign_in_with_http_info: #{e}"
463
- end
464
- ```
465
-
466
- ### Parameters
467
-
468
- | Name | Type | Description | Notes |
469
- | ---- | ---- | ----------- | ----- |
470
- | **app_key** | **String** | | |
471
- | **email_sign_in_request** | [**EmailSignInRequest**](EmailSignInRequest.md) | 登录请求参数 | [optional] |
472
-
473
- ### Return type
474
-
475
- [**TokenModelApiResponse**](TokenModelApiResponse.md)
476
-
477
- ### Authorization
478
-
479
- [Bearer](../README.md#Bearer)
480
-
481
- ### HTTP request headers
482
-
483
- - **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
484
- - **Accept**: application/json
485
-
486
-
487
- ## user_email_sign_up
488
-
489
- > <TokenModelApiResponse> user_email_sign_up(app_key, opts)
490
-
491
- 邮箱注册
492
-
493
- 使用邮箱进行注册
494
-
495
- ### Examples
496
-
497
- ```ruby
498
- require 'time'
499
- require 'zsgf_client'
500
- # setup authorization
501
- ZSGFClient.configure do |config|
502
- # Configure Bearer authorization: Bearer
503
- config.access_token = 'YOUR_BEARER_TOKEN'
504
- end
505
-
506
- api_instance = ZSGFClient::UserApi.new
507
- app_key = 'app_key_example' # String |
508
- opts = {
509
- email_sign_up_request: ZSGFClient::EmailSignUpRequest.new({email: 'email_example', pwd: 'pwd_example'}) # EmailSignUpRequest | 注册请求参数
510
- }
511
-
512
- begin
513
- # 邮箱注册
514
- result = api_instance.user_email_sign_up(app_key, opts)
515
- p result
516
- rescue ZSGFClient::ApiError => e
517
- puts "Error when calling UserApi->user_email_sign_up: #{e}"
518
- end
519
- ```
520
-
521
- #### Using the user_email_sign_up_with_http_info variant
522
-
523
- This returns an Array which contains the response data, status code and headers.
524
-
525
- > <Array(<TokenModelApiResponse>, Integer, Hash)> user_email_sign_up_with_http_info(app_key, opts)
526
-
527
- ```ruby
528
- begin
529
- # 邮箱注册
530
- data, status_code, headers = api_instance.user_email_sign_up_with_http_info(app_key, opts)
531
- p status_code # => 2xx
532
- p headers # => { ... }
533
- p data # => <TokenModelApiResponse>
534
- rescue ZSGFClient::ApiError => e
535
- puts "Error when calling UserApi->user_email_sign_up_with_http_info: #{e}"
536
- end
537
- ```
538
-
539
- ### Parameters
540
-
541
- | Name | Type | Description | Notes |
542
- | ---- | ---- | ----------- | ----- |
543
- | **app_key** | **String** | | |
544
- | **email_sign_up_request** | [**EmailSignUpRequest**](EmailSignUpRequest.md) | 注册请求参数 | [optional] |
545
-
546
- ### Return type
547
-
548
- [**TokenModelApiResponse**](TokenModelApiResponse.md)
549
-
550
- ### Authorization
551
-
552
- [Bearer](../README.md#Bearer)
553
-
554
- ### HTTP request headers
555
-
556
- - **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
557
- - **Accept**: application/json
558
-
559
-
560
- ## user_export
561
-
562
- > File user_export(app_key)
563
-
564
- 导出用户数据
565
-
566
- 导出所有用户数据为Excel文件
567
-
568
- ### Examples
569
-
570
- ```ruby
571
- require 'time'
572
- require 'zsgf_client'
573
- # setup authorization
574
- ZSGFClient.configure do |config|
575
- # Configure Bearer authorization: Bearer
576
- config.access_token = 'YOUR_BEARER_TOKEN'
577
- end
578
-
579
- api_instance = ZSGFClient::UserApi.new
580
- app_key = 'app_key_example' # String |
581
-
582
- begin
583
- # 导出用户数据
584
- result = api_instance.user_export(app_key)
585
- p result
586
- rescue ZSGFClient::ApiError => e
587
- puts "Error when calling UserApi->user_export: #{e}"
588
- end
589
- ```
590
-
591
- #### Using the user_export_with_http_info variant
592
-
593
- This returns an Array which contains the response data, status code and headers.
594
-
595
- > <Array(File, Integer, Hash)> user_export_with_http_info(app_key)
596
-
597
- ```ruby
598
- begin
599
- # 导出用户数据
600
- data, status_code, headers = api_instance.user_export_with_http_info(app_key)
601
- p status_code # => 2xx
602
- p headers # => { ... }
603
- p data # => File
604
- rescue ZSGFClient::ApiError => e
605
- puts "Error when calling UserApi->user_export_with_http_info: #{e}"
606
- end
607
- ```
608
-
609
- ### Parameters
610
-
611
- | Name | Type | Description | Notes |
612
- | ---- | ---- | ----------- | ----- |
613
- | **app_key** | **String** | | |
614
-
615
- ### Return type
616
-
617
- **File**
618
-
619
- ### Authorization
620
-
621
- [Bearer](../README.md#Bearer)
622
-
623
- ### HTTP request headers
624
-
625
- - **Content-Type**: Not defined
626
- - **Accept**: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
627
-
628
-
629
- ## user_follow_user
630
-
631
- > <BooleanApiResponse> user_follow_user(user_id, app_key)
632
-
633
- 关注用户
634
-
635
- 关注指定用户
636
-
637
- ### Examples
638
-
639
- ```ruby
640
- require 'time'
641
- require 'zsgf_client'
642
- # setup authorization
643
- ZSGFClient.configure do |config|
644
- # Configure Bearer authorization: Bearer
645
- config.access_token = 'YOUR_BEARER_TOKEN'
646
- end
647
-
648
- api_instance = ZSGFClient::UserApi.new
649
- user_id = 789 # Integer | 要关注的用户ID
650
- app_key = 'app_key_example' # String |
651
-
652
- begin
653
- # 关注用户
654
- result = api_instance.user_follow_user(user_id, app_key)
655
- p result
656
- rescue ZSGFClient::ApiError => e
657
- puts "Error when calling UserApi->user_follow_user: #{e}"
658
- end
659
- ```
660
-
661
- #### Using the user_follow_user_with_http_info variant
662
-
663
- This returns an Array which contains the response data, status code and headers.
664
-
665
- > <Array(<BooleanApiResponse>, Integer, Hash)> user_follow_user_with_http_info(user_id, app_key)
666
-
667
- ```ruby
668
- begin
669
- # 关注用户
670
- data, status_code, headers = api_instance.user_follow_user_with_http_info(user_id, app_key)
671
- p status_code # => 2xx
672
- p headers # => { ... }
673
- p data # => <BooleanApiResponse>
674
- rescue ZSGFClient::ApiError => e
675
- puts "Error when calling UserApi->user_follow_user_with_http_info: #{e}"
676
- end
677
- ```
678
-
679
- ### Parameters
680
-
681
- | Name | Type | Description | Notes |
682
- | ---- | ---- | ----------- | ----- |
683
- | **user_id** | **Integer** | 要关注的用户ID | |
684
- | **app_key** | **String** | | |
685
-
686
- ### Return type
687
-
688
- [**BooleanApiResponse**](BooleanApiResponse.md)
689
-
690
- ### Authorization
691
-
692
- [Bearer](../README.md#Bearer)
693
-
694
- ### HTTP request headers
695
-
696
- - **Content-Type**: Not defined
697
- - **Accept**: application/json
698
-
699
-
700
- ## user_follower_put
701
-
702
- > <BooleanApiResponse> user_follower_put(id, app_key, opts)
703
-
704
- 更新粉丝
705
-
706
- 根据粉丝ID更新粉丝信息
707
-
708
- ### Examples
709
-
710
- ```ruby
711
- require 'time'
712
- require 'zsgf_client'
713
- # setup authorization
714
- ZSGFClient.configure do |config|
715
- # Configure Bearer authorization: Bearer
716
- config.access_token = 'YOUR_BEARER_TOKEN'
717
- end
718
-
719
- api_instance = ZSGFClient::UserApi.new
720
- id = 789 # Integer | 粉丝ID
721
- app_key = 'app_key_example' # String |
722
- opts = {
723
- follower_put_model: ZSGFClient::FollowerPutModel.new # FollowerPutModel | 更新粉丝的请求参数
724
- }
725
-
726
- begin
727
- # 更新粉丝
728
- result = api_instance.user_follower_put(id, app_key, opts)
729
- p result
730
- rescue ZSGFClient::ApiError => e
731
- puts "Error when calling UserApi->user_follower_put: #{e}"
732
- end
733
- ```
734
-
735
- #### Using the user_follower_put_with_http_info variant
736
-
737
- This returns an Array which contains the response data, status code and headers.
738
-
739
- > <Array(<BooleanApiResponse>, Integer, Hash)> user_follower_put_with_http_info(id, app_key, opts)
740
-
741
- ```ruby
742
- begin
743
- # 更新粉丝
744
- data, status_code, headers = api_instance.user_follower_put_with_http_info(id, app_key, opts)
745
- p status_code # => 2xx
746
- p headers # => { ... }
747
- p data # => <BooleanApiResponse>
748
- rescue ZSGFClient::ApiError => e
749
- puts "Error when calling UserApi->user_follower_put_with_http_info: #{e}"
750
- end
751
- ```
752
-
753
- ### Parameters
754
-
755
- | Name | Type | Description | Notes |
756
- | ---- | ---- | ----------- | ----- |
757
- | **id** | **Integer** | 粉丝ID | |
758
- | **app_key** | **String** | | |
759
- | **follower_put_model** | [**FollowerPutModel**](FollowerPutModel.md) | 更新粉丝的请求参数 | [optional] |
760
-
761
- ### Return type
762
-
763
- [**BooleanApiResponse**](BooleanApiResponse.md)
764
-
765
- ### Authorization
766
-
767
- [Bearer](../README.md#Bearer)
768
-
769
- ### HTTP request headers
770
-
771
- - **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
772
- - **Accept**: application/json
773
-
774
-
775
- ## user_followers
776
-
777
- > <UserFollowersResultApiResponse> user_followers(app_key, opts)
778
-
779
- 获取我的粉丝列表
780
-
781
- 根据条件获取我的粉丝列表
782
-
783
- ### Examples
784
-
785
- ```ruby
786
- require 'time'
787
- require 'zsgf_client'
788
- # setup authorization
789
- ZSGFClient.configure do |config|
790
- # Configure Bearer authorization: Bearer
791
- config.access_token = 'YOUR_BEARER_TOKEN'
792
- end
793
-
794
- api_instance = ZSGFClient::UserApi.new
795
- app_key = 'app_key_example' # String |
796
- opts = {
797
- tag: 'tag_example', # String | 标签
798
- status: 'status_example', # String | 状态
799
- target_user_id: 789, # Integer | 指定用户的粉丝
800
- skip: 56, # Integer | 跳过的记录数
801
- take: 56 # Integer | 获取的记录数
802
- }
803
-
804
- begin
805
- # 获取我的粉丝列表
806
- result = api_instance.user_followers(app_key, opts)
807
- p result
808
- rescue ZSGFClient::ApiError => e
809
- puts "Error when calling UserApi->user_followers: #{e}"
810
- end
811
- ```
812
-
813
- #### Using the user_followers_with_http_info variant
814
-
815
- This returns an Array which contains the response data, status code and headers.
816
-
817
- > <Array(<UserFollowersResultApiResponse>, Integer, Hash)> user_followers_with_http_info(app_key, opts)
818
-
819
- ```ruby
820
- begin
821
- # 获取我的粉丝列表
822
- data, status_code, headers = api_instance.user_followers_with_http_info(app_key, opts)
823
- p status_code # => 2xx
824
- p headers # => { ... }
825
- p data # => <UserFollowersResultApiResponse>
826
- rescue ZSGFClient::ApiError => e
827
- puts "Error when calling UserApi->user_followers_with_http_info: #{e}"
828
- end
829
- ```
830
-
831
- ### Parameters
832
-
833
- | Name | Type | Description | Notes |
834
- | ---- | ---- | ----------- | ----- |
835
- | **app_key** | **String** | | |
836
- | **tag** | **String** | 标签 | [optional] |
837
- | **status** | **String** | 状态 | [optional] |
838
- | **target_user_id** | **Integer** | 指定用户的粉丝 | [optional][default to 0] |
839
- | **skip** | **Integer** | 跳过的记录数 | [optional][default to 0] |
840
- | **take** | **Integer** | 获取的记录数 | [optional][default to 10] |
841
-
842
- ### Return type
843
-
844
- [**UserFollowersResultApiResponse**](UserFollowersResultApiResponse.md)
845
-
846
- ### Authorization
847
-
848
- [Bearer](../README.md#Bearer)
849
-
850
- ### HTTP request headers
851
-
852
- - **Content-Type**: Not defined
853
- - **Accept**: application/json
854
-
855
-
856
- ## user_following
857
-
858
- > <BooleanApiResponse> user_following(app_key, opts)
859
-
860
- 获取当前用户的关注列表,或者判断是否关注某个特定用户。
861
-
862
- 根据条件获取我的关注列表,或判断是否关注某个用户
863
-
864
- ### Examples
865
-
866
- ```ruby
867
- require 'time'
868
- require 'zsgf_client'
869
- # setup authorization
870
- ZSGFClient.configure do |config|
871
- # Configure Bearer authorization: Bearer
872
- config.access_token = 'YOUR_BEARER_TOKEN'
873
- end
874
-
875
- api_instance = ZSGFClient::UserApi.new
876
- app_key = 'app_key_example' # String |
877
- opts = {
878
- tag: 'tag_example', # String | 用于过滤关注列表的标签(可选)。
879
- status: 'status_example', # String | 用于过滤关注列表的状态(可选)。
880
- target_user_id: 789, # Integer | 指定用户的关注记录,如果不提供则默认为当前用户的关注。
881
- skip: 56, # Integer | 跳过的记录数,用于分页(默认0)。
882
- take: 56, # Integer | 获取的记录数,用于分页(默认10)。
883
- check_user_id: 789, # Integer | 要判断是否关注的目标用户ID。如果提供此参数,方法将返回一个布尔值,表示当前用户是否关注该目标用户。
884
- only_ids: true # Boolean | 是否只返回关注用户的ID集合,默认为false(即返回完整的关注用户信息)。
885
- }
886
-
887
- begin
888
- # 获取当前用户的关注列表,或者判断是否关注某个特定用户。
889
- result = api_instance.user_following(app_key, opts)
890
- p result
891
- rescue ZSGFClient::ApiError => e
892
- puts "Error when calling UserApi->user_following: #{e}"
893
- end
894
- ```
895
-
896
- #### Using the user_following_with_http_info variant
897
-
898
- This returns an Array which contains the response data, status code and headers.
899
-
900
- > <Array(<BooleanApiResponse>, Integer, Hash)> user_following_with_http_info(app_key, opts)
901
-
902
- ```ruby
903
- begin
904
- # 获取当前用户的关注列表,或者判断是否关注某个特定用户。
905
- data, status_code, headers = api_instance.user_following_with_http_info(app_key, opts)
906
- p status_code # => 2xx
907
- p headers # => { ... }
908
- p data # => <BooleanApiResponse>
909
- rescue ZSGFClient::ApiError => e
910
- puts "Error when calling UserApi->user_following_with_http_info: #{e}"
911
- end
912
- ```
913
-
914
- ### Parameters
915
-
916
- | Name | Type | Description | Notes |
917
- | ---- | ---- | ----------- | ----- |
918
- | **app_key** | **String** | | |
919
- | **tag** | **String** | 用于过滤关注列表的标签(可选)。 | [optional] |
920
- | **status** | **String** | 用于过滤关注列表的状态(可选)。 | [optional] |
921
- | **target_user_id** | **Integer** | 指定用户的关注记录,如果不提供则默认为当前用户的关注。 | [optional][default to 0] |
922
- | **skip** | **Integer** | 跳过的记录数,用于分页(默认0)。 | [optional][default to 0] |
923
- | **take** | **Integer** | 获取的记录数,用于分页(默认10)。 | [optional][default to 10] |
924
- | **check_user_id** | **Integer** | 要判断是否关注的目标用户ID。如果提供此参数,方法将返回一个布尔值,表示当前用户是否关注该目标用户。 | [optional] |
925
- | **only_ids** | **Boolean** | 是否只返回关注用户的ID集合,默认为false(即返回完整的关注用户信息)。 | [optional][default to false] |
926
-
927
- ### Return type
928
-
929
- [**BooleanApiResponse**](BooleanApiResponse.md)
930
-
931
- ### Authorization
932
-
933
- [Bearer](../README.md#Bearer)
934
-
935
- ### HTTP request headers
936
-
937
- - **Content-Type**: Not defined
938
- - **Accept**: application/json
939
-
940
-
941
- ## user_friends_near_by
942
-
943
- > <UserFriendsNearByResultApiResponse> user_friends_near_by(longitude, latitude, app_key, opts)
944
-
945
- 获取附近的用户推荐列表
946
-
947
- 根据地理位置坐标和多种筛选条件,查询附近满足条件的用户列表,支持分页和按距离排序。 地理位置查询使用MySQL的ST_Distance_Sphere函数计算球面距离。 注意:longitude为经度(X轴),latitude为纬度(Y轴),参数顺序与常规坐标系一致
948
-
949
- ### Examples
950
-
951
- ```ruby
952
- require 'time'
953
- require 'zsgf_client'
954
- # setup authorization
955
- ZSGFClient.configure do |config|
956
- # Configure Bearer authorization: Bearer
957
- config.access_token = 'YOUR_BEARER_TOKEN'
958
- end
959
-
960
- api_instance = ZSGFClient::UserApi.new
961
- longitude = 1.2 # Float | 当前用户经度坐标(WGS84坐标系)
962
- latitude = 1.2 # Float | 当前用户纬度坐标(WGS84坐标系)
963
- app_key = 'app_key_example' # String |
964
- opts = {
965
- country: 'country_example', # String | 国家过滤条件(精确匹配)
966
- state: 'state_example', # String | 省份过滤条件(精确匹配)
967
- city: 'city_example', # String | 城市过滤条件(精确匹配)
968
- district: 'district_example', # String | 区县过滤条件(精确匹配)
969
- gender: 'gender_example', # String | 性别过滤条件(可选值示例:Male/Female/Other)
970
- age_s: 56, # Integer | 年龄起始范围(包含,0表示不限制)
971
- age_e: 56, # Integer | 年龄结束范围(包含,0表示不限制)
972
- tag: 'tag_example', # String | 兴趣标签过滤(支持模糊匹配,如:\"运动\")
973
- distance: 789, # Integer | 搜索半径(单位:米,0表示不限制距离)
974
- skip: 56, # Integer | 跳过的记录数(分页起始位置,默认0)
975
- take: 56 # Integer | 获取的记录数(分页大小,默认10,最大100)
976
- }
977
-
978
- begin
979
- # 获取附近的用户推荐列表
980
- result = api_instance.user_friends_near_by(longitude, latitude, app_key, opts)
981
- p result
982
- rescue ZSGFClient::ApiError => e
983
- puts "Error when calling UserApi->user_friends_near_by: #{e}"
984
- end
985
- ```
986
-
987
- #### Using the user_friends_near_by_with_http_info variant
988
-
989
- This returns an Array which contains the response data, status code and headers.
990
-
991
- > <Array(<UserFriendsNearByResultApiResponse>, Integer, Hash)> user_friends_near_by_with_http_info(longitude, latitude, app_key, opts)
992
-
993
- ```ruby
994
- begin
995
- # 获取附近的用户推荐列表
996
- data, status_code, headers = api_instance.user_friends_near_by_with_http_info(longitude, latitude, app_key, opts)
997
- p status_code # => 2xx
998
- p headers # => { ... }
999
- p data # => <UserFriendsNearByResultApiResponse>
1000
- rescue ZSGFClient::ApiError => e
1001
- puts "Error when calling UserApi->user_friends_near_by_with_http_info: #{e}"
1002
- end
1003
- ```
1004
-
1005
- ### Parameters
1006
-
1007
- | Name | Type | Description | Notes |
1008
- | ---- | ---- | ----------- | ----- |
1009
- | **longitude** | **Float** | 当前用户经度坐标(WGS84坐标系) | |
1010
- | **latitude** | **Float** | 当前用户纬度坐标(WGS84坐标系) | |
1011
- | **app_key** | **String** | | |
1012
- | **country** | **String** | 国家过滤条件(精确匹配) | [optional] |
1013
- | **state** | **String** | 省份过滤条件(精确匹配) | [optional] |
1014
- | **city** | **String** | 城市过滤条件(精确匹配) | [optional] |
1015
- | **district** | **String** | 区县过滤条件(精确匹配) | [optional] |
1016
- | **gender** | **String** | 性别过滤条件(可选值示例:Male/Female/Other) | [optional] |
1017
- | **age_s** | **Integer** | 年龄起始范围(包含,0表示不限制) | [optional] |
1018
- | **age_e** | **Integer** | 年龄结束范围(包含,0表示不限制) | [optional] |
1019
- | **tag** | **String** | 兴趣标签过滤(支持模糊匹配,如:\&quot;运动\&quot;) | [optional] |
1020
- | **distance** | **Integer** | 搜索半径(单位:米,0表示不限制距离) | [optional][default to 0] |
1021
- | **skip** | **Integer** | 跳过的记录数(分页起始位置,默认0) | [optional][default to 0] |
1022
- | **take** | **Integer** | 获取的记录数(分页大小,默认10,最大100) | [optional][default to 10] |
1023
-
1024
- ### Return type
1025
-
1026
- [**UserFriendsNearByResultApiResponse**](UserFriendsNearByResultApiResponse.md)
1027
-
1028
- ### Authorization
1029
-
1030
- [Bearer](../README.md#Bearer)
1031
-
1032
- ### HTTP request headers
1033
-
1034
- - **Content-Type**: Not defined
1035
- - **Accept**: application/json
1036
-
1037
-
1038
- ## user_import
1039
-
1040
- > <BooleanApiResponse> user_import(app_key, opts)
1041
-
1042
- 导入用户数据
1043
-
1044
- 导入用户数据
1045
-
1046
- ### Examples
1047
-
1048
- ```ruby
1049
- require 'time'
1050
- require 'zsgf_client'
1051
- # setup authorization
1052
- ZSGFClient.configure do |config|
1053
- # Configure Bearer authorization: Bearer
1054
- config.access_token = 'YOUR_BEARER_TOKEN'
1055
- end
1056
-
1057
- api_instance = ZSGFClient::UserApi.new
1058
- app_key = 'app_key_example' # String |
1059
- opts = {
1060
- check: true, # Boolean | 是否进行检查
1061
- file: File.new('/path/to/some/file') # File | 导入的文件
1062
- }
1063
-
1064
- begin
1065
- # 导入用户数据
1066
- result = api_instance.user_import(app_key, opts)
1067
- p result
1068
- rescue ZSGFClient::ApiError => e
1069
- puts "Error when calling UserApi->user_import: #{e}"
1070
- end
1071
- ```
1072
-
1073
- #### Using the user_import_with_http_info variant
1074
-
1075
- This returns an Array which contains the response data, status code and headers.
1076
-
1077
- > <Array(<BooleanApiResponse>, Integer, Hash)> user_import_with_http_info(app_key, opts)
1078
-
1079
- ```ruby
1080
- begin
1081
- # 导入用户数据
1082
- data, status_code, headers = api_instance.user_import_with_http_info(app_key, opts)
1083
- p status_code # => 2xx
1084
- p headers # => { ... }
1085
- p data # => <BooleanApiResponse>
1086
- rescue ZSGFClient::ApiError => e
1087
- puts "Error when calling UserApi->user_import_with_http_info: #{e}"
1088
- end
1089
- ```
1090
-
1091
- ### Parameters
1092
-
1093
- | Name | Type | Description | Notes |
1094
- | ---- | ---- | ----------- | ----- |
1095
- | **app_key** | **String** | | |
1096
- | **check** | **Boolean** | 是否进行检查 | [optional] |
1097
- | **file** | **File** | 导入的文件 | [optional] |
1098
-
1099
- ### Return type
1100
-
1101
- [**BooleanApiResponse**](BooleanApiResponse.md)
1102
-
1103
- ### Authorization
1104
-
1105
- [Bearer](../README.md#Bearer)
1106
-
1107
- ### HTTP request headers
1108
-
1109
- - **Content-Type**: multipart/form-data
1110
- - **Accept**: application/json
1111
-
1112
-
1113
- ## user_location
1114
-
1115
- > <GeoLocationModelApiResponse> user_location(id, app_key)
1116
-
1117
- 获取位置详情
1118
-
1119
- 根据位置ID获取位置详情
1120
-
1121
- ### Examples
1122
-
1123
- ```ruby
1124
- require 'time'
1125
- require 'zsgf_client'
1126
- # setup authorization
1127
- ZSGFClient.configure do |config|
1128
- # Configure Bearer authorization: Bearer
1129
- config.access_token = 'YOUR_BEARER_TOKEN'
1130
- end
1131
-
1132
- api_instance = ZSGFClient::UserApi.new
1133
- id = 789 # Integer | 位置ID
1134
- app_key = 'app_key_example' # String |
1135
-
1136
- begin
1137
- # 获取位置详情
1138
- result = api_instance.user_location(id, app_key)
1139
- p result
1140
- rescue ZSGFClient::ApiError => e
1141
- puts "Error when calling UserApi->user_location: #{e}"
1142
- end
1143
- ```
1144
-
1145
- #### Using the user_location_with_http_info variant
1146
-
1147
- This returns an Array which contains the response data, status code and headers.
1148
-
1149
- > <Array(<GeoLocationModelApiResponse>, Integer, Hash)> user_location_with_http_info(id, app_key)
1150
-
1151
- ```ruby
1152
- begin
1153
- # 获取位置详情
1154
- data, status_code, headers = api_instance.user_location_with_http_info(id, app_key)
1155
- p status_code # => 2xx
1156
- p headers # => { ... }
1157
- p data # => <GeoLocationModelApiResponse>
1158
- rescue ZSGFClient::ApiError => e
1159
- puts "Error when calling UserApi->user_location_with_http_info: #{e}"
1160
- end
1161
- ```
1162
-
1163
- ### Parameters
1164
-
1165
- | Name | Type | Description | Notes |
1166
- | ---- | ---- | ----------- | ----- |
1167
- | **id** | **Integer** | 位置ID | |
1168
- | **app_key** | **String** | | |
1169
-
1170
- ### Return type
1171
-
1172
- [**GeoLocationModelApiResponse**](GeoLocationModelApiResponse.md)
1173
-
1174
- ### Authorization
1175
-
1176
- [Bearer](../README.md#Bearer)
1177
-
1178
- ### HTTP request headers
1179
-
1180
- - **Content-Type**: Not defined
1181
- - **Accept**: application/json
1182
-
1183
-
1184
- ## user_location_delete
1185
-
1186
- > <BooleanApiResponse> user_location_delete(id, app_key)
1187
-
1188
- 删除位置
1189
-
1190
- 根据位置ID删除位置信息
1191
-
1192
- ### Examples
1193
-
1194
- ```ruby
1195
- require 'time'
1196
- require 'zsgf_client'
1197
- # setup authorization
1198
- ZSGFClient.configure do |config|
1199
- # Configure Bearer authorization: Bearer
1200
- config.access_token = 'YOUR_BEARER_TOKEN'
1201
- end
1202
-
1203
- api_instance = ZSGFClient::UserApi.new
1204
- id = 789 # Integer | 位置ID
1205
- app_key = 'app_key_example' # String |
1206
-
1207
- begin
1208
- # 删除位置
1209
- result = api_instance.user_location_delete(id, app_key)
1210
- p result
1211
- rescue ZSGFClient::ApiError => e
1212
- puts "Error when calling UserApi->user_location_delete: #{e}"
1213
- end
1214
- ```
1215
-
1216
- #### Using the user_location_delete_with_http_info variant
1217
-
1218
- This returns an Array which contains the response data, status code and headers.
1219
-
1220
- > <Array(<BooleanApiResponse>, Integer, Hash)> user_location_delete_with_http_info(id, app_key)
1221
-
1222
- ```ruby
1223
- begin
1224
- # 删除位置
1225
- data, status_code, headers = api_instance.user_location_delete_with_http_info(id, app_key)
1226
- p status_code # => 2xx
1227
- p headers # => { ... }
1228
- p data # => <BooleanApiResponse>
1229
- rescue ZSGFClient::ApiError => e
1230
- puts "Error when calling UserApi->user_location_delete_with_http_info: #{e}"
1231
- end
1232
- ```
1233
-
1234
- ### Parameters
1235
-
1236
- | Name | Type | Description | Notes |
1237
- | ---- | ---- | ----------- | ----- |
1238
- | **id** | **Integer** | 位置ID | |
1239
- | **app_key** | **String** | | |
1240
-
1241
- ### Return type
1242
-
1243
- [**BooleanApiResponse**](BooleanApiResponse.md)
1244
-
1245
- ### Authorization
1246
-
1247
- [Bearer](../README.md#Bearer)
1248
-
1249
- ### HTTP request headers
1250
-
1251
- - **Content-Type**: Not defined
1252
- - **Accept**: application/json
1253
-
1254
-
1255
- ## user_location_post
1256
-
1257
- > <UserLocationPostResultApiResponse> user_location_post(app_key, opts)
1258
-
1259
- 添加位置
1260
-
1261
- 添加新的位置信息
1262
-
1263
- ### Examples
1264
-
1265
- ```ruby
1266
- require 'time'
1267
- require 'zsgf_client'
1268
- # setup authorization
1269
- ZSGFClient.configure do |config|
1270
- # Configure Bearer authorization: Bearer
1271
- config.access_token = 'YOUR_BEARER_TOKEN'
1272
- end
1273
-
1274
- api_instance = ZSGFClient::UserApi.new
1275
- app_key = 'app_key_example' # String |
1276
- opts = {
1277
- geo_location_model: ZSGFClient::GeoLocationModel.new({latitude: 3.56, longitude: 3.56, location_type: 'location_type_example'}) # GeoLocationModel | 位置信息
1278
- }
1279
-
1280
- begin
1281
- # 添加位置
1282
- result = api_instance.user_location_post(app_key, opts)
1283
- p result
1284
- rescue ZSGFClient::ApiError => e
1285
- puts "Error when calling UserApi->user_location_post: #{e}"
1286
- end
1287
- ```
1288
-
1289
- #### Using the user_location_post_with_http_info variant
1290
-
1291
- This returns an Array which contains the response data, status code and headers.
1292
-
1293
- > <Array(<UserLocationPostResultApiResponse>, Integer, Hash)> user_location_post_with_http_info(app_key, opts)
1294
-
1295
- ```ruby
1296
- begin
1297
- # 添加位置
1298
- data, status_code, headers = api_instance.user_location_post_with_http_info(app_key, opts)
1299
- p status_code # => 2xx
1300
- p headers # => { ... }
1301
- p data # => <UserLocationPostResultApiResponse>
1302
- rescue ZSGFClient::ApiError => e
1303
- puts "Error when calling UserApi->user_location_post_with_http_info: #{e}"
1304
- end
1305
- ```
1306
-
1307
- ### Parameters
1308
-
1309
- | Name | Type | Description | Notes |
1310
- | ---- | ---- | ----------- | ----- |
1311
- | **app_key** | **String** | | |
1312
- | **geo_location_model** | [**GeoLocationModel**](GeoLocationModel.md) | 位置信息 | [optional] |
1313
-
1314
- ### Return type
1315
-
1316
- [**UserLocationPostResultApiResponse**](UserLocationPostResultApiResponse.md)
1317
-
1318
- ### Authorization
1319
-
1320
- [Bearer](../README.md#Bearer)
1321
-
1322
- ### HTTP request headers
1323
-
1324
- - **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
1325
- - **Accept**: application/json
1326
-
1327
-
1328
- ## user_location_put
1329
-
1330
- > <BooleanApiResponse> user_location_put(id, app_key, opts)
1331
-
1332
- 更新位置
1333
-
1334
- 此方法用于更新指定位置ID的位置信息。如果位置不存在,则创建一个新的位置。
1335
-
1336
- ### Examples
1337
-
1338
- ```ruby
1339
- require 'time'
1340
- require 'zsgf_client'
1341
- # setup authorization
1342
- ZSGFClient.configure do |config|
1343
- # Configure Bearer authorization: Bearer
1344
- config.access_token = 'YOUR_BEARER_TOKEN'
1345
- end
1346
-
1347
- api_instance = ZSGFClient::UserApi.new
1348
- id = 789 # Integer | 位置ID
1349
- app_key = 'app_key_example' # String |
1350
- opts = {
1351
- geo_location_model: ZSGFClient::GeoLocationModel.new({latitude: 3.56, longitude: 3.56, location_type: 'location_type_example'}) # GeoLocationModel | 位置信息
1352
- }
1353
-
1354
- begin
1355
- # 更新位置
1356
- result = api_instance.user_location_put(id, app_key, opts)
1357
- p result
1358
- rescue ZSGFClient::ApiError => e
1359
- puts "Error when calling UserApi->user_location_put: #{e}"
1360
- end
1361
- ```
1362
-
1363
- #### Using the user_location_put_with_http_info variant
1364
-
1365
- This returns an Array which contains the response data, status code and headers.
1366
-
1367
- > <Array(<BooleanApiResponse>, Integer, Hash)> user_location_put_with_http_info(id, app_key, opts)
1368
-
1369
- ```ruby
1370
- begin
1371
- # 更新位置
1372
- data, status_code, headers = api_instance.user_location_put_with_http_info(id, app_key, opts)
1373
- p status_code # => 2xx
1374
- p headers # => { ... }
1375
- p data # => <BooleanApiResponse>
1376
- rescue ZSGFClient::ApiError => e
1377
- puts "Error when calling UserApi->user_location_put_with_http_info: #{e}"
1378
- end
1379
- ```
1380
-
1381
- ### Parameters
1382
-
1383
- | Name | Type | Description | Notes |
1384
- | ---- | ---- | ----------- | ----- |
1385
- | **id** | **Integer** | 位置ID | |
1386
- | **app_key** | **String** | | |
1387
- | **geo_location_model** | [**GeoLocationModel**](GeoLocationModel.md) | 位置信息 | [optional] |
1388
-
1389
- ### Return type
1390
-
1391
- [**BooleanApiResponse**](BooleanApiResponse.md)
1392
-
1393
- ### Authorization
1394
-
1395
- [Bearer](../README.md#Bearer)
1396
-
1397
- ### HTTP request headers
1398
-
1399
- - **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
1400
- - **Accept**: application/json
1401
-
1402
-
1403
- ## user_locations
1404
-
1405
- > <UserLocationsResultApiResponse> user_locations(app_key, opts)
1406
-
1407
- 获取位置列表
1408
-
1409
- 根据条件获取位置列表
1410
-
1411
- ### Examples
1412
-
1413
- ```ruby
1414
- require 'time'
1415
- require 'zsgf_client'
1416
- # setup authorization
1417
- ZSGFClient.configure do |config|
1418
- # Configure Bearer authorization: Bearer
1419
- config.access_token = 'YOUR_BEARER_TOKEN'
1420
- end
1421
-
1422
- api_instance = ZSGFClient::UserApi.new
1423
- app_key = 'app_key_example' # String |
1424
- opts = {
1425
- tag: 'tag_example', # String | 标签
1426
- type: 'type_example', # String | 分类
1427
- x: 1.2, # Float | 纬度
1428
- y: 1.2, # Float | 经度
1429
- sphere: 789, # Integer | 附近距离,单位:米
1430
- skip: 56, # Integer | 跳过的记录数
1431
- take: 56 # Integer | 获取的记录数
1432
- }
1433
-
1434
- begin
1435
- # 获取位置列表
1436
- result = api_instance.user_locations(app_key, opts)
1437
- p result
1438
- rescue ZSGFClient::ApiError => e
1439
- puts "Error when calling UserApi->user_locations: #{e}"
1440
- end
1441
- ```
1442
-
1443
- #### Using the user_locations_with_http_info variant
1444
-
1445
- This returns an Array which contains the response data, status code and headers.
1446
-
1447
- > <Array(<UserLocationsResultApiResponse>, Integer, Hash)> user_locations_with_http_info(app_key, opts)
1448
-
1449
- ```ruby
1450
- begin
1451
- # 获取位置列表
1452
- data, status_code, headers = api_instance.user_locations_with_http_info(app_key, opts)
1453
- p status_code # => 2xx
1454
- p headers # => { ... }
1455
- p data # => <UserLocationsResultApiResponse>
1456
- rescue ZSGFClient::ApiError => e
1457
- puts "Error when calling UserApi->user_locations_with_http_info: #{e}"
1458
- end
1459
- ```
1460
-
1461
- ### Parameters
1462
-
1463
- | Name | Type | Description | Notes |
1464
- | ---- | ---- | ----------- | ----- |
1465
- | **app_key** | **String** | | |
1466
- | **tag** | **String** | 标签 | [optional] |
1467
- | **type** | **String** | 分类 | [optional] |
1468
- | **x** | **Float** | 纬度 | [optional] |
1469
- | **y** | **Float** | 经度 | [optional] |
1470
- | **sphere** | **Integer** | 附近距离,单位:米 | [optional] |
1471
- | **skip** | **Integer** | 跳过的记录数 | [optional] |
1472
- | **take** | **Integer** | 获取的记录数 | [optional][default to 10] |
1473
-
1474
- ### Return type
1475
-
1476
- [**UserLocationsResultApiResponse**](UserLocationsResultApiResponse.md)
1477
-
1478
- ### Authorization
1479
-
1480
- [Bearer](../README.md#Bearer)
1481
-
1482
- ### HTTP request headers
1483
-
1484
- - **Content-Type**: Not defined
1485
- - **Accept**: application/json
1486
-
1487
-
1488
- ## user_mutual_followers
1489
-
1490
- > <UserMutualFollowersResultApiResponse> user_mutual_followers(app_key, opts)
1491
-
1492
- 有共同粉丝的用户推荐
1493
-
1494
- 推荐有共同粉丝的用户
1495
-
1496
- ### Examples
1497
-
1498
- ```ruby
1499
- require 'time'
1500
- require 'zsgf_client'
1501
- # setup authorization
1502
- ZSGFClient.configure do |config|
1503
- # Configure Bearer authorization: Bearer
1504
- config.access_token = 'YOUR_BEARER_TOKEN'
1505
- end
1506
-
1507
- api_instance = ZSGFClient::UserApi.new
1508
- app_key = 'app_key_example' # String |
1509
- opts = {
1510
- skip: 56, # Integer | 跳过的记录数
1511
- take: 56 # Integer | 获取的记录数
1512
- }
1513
-
1514
- begin
1515
- # 有共同粉丝的用户推荐
1516
- result = api_instance.user_mutual_followers(app_key, opts)
1517
- p result
1518
- rescue ZSGFClient::ApiError => e
1519
- puts "Error when calling UserApi->user_mutual_followers: #{e}"
1520
- end
1521
- ```
1522
-
1523
- #### Using the user_mutual_followers_with_http_info variant
1524
-
1525
- This returns an Array which contains the response data, status code and headers.
1526
-
1527
- > <Array(<UserMutualFollowersResultApiResponse>, Integer, Hash)> user_mutual_followers_with_http_info(app_key, opts)
1528
-
1529
- ```ruby
1530
- begin
1531
- # 有共同粉丝的用户推荐
1532
- data, status_code, headers = api_instance.user_mutual_followers_with_http_info(app_key, opts)
1533
- p status_code # => 2xx
1534
- p headers # => { ... }
1535
- p data # => <UserMutualFollowersResultApiResponse>
1536
- rescue ZSGFClient::ApiError => e
1537
- puts "Error when calling UserApi->user_mutual_followers_with_http_info: #{e}"
1538
- end
1539
- ```
1540
-
1541
- ### Parameters
1542
-
1543
- | Name | Type | Description | Notes |
1544
- | ---- | ---- | ----------- | ----- |
1545
- | **app_key** | **String** | | |
1546
- | **skip** | **Integer** | 跳过的记录数 | [optional][default to 0] |
1547
- | **take** | **Integer** | 获取的记录数 | [optional][default to 10] |
1548
-
1549
- ### Return type
1550
-
1551
- [**UserMutualFollowersResultApiResponse**](UserMutualFollowersResultApiResponse.md)
1552
-
1553
- ### Authorization
1554
-
1555
- [Bearer](../README.md#Bearer)
1556
-
1557
- ### HTTP request headers
1558
-
1559
- - **Content-Type**: Not defined
1560
- - **Accept**: application/json
1561
-
1562
-
1563
- ## user_mutual_followings
1564
-
1565
- > <UserMutualFollowingsResultApiResponse> user_mutual_followings(app_key, opts)
1566
-
1567
- 有共同关注的用户推荐
1568
-
1569
- 推荐有共同关注的用户
1570
-
1571
- ### Examples
1572
-
1573
- ```ruby
1574
- require 'time'
1575
- require 'zsgf_client'
1576
- # setup authorization
1577
- ZSGFClient.configure do |config|
1578
- # Configure Bearer authorization: Bearer
1579
- config.access_token = 'YOUR_BEARER_TOKEN'
1580
- end
1581
-
1582
- api_instance = ZSGFClient::UserApi.new
1583
- app_key = 'app_key_example' # String |
1584
- opts = {
1585
- skip: 56, # Integer | 跳过的记录数
1586
- take: 56 # Integer | 获取的记录数
1587
- }
1588
-
1589
- begin
1590
- # 有共同关注的用户推荐
1591
- result = api_instance.user_mutual_followings(app_key, opts)
1592
- p result
1593
- rescue ZSGFClient::ApiError => e
1594
- puts "Error when calling UserApi->user_mutual_followings: #{e}"
1595
- end
1596
- ```
1597
-
1598
- #### Using the user_mutual_followings_with_http_info variant
1599
-
1600
- This returns an Array which contains the response data, status code and headers.
1601
-
1602
- > <Array(<UserMutualFollowingsResultApiResponse>, Integer, Hash)> user_mutual_followings_with_http_info(app_key, opts)
1603
-
1604
- ```ruby
1605
- begin
1606
- # 有共同关注的用户推荐
1607
- data, status_code, headers = api_instance.user_mutual_followings_with_http_info(app_key, opts)
1608
- p status_code # => 2xx
1609
- p headers # => { ... }
1610
- p data # => <UserMutualFollowingsResultApiResponse>
1611
- rescue ZSGFClient::ApiError => e
1612
- puts "Error when calling UserApi->user_mutual_followings_with_http_info: #{e}"
1613
- end
1614
- ```
1615
-
1616
- ### Parameters
1617
-
1618
- | Name | Type | Description | Notes |
1619
- | ---- | ---- | ----------- | ----- |
1620
- | **app_key** | **String** | | |
1621
- | **skip** | **Integer** | 跳过的记录数 | [optional][default to 0] |
1622
- | **take** | **Integer** | 获取的记录数 | [optional][default to 10] |
1623
-
1624
- ### Return type
1625
-
1626
- [**UserMutualFollowingsResultApiResponse**](UserMutualFollowingsResultApiResponse.md)
1627
-
1628
- ### Authorization
1629
-
1630
- [Bearer](../README.md#Bearer)
1631
-
1632
- ### HTTP request headers
1633
-
1634
- - **Content-Type**: Not defined
1635
- - **Accept**: application/json
1636
-
1637
-
1638
- ## user_o_auth_account_bind
1639
-
1640
- > <BooleanApiResponse> user_o_auth_account_bind(app_key, opts)
1641
-
1642
- 外部账号 绑定,如果已存在绑定则直接返回成功
1643
-
1644
- 绑定外部账号
1645
-
1646
- ### Examples
1647
-
1648
- ```ruby
1649
- require 'time'
1650
- require 'zsgf_client'
1651
- # setup authorization
1652
- ZSGFClient.configure do |config|
1653
- # Configure Bearer authorization: Bearer
1654
- config.access_token = 'YOUR_BEARER_TOKEN'
1655
- end
1656
-
1657
- api_instance = ZSGFClient::UserApi.new
1658
- app_key = 'app_key_example' # String |
1659
- opts = {
1660
- o_auth_account_bind_request: ZSGFClient::OAuthAccountBindRequest.new({union_id: 'union_id_example', platform: 'platform_example', platform_name: 'platform_name_example'}) # OAuthAccountBindRequest | 绑定请求参数
1661
- }
1662
-
1663
- begin
1664
- # 外部账号 绑定,如果已存在绑定则直接返回成功
1665
- result = api_instance.user_o_auth_account_bind(app_key, opts)
1666
- p result
1667
- rescue ZSGFClient::ApiError => e
1668
- puts "Error when calling UserApi->user_o_auth_account_bind: #{e}"
1669
- end
1670
- ```
1671
-
1672
- #### Using the user_o_auth_account_bind_with_http_info variant
1673
-
1674
- This returns an Array which contains the response data, status code and headers.
1675
-
1676
- > <Array(<BooleanApiResponse>, Integer, Hash)> user_o_auth_account_bind_with_http_info(app_key, opts)
1677
-
1678
- ```ruby
1679
- begin
1680
- # 外部账号 绑定,如果已存在绑定则直接返回成功
1681
- data, status_code, headers = api_instance.user_o_auth_account_bind_with_http_info(app_key, opts)
1682
- p status_code # => 2xx
1683
- p headers # => { ... }
1684
- p data # => <BooleanApiResponse>
1685
- rescue ZSGFClient::ApiError => e
1686
- puts "Error when calling UserApi->user_o_auth_account_bind_with_http_info: #{e}"
1687
- end
1688
- ```
1689
-
1690
- ### Parameters
1691
-
1692
- | Name | Type | Description | Notes |
1693
- | ---- | ---- | ----------- | ----- |
1694
- | **app_key** | **String** | | |
1695
- | **o_auth_account_bind_request** | [**OAuthAccountBindRequest**](OAuthAccountBindRequest.md) | 绑定请求参数 | [optional] |
1696
-
1697
- ### Return type
1698
-
1699
- [**BooleanApiResponse**](BooleanApiResponse.md)
1700
-
1701
- ### Authorization
1702
-
1703
- [Bearer](../README.md#Bearer)
1704
-
1705
- ### HTTP request headers
1706
-
1707
- - **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
1708
- - **Accept**: application/json
1709
-
1710
-
1711
- ## user_o_auth_account_sign_in
1712
-
1713
- > <TokenModelApiResponse> user_o_auth_account_sign_in(app_key, opts)
1714
-
1715
- 外部账号 登录
1716
-
1717
- 使用外部账号进行登录
1718
-
1719
- ### Examples
1720
-
1721
- ```ruby
1722
- require 'time'
1723
- require 'zsgf_client'
1724
- # setup authorization
1725
- ZSGFClient.configure do |config|
1726
- # Configure Bearer authorization: Bearer
1727
- config.access_token = 'YOUR_BEARER_TOKEN'
1728
- end
1729
-
1730
- api_instance = ZSGFClient::UserApi.new
1731
- app_key = 'app_key_example' # String |
1732
- opts = {
1733
- o_auth_account_sign_in_request: ZSGFClient::OAuthAccountSignInRequest.new({union_id: 'union_id_example', platform: 'platform_example'}) # OAuthAccountSignInRequest | 登录请求参数
1734
- }
1735
-
1736
- begin
1737
- # 外部账号 登录
1738
- result = api_instance.user_o_auth_account_sign_in(app_key, opts)
1739
- p result
1740
- rescue ZSGFClient::ApiError => e
1741
- puts "Error when calling UserApi->user_o_auth_account_sign_in: #{e}"
1742
- end
1743
- ```
1744
-
1745
- #### Using the user_o_auth_account_sign_in_with_http_info variant
1746
-
1747
- This returns an Array which contains the response data, status code and headers.
1748
-
1749
- > <Array(<TokenModelApiResponse>, Integer, Hash)> user_o_auth_account_sign_in_with_http_info(app_key, opts)
1750
-
1751
- ```ruby
1752
- begin
1753
- # 外部账号 登录
1754
- data, status_code, headers = api_instance.user_o_auth_account_sign_in_with_http_info(app_key, opts)
1755
- p status_code # => 2xx
1756
- p headers # => { ... }
1757
- p data # => <TokenModelApiResponse>
1758
- rescue ZSGFClient::ApiError => e
1759
- puts "Error when calling UserApi->user_o_auth_account_sign_in_with_http_info: #{e}"
1760
- end
1761
- ```
1762
-
1763
- ### Parameters
1764
-
1765
- | Name | Type | Description | Notes |
1766
- | ---- | ---- | ----------- | ----- |
1767
- | **app_key** | **String** | | |
1768
- | **o_auth_account_sign_in_request** | [**OAuthAccountSignInRequest**](OAuthAccountSignInRequest.md) | 登录请求参数 | [optional] |
1769
-
1770
- ### Return type
1771
-
1772
- [**TokenModelApiResponse**](TokenModelApiResponse.md)
1773
-
1774
- ### Authorization
1775
-
1776
- [Bearer](../README.md#Bearer)
1777
-
1778
- ### HTTP request headers
1779
-
1780
- - **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
1781
- - **Accept**: application/json
1782
-
1783
-
1784
- ## user_o_auth_accounts
1785
-
1786
- > <UserLoginsListApiResponse> user_o_auth_accounts(app_key)
1787
-
1788
- 外部账号 绑定列表
1789
-
1790
- 获取外部账号绑定列表
1791
-
1792
- ### Examples
1793
-
1794
- ```ruby
1795
- require 'time'
1796
- require 'zsgf_client'
1797
- # setup authorization
1798
- ZSGFClient.configure do |config|
1799
- # Configure Bearer authorization: Bearer
1800
- config.access_token = 'YOUR_BEARER_TOKEN'
1801
- end
1802
-
1803
- api_instance = ZSGFClient::UserApi.new
1804
- app_key = 'app_key_example' # String |
1805
-
1806
- begin
1807
- # 外部账号 绑定列表
1808
- result = api_instance.user_o_auth_accounts(app_key)
1809
- p result
1810
- rescue ZSGFClient::ApiError => e
1811
- puts "Error when calling UserApi->user_o_auth_accounts: #{e}"
1812
- end
1813
- ```
1814
-
1815
- #### Using the user_o_auth_accounts_with_http_info variant
1816
-
1817
- This returns an Array which contains the response data, status code and headers.
1818
-
1819
- > <Array(<UserLoginsListApiResponse>, Integer, Hash)> user_o_auth_accounts_with_http_info(app_key)
1820
-
1821
- ```ruby
1822
- begin
1823
- # 外部账号 绑定列表
1824
- data, status_code, headers = api_instance.user_o_auth_accounts_with_http_info(app_key)
1825
- p status_code # => 2xx
1826
- p headers # => { ... }
1827
- p data # => <UserLoginsListApiResponse>
1828
- rescue ZSGFClient::ApiError => e
1829
- puts "Error when calling UserApi->user_o_auth_accounts_with_http_info: #{e}"
1830
- end
1831
- ```
1832
-
1833
- ### Parameters
1834
-
1835
- | Name | Type | Description | Notes |
1836
- | ---- | ---- | ----------- | ----- |
1837
- | **app_key** | **String** | | |
1838
-
1839
- ### Return type
1840
-
1841
- [**UserLoginsListApiResponse**](UserLoginsListApiResponse.md)
1842
-
1843
- ### Authorization
1844
-
1845
- [Bearer](../README.md#Bearer)
1846
-
1847
- ### HTTP request headers
1848
-
1849
- - **Content-Type**: Not defined
1850
- - **Accept**: application/json
1851
-
1852
-
1853
- ## user_o_auth_accounts_put_bind
1854
-
1855
- > <BooleanApiResponse> user_o_auth_accounts_put_bind(id, app_key, opts)
1856
-
1857
- 外部账号 更新绑定
1858
-
1859
- 更新外部账号绑定信息
1860
-
1861
- ### Examples
1862
-
1863
- ```ruby
1864
- require 'time'
1865
- require 'zsgf_client'
1866
- # setup authorization
1867
- ZSGFClient.configure do |config|
1868
- # Configure Bearer authorization: Bearer
1869
- config.access_token = 'YOUR_BEARER_TOKEN'
1870
- end
1871
-
1872
- api_instance = ZSGFClient::UserApi.new
1873
- id = 789 # Integer | 绑定ID
1874
- app_key = 'app_key_example' # String |
1875
- opts = {
1876
- o_auth_account_put_bind_request: ZSGFClient::OAuthAccountPutBindRequest.new # OAuthAccountPutBindRequest | 更新请求参数
1877
- }
1878
-
1879
- begin
1880
- # 外部账号 更新绑定
1881
- result = api_instance.user_o_auth_accounts_put_bind(id, app_key, opts)
1882
- p result
1883
- rescue ZSGFClient::ApiError => e
1884
- puts "Error when calling UserApi->user_o_auth_accounts_put_bind: #{e}"
1885
- end
1886
- ```
1887
-
1888
- #### Using the user_o_auth_accounts_put_bind_with_http_info variant
1889
-
1890
- This returns an Array which contains the response data, status code and headers.
1891
-
1892
- > <Array(<BooleanApiResponse>, Integer, Hash)> user_o_auth_accounts_put_bind_with_http_info(id, app_key, opts)
1893
-
1894
- ```ruby
1895
- begin
1896
- # 外部账号 更新绑定
1897
- data, status_code, headers = api_instance.user_o_auth_accounts_put_bind_with_http_info(id, app_key, opts)
1898
- p status_code # => 2xx
1899
- p headers # => { ... }
1900
- p data # => <BooleanApiResponse>
1901
- rescue ZSGFClient::ApiError => e
1902
- puts "Error when calling UserApi->user_o_auth_accounts_put_bind_with_http_info: #{e}"
1903
- end
1904
- ```
1905
-
1906
- ### Parameters
1907
-
1908
- | Name | Type | Description | Notes |
1909
- | ---- | ---- | ----------- | ----- |
1910
- | **id** | **Integer** | 绑定ID | |
1911
- | **app_key** | **String** | | |
1912
- | **o_auth_account_put_bind_request** | [**OAuthAccountPutBindRequest**](OAuthAccountPutBindRequest.md) | 更新请求参数 | [optional] |
1913
-
1914
- ### Return type
1915
-
1916
- [**BooleanApiResponse**](BooleanApiResponse.md)
1917
-
1918
- ### Authorization
1919
-
1920
- [Bearer](../README.md#Bearer)
1921
-
1922
- ### HTTP request headers
1923
-
1924
- - **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
1925
- - **Accept**: application/json
1926
-
1927
-
1928
- ## user_o_auth_accounts_un_bind
1929
-
1930
- > <BooleanApiResponse> user_o_auth_accounts_un_bind(id, app_key)
1931
-
1932
- 外部账号 删除绑定
1933
-
1934
- 删除外部账号绑定
1935
-
1936
- ### Examples
1937
-
1938
- ```ruby
1939
- require 'time'
1940
- require 'zsgf_client'
1941
- # setup authorization
1942
- ZSGFClient.configure do |config|
1943
- # Configure Bearer authorization: Bearer
1944
- config.access_token = 'YOUR_BEARER_TOKEN'
1945
- end
1946
-
1947
- api_instance = ZSGFClient::UserApi.new
1948
- id = 789 # Integer | 绑定ID
1949
- app_key = 'app_key_example' # String |
1950
-
1951
- begin
1952
- # 外部账号 删除绑定
1953
- result = api_instance.user_o_auth_accounts_un_bind(id, app_key)
1954
- p result
1955
- rescue ZSGFClient::ApiError => e
1956
- puts "Error when calling UserApi->user_o_auth_accounts_un_bind: #{e}"
1957
- end
1958
- ```
1959
-
1960
- #### Using the user_o_auth_accounts_un_bind_with_http_info variant
1961
-
1962
- This returns an Array which contains the response data, status code and headers.
1963
-
1964
- > <Array(<BooleanApiResponse>, Integer, Hash)> user_o_auth_accounts_un_bind_with_http_info(id, app_key)
1965
-
1966
- ```ruby
1967
- begin
1968
- # 外部账号 删除绑定
1969
- data, status_code, headers = api_instance.user_o_auth_accounts_un_bind_with_http_info(id, app_key)
1970
- p status_code # => 2xx
1971
- p headers # => { ... }
1972
- p data # => <BooleanApiResponse>
1973
- rescue ZSGFClient::ApiError => e
1974
- puts "Error when calling UserApi->user_o_auth_accounts_un_bind_with_http_info: #{e}"
1975
- end
1976
- ```
1977
-
1978
- ### Parameters
1979
-
1980
- | Name | Type | Description | Notes |
1981
- | ---- | ---- | ----------- | ----- |
1982
- | **id** | **Integer** | 绑定ID | |
1983
- | **app_key** | **String** | | |
1984
-
1985
- ### Return type
1986
-
1987
- [**BooleanApiResponse**](BooleanApiResponse.md)
1988
-
1989
- ### Authorization
1990
-
1991
- [Bearer](../README.md#Bearer)
1992
-
1993
- ### HTTP request headers
1994
-
1995
- - **Content-Type**: Not defined
1996
- - **Accept**: application/json
1997
-
1998
-
1999
- ## user_phone_sign_in
2000
-
2001
- > <TokenModelApiResponse> user_phone_sign_in(app_key, opts)
2002
-
2003
- 手机登录
2004
-
2005
- 使用手机号码进行登录
2006
-
2007
- ### Examples
2008
-
2009
- ```ruby
2010
- require 'time'
2011
- require 'zsgf_client'
2012
- # setup authorization
2013
- ZSGFClient.configure do |config|
2014
- # Configure Bearer authorization: Bearer
2015
- config.access_token = 'YOUR_BEARER_TOKEN'
2016
- end
2017
-
2018
- api_instance = ZSGFClient::UserApi.new
2019
- app_key = 'app_key_example' # String |
2020
- opts = {
2021
- phone_sign_in_request: ZSGFClient::PhoneSignInRequest.new({phone: 'phone_example', verify_code: 'verify_code_example'}) # PhoneSignInRequest | 登录请求参数
2022
- }
2023
-
2024
- begin
2025
- # 手机登录
2026
- result = api_instance.user_phone_sign_in(app_key, opts)
2027
- p result
2028
- rescue ZSGFClient::ApiError => e
2029
- puts "Error when calling UserApi->user_phone_sign_in: #{e}"
2030
- end
2031
- ```
2032
-
2033
- #### Using the user_phone_sign_in_with_http_info variant
2034
-
2035
- This returns an Array which contains the response data, status code and headers.
2036
-
2037
- > <Array(<TokenModelApiResponse>, Integer, Hash)> user_phone_sign_in_with_http_info(app_key, opts)
2038
-
2039
- ```ruby
2040
- begin
2041
- # 手机登录
2042
- data, status_code, headers = api_instance.user_phone_sign_in_with_http_info(app_key, opts)
2043
- p status_code # => 2xx
2044
- p headers # => { ... }
2045
- p data # => <TokenModelApiResponse>
2046
- rescue ZSGFClient::ApiError => e
2047
- puts "Error when calling UserApi->user_phone_sign_in_with_http_info: #{e}"
2048
- end
2049
- ```
2050
-
2051
- ### Parameters
2052
-
2053
- | Name | Type | Description | Notes |
2054
- | ---- | ---- | ----------- | ----- |
2055
- | **app_key** | **String** | | |
2056
- | **phone_sign_in_request** | [**PhoneSignInRequest**](PhoneSignInRequest.md) | 登录请求参数 | [optional] |
2057
-
2058
- ### Return type
2059
-
2060
- [**TokenModelApiResponse**](TokenModelApiResponse.md)
2061
-
2062
- ### Authorization
2063
-
2064
- [Bearer](../README.md#Bearer)
2065
-
2066
- ### HTTP request headers
2067
-
2068
- - **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
2069
- - **Accept**: application/json
2070
-
2071
-
2072
- ## user_phone_sign_up
2073
-
2074
- > <TokenModelApiResponse> user_phone_sign_up(app_key, opts)
2075
-
2076
- 手机注册
2077
-
2078
- 使用手机号码进行注册
2079
-
2080
- ### Examples
2081
-
2082
- ```ruby
2083
- require 'time'
2084
- require 'zsgf_client'
2085
- # setup authorization
2086
- ZSGFClient.configure do |config|
2087
- # Configure Bearer authorization: Bearer
2088
- config.access_token = 'YOUR_BEARER_TOKEN'
2089
- end
2090
-
2091
- api_instance = ZSGFClient::UserApi.new
2092
- app_key = 'app_key_example' # String |
2093
- opts = {
2094
- phone_sign_up_request: ZSGFClient::PhoneSignUpRequest.new({phone: 'phone_example', phone_code: 'phone_code_example', pwd: 'pwd_example'}) # PhoneSignUpRequest | 注册请求参数
2095
- }
2096
-
2097
- begin
2098
- # 手机注册
2099
- result = api_instance.user_phone_sign_up(app_key, opts)
2100
- p result
2101
- rescue ZSGFClient::ApiError => e
2102
- puts "Error when calling UserApi->user_phone_sign_up: #{e}"
2103
- end
2104
- ```
2105
-
2106
- #### Using the user_phone_sign_up_with_http_info variant
2107
-
2108
- This returns an Array which contains the response data, status code and headers.
2109
-
2110
- > <Array(<TokenModelApiResponse>, Integer, Hash)> user_phone_sign_up_with_http_info(app_key, opts)
2111
-
2112
- ```ruby
2113
- begin
2114
- # 手机注册
2115
- data, status_code, headers = api_instance.user_phone_sign_up_with_http_info(app_key, opts)
2116
- p status_code # => 2xx
2117
- p headers # => { ... }
2118
- p data # => <TokenModelApiResponse>
2119
- rescue ZSGFClient::ApiError => e
2120
- puts "Error when calling UserApi->user_phone_sign_up_with_http_info: #{e}"
2121
- end
2122
- ```
2123
-
2124
- ### Parameters
2125
-
2126
- | Name | Type | Description | Notes |
2127
- | ---- | ---- | ----------- | ----- |
2128
- | **app_key** | **String** | | |
2129
- | **phone_sign_up_request** | [**PhoneSignUpRequest**](PhoneSignUpRequest.md) | 注册请求参数 | [optional] |
2130
-
2131
- ### Return type
2132
-
2133
- [**TokenModelApiResponse**](TokenModelApiResponse.md)
2134
-
2135
- ### Authorization
2136
-
2137
- [Bearer](../README.md#Bearer)
2138
-
2139
- ### HTTP request headers
2140
-
2141
- - **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
2142
- - **Accept**: application/json
2143
-
2144
-
2145
- ## user_profile
2146
-
2147
- > <UserProfileResultApiResponse> user_profile(app_key)
2148
-
2149
- 获取个人资料
2150
-
2151
- 获取当前用户的个人资料
2152
-
2153
- ### Examples
2154
-
2155
- ```ruby
2156
- require 'time'
2157
- require 'zsgf_client'
2158
- # setup authorization
2159
- ZSGFClient.configure do |config|
2160
- # Configure Bearer authorization: Bearer
2161
- config.access_token = 'YOUR_BEARER_TOKEN'
2162
- end
2163
-
2164
- api_instance = ZSGFClient::UserApi.new
2165
- app_key = 'app_key_example' # String |
2166
-
2167
- begin
2168
- # 获取个人资料
2169
- result = api_instance.user_profile(app_key)
2170
- p result
2171
- rescue ZSGFClient::ApiError => e
2172
- puts "Error when calling UserApi->user_profile: #{e}"
2173
- end
2174
- ```
2175
-
2176
- #### Using the user_profile_with_http_info variant
2177
-
2178
- This returns an Array which contains the response data, status code and headers.
2179
-
2180
- > <Array(<UserProfileResultApiResponse>, Integer, Hash)> user_profile_with_http_info(app_key)
2181
-
2182
- ```ruby
2183
- begin
2184
- # 获取个人资料
2185
- data, status_code, headers = api_instance.user_profile_with_http_info(app_key)
2186
- p status_code # => 2xx
2187
- p headers # => { ... }
2188
- p data # => <UserProfileResultApiResponse>
2189
- rescue ZSGFClient::ApiError => e
2190
- puts "Error when calling UserApi->user_profile_with_http_info: #{e}"
2191
- end
2192
- ```
2193
-
2194
- ### Parameters
2195
-
2196
- | Name | Type | Description | Notes |
2197
- | ---- | ---- | ----------- | ----- |
2198
- | **app_key** | **String** | | |
2199
-
2200
- ### Return type
2201
-
2202
- [**UserProfileResultApiResponse**](UserProfileResultApiResponse.md)
2203
-
2204
- ### Authorization
2205
-
2206
- [Bearer](../README.md#Bearer)
2207
-
2208
- ### HTTP request headers
2209
-
2210
- - **Content-Type**: Not defined
2211
- - **Accept**: application/json
2212
-
2213
-
2214
- ## user_profile_by_id
26
+ ## user_deactivate_hard
2215
27
 
2216
- > <GetUserProfileResultApiResponse> user_profile_by_id(user_id, app_key)
28
+ > <BooleanApiResponse> user_deactivate_hard(app_key)
2217
29
 
2218
- 获取指定用户资料
30
+ 注销账号
2219
31
 
2220
- 用于他人主页展示
32
+ 清除用户所有附属数据,并注销账号
2221
33
 
2222
34
  ### Examples
2223
35
 
@@ -2231,33 +43,32 @@ ZSGFClient.configure do |config|
2231
43
  end
2232
44
 
2233
45
  api_instance = ZSGFClient::UserApi.new
2234
- user_id = 789 # Integer | 用户ID
2235
46
  app_key = 'app_key_example' # String |
2236
47
 
2237
48
  begin
2238
- # 获取指定用户资料
2239
- result = api_instance.user_profile_by_id(user_id, app_key)
49
+ # 注销账号
50
+ result = api_instance.user_deactivate_hard(app_key)
2240
51
  p result
2241
52
  rescue ZSGFClient::ApiError => e
2242
- puts "Error when calling UserApi->user_profile_by_id: #{e}"
53
+ puts "Error when calling UserApi->user_deactivate_hard: #{e}"
2243
54
  end
2244
55
  ```
2245
56
 
2246
- #### Using the user_profile_by_id_with_http_info variant
57
+ #### Using the user_deactivate_hard_with_http_info variant
2247
58
 
2248
59
  This returns an Array which contains the response data, status code and headers.
2249
60
 
2250
- > <Array(<GetUserProfileResultApiResponse>, Integer, Hash)> user_profile_by_id_with_http_info(user_id, app_key)
61
+ > <Array(<BooleanApiResponse>, Integer, Hash)> user_deactivate_hard_with_http_info(app_key)
2251
62
 
2252
63
  ```ruby
2253
64
  begin
2254
- # 获取指定用户资料
2255
- data, status_code, headers = api_instance.user_profile_by_id_with_http_info(user_id, app_key)
65
+ # 注销账号
66
+ data, status_code, headers = api_instance.user_deactivate_hard_with_http_info(app_key)
2256
67
  p status_code # => 2xx
2257
68
  p headers # => { ... }
2258
- p data # => <GetUserProfileResultApiResponse>
69
+ p data # => <BooleanApiResponse>
2259
70
  rescue ZSGFClient::ApiError => e
2260
- puts "Error when calling UserApi->user_profile_by_id_with_http_info: #{e}"
71
+ puts "Error when calling UserApi->user_deactivate_hard_with_http_info: #{e}"
2261
72
  end
2262
73
  ```
2263
74
 
@@ -2265,12 +76,11 @@ end
2265
76
 
2266
77
  | Name | Type | Description | Notes |
2267
78
  | ---- | ---- | ----------- | ----- |
2268
- | **user_id** | **Integer** | 用户ID | |
2269
79
  | **app_key** | **String** | | |
2270
80
 
2271
81
  ### Return type
2272
82
 
2273
- [**GetUserProfileResultApiResponse**](GetUserProfileResultApiResponse.md)
83
+ [**BooleanApiResponse**](BooleanApiResponse.md)
2274
84
 
2275
85
  ### Authorization
2276
86
 
@@ -2282,13 +92,13 @@ end
2282
92
  - **Accept**: application/json
2283
93
 
2284
94
 
2285
- ## user_put
95
+ ## user_email_sign_in
2286
96
 
2287
- > <BooleanApiResponse> user_put(id, app_key, opts)
97
+ > <TokenModelApiResponse> user_email_sign_in(app_key, opts)
2288
98
 
2289
- 更新用户信息
99
+ 邮箱登录
2290
100
 
2291
- 根据用户ID更新用户信息
101
+ 使用邮箱进行登录
2292
102
 
2293
103
  ### Examples
2294
104
 
@@ -2302,36 +112,35 @@ ZSGFClient.configure do |config|
2302
112
  end
2303
113
 
2304
114
  api_instance = ZSGFClient::UserApi.new
2305
- id = 789 # Integer | 用户ID
2306
115
  app_key = 'app_key_example' # String |
2307
116
  opts = {
2308
- user: ZSGFClient::User.new # User | 用户信息
117
+ email_sign_in_request: ZSGFClient::EmailSignInRequest.new({email: 'email_example', verify_code: 'verify_code_example'}) # EmailSignInRequest | 登录请求参数
2309
118
  }
2310
119
 
2311
120
  begin
2312
- # 更新用户信息
2313
- result = api_instance.user_put(id, app_key, opts)
121
+ # 邮箱登录
122
+ result = api_instance.user_email_sign_in(app_key, opts)
2314
123
  p result
2315
124
  rescue ZSGFClient::ApiError => e
2316
- puts "Error when calling UserApi->user_put: #{e}"
125
+ puts "Error when calling UserApi->user_email_sign_in: #{e}"
2317
126
  end
2318
127
  ```
2319
128
 
2320
- #### Using the user_put_with_http_info variant
129
+ #### Using the user_email_sign_in_with_http_info variant
2321
130
 
2322
131
  This returns an Array which contains the response data, status code and headers.
2323
132
 
2324
- > <Array(<BooleanApiResponse>, Integer, Hash)> user_put_with_http_info(id, app_key, opts)
133
+ > <Array(<TokenModelApiResponse>, Integer, Hash)> user_email_sign_in_with_http_info(app_key, opts)
2325
134
 
2326
135
  ```ruby
2327
136
  begin
2328
- # 更新用户信息
2329
- data, status_code, headers = api_instance.user_put_with_http_info(id, app_key, opts)
137
+ # 邮箱登录
138
+ data, status_code, headers = api_instance.user_email_sign_in_with_http_info(app_key, opts)
2330
139
  p status_code # => 2xx
2331
140
  p headers # => { ... }
2332
- p data # => <BooleanApiResponse>
141
+ p data # => <TokenModelApiResponse>
2333
142
  rescue ZSGFClient::ApiError => e
2334
- puts "Error when calling UserApi->user_put_with_http_info: #{e}"
143
+ puts "Error when calling UserApi->user_email_sign_in_with_http_info: #{e}"
2335
144
  end
2336
145
  ```
2337
146
 
@@ -2339,13 +148,12 @@ end
2339
148
 
2340
149
  | Name | Type | Description | Notes |
2341
150
  | ---- | ---- | ----------- | ----- |
2342
- | **id** | **Integer** | 用户ID | |
2343
151
  | **app_key** | **String** | | |
2344
- | **user** | [**User**](User.md) | 用户信息 | [optional] |
152
+ | **email_sign_in_request** | [**EmailSignInRequest**](EmailSignInRequest.md) | 登录请求参数 | [optional] |
2345
153
 
2346
154
  ### Return type
2347
155
 
2348
- [**BooleanApiResponse**](BooleanApiResponse.md)
156
+ [**TokenModelApiResponse**](TokenModelApiResponse.md)
2349
157
 
2350
158
  ### Authorization
2351
159
 
@@ -2357,13 +165,13 @@ end
2357
165
  - **Accept**: application/json
2358
166
 
2359
167
 
2360
- ## user_qr_code_pre_sign_in
168
+ ## user_email_sign_up
2361
169
 
2362
- > <Int64ApiResponse> user_qr_code_pre_sign_in(app_key, opts)
170
+ > <TokenModelApiResponse> user_email_sign_up(app_key, opts)
2363
171
 
2364
- 微信小程序 - 预登陆
172
+ 邮箱注册
2365
173
 
2366
- 使用微信小程序二维码进行预登陆
174
+ 使用邮箱进行注册
2367
175
 
2368
176
  ### Examples
2369
177
 
@@ -2379,33 +187,33 @@ end
2379
187
  api_instance = ZSGFClient::UserApi.new
2380
188
  app_key = 'app_key_example' # String |
2381
189
  opts = {
2382
- qr_code_pre_sign_in_request: ZSGFClient::QRCodePreSignInRequest.new # QRCodePreSignInRequest | 预登陆请求参数
190
+ email_sign_up_request: ZSGFClient::EmailSignUpRequest.new({email: 'email_example', pwd: 'pwd_example'}) # EmailSignUpRequest | 注册请求参数
2383
191
  }
2384
192
 
2385
193
  begin
2386
- # 微信小程序 - 预登陆
2387
- result = api_instance.user_qr_code_pre_sign_in(app_key, opts)
194
+ # 邮箱注册
195
+ result = api_instance.user_email_sign_up(app_key, opts)
2388
196
  p result
2389
197
  rescue ZSGFClient::ApiError => e
2390
- puts "Error when calling UserApi->user_qr_code_pre_sign_in: #{e}"
198
+ puts "Error when calling UserApi->user_email_sign_up: #{e}"
2391
199
  end
2392
200
  ```
2393
201
 
2394
- #### Using the user_qr_code_pre_sign_in_with_http_info variant
202
+ #### Using the user_email_sign_up_with_http_info variant
2395
203
 
2396
204
  This returns an Array which contains the response data, status code and headers.
2397
205
 
2398
- > <Array(<Int64ApiResponse>, Integer, Hash)> user_qr_code_pre_sign_in_with_http_info(app_key, opts)
206
+ > <Array(<TokenModelApiResponse>, Integer, Hash)> user_email_sign_up_with_http_info(app_key, opts)
2399
207
 
2400
208
  ```ruby
2401
209
  begin
2402
- # 微信小程序 - 预登陆
2403
- data, status_code, headers = api_instance.user_qr_code_pre_sign_in_with_http_info(app_key, opts)
210
+ # 邮箱注册
211
+ data, status_code, headers = api_instance.user_email_sign_up_with_http_info(app_key, opts)
2404
212
  p status_code # => 2xx
2405
213
  p headers # => { ... }
2406
- p data # => <Int64ApiResponse>
214
+ p data # => <TokenModelApiResponse>
2407
215
  rescue ZSGFClient::ApiError => e
2408
- puts "Error when calling UserApi->user_qr_code_pre_sign_in_with_http_info: #{e}"
216
+ puts "Error when calling UserApi->user_email_sign_up_with_http_info: #{e}"
2409
217
  end
2410
218
  ```
2411
219
 
@@ -2414,11 +222,11 @@ end
2414
222
  | Name | Type | Description | Notes |
2415
223
  | ---- | ---- | ----------- | ----- |
2416
224
  | **app_key** | **String** | | |
2417
- | **qr_code_pre_sign_in_request** | [**QRCodePreSignInRequest**](QRCodePreSignInRequest.md) | 预登陆请求参数 | [optional] |
225
+ | **email_sign_up_request** | [**EmailSignUpRequest**](EmailSignUpRequest.md) | 注册请求参数 | [optional] |
2418
226
 
2419
227
  ### Return type
2420
228
 
2421
- [**Int64ApiResponse**](Int64ApiResponse.md)
229
+ [**TokenModelApiResponse**](TokenModelApiResponse.md)
2422
230
 
2423
231
  ### Authorization
2424
232
 
@@ -2430,13 +238,13 @@ end
2430
238
  - **Accept**: application/json
2431
239
 
2432
240
 
2433
- ## user_qr_code_scan
241
+ ## user_phone_sign_in
2434
242
 
2435
- > <UserQRCodeScanResultApiResponse> user_qr_code_scan(app_key, opts)
243
+ > <TokenModelApiResponse> user_phone_sign_in(app_key, opts)
2436
244
 
2437
- 微信小程序 - 扫码
245
+ 手机登录
2438
246
 
2439
- 使用微信小程序二维码进行扫码
247
+ 使用手机号码进行登录
2440
248
 
2441
249
  ### Examples
2442
250
 
@@ -2452,33 +260,33 @@ end
2452
260
  api_instance = ZSGFClient::UserApi.new
2453
261
  app_key = 'app_key_example' # String |
2454
262
  opts = {
2455
- qr_code_scan_request: ZSGFClient::QRCodeScanRequest.new({sign_in_key: 3.56}) # QRCodeScanRequest | 扫码请求参数
263
+ phone_sign_in_request: ZSGFClient::PhoneSignInRequest.new({phone: 'phone_example', verify_code: 'verify_code_example'}) # PhoneSignInRequest | 登录请求参数
2456
264
  }
2457
265
 
2458
266
  begin
2459
- # 微信小程序 - 扫码
2460
- result = api_instance.user_qr_code_scan(app_key, opts)
267
+ # 手机登录
268
+ result = api_instance.user_phone_sign_in(app_key, opts)
2461
269
  p result
2462
270
  rescue ZSGFClient::ApiError => e
2463
- puts "Error when calling UserApi->user_qr_code_scan: #{e}"
271
+ puts "Error when calling UserApi->user_phone_sign_in: #{e}"
2464
272
  end
2465
273
  ```
2466
274
 
2467
- #### Using the user_qr_code_scan_with_http_info variant
275
+ #### Using the user_phone_sign_in_with_http_info variant
2468
276
 
2469
277
  This returns an Array which contains the response data, status code and headers.
2470
278
 
2471
- > <Array(<UserQRCodeScanResultApiResponse>, Integer, Hash)> user_qr_code_scan_with_http_info(app_key, opts)
279
+ > <Array(<TokenModelApiResponse>, Integer, Hash)> user_phone_sign_in_with_http_info(app_key, opts)
2472
280
 
2473
281
  ```ruby
2474
282
  begin
2475
- # 微信小程序 - 扫码
2476
- data, status_code, headers = api_instance.user_qr_code_scan_with_http_info(app_key, opts)
283
+ # 手机登录
284
+ data, status_code, headers = api_instance.user_phone_sign_in_with_http_info(app_key, opts)
2477
285
  p status_code # => 2xx
2478
286
  p headers # => { ... }
2479
- p data # => <UserQRCodeScanResultApiResponse>
287
+ p data # => <TokenModelApiResponse>
2480
288
  rescue ZSGFClient::ApiError => e
2481
- puts "Error when calling UserApi->user_qr_code_scan_with_http_info: #{e}"
289
+ puts "Error when calling UserApi->user_phone_sign_in_with_http_info: #{e}"
2482
290
  end
2483
291
  ```
2484
292
 
@@ -2487,11 +295,11 @@ end
2487
295
  | Name | Type | Description | Notes |
2488
296
  | ---- | ---- | ----------- | ----- |
2489
297
  | **app_key** | **String** | | |
2490
- | **qr_code_scan_request** | [**QRCodeScanRequest**](QRCodeScanRequest.md) | 扫码请求参数 | [optional] |
298
+ | **phone_sign_in_request** | [**PhoneSignInRequest**](PhoneSignInRequest.md) | 登录请求参数 | [optional] |
2491
299
 
2492
300
  ### Return type
2493
301
 
2494
- [**UserQRCodeScanResultApiResponse**](UserQRCodeScanResultApiResponse.md)
302
+ [**TokenModelApiResponse**](TokenModelApiResponse.md)
2495
303
 
2496
304
  ### Authorization
2497
305
 
@@ -2503,13 +311,13 @@ end
2503
311
  - **Accept**: application/json
2504
312
 
2505
313
 
2506
- ## user_qr_code_sign_in
314
+ ## user_phone_sign_up
2507
315
 
2508
- > <TokenModelApiResponse> user_qr_code_sign_in(app_key, opts)
316
+ > <TokenModelApiResponse> user_phone_sign_up(app_key, opts)
2509
317
 
2510
- 微信小程序 - 网页登录
318
+ 手机注册
2511
319
 
2512
- 使用微信小程序二维码进行网页登录
320
+ 使用手机号码进行注册
2513
321
 
2514
322
  ### Examples
2515
323
 
@@ -2525,33 +333,33 @@ end
2525
333
  api_instance = ZSGFClient::UserApi.new
2526
334
  app_key = 'app_key_example' # String |
2527
335
  opts = {
2528
- qr_code_sign_in_request: ZSGFClient::QRCodeSignInRequest.new({sign_in_key: 3.56}) # QRCodeSignInRequest | 登录请求参数
336
+ phone_sign_up_request: ZSGFClient::PhoneSignUpRequest.new({phone: 'phone_example', phone_code: 'phone_code_example', pwd: 'pwd_example'}) # PhoneSignUpRequest | 注册请求参数
2529
337
  }
2530
338
 
2531
339
  begin
2532
- # 微信小程序 - 网页登录
2533
- result = api_instance.user_qr_code_sign_in(app_key, opts)
340
+ # 手机注册
341
+ result = api_instance.user_phone_sign_up(app_key, opts)
2534
342
  p result
2535
343
  rescue ZSGFClient::ApiError => e
2536
- puts "Error when calling UserApi->user_qr_code_sign_in: #{e}"
344
+ puts "Error when calling UserApi->user_phone_sign_up: #{e}"
2537
345
  end
2538
346
  ```
2539
347
 
2540
- #### Using the user_qr_code_sign_in_with_http_info variant
348
+ #### Using the user_phone_sign_up_with_http_info variant
2541
349
 
2542
350
  This returns an Array which contains the response data, status code and headers.
2543
351
 
2544
- > <Array(<TokenModelApiResponse>, Integer, Hash)> user_qr_code_sign_in_with_http_info(app_key, opts)
352
+ > <Array(<TokenModelApiResponse>, Integer, Hash)> user_phone_sign_up_with_http_info(app_key, opts)
2545
353
 
2546
354
  ```ruby
2547
355
  begin
2548
- # 微信小程序 - 网页登录
2549
- data, status_code, headers = api_instance.user_qr_code_sign_in_with_http_info(app_key, opts)
356
+ # 手机注册
357
+ data, status_code, headers = api_instance.user_phone_sign_up_with_http_info(app_key, opts)
2550
358
  p status_code # => 2xx
2551
359
  p headers # => { ... }
2552
360
  p data # => <TokenModelApiResponse>
2553
361
  rescue ZSGFClient::ApiError => e
2554
- puts "Error when calling UserApi->user_qr_code_sign_in_with_http_info: #{e}"
362
+ puts "Error when calling UserApi->user_phone_sign_up_with_http_info: #{e}"
2555
363
  end
2556
364
  ```
2557
365
 
@@ -2560,7 +368,7 @@ end
2560
368
  | Name | Type | Description | Notes |
2561
369
  | ---- | ---- | ----------- | ----- |
2562
370
  | **app_key** | **String** | | |
2563
- | **qr_code_sign_in_request** | [**QRCodeSignInRequest**](QRCodeSignInRequest.md) | 登录请求参数 | [optional] |
371
+ | **phone_sign_up_request** | [**PhoneSignUpRequest**](PhoneSignUpRequest.md) | 注册请求参数 | [optional] |
2564
372
 
2565
373
  ### Return type
2566
374
 
@@ -2576,13 +384,13 @@ end
2576
384
  - **Accept**: application/json
2577
385
 
2578
386
 
2579
- ## user_qr_code_sign_up
387
+ ## user_profile
2580
388
 
2581
- > <TokenModelApiResponse> user_qr_code_sign_up(app_key, opts)
389
+ > <UserProfileResultApiResponse> user_profile(app_key)
2582
390
 
2583
- 微信小程序 - 注册
391
+ 获取个人资料
2584
392
 
2585
- 使用微信小程序二维码进行注册
393
+ 获取当前用户的个人资料
2586
394
 
2587
395
  ### Examples
2588
396
 
@@ -2597,34 +405,31 @@ end
2597
405
 
2598
406
  api_instance = ZSGFClient::UserApi.new
2599
407
  app_key = 'app_key_example' # String |
2600
- opts = {
2601
- qr_code_sign_up_request: ZSGFClient::QRCodeSignUpRequest.new({union_id: 'union_id_example'}) # QRCodeSignUpRequest | 注册请求参数
2602
- }
2603
408
 
2604
409
  begin
2605
- # 微信小程序 - 注册
2606
- result = api_instance.user_qr_code_sign_up(app_key, opts)
410
+ # 获取个人资料
411
+ result = api_instance.user_profile(app_key)
2607
412
  p result
2608
413
  rescue ZSGFClient::ApiError => e
2609
- puts "Error when calling UserApi->user_qr_code_sign_up: #{e}"
414
+ puts "Error when calling UserApi->user_profile: #{e}"
2610
415
  end
2611
416
  ```
2612
417
 
2613
- #### Using the user_qr_code_sign_up_with_http_info variant
418
+ #### Using the user_profile_with_http_info variant
2614
419
 
2615
420
  This returns an Array which contains the response data, status code and headers.
2616
421
 
2617
- > <Array(<TokenModelApiResponse>, Integer, Hash)> user_qr_code_sign_up_with_http_info(app_key, opts)
422
+ > <Array(<UserProfileResultApiResponse>, Integer, Hash)> user_profile_with_http_info(app_key)
2618
423
 
2619
424
  ```ruby
2620
425
  begin
2621
- # 微信小程序 - 注册
2622
- data, status_code, headers = api_instance.user_qr_code_sign_up_with_http_info(app_key, opts)
426
+ # 获取个人资料
427
+ data, status_code, headers = api_instance.user_profile_with_http_info(app_key)
2623
428
  p status_code # => 2xx
2624
429
  p headers # => { ... }
2625
- p data # => <TokenModelApiResponse>
430
+ p data # => <UserProfileResultApiResponse>
2626
431
  rescue ZSGFClient::ApiError => e
2627
- puts "Error when calling UserApi->user_qr_code_sign_up_with_http_info: #{e}"
432
+ puts "Error when calling UserApi->user_profile_with_http_info: #{e}"
2628
433
  end
2629
434
  ```
2630
435
 
@@ -2633,11 +438,10 @@ end
2633
438
  | Name | Type | Description | Notes |
2634
439
  | ---- | ---- | ----------- | ----- |
2635
440
  | **app_key** | **String** | | |
2636
- | **qr_code_sign_up_request** | [**QRCodeSignUpRequest**](QRCodeSignUpRequest.md) | 注册请求参数 | [optional] |
2637
441
 
2638
442
  ### Return type
2639
443
 
2640
- [**TokenModelApiResponse**](TokenModelApiResponse.md)
444
+ [**UserProfileResultApiResponse**](UserProfileResultApiResponse.md)
2641
445
 
2642
446
  ### Authorization
2643
447
 
@@ -2645,7 +449,7 @@ end
2645
449
 
2646
450
  ### HTTP request headers
2647
451
 
2648
- - **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
452
+ - **Content-Type**: Not defined
2649
453
  - **Accept**: application/json
2650
454
 
2651
455
 
@@ -3018,7 +822,7 @@ end
3018
822
 
3019
823
  > <TokenModelApiResponse> user_sign_in(app_key, opts)
3020
824
 
3021
- 账号密码 登录
825
+ 密码登录
3022
826
 
3023
827
  使用账号密码进行登录
3024
828
 
@@ -3040,7 +844,7 @@ opts = {
3040
844
  }
3041
845
 
3042
846
  begin
3043
- # 账号密码 登录
847
+ # 密码登录
3044
848
  result = api_instance.user_sign_in(app_key, opts)
3045
849
  p result
3046
850
  rescue ZSGFClient::ApiError => e
@@ -3056,7 +860,7 @@ This returns an Array which contains the response data, status code and headers.
3056
860
 
3057
861
  ```ruby
3058
862
  begin
3059
- # 账号密码 登录
863
+ # 密码登录
3060
864
  data, status_code, headers = api_instance.user_sign_in_with_http_info(app_key, opts)
3061
865
  p status_code # => 2xx
3062
866
  p headers # => { ... }
@@ -3091,7 +895,7 @@ end
3091
895
 
3092
896
  > <TokenModelApiResponse> user_sign_up(app_key, opts)
3093
897
 
3094
- 账号密码 注册
898
+ 账号注册
3095
899
 
3096
900
  使用账号密码进行注册
3097
901
 
@@ -3113,7 +917,7 @@ opts = {
3113
917
  }
3114
918
 
3115
919
  begin
3116
- # 账号密码 注册
920
+ # 账号注册
3117
921
  result = api_instance.user_sign_up(app_key, opts)
3118
922
  p result
3119
923
  rescue ZSGFClient::ApiError => e
@@ -3129,7 +933,7 @@ This returns an Array which contains the response data, status code and headers.
3129
933
 
3130
934
  ```ruby
3131
935
  begin
3132
- # 账号密码 注册
936
+ # 账号注册
3133
937
  data, status_code, headers = api_instance.user_sign_up_with_http_info(app_key, opts)
3134
938
  p status_code # => 2xx
3135
939
  p headers # => { ... }
@@ -3164,9 +968,9 @@ end
3164
968
 
3165
969
  > <SetupCodeApiResponse> user_two_factor_auth(app_key)
3166
970
 
3167
- 双因素验证
971
+ 二次验证
3168
972
 
3169
- 获取双因素验证的设置信息
973
+ 获取当前用户在指定应用下启用二次验证(2FA)所需的设置信息,主要包括二维码链接和手动密钥,用户可以将其录入在 Google Authenticator 等 TOTP 应用中,用于后续动态验证码验证。
3170
974
 
3171
975
  ### Examples
3172
976
 
@@ -3183,7 +987,7 @@ api_instance = ZSGFClient::UserApi.new
3183
987
  app_key = 'app_key_example' # String |
3184
988
 
3185
989
  begin
3186
- # 双因素验证
990
+ # 二次验证
3187
991
  result = api_instance.user_two_factor_auth(app_key)
3188
992
  p result
3189
993
  rescue ZSGFClient::ApiError => e
@@ -3199,7 +1003,7 @@ This returns an Array which contains the response data, status code and headers.
3199
1003
 
3200
1004
  ```ruby
3201
1005
  begin
3202
- # 双因素验证
1006
+ # 二次验证
3203
1007
  data, status_code, headers = api_instance.user_two_factor_auth_with_http_info(app_key)
3204
1008
  p status_code # => 2xx
3205
1009
  p headers # => { ... }
@@ -3229,77 +1033,6 @@ end
3229
1033
  - **Accept**: application/json
3230
1034
 
3231
1035
 
3232
- ## user_unfollow_user
3233
-
3234
- > <BooleanApiResponse> user_unfollow_user(user_id, app_key)
3235
-
3236
- 取消关注
3237
-
3238
- 取消关注指定用户
3239
-
3240
- ### Examples
3241
-
3242
- ```ruby
3243
- require 'time'
3244
- require 'zsgf_client'
3245
- # setup authorization
3246
- ZSGFClient.configure do |config|
3247
- # Configure Bearer authorization: Bearer
3248
- config.access_token = 'YOUR_BEARER_TOKEN'
3249
- end
3250
-
3251
- api_instance = ZSGFClient::UserApi.new
3252
- user_id = 789 # Integer | 要取消关注的用户ID
3253
- app_key = 'app_key_example' # String |
3254
-
3255
- begin
3256
- # 取消关注
3257
- result = api_instance.user_unfollow_user(user_id, app_key)
3258
- p result
3259
- rescue ZSGFClient::ApiError => e
3260
- puts "Error when calling UserApi->user_unfollow_user: #{e}"
3261
- end
3262
- ```
3263
-
3264
- #### Using the user_unfollow_user_with_http_info variant
3265
-
3266
- This returns an Array which contains the response data, status code and headers.
3267
-
3268
- > <Array(<BooleanApiResponse>, Integer, Hash)> user_unfollow_user_with_http_info(user_id, app_key)
3269
-
3270
- ```ruby
3271
- begin
3272
- # 取消关注
3273
- data, status_code, headers = api_instance.user_unfollow_user_with_http_info(user_id, app_key)
3274
- p status_code # => 2xx
3275
- p headers # => { ... }
3276
- p data # => <BooleanApiResponse>
3277
- rescue ZSGFClient::ApiError => e
3278
- puts "Error when calling UserApi->user_unfollow_user_with_http_info: #{e}"
3279
- end
3280
- ```
3281
-
3282
- ### Parameters
3283
-
3284
- | Name | Type | Description | Notes |
3285
- | ---- | ---- | ----------- | ----- |
3286
- | **user_id** | **Integer** | 要取消关注的用户ID | |
3287
- | **app_key** | **String** | | |
3288
-
3289
- ### Return type
3290
-
3291
- [**BooleanApiResponse**](BooleanApiResponse.md)
3292
-
3293
- ### Authorization
3294
-
3295
- [Bearer](../README.md#Bearer)
3296
-
3297
- ### HTTP request headers
3298
-
3299
- - **Content-Type**: Not defined
3300
- - **Accept**: application/json
3301
-
3302
-
3303
1036
  ## user_union_id_sign_in
3304
1037
 
3305
1038
  > <TokenModelApiResponse> user_union_id_sign_in(app_key, opts)
@@ -3518,90 +1251,3 @@ end
3518
1251
  - **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
3519
1252
  - **Accept**: application/json
3520
1253
 
3521
-
3522
- ## users
3523
-
3524
- > <UserListResultApiResponse> users(app_key, opts)
3525
-
3526
- 获取用户列表
3527
-
3528
- 根据条件获取用户列表
3529
-
3530
- ### Examples
3531
-
3532
- ```ruby
3533
- require 'time'
3534
- require 'zsgf_client'
3535
- # setup authorization
3536
- ZSGFClient.configure do |config|
3537
- # Configure Bearer authorization: Bearer
3538
- config.access_token = 'YOUR_BEARER_TOKEN'
3539
- end
3540
-
3541
- api_instance = ZSGFClient::UserApi.new
3542
- app_key = 'app_key_example' # String |
3543
- opts = {
3544
- user_name: 'user_name_example', # String | 用户名
3545
- email: 'email_example', # String | 邮箱
3546
- phone: 'phone_example', # String | 电话
3547
- platform: 'platform_example', # String | 平台
3548
- union_id: 'union_id_example', # String | 联合ID
3549
- role: 'role_example', # String | 角色
3550
- skip: 56, # Integer | 跳过的记录数
3551
- take: 56 # Integer | 获取的记录数
3552
- }
3553
-
3554
- begin
3555
- # 获取用户列表
3556
- result = api_instance.users(app_key, opts)
3557
- p result
3558
- rescue ZSGFClient::ApiError => e
3559
- puts "Error when calling UserApi->users: #{e}"
3560
- end
3561
- ```
3562
-
3563
- #### Using the users_with_http_info variant
3564
-
3565
- This returns an Array which contains the response data, status code and headers.
3566
-
3567
- > <Array(<UserListResultApiResponse>, Integer, Hash)> users_with_http_info(app_key, opts)
3568
-
3569
- ```ruby
3570
- begin
3571
- # 获取用户列表
3572
- data, status_code, headers = api_instance.users_with_http_info(app_key, opts)
3573
- p status_code # => 2xx
3574
- p headers # => { ... }
3575
- p data # => <UserListResultApiResponse>
3576
- rescue ZSGFClient::ApiError => e
3577
- puts "Error when calling UserApi->users_with_http_info: #{e}"
3578
- end
3579
- ```
3580
-
3581
- ### Parameters
3582
-
3583
- | Name | Type | Description | Notes |
3584
- | ---- | ---- | ----------- | ----- |
3585
- | **app_key** | **String** | | |
3586
- | **user_name** | **String** | 用户名 | [optional] |
3587
- | **email** | **String** | 邮箱 | [optional] |
3588
- | **phone** | **String** | 电话 | [optional] |
3589
- | **platform** | **String** | 平台 | [optional] |
3590
- | **union_id** | **String** | 联合ID | [optional] |
3591
- | **role** | **String** | 角色 | [optional] |
3592
- | **skip** | **Integer** | 跳过的记录数 | [optional] |
3593
- | **take** | **Integer** | 获取的记录数 | [optional] |
3594
-
3595
- ### Return type
3596
-
3597
- [**UserListResultApiResponse**](UserListResultApiResponse.md)
3598
-
3599
- ### Authorization
3600
-
3601
- [Bearer](../README.md#Bearer)
3602
-
3603
- ### HTTP request headers
3604
-
3605
- - **Content-Type**: Not defined
3606
- - **Accept**: application/json
3607
-