zsgf_client 1.0.24 → 1.0.25

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 (99) hide show
  1. checksums.yaml +4 -4
  2. data/docs/AccessTokenApi.md +14 -14
  3. data/docs/AccessTokenPutRequest.md +2 -2
  4. data/docs/AppUserListResponse.md +12 -12
  5. data/docs/AppUserResetEmailRequest.md +20 -0
  6. data/docs/AppUserResetPhoneRequest.md +20 -0
  7. data/docs/AppUserResetPwdRequest.md +4 -8
  8. data/docs/CommonFriendModel.md +3 -3
  9. data/docs/EmailSignInRequest.md +3 -3
  10. data/docs/EmailSignUpRequest.md +5 -5
  11. data/docs/FileApi.md +4 -4
  12. data/docs/FollowerModel.md +12 -12
  13. data/docs/FollowerPutModel.md +6 -6
  14. data/docs/GeoLocation.md +62 -0
  15. data/docs/GeoLocationModel.md +4 -4
  16. data/docs/GeoLocationResponseModel.md +4 -4
  17. data/docs/GetUserProfileResult.md +24 -0
  18. data/docs/{UserFollowingResultApiResponse.md → GetUserProfileResultApiResponse.md} +3 -3
  19. data/docs/MySqlGeometry.md +26 -0
  20. data/docs/OAuthAccountSignInRequest.md +3 -3
  21. data/docs/PhoneSignInRequest.md +3 -3
  22. data/docs/PhoneSignUpRequest.md +7 -7
  23. data/docs/QRCodePreSignInRequest.md +3 -3
  24. data/docs/QRCodeScanRequest.md +1 -1
  25. data/docs/QRCodeSignInRequest.md +1 -1
  26. data/docs/QRCodeSignUpRequest.md +8 -8
  27. data/docs/RecommendFriend.md +21 -11
  28. data/docs/SendEmailCodeRequest.md +2 -2
  29. data/docs/SendSMSCodeRequest.md +2 -2
  30. data/docs/SignInRequest.md +3 -3
  31. data/docs/SignUpRequest.md +8 -8
  32. data/docs/StorageApi.md +86 -6
  33. data/docs/UnionIDSignInRequest.md +3 -3
  34. data/docs/UnionIDSignUpRequest.md +10 -10
  35. data/docs/UpdateProfileRequest.md +27 -15
  36. data/docs/UserApi.md +358 -54
  37. data/docs/UserFriendsNearByResult.md +3 -3
  38. data/docs/UserProfileResult.md +2 -28
  39. data/docs/WechatApi.md +86 -12
  40. data/lib/zsgf_client/api/access_token_api.rb +14 -14
  41. data/lib/zsgf_client/api/file_api.rb +3 -3
  42. data/lib/zsgf_client/api/storage_api.rb +105 -6
  43. data/lib/zsgf_client/api/user_api.rb +349 -60
  44. data/lib/zsgf_client/api/wechat_api.rb +88 -18
  45. data/lib/zsgf_client/models/access_token_put_request.rb +3 -27
  46. data/lib/zsgf_client/models/app_user_list_response.rb +12 -0
  47. data/lib/zsgf_client/models/app_user_reset_email_request.rb +269 -0
  48. data/lib/zsgf_client/models/app_user_reset_phone_request.rb +269 -0
  49. data/lib/zsgf_client/models/app_user_reset_pwd_request.rb +52 -70
  50. data/lib/zsgf_client/models/common_friend_model.rb +3 -0
  51. data/lib/zsgf_client/models/email_sign_in_request.rb +38 -1
  52. data/lib/zsgf_client/models/email_sign_up_request.rb +30 -8
  53. data/lib/zsgf_client/models/follower_model.rb +12 -0
  54. data/lib/zsgf_client/models/follower_put_model.rb +6 -0
  55. data/lib/zsgf_client/models/geo_location.rb +750 -0
  56. data/lib/zsgf_client/models/geo_location_model.rb +262 -12
  57. data/lib/zsgf_client/models/geo_location_response_model.rb +262 -12
  58. data/lib/zsgf_client/models/{user_following_result.rb → get_user_profile_result.rb} +37 -18
  59. data/lib/zsgf_client/models/{user_following_result_api_response.rb → get_user_profile_result_api_response.rb} +4 -4
  60. data/lib/zsgf_client/models/my_sql_geometry.rb +260 -0
  61. data/lib/zsgf_client/models/o_auth_account_sign_in_request.rb +78 -1
  62. data/lib/zsgf_client/models/phone_sign_in_request.rb +49 -1
  63. data/lib/zsgf_client/models/phone_sign_up_request.rb +29 -24
  64. data/lib/zsgf_client/models/qr_code_pre_sign_in_request.rb +97 -0
  65. data/lib/zsgf_client/models/qr_code_scan_request.rb +1 -0
  66. data/lib/zsgf_client/models/qr_code_sign_in_request.rb +1 -0
  67. data/lib/zsgf_client/models/qr_code_sign_up_request.rb +38 -33
  68. data/lib/zsgf_client/models/recommend_friend.rb +69 -4
  69. data/lib/zsgf_client/models/send_email_code_request.rb +2 -1
  70. data/lib/zsgf_client/models/send_sms_code_request.rb +2 -2
  71. data/lib/zsgf_client/models/sign_in_request.rb +77 -11
  72. data/lib/zsgf_client/models/sign_up_request.rb +47 -35
  73. data/lib/zsgf_client/models/union_id_sign_in_request.rb +78 -1
  74. data/lib/zsgf_client/models/union_id_sign_up_request.rb +92 -45
  75. data/lib/zsgf_client/models/update_profile_request.rb +99 -24
  76. data/lib/zsgf_client/models/user_friends_near_by_result.rb +10 -7
  77. data/lib/zsgf_client/models/user_profile_result.rb +7 -133
  78. data/lib/zsgf_client/version.rb +1 -1
  79. data/lib/zsgf_client.rb +6 -2
  80. data/spec/api/access_token_api_spec.rb +7 -7
  81. data/spec/api/file_api_spec.rb +1 -1
  82. data/spec/api/storage_api_spec.rb +17 -1
  83. data/spec/api/user_api_spec.rb +81 -23
  84. data/spec/api/wechat_api_spec.rb +19 -6
  85. data/spec/models/{user_following_result_spec.rb → app_user_reset_email_request_spec.rb} +8 -8
  86. data/spec/models/app_user_reset_phone_request_spec.rb +42 -0
  87. data/spec/models/app_user_reset_pwd_request_spec.rb +2 -14
  88. data/spec/models/geo_location_model_spec.rb +3 -3
  89. data/spec/models/geo_location_response_model_spec.rb +3 -3
  90. data/spec/models/geo_location_spec.rb +168 -0
  91. data/spec/models/{user_following_result_api_response_spec.rb → get_user_profile_result_api_response_spec.rb} +6 -6
  92. data/spec/models/get_user_profile_result_spec.rb +54 -0
  93. data/spec/models/my_sql_geometry_spec.rb +60 -0
  94. data/spec/models/recommend_friend_spec.rb +30 -0
  95. data/spec/models/update_profile_request_spec.rb +36 -0
  96. data/spec/models/user_friends_near_by_result_spec.rb +1 -1
  97. data/spec/models/user_profile_result_spec.rb +1 -79
  98. metadata +215 -199
  99. data/docs/UserFollowingResult.md +0 -20
data/docs/UserApi.md CHANGED
@@ -7,6 +7,7 @@ All URIs are relative to *https://api.zashigaofa.cn*
7
7
  | [**user**](UserApi.md#user) | **GET** /User/{appKey}/{id} | 获取用户详情 |
8
8
  | [**user_clear**](UserApi.md#user_clear) | **DELETE** /User/{appKey}/Clear | 清空用户数据 |
9
9
  | [**user_common_interests**](UserApi.md#user_common_interests) | **GET** /User/{appKey}/Friends/CommonInterests | 有共同爱好的用户推荐 |
10
+ | [**user_deactivate_hard**](UserApi.md#user_deactivate_hard) | **DELETE** /User/{appKey}/DeactivateHard | 注销账号 |
10
11
  | [**user_delete**](UserApi.md#user_delete) | **DELETE** /User/{appKey}/{id} | 删除用户 |
11
12
  | [**user_email_sign_in**](UserApi.md#user_email_sign_in) | **POST** /User/{appKey}/EmailSignIn | 邮箱登录 |
12
13
  | [**user_email_sign_up**](UserApi.md#user_email_sign_up) | **POST** /User/{appKey}/EmailSignUp | 邮箱注册 |
@@ -14,8 +15,8 @@ All URIs are relative to *https://api.zashigaofa.cn*
14
15
  | [**user_follow_user**](UserApi.md#user_follow_user) | **POST** /User/{appKey}/Follower/{userId} | 关注用户 |
15
16
  | [**user_follower_put**](UserApi.md#user_follower_put) | **PUT** /User/{appKey}/Follower/{id} | 更新粉丝 |
16
17
  | [**user_followers**](UserApi.md#user_followers) | **GET** /User/{appKey}/Followers | 获取我的粉丝列表 |
17
- | [**user_following**](UserApi.md#user_following) | **GET** /User/{appKey}/Following | 获取我的关注列表 |
18
- | [**user_friends_near_by**](UserApi.md#user_friends_near_by) | **GET** /User/{appKey}/Friends/NearBy | 附近的用户推荐 |
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 | 获取附近的用户推荐列表 |
19
20
  | [**user_import**](UserApi.md#user_import) | **POST** /User/{appKey}/Import | 导入用户数据 |
20
21
  | [**user_location**](UserApi.md#user_location) | **GET** /User/{appKey}/Location/{id} | 获取位置详情 |
21
22
  | [**user_location_delete**](UserApi.md#user_location_delete) | **DELETE** /User/{appKey}/Location/{id} | 删除位置 |
@@ -24,7 +25,7 @@ All URIs are relative to *https://api.zashigaofa.cn*
24
25
  | [**user_locations**](UserApi.md#user_locations) | **GET** /User/{appKey}/Locations | 获取位置列表 |
25
26
  | [**user_mutual_followers**](UserApi.md#user_mutual_followers) | **GET** /User/{appKey}/Friends/MutualFollowers | 有共同粉丝的用户推荐 |
26
27
  | [**user_mutual_followings**](UserApi.md#user_mutual_followings) | **GET** /User/{appKey}/Friends/MutualFollowings | 有共同关注的用户推荐 |
27
- | [**user_o_auth_account_bind**](UserApi.md#user_o_auth_account_bind) | **POST** /User/{appKey}/OAuthAccountBind | 外部账号 绑定 |
28
+ | [**user_o_auth_account_bind**](UserApi.md#user_o_auth_account_bind) | **POST** /User/{appKey}/OAuthAccountBind | 外部账号 绑定,如果已存在绑定则直接返回成功 |
28
29
  | [**user_o_auth_account_sign_in**](UserApi.md#user_o_auth_account_sign_in) | **POST** /User/{appKey}/OAuthAccountSignIn | 外部账号 登录 |
29
30
  | [**user_o_auth_accounts**](UserApi.md#user_o_auth_accounts) | **GET** /User/{appKey}/OAuthAccounts | 外部账号 绑定列表 |
30
31
  | [**user_o_auth_accounts_put_bind**](UserApi.md#user_o_auth_accounts_put_bind) | **PUT** /User/{appKey}/OAuthAccounts/{id} | 外部账号 更新绑定 |
@@ -32,11 +33,14 @@ All URIs are relative to *https://api.zashigaofa.cn*
32
33
  | [**user_phone_sign_in**](UserApi.md#user_phone_sign_in) | **POST** /User/{appKey}/PhoneSignIn | 手机登录 |
33
34
  | [**user_phone_sign_up**](UserApi.md#user_phone_sign_up) | **POST** /User/{appKey}/PhoneSignUp | 手机注册 |
34
35
  | [**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} | 获取指定用户资料 |
35
37
  | [**user_put**](UserApi.md#user_put) | **PUT** /User/{appKey}/{id} | 更新用户信息 |
36
38
  | [**user_qr_code_pre_sign_in**](UserApi.md#user_qr_code_pre_sign_in) | **POST** /User/{appKey}/QRCodePreSignIn | 微信小程序 - 预登陆 |
37
39
  | [**user_qr_code_scan**](UserApi.md#user_qr_code_scan) | **POST** /User/{appKey}/QRCodeScan | 微信小程序 - 扫码 |
38
40
  | [**user_qr_code_sign_in**](UserApi.md#user_qr_code_sign_in) | **POST** /User/{appKey}/QRCodeSignIn | 微信小程序 - 网页登录 |
39
41
  | [**user_qr_code_sign_up**](UserApi.md#user_qr_code_sign_up) | **POST** /User/{appKey}/QRCodeSignUp | 微信小程序 - 注册 |
42
+ | [**user_reset_email**](UserApi.md#user_reset_email) | **PUT** /User/{appKey}/ResetEmail | 重置邮箱 |
43
+ | [**user_reset_phone**](UserApi.md#user_reset_phone) | **PUT** /User/{appKey}/ResetPhone | 重置手机号 |
40
44
  | [**user_reset_pwd**](UserApi.md#user_reset_pwd) | **POST** /User/{appKey}/ResetPwd | 重置密码 |
41
45
  | [**user_send_email_code**](UserApi.md#user_send_email_code) | **POST** /User/{appKey}/SendEmailCode | 发送邮箱验证码 |
42
46
  | [**user_send_sms_code**](UserApi.md#user_send_sms_code) | **POST** /User/{appKey}/SendSMSCode | 发送手机验证码 |
@@ -267,6 +271,75 @@ end
267
271
  - **Accept**: application/json
268
272
 
269
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
+
270
343
  ## user_delete
271
344
 
272
345
  > <BooleanApiResponse> user_delete(id, app_key)
@@ -723,6 +796,7 @@ app_key = 'app_key_example' # String |
723
796
  opts = {
724
797
  tag: 'tag_example', # String | 标签
725
798
  status: 'status_example', # String | 状态
799
+ target_user_id: 789, # Integer | 指定用户的粉丝
726
800
  skip: 56, # Integer | 跳过的记录数
727
801
  take: 56 # Integer | 获取的记录数
728
802
  }
@@ -761,6 +835,7 @@ end
761
835
  | **app_key** | **String** | | |
762
836
  | **tag** | **String** | 标签 | [optional] |
763
837
  | **status** | **String** | 状态 | [optional] |
838
+ | **target_user_id** | **Integer** | 指定用户的粉丝 | [optional][default to 0] |
764
839
  | **skip** | **Integer** | 跳过的记录数 | [optional][default to 0] |
765
840
  | **take** | **Integer** | 获取的记录数 | [optional][default to 10] |
766
841
 
@@ -780,11 +855,11 @@ end
780
855
 
781
856
  ## user_following
782
857
 
783
- > <UserFollowingResultApiResponse> user_following(app_key, opts)
858
+ > <BooleanApiResponse> user_following(app_key, opts)
784
859
 
785
- 获取我的关注列表
860
+ 获取当前用户的关注列表,或者判断是否关注某个特定用户。
786
861
 
787
- 根据条件获取我的关注列表
862
+ 根据条件获取我的关注列表,或判断是否关注某个用户
788
863
 
789
864
  ### Examples
790
865
 
@@ -800,14 +875,17 @@ end
800
875
  api_instance = ZSGFClient::UserApi.new
801
876
  app_key = 'app_key_example' # String |
802
877
  opts = {
803
- tag: 'tag_example', # String | 标签
804
- status: 'status_example', # String | 状态
805
- skip: 56, # Integer | 跳过的记录数
806
- take: 56 # Integer | 获取的记录数
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(即返回完整的关注用户信息)。
807
885
  }
808
886
 
809
887
  begin
810
- # 获取我的关注列表
888
+ # 获取当前用户的关注列表,或者判断是否关注某个特定用户。
811
889
  result = api_instance.user_following(app_key, opts)
812
890
  p result
813
891
  rescue ZSGFClient::ApiError => e
@@ -819,15 +897,15 @@ end
819
897
 
820
898
  This returns an Array which contains the response data, status code and headers.
821
899
 
822
- > <Array(<UserFollowingResultApiResponse>, Integer, Hash)> user_following_with_http_info(app_key, opts)
900
+ > <Array(<BooleanApiResponse>, Integer, Hash)> user_following_with_http_info(app_key, opts)
823
901
 
824
902
  ```ruby
825
903
  begin
826
- # 获取我的关注列表
904
+ # 获取当前用户的关注列表,或者判断是否关注某个特定用户。
827
905
  data, status_code, headers = api_instance.user_following_with_http_info(app_key, opts)
828
906
  p status_code # => 2xx
829
907
  p headers # => { ... }
830
- p data # => <UserFollowingResultApiResponse>
908
+ p data # => <BooleanApiResponse>
831
909
  rescue ZSGFClient::ApiError => e
832
910
  puts "Error when calling UserApi->user_following_with_http_info: #{e}"
833
911
  end
@@ -838,14 +916,17 @@ end
838
916
  | Name | Type | Description | Notes |
839
917
  | ---- | ---- | ----------- | ----- |
840
918
  | **app_key** | **String** | | |
841
- | **tag** | **String** | 标签 | [optional] |
842
- | **status** | **String** | 状态 | [optional] |
843
- | **skip** | **Integer** | 跳过的记录数 | [optional][default to 0] |
844
- | **take** | **Integer** | 获取的记录数 | [optional][default to 10] |
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] |
845
926
 
846
927
  ### Return type
847
928
 
848
- [**UserFollowingResultApiResponse**](UserFollowingResultApiResponse.md)
929
+ [**BooleanApiResponse**](BooleanApiResponse.md)
849
930
 
850
931
  ### Authorization
851
932
 
@@ -859,11 +940,11 @@ end
859
940
 
860
941
  ## user_friends_near_by
861
942
 
862
- > <UserFriendsNearByResultApiResponse> user_friends_near_by(x, y, distance, app_key, opts)
943
+ > <UserFriendsNearByResultApiResponse> user_friends_near_by(longitude, latitude, app_key, opts)
863
944
 
864
- 附近的用户推荐
945
+ 获取附近的用户推荐列表
865
946
 
866
- 推荐附近的用户
947
+ 根据地理位置坐标和多种筛选条件,查询附近满足条件的用户列表,支持分页和按距离排序。 地理位置查询使用MySQL的ST_Distance_Sphere函数计算球面距离。 注意:longitude为经度(X轴),latitude为纬度(Y轴),参数顺序与常规坐标系一致
867
948
 
868
949
  ### Examples
869
950
 
@@ -877,23 +958,26 @@ ZSGFClient.configure do |config|
877
958
  end
878
959
 
879
960
  api_instance = ZSGFClient::UserApi.new
880
- x = 1.2 # Float | 纬度
881
- y = 1.2 # Float | 经度
882
- distance = 789 # Integer | 附近距离,单位:米
961
+ longitude = 1.2 # Float | 当前用户经度坐标(WGS84坐标系)
962
+ latitude = 1.2 # Float | 当前用户纬度坐标(WGS84坐标系)
883
963
  app_key = 'app_key_example' # String |
884
964
  opts = {
885
- gender: 'gender_example', # String | 性别
886
- age_s: 56, # Integer | 年龄段起始
887
- age_e: 56, # Integer | 年龄段结束
888
- tag: 'tag_example', # String | 兴趣标签
889
- type: 'type_example', # String | 分类
890
- skip: 56, # Integer | 跳过的记录数
891
- take: 56 # Integer | 获取的记录数
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)
892
976
  }
893
977
 
894
978
  begin
895
- # 附近的用户推荐
896
- result = api_instance.user_friends_near_by(x, y, distance, app_key, opts)
979
+ # 获取附近的用户推荐列表
980
+ result = api_instance.user_friends_near_by(longitude, latitude, app_key, opts)
897
981
  p result
898
982
  rescue ZSGFClient::ApiError => e
899
983
  puts "Error when calling UserApi->user_friends_near_by: #{e}"
@@ -904,12 +988,12 @@ end
904
988
 
905
989
  This returns an Array which contains the response data, status code and headers.
906
990
 
907
- > <Array(<UserFriendsNearByResultApiResponse>, Integer, Hash)> user_friends_near_by_with_http_info(x, y, distance, app_key, opts)
991
+ > <Array(<UserFriendsNearByResultApiResponse>, Integer, Hash)> user_friends_near_by_with_http_info(longitude, latitude, app_key, opts)
908
992
 
909
993
  ```ruby
910
994
  begin
911
- # 附近的用户推荐
912
- data, status_code, headers = api_instance.user_friends_near_by_with_http_info(x, y, distance, app_key, opts)
995
+ # 获取附近的用户推荐列表
996
+ data, status_code, headers = api_instance.user_friends_near_by_with_http_info(longitude, latitude, app_key, opts)
913
997
  p status_code # => 2xx
914
998
  p headers # => { ... }
915
999
  p data # => <UserFriendsNearByResultApiResponse>
@@ -922,17 +1006,20 @@ end
922
1006
 
923
1007
  | Name | Type | Description | Notes |
924
1008
  | ---- | ---- | ----------- | ----- |
925
- | **x** | **Float** | 纬度 | |
926
- | **y** | **Float** | 经度 | |
927
- | **distance** | **Integer** | 附近距离,单位:米 | |
1009
+ | **longitude** | **Float** | 当前用户经度坐标(WGS84坐标系) | |
1010
+ | **latitude** | **Float** | 当前用户纬度坐标(WGS84坐标系) | |
928
1011
  | **app_key** | **String** | | |
929
- | **gender** | **String** | 性别 | [optional] |
930
- | **age_s** | **Integer** | 年龄段起始 | [optional] |
931
- | **age_e** | **Integer** | 年龄段结束 | [optional] |
932
- | **tag** | **String** | 兴趣标签 | [optional] |
933
- | **type** | **String** | 分类 | [optional] |
934
- | **skip** | **Integer** | 跳过的记录数 | [optional][default to 0] |
935
- | **take** | **Integer** | 获取的记录数 | [optional][default to 10] |
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] |
936
1023
 
937
1024
  ### Return type
938
1025
 
@@ -1187,7 +1274,7 @@ end
1187
1274
  api_instance = ZSGFClient::UserApi.new
1188
1275
  app_key = 'app_key_example' # String |
1189
1276
  opts = {
1190
- geo_location_model: ZSGFClient::GeoLocationModel.new # GeoLocationModel | 位置信息
1277
+ geo_location_model: ZSGFClient::GeoLocationModel.new({latitude: 3.56, longitude: 3.56, location_type: 'location_type_example'}) # GeoLocationModel | 位置信息
1191
1278
  }
1192
1279
 
1193
1280
  begin
@@ -1244,7 +1331,7 @@ end
1244
1331
 
1245
1332
  更新位置
1246
1333
 
1247
- 根据位置ID更新位置信息
1334
+ 此方法用于更新指定位置ID的位置信息。如果位置不存在,则创建一个新的位置。
1248
1335
 
1249
1336
  ### Examples
1250
1337
 
@@ -1261,7 +1348,7 @@ api_instance = ZSGFClient::UserApi.new
1261
1348
  id = 789 # Integer | 位置ID
1262
1349
  app_key = 'app_key_example' # String |
1263
1350
  opts = {
1264
- geo_location_model: ZSGFClient::GeoLocationModel.new # GeoLocationModel | 位置信息
1351
+ geo_location_model: ZSGFClient::GeoLocationModel.new({latitude: 3.56, longitude: 3.56, location_type: 'location_type_example'}) # GeoLocationModel | 位置信息
1265
1352
  }
1266
1353
 
1267
1354
  begin
@@ -1552,7 +1639,7 @@ end
1552
1639
 
1553
1640
  > <BooleanApiResponse> user_o_auth_account_bind(app_key, opts)
1554
1641
 
1555
- 外部账号 绑定
1642
+ 外部账号 绑定,如果已存在绑定则直接返回成功
1556
1643
 
1557
1644
  绑定外部账号
1558
1645
 
@@ -1574,7 +1661,7 @@ opts = {
1574
1661
  }
1575
1662
 
1576
1663
  begin
1577
- # 外部账号 绑定
1664
+ # 外部账号 绑定,如果已存在绑定则直接返回成功
1578
1665
  result = api_instance.user_o_auth_account_bind(app_key, opts)
1579
1666
  p result
1580
1667
  rescue ZSGFClient::ApiError => e
@@ -1590,7 +1677,7 @@ This returns an Array which contains the response data, status code and headers.
1590
1677
 
1591
1678
  ```ruby
1592
1679
  begin
1593
- # 外部账号 绑定
1680
+ # 外部账号 绑定,如果已存在绑定则直接返回成功
1594
1681
  data, status_code, headers = api_instance.user_o_auth_account_bind_with_http_info(app_key, opts)
1595
1682
  p status_code # => 2xx
1596
1683
  p headers # => { ... }
@@ -2124,6 +2211,77 @@ end
2124
2211
  - **Accept**: application/json
2125
2212
 
2126
2213
 
2214
+ ## user_profile_by_id
2215
+
2216
+ > <GetUserProfileResultApiResponse> user_profile_by_id(user_id, app_key)
2217
+
2218
+ 获取指定用户资料
2219
+
2220
+ 用于他人主页展示
2221
+
2222
+ ### Examples
2223
+
2224
+ ```ruby
2225
+ require 'time'
2226
+ require 'zsgf_client'
2227
+ # setup authorization
2228
+ ZSGFClient.configure do |config|
2229
+ # Configure Bearer authorization: Bearer
2230
+ config.access_token = 'YOUR_BEARER_TOKEN'
2231
+ end
2232
+
2233
+ api_instance = ZSGFClient::UserApi.new
2234
+ user_id = 789 # Integer | 用户ID
2235
+ app_key = 'app_key_example' # String |
2236
+
2237
+ begin
2238
+ # 获取指定用户资料
2239
+ result = api_instance.user_profile_by_id(user_id, app_key)
2240
+ p result
2241
+ rescue ZSGFClient::ApiError => e
2242
+ puts "Error when calling UserApi->user_profile_by_id: #{e}"
2243
+ end
2244
+ ```
2245
+
2246
+ #### Using the user_profile_by_id_with_http_info variant
2247
+
2248
+ This returns an Array which contains the response data, status code and headers.
2249
+
2250
+ > <Array(<GetUserProfileResultApiResponse>, Integer, Hash)> user_profile_by_id_with_http_info(user_id, app_key)
2251
+
2252
+ ```ruby
2253
+ begin
2254
+ # 获取指定用户资料
2255
+ data, status_code, headers = api_instance.user_profile_by_id_with_http_info(user_id, app_key)
2256
+ p status_code # => 2xx
2257
+ p headers # => { ... }
2258
+ p data # => <GetUserProfileResultApiResponse>
2259
+ rescue ZSGFClient::ApiError => e
2260
+ puts "Error when calling UserApi->user_profile_by_id_with_http_info: #{e}"
2261
+ end
2262
+ ```
2263
+
2264
+ ### Parameters
2265
+
2266
+ | Name | Type | Description | Notes |
2267
+ | ---- | ---- | ----------- | ----- |
2268
+ | **user_id** | **Integer** | 用户ID | |
2269
+ | **app_key** | **String** | | |
2270
+
2271
+ ### Return type
2272
+
2273
+ [**GetUserProfileResultApiResponse**](GetUserProfileResultApiResponse.md)
2274
+
2275
+ ### Authorization
2276
+
2277
+ [Bearer](../README.md#Bearer)
2278
+
2279
+ ### HTTP request headers
2280
+
2281
+ - **Content-Type**: Not defined
2282
+ - **Accept**: application/json
2283
+
2284
+
2127
2285
  ## user_put
2128
2286
 
2129
2287
  > <BooleanApiResponse> user_put(id, app_key, opts)
@@ -2491,6 +2649,152 @@ end
2491
2649
  - **Accept**: application/json
2492
2650
 
2493
2651
 
2652
+ ## user_reset_email
2653
+
2654
+ > <BooleanApiResponse> user_reset_email(app_key, opts)
2655
+
2656
+ 重置邮箱
2657
+
2658
+ 通过邮箱验证码重置邮箱
2659
+
2660
+ ### Examples
2661
+
2662
+ ```ruby
2663
+ require 'time'
2664
+ require 'zsgf_client'
2665
+ # setup authorization
2666
+ ZSGFClient.configure do |config|
2667
+ # Configure Bearer authorization: Bearer
2668
+ config.access_token = 'YOUR_BEARER_TOKEN'
2669
+ end
2670
+
2671
+ api_instance = ZSGFClient::UserApi.new
2672
+ app_key = 'app_key_example' # String |
2673
+ opts = {
2674
+ app_user_reset_email_request: ZSGFClient::AppUserResetEmailRequest.new({code: 'code_example'}) # AppUserResetEmailRequest | 重置邮箱的请求参数
2675
+ }
2676
+
2677
+ begin
2678
+ # 重置邮箱
2679
+ result = api_instance.user_reset_email(app_key, opts)
2680
+ p result
2681
+ rescue ZSGFClient::ApiError => e
2682
+ puts "Error when calling UserApi->user_reset_email: #{e}"
2683
+ end
2684
+ ```
2685
+
2686
+ #### Using the user_reset_email_with_http_info variant
2687
+
2688
+ This returns an Array which contains the response data, status code and headers.
2689
+
2690
+ > <Array(<BooleanApiResponse>, Integer, Hash)> user_reset_email_with_http_info(app_key, opts)
2691
+
2692
+ ```ruby
2693
+ begin
2694
+ # 重置邮箱
2695
+ data, status_code, headers = api_instance.user_reset_email_with_http_info(app_key, opts)
2696
+ p status_code # => 2xx
2697
+ p headers # => { ... }
2698
+ p data # => <BooleanApiResponse>
2699
+ rescue ZSGFClient::ApiError => e
2700
+ puts "Error when calling UserApi->user_reset_email_with_http_info: #{e}"
2701
+ end
2702
+ ```
2703
+
2704
+ ### Parameters
2705
+
2706
+ | Name | Type | Description | Notes |
2707
+ | ---- | ---- | ----------- | ----- |
2708
+ | **app_key** | **String** | | |
2709
+ | **app_user_reset_email_request** | [**AppUserResetEmailRequest**](AppUserResetEmailRequest.md) | 重置邮箱的请求参数 | [optional] |
2710
+
2711
+ ### Return type
2712
+
2713
+ [**BooleanApiResponse**](BooleanApiResponse.md)
2714
+
2715
+ ### Authorization
2716
+
2717
+ [Bearer](../README.md#Bearer)
2718
+
2719
+ ### HTTP request headers
2720
+
2721
+ - **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
2722
+ - **Accept**: application/json
2723
+
2724
+
2725
+ ## user_reset_phone
2726
+
2727
+ > <BooleanApiResponse> user_reset_phone(app_key, opts)
2728
+
2729
+ 重置手机号
2730
+
2731
+ 通过手机号验证码重置手机号
2732
+
2733
+ ### Examples
2734
+
2735
+ ```ruby
2736
+ require 'time'
2737
+ require 'zsgf_client'
2738
+ # setup authorization
2739
+ ZSGFClient.configure do |config|
2740
+ # Configure Bearer authorization: Bearer
2741
+ config.access_token = 'YOUR_BEARER_TOKEN'
2742
+ end
2743
+
2744
+ api_instance = ZSGFClient::UserApi.new
2745
+ app_key = 'app_key_example' # String |
2746
+ opts = {
2747
+ app_user_reset_phone_request: ZSGFClient::AppUserResetPhoneRequest.new({code: 'code_example'}) # AppUserResetPhoneRequest | 重置手机号的请求参数
2748
+ }
2749
+
2750
+ begin
2751
+ # 重置手机号
2752
+ result = api_instance.user_reset_phone(app_key, opts)
2753
+ p result
2754
+ rescue ZSGFClient::ApiError => e
2755
+ puts "Error when calling UserApi->user_reset_phone: #{e}"
2756
+ end
2757
+ ```
2758
+
2759
+ #### Using the user_reset_phone_with_http_info variant
2760
+
2761
+ This returns an Array which contains the response data, status code and headers.
2762
+
2763
+ > <Array(<BooleanApiResponse>, Integer, Hash)> user_reset_phone_with_http_info(app_key, opts)
2764
+
2765
+ ```ruby
2766
+ begin
2767
+ # 重置手机号
2768
+ data, status_code, headers = api_instance.user_reset_phone_with_http_info(app_key, opts)
2769
+ p status_code # => 2xx
2770
+ p headers # => { ... }
2771
+ p data # => <BooleanApiResponse>
2772
+ rescue ZSGFClient::ApiError => e
2773
+ puts "Error when calling UserApi->user_reset_phone_with_http_info: #{e}"
2774
+ end
2775
+ ```
2776
+
2777
+ ### Parameters
2778
+
2779
+ | Name | Type | Description | Notes |
2780
+ | ---- | ---- | ----------- | ----- |
2781
+ | **app_key** | **String** | | |
2782
+ | **app_user_reset_phone_request** | [**AppUserResetPhoneRequest**](AppUserResetPhoneRequest.md) | 重置手机号的请求参数 | [optional] |
2783
+
2784
+ ### Return type
2785
+
2786
+ [**BooleanApiResponse**](BooleanApiResponse.md)
2787
+
2788
+ ### Authorization
2789
+
2790
+ [Bearer](../README.md#Bearer)
2791
+
2792
+ ### HTTP request headers
2793
+
2794
+ - **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
2795
+ - **Accept**: application/json
2796
+
2797
+
2494
2798
  ## user_reset_pwd
2495
2799
 
2496
2800
  > <BooleanApiResponse> user_reset_pwd(app_key, opts)
@@ -2513,7 +2817,7 @@ end
2513
2817
  api_instance = ZSGFClient::UserApi.new
2514
2818
  app_key = 'app_key_example' # String |
2515
2819
  opts = {
2516
- app_user_reset_pwd_request: ZSGFClient::AppUserResetPwdRequest.new({code: 'code_example', pwd: 'pwd_example'}) # AppUserResetPwdRequest | 重置密码的请求参数
2820
+ app_user_reset_pwd_request: ZSGFClient::AppUserResetPwdRequest.new({pwd: 'pwd_example', oldpwd: 'oldpwd_example'}) # AppUserResetPwdRequest | 重置密码的请求参数
2517
2821
  }
2518
2822
 
2519
2823
  begin
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **total_followers** | **Integer** | | [optional] |
8
- | **data** | [**Array&lt;RecommendFriend&gt;**](RecommendFriend.md) | | [optional] |
7
+ | **total** | **Integer** | 符合条件的总记录数 | [optional] |
8
+ | **data** | [**Array&lt;RecommendFriend&gt;**](RecommendFriend.md) | 当前分页的用户数据列表 | [optional] |
9
9
 
10
10
  ## Example
11
11
 
@@ -13,7 +13,7 @@
13
13
  require 'zsgf_client'
14
14
 
15
15
  instance = ZSGFClient::UserFriendsNearByResult.new(
16
- total_followers: null,
16
+ total: null,
17
17
  data: null
18
18
  )
19
19
  ```
@@ -4,20 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **app_key** | **String** | | [optional] |
8
- | **platform** | **String** | | [optional] |
9
- | **union_id** | **String** | | [optional] |
10
- | **phone** | **String** | | [optional] |
11
- | **create_date** | **Time** | | [optional] |
12
- | **user_name** | **String** | | [optional] |
13
- | **phone_is_valid** | **Boolean** | | [optional] |
14
- | **data** | **String** | | [optional] |
15
- | **email** | **String** | | [optional] |
16
- | **email_is_valid** | **Boolean** | | [optional] |
17
- | **last_update** | **Time** | | [optional] |
18
- | **nick_name** | **String** | | [optional] |
19
- | **id** | **Integer** | | [optional] |
20
- | **avatar** | **String** | | [optional] |
7
+ | **user** | [**User**](User.md) | | [optional] |
21
8
  | **currencies** | [**Array&lt;UserCurrency&gt;**](UserCurrency.md) | | [optional] |
22
9
  | **role** | **String** | | [optional] |
23
10
 
@@ -27,20 +14,7 @@
27
14
  require 'zsgf_client'
28
15
 
29
16
  instance = ZSGFClient::UserProfileResult.new(
30
- app_key: null,
31
- platform: null,
32
- union_id: null,
33
- phone: null,
34
- create_date: null,
35
- user_name: null,
36
- phone_is_valid: null,
37
- data: null,
38
- email: null,
39
- email_is_valid: null,
40
- last_update: null,
41
- nick_name: null,
42
- id: null,
43
- avatar: null,
17
+ user: null,
44
18
  currencies: null,
45
19
  role: null
46
20
  )