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
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a5f6f7d31f0528ddebfdffe930e91239daf3f74e078b6df7db02d24f58b89b87
4
- data.tar.gz: 1b1985775c8aabdfb36f87f7ffbac8d37ea10de6b211d4d97ba1b8943ad57e1e
3
+ metadata.gz: 4531d703f6dc7b53b7c30db48aeaba73f70079df13908b21e73df8ab97278aa9
4
+ data.tar.gz: ff3330f8ca3c606f2f1729e9567cf9c9b666db3a1fd0e7d28ff7a258b8fe81ab
5
5
  SHA512:
6
- metadata.gz: 4fb8ee006a632312925d0b57bde7d99f32b0a831f528f1baf1acd5441e0d83b6411a711df5b6b060afe0eeda66760b18a786bfebb1ada173794dc12d91de81fe
7
- data.tar.gz: 9e6c1605178bcaf784c13a50de293530867dd7e5ad8d490f8b6812bec4646dd3b112a35d0e6d4491ccd27c6385815dfe2a29f2082637751bdb41de6c6bbf56aa
6
+ metadata.gz: b2578cb44aca1ba938a6b010c3177fcadb16b21f1ded5d084e15a94a7dcadc5ea324b49214f24ebd280776dcb532cf65f575cec3d30a73cc7783a5d5a8e338c8
7
+ data.tar.gz: 2b1a5e65313838fde8820cdcdadcf4b6bdd12126d98064ba8e0fd4110681bd84c48dd63beb7587bb7fc2490ef75a2966ab37c2933a6dce6853ade908469aa43d
data/docs/AccessTokenApi.md CHANGED
@@ -30,7 +30,7 @@ ZSGFClient.configure do |config|
30
30
  end
31
31
 
32
32
  api_instance = ZSGFClient::AccessTokenApi.new
33
- id = 789 # Integer | 令牌ID
33
+ id = 789 # Integer |
34
34
  app_key = 'app_key_example' # String |
35
35
 
36
36
  begin
@@ -64,7 +64,7 @@ end
64
64
 
65
65
  | Name | Type | Description | Notes |
66
66
  | ---- | ---- | ----------- | ----- |
67
- | **id** | **Integer** | 令牌ID | |
67
+ | **id** | **Integer** | | |
68
68
  | **app_key** | **String** | | |
69
69
 
70
70
  ### Return type
@@ -103,7 +103,7 @@ end
103
103
  api_instance = ZSGFClient::AccessTokenApi.new
104
104
  app_key = 'app_key_example' # String |
105
105
  opts = {
106
- access_token_post_request: ZSGFClient::AccessTokenPostRequest.new({title: 'title_example'}) # AccessTokenPostRequest | 令牌创建请求参数
106
+ access_token_post_request: ZSGFClient::AccessTokenPostRequest.new({title: 'title_example'}) # AccessTokenPostRequest |
107
107
  }
108
108
 
109
109
  begin
@@ -138,7 +138,7 @@ end
138
138
  | Name | Type | Description | Notes |
139
139
  | ---- | ---- | ----------- | ----- |
140
140
  | **app_key** | **String** | | |
141
- | **access_token_post_request** | [**AccessTokenPostRequest**](AccessTokenPostRequest.md) | 令牌创建请求参数 | [optional] |
141
+ | **access_token_post_request** | [**AccessTokenPostRequest**](AccessTokenPostRequest.md) | | [optional] |
142
142
 
143
143
  ### Return type
144
144
 
@@ -174,10 +174,10 @@ ZSGFClient.configure do |config|
174
174
  end
175
175
 
176
176
  api_instance = ZSGFClient::AccessTokenApi.new
177
- id = 789 # Integer | 令牌ID
177
+ id = 789 # Integer |
178
178
  app_key = 'app_key_example' # String |
179
179
  opts = {
180
- access_token_put_request: ZSGFClient::AccessTokenPutRequest.new({title: 'title_example'}) # AccessTokenPutRequest | 令牌更新请求参数
180
+ access_token_put_request: ZSGFClient::AccessTokenPutRequest.new # AccessTokenPutRequest |
181
181
  }
182
182
 
183
183
  begin
@@ -211,9 +211,9 @@ end
211
211
 
212
212
  | Name | Type | Description | Notes |
213
213
  | ---- | ---- | ----------- | ----- |
214
- | **id** | **Integer** | 令牌ID | |
214
+ | **id** | **Integer** | | |
215
215
  | **app_key** | **String** | | |
216
- | **access_token_put_request** | [**AccessTokenPutRequest**](AccessTokenPutRequest.md) | 令牌更新请求参数 | [optional] |
216
+ | **access_token_put_request** | [**AccessTokenPutRequest**](AccessTokenPutRequest.md) | | [optional] |
217
217
 
218
218
  ### Return type
219
219
 
@@ -251,9 +251,9 @@ end
251
251
  api_instance = ZSGFClient::AccessTokenApi.new
252
252
  app_key = 'app_key_example' # String |
253
253
  opts = {
254
- user_id: 789, # Integer | 用户ID
255
- skip: 56, # Integer | 跳过的记录数
256
- take: 56 # Integer | 获取的记录数
254
+ user_id: 789, # Integer |
255
+ skip: 56, # Integer |
256
+ take: 56 # Integer |
257
257
  }
258
258
 
259
259
  begin
@@ -288,9 +288,9 @@ end
288
288
  | Name | Type | Description | Notes |
289
289
  | ---- | ---- | ----------- | ----- |
290
290
  | **app_key** | **String** | | |
291
- | **user_id** | **Integer** | 用户ID | [optional] |
292
- | **skip** | **Integer** | 跳过的记录数 | [optional] |
293
- | **take** | **Integer** | 获取的记录数 | [optional] |
291
+ | **user_id** | **Integer** | | [optional] |
292
+ | **skip** | **Integer** | | [optional] |
293
+ | **take** | **Integer** | | [optional] |
294
294
 
295
295
  ### Return type
296
296
 
data/docs/AccessTokenPutRequest.md CHANGED
@@ -4,11 +4,11 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **title** | **String** | 访问令牌的标题 | [default to '默认标题'] |
7
+ | **title** | **String** | 访问令牌的标题 | [optional][default to ''] |
8
8
  | **tags** | **String** | 访问令牌的标签 | [optional][default to ''] |
9
9
  | **description** | **String** | 访问令牌的描述 | [optional][default to ''] |
10
10
  | **permissions** | **String** | 访问令牌的权限 | [optional][default to ''] |
11
- | **enable** | **Boolean** | 是否启用访问令牌 | [optional][default to false] |
11
+ | **enable** | **Boolean** | 是否启用访问令牌 | [optional] |
12
12
 
13
13
  ## Example
14
14
 
data/docs/AppUserListResponse.md CHANGED
@@ -4,18 +4,18 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **id** | **Integer** | | [optional] |
8
- | **union_id** | **String** | | [optional] |
9
- | **platform** | **String** | | [optional] |
10
- | **user_name** | **String** | | [optional] |
11
- | **nick_name** | **String** | | [optional] |
12
- | **email** | **String** | | [optional] |
13
- | **phone** | **String** | | [optional] |
14
- | **avatar** | **String** | | [optional] |
15
- | **role** | **String** | | [optional] |
16
- | **role_id** | **Integer** | | [optional] |
17
- | **create_date** | **Time** | | [optional] |
18
- | **last_update** | **Time** | | [optional] |
7
+ | **id** | **Integer** | 用户ID | [optional] |
8
+ | **union_id** | **String** | 用户的联合ID | [optional] |
9
+ | **platform** | **String** | 用户所在平台 | [optional] |
10
+ | **user_name** | **String** | 用户名 | [optional] |
11
+ | **nick_name** | **String** | 用户昵称 | [optional] |
12
+ | **email** | **String** | 用户邮箱 | [optional] |
13
+ | **phone** | **String** | 用户电话 | [optional] |
14
+ | **avatar** | **String** | 用户头像URL | [optional] |
15
+ | **role** | **String** | 用户角色 | [optional] |
16
+ | **role_id** | **Integer** | 用户角色ID | [optional] |
17
+ | **create_date** | **Time** | 用户创建日期 | [optional] |
18
+ | **last_update** | **Time** | 用户最后更新日期 | [optional] |
19
19
 
20
20
  ## Example
21
21
 
data/docs/AppUserResetEmailRequest.md ADDED
@@ -0,0 +1,20 @@
1
+ # ZSGFClient::AppUserResetEmailRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **email** | **String** | 邮箱 | [optional] |
8
+ | **code** | **String** | 邮箱验证码 | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zsgf_client'
14
+
15
+ instance = ZSGFClient::AppUserResetEmailRequest.new(
16
+ email: null,
17
+ code: null
18
+ )
19
+ ```
20
+
data/docs/AppUserResetPhoneRequest.md ADDED
@@ -0,0 +1,20 @@
1
+ # ZSGFClient::AppUserResetPhoneRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **phone** | **String** | 手机号码 | [optional] |
8
+ | **code** | **String** | 手机验证码 | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zsgf_client'
14
+
15
+ instance = ZSGFClient::AppUserResetPhoneRequest.new(
16
+ phone: null,
17
+ code: null
18
+ )
19
+ ```
20
+
data/docs/AppUserResetPwdRequest.md CHANGED
@@ -4,10 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **phone** | **String** | | [optional] |
8
- | **email** | **String** | | [optional] |
9
- | **code** | **String** | | |
10
- | **pwd** | **String** | | |
7
+ | **pwd** | **String** | 新的密码 | |
8
+ | **oldpwd** | **String** | 旧的密码 | |
11
9
 
12
10
  ## Example
13
11
 
@@ -15,10 +13,8 @@
15
13
  require 'zsgf_client'
16
14
 
17
15
  instance = ZSGFClient::AppUserResetPwdRequest.new(
18
- phone: null,
19
- email: null,
20
- code: null,
21
- pwd: null
16
+ pwd: null,
17
+ oldpwd: null
22
18
  )
23
19
  ```
24
20
 
data/docs/CommonFriendModel.md CHANGED
@@ -4,9 +4,9 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **user_id** | **Integer** | | [optional] |
8
- | **nick_name** | **String** | | [optional] |
9
- | **avatar** | **String** | | [optional] |
7
+ | **user_id** | **Integer** | 用户ID | [optional] |
8
+ | **nick_name** | **String** | 昵称 | [optional] |
9
+ | **avatar** | **String** | 头像 | [optional] |
10
10
 
11
11
  ## Example
12
12
 
data/docs/EmailSignInRequest.md CHANGED
@@ -4,9 +4,9 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **email** | **String** | | |
8
- | **verify_code** | **String** | | |
9
- | **two_factor_code** | **String** | 如果启用双因素认证登录，则必填 | [optional] |
7
+ | **email** | **String** | 用户邮箱地址 | |
8
+ | **verify_code** | **String** | 验证码，长度为4到8位的数字 | |
9
+ | **two_factor_code** | **String** | 双因素认证代码，如果启用双因素认证登录，则必填 | [optional] |
10
10
 
11
11
  ## Example
12
12
 
data/docs/EmailSignUpRequest.md CHANGED
@@ -4,13 +4,13 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **email** | **String** | | |
8
- | **pwd** | **String** | | |
7
+ | **email** | **String** | 用户邮箱地址 | |
8
+ | **pwd** | **String** | 用户密码，长度为6到32个字符 | |
9
9
  | **email_code** | **String** | 邮箱验证码 | [optional] |
10
- | **phone** | **String** | 手机号 | [optional] |
10
+ | **phone** | **String** | 手机号，必须为11位数字 | [optional] |
11
11
  | **phone_code** | **String** | 手机验证码（只有启用的手机验证码功能时，才需要传入） | [optional] |
12
- | **nick_name** | **String** | 昵称 | [optional] |
13
- | **avatar** | **String** | 头像 | [optional] |
12
+ | **nick_name** | **String** | 用户昵称 | [optional] |
13
+ | **avatar** | **String** | 用户头像URL | [optional] |
14
14
  | **data** | **String** | 自定义数据 | [optional] |
15
15
 
16
16
  ## Example
data/docs/FileApi.md CHANGED
@@ -234,7 +234,7 @@ end
234
234
 
235
235
  ## file_upload
236
236
 
237
- > <BooleanApiResponse> file_upload(app_key, opts)
237
+ > <StringApiResponse> file_upload(app_key, opts)
238
238
 
239
239
  上传文件
240
240
 
@@ -271,7 +271,7 @@ end
271
271
 
272
272
  This returns an Array which contains the response data, status code and headers.
273
273
 
274
- > <Array(<BooleanApiResponse>, Integer, Hash)> file_upload_with_http_info(app_key, opts)
274
+ > <Array(<StringApiResponse>, Integer, Hash)> file_upload_with_http_info(app_key, opts)
275
275
 
276
276
  ```ruby
277
277
  begin
@@ -279,7 +279,7 @@ begin
279
279
  data, status_code, headers = api_instance.file_upload_with_http_info(app_key, opts)
280
280
  p status_code # => 2xx
281
281
  p headers # => { ... }
282
- p data # => <BooleanApiResponse>
282
+ p data # => <StringApiResponse>
283
283
  rescue ZSGFClient::ApiError => e
284
284
  puts "Error when calling FileApi->file_upload_with_http_info: #{e}"
285
285
  end
@@ -295,7 +295,7 @@ end
295
295
 
296
296
  ### Return type
297
297
 
298
- [**BooleanApiResponse**](BooleanApiResponse.md)
298
+ [**StringApiResponse**](StringApiResponse.md)
299
299
 
300
300
  ### Authorization
301
301
 
data/docs/FollowerModel.md CHANGED
@@ -4,18 +4,18 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **id** | **Integer** | | [optional] |
8
- | **target_user_id** | **Integer** | | [optional] |
9
- | **_alias** | **String** | | [optional] |
10
- | **nick_name** | **String** | | [optional] |
11
- | **avatar** | **String** | | [optional] |
12
- | **is_mutual** | **Boolean** | | [optional] |
13
- | **closeness_score** | **Integer** | | [optional] |
14
- | **attention_score** | **Integer** | | [optional] |
15
- | **tags** | **String** | | [optional] |
16
- | **status** | **String** | | [optional] |
17
- | **remark** | **String** | | [optional] |
18
- | **create_date** | **Time** | | [optional] |
7
+ | **id** | **Integer** | 用户ID | [optional] |
8
+ | **target_user_id** | **Integer** | 目标用户ID | [optional] |
9
+ | **_alias** | **String** | 别名 | [optional] |
10
+ | **nick_name** | **String** | 昵称 | [optional] |
11
+ | **avatar** | **String** | 头像 | [optional] |
12
+ | **is_mutual** | **Boolean** | 是否互相关注 | [optional] |
13
+ | **closeness_score** | **Integer** | 亲密度分数 | [optional] |
14
+ | **attention_score** | **Integer** | 关注度分数 | [optional] |
15
+ | **tags** | **String** | 标签 | [optional] |
16
+ | **status** | **String** | 状态 | [optional] |
17
+ | **remark** | **String** | 备注 | [optional] |
18
+ | **create_date** | **Time** | 创建日期 | [optional] |
19
19
 
20
20
  ## Example
21
21
 
data/docs/FollowerPutModel.md CHANGED
@@ -4,12 +4,12 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **_alias** | **String** | | [optional] |
8
- | **closeness_score** | **Integer** | | [optional] |
9
- | **attention_score** | **Integer** | | [optional] |
10
- | **tags** | **String** | | [optional] |
11
- | **status** | **String** | | [optional] |
12
- | **remark** | **String** | | [optional] |
7
+ | **_alias** | **String** | 别名 | [optional] |
8
+ | **closeness_score** | **Integer** | 亲密度分数 | [optional] |
9
+ | **attention_score** | **Integer** | 关注度分数 | [optional] |
10
+ | **tags** | **String** | 标签 | [optional] |
11
+ | **status** | **String** | 状态 | [optional] |
12
+ | **remark** | **String** | 备注 | [optional] |
13
13
 
14
14
  ## Example
15
15
 
data/docs/GeoLocation.md ADDED
@@ -0,0 +1,62 @@
1
+ # ZSGFClient::GeoLocation
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **Integer** | 唯一标识 | [optional] |
8
+ | **biz_code** | **String** | 业务代码 | |
9
+ | **biz_id** | **Integer** | 业务ID | |
10
+ | **coordinates** | [**MySqlGeometry**](MySqlGeometry.md) | | |
11
+ | **location_name** | **String** | 地点的名称 | [optional] |
12
+ | **location_type** | **String** | 地点类型 | [optional] |
13
+ | **recipient_name** | **String** | 收货人姓名 | [optional] |
14
+ | **phone_number** | **String** | 收货人联系电话 | [optional] |
15
+ | **email** | **String** | 收货人电子邮件 | [optional] |
16
+ | **country** | **String** | 国家 | [optional] |
17
+ | **state** | **String** | 州/省 | [optional] |
18
+ | **city** | **String** | 城市 | [optional] |
19
+ | **district** | **String** | 区/县 | [optional] |
20
+ | **street** | **String** | 街道 | [optional] |
21
+ | **zip_code** | **String** | 邮政编码 | [optional] |
22
+ | **address** | **String** | 详细的地址信息 | [optional] |
23
+ | **map_type** | **String** | 地址类型 | [optional] |
24
+ | **remark** | **String** | 备注 | [optional] |
25
+ | **tags** | **String** | 标签 | [optional] |
26
+ | **enable** | **Boolean** | 是否启用 | [optional] |
27
+ | **show_index** | **Integer** | 排序索引 | [optional] |
28
+ | **create_date** | **Time** | 创建时间 | [optional] |
29
+ | **last_update** | **Time** | 最后更新时间 | [optional] |
30
+
31
+ ## Example
32
+
33
+ ```ruby
34
+ require 'zsgf_client'
35
+
36
+ instance = ZSGFClient::GeoLocation.new(
37
+ id: null,
38
+ biz_code: null,
39
+ biz_id: null,
40
+ coordinates: null,
41
+ location_name: null,
42
+ location_type: null,
43
+ recipient_name: null,
44
+ phone_number: null,
45
+ email: null,
46
+ country: null,
47
+ state: null,
48
+ city: null,
49
+ district: null,
50
+ street: null,
51
+ zip_code: null,
52
+ address: null,
53
+ map_type: null,
54
+ remark: null,
55
+ tags: null,
56
+ enable: null,
57
+ show_index: null,
58
+ create_date: null,
59
+ last_update: null
60
+ )
61
+ ```
62
+
data/docs/GeoLocationModel.md CHANGED
@@ -4,10 +4,10 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **latitude** | **Float** | 纬度 | [optional] |
8
- | **longitude** | **Float** | 经度 | [optional] |
9
7
  | **location_name** | **String** | 地点的名称 | [optional] |
10
- | **location_type** | **String** | 地点的类型，如家庭、工作、学校等 | [optional] |
8
+ | **latitude** | **Float** | 纬度 | |
9
+ | **longitude** | **Float** | 经度 | |
10
+ | **location_type** | **String** | 地点的类型，如家庭、工作、学校等 | |
11
11
  | **recipient_name** | **String** | 收货人姓名 | [optional] |
12
12
  | **phone_number** | **String** | 收货人联系电话 | [optional] |
13
13
  | **email** | **String** | 收货人电子邮件 | [optional] |
@@ -32,9 +32,9 @@
32
32
  require 'zsgf_client'
33
33
 
34
34
  instance = ZSGFClient::GeoLocationModel.new(
35
+ location_name: null,
35
36
  latitude: null,
36
37
  longitude: null,
37
- location_name: null,
38
38
  location_type: null,
39
39
  recipient_name: null,
40
40
  phone_number: null,
data/docs/GeoLocationResponseModel.md CHANGED
@@ -4,10 +4,10 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **latitude** | **Float** | 纬度 | [optional] |
8
- | **longitude** | **Float** | 经度 | [optional] |
9
7
  | **location_name** | **String** | 地点的名称 | [optional] |
10
- | **location_type** | **String** | 地点的类型，如家庭、工作、学校等 | [optional] |
8
+ | **latitude** | **Float** | 纬度 | |
9
+ | **longitude** | **Float** | 经度 | |
10
+ | **location_type** | **String** | 地点的类型，如家庭、工作、学校等 | |
11
11
  | **recipient_name** | **String** | 收货人姓名 | [optional] |
12
12
  | **phone_number** | **String** | 收货人联系电话 | [optional] |
13
13
  | **email** | **String** | 收货人电子邮件 | [optional] |
@@ -33,9 +33,9 @@
33
33
  require 'zsgf_client'
34
34
 
35
35
  instance = ZSGFClient::GeoLocationResponseModel.new(
36
+ location_name: null,
36
37
  latitude: null,
37
38
  longitude: null,
38
- location_name: null,
39
39
  location_type: null,
40
40
  recipient_name: null,
41
41
  phone_number: null,
data/docs/GetUserProfileResult.md ADDED
@@ -0,0 +1,24 @@
1
+ # ZSGFClient::GetUserProfileResult
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **user** | [**User**](User.md) | | [optional] |
8
+ | **currencies** | [**Array&lt;UserCurrency&gt;**](UserCurrency.md) | | [optional] |
9
+ | **role** | **String** | | [optional] |
10
+ | **location** | [**GeoLocation**](GeoLocation.md) | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'zsgf_client'
16
+
17
+ instance = ZSGFClient::GetUserProfileResult.new(
18
+ user: null,
19
+ currencies: null,
20
+ role: null,
21
+ location: null
22
+ )
23
+ ```
24
+
data/docs/{UserFollowingResultApiResponse.md → GetUserProfileResultApiResponse.md} RENAMED
@@ -1,11 +1,11 @@
1
- # ZSGFClient::UserFollowingResultApiResponse
1
+ # ZSGFClient::GetUserProfileResultApiResponse
2
2
 
3
3
  ## Properties
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **code** | **Integer** | 状态码 | [optional][default to 200] |
8
- | **data** | [**UserFollowingResult**](UserFollowingResult.md) | | [optional] |
8
+ | **data** | [**GetUserProfileResult**](GetUserProfileResult.md) | | [optional] |
9
9
  | **error** | **String** | 错误信息 | [optional][default to &#39;&#39;] |
10
10
 
11
11
  ## Example
@@ -13,7 +13,7 @@
13
13
  ```ruby
14
14
  require 'zsgf_client'
15
15
 
16
- instance = ZSGFClient::UserFollowingResultApiResponse.new(
16
+ instance = ZSGFClient::GetUserProfileResultApiResponse.new(
17
17
  code: null,
18
18
  data: null,
19
19
  error: null
data/docs/MySqlGeometry.md ADDED
@@ -0,0 +1,26 @@
1
+ # ZSGFClient::MySqlGeometry
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **x_coordinate** | **Float** | | [optional][readonly] |
8
+ | **y_coordinate** | **Float** | | [optional][readonly] |
9
+ | **srid** | **Integer** | | [optional][readonly] |
10
+ | **is_null** | **Boolean** | | [optional] |
11
+ | **value** | **String** | | [optional][readonly] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'zsgf_client'
17
+
18
+ instance = ZSGFClient::MySqlGeometry.new(
19
+ x_coordinate: null,
20
+ y_coordinate: null,
21
+ srid: null,
22
+ is_null: null,
23
+ value: null
24
+ )
25
+ ```
26
+
data/docs/OAuthAccountSignInRequest.md CHANGED
@@ -4,9 +4,9 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **union_id** | **String** | | |
8
- | **platform** | **String** | | |
9
- | **two_factor_code** | **String** | 如果启用双因素认证登录，则必填 | [optional] |
7
+ | **union_id** | **String** | UnionID，长度必须在1到50个字符之间，只能包含字母、数字、下划线和连字符 | |
8
+ | **platform** | **String** | 平台，长度必须在1到20个字符之间，只能包含字母和数字 | |
9
+ | **two_factor_code** | **String** | 双因素认证代码，如果启用双因素认证登录，则必填，长度必须为6个字符，只能包含数字 | [optional] |
10
10
 
11
11
  ## Example
12
12
 
data/docs/PhoneSignInRequest.md CHANGED
@@ -4,9 +4,9 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **phone** | **String** | | |
8
- | **verify_code** | **String** | | |
9
- | **two_factor_code** | **String** | 如果启用双因素认证登录，则必填 | [optional] |
7
+ | **phone** | **String** | 用户手机号 | |
8
+ | **verify_code** | **String** | 验证码，长度为4到8位的数字 | |
9
+ | **two_factor_code** | **String** | 双因素认证代码，如果启用双因素认证登录，则必填，长度必须为6个字符，只能包含数字 | [optional] |
10
10
 
11
11
  ## Example
12
12
 
data/docs/PhoneSignUpRequest.md CHANGED
@@ -4,13 +4,13 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **phone** | **String** | | |
8
- | **phone_code** | **String** | 手机验证码 | |
9
- | **pwd** | **String** | | |
10
- | **email** | **String** | 邮箱 | [optional] |
11
- | **email_code** | **String** | 邮箱验证码（只有启用的邮箱验证码功能时，才需要传入） | [optional] |
12
- | **nick_name** | **String** | 昵称 | [optional] |
13
- | **avatar** | **String** | 头像 | [optional] |
7
+ | **phone** | **String** | 用户手机号 | |
8
+ | **phone_code** | **String** | 手机验证码，长度为4到8位的数字 | |
9
+ | **pwd** | **String** | 用户密码，长度为6到32个字符 | |
10
+ | **email** | **String** | 用户邮箱 | [optional] |
11
+ | **email_code** | **String** | 邮箱验证码（只有启用的邮箱验证码功能时，才需要传入），长度为4到8位的数字 | [optional] |
12
+ | **nick_name** | **String** | 用户昵称 | [optional] |
13
+ | **avatar** | **String** | 用户头像URL | [optional] |
14
14
  | **data** | **String** | 自定义数据 | [optional] |
15
15
 
16
16
  ## Example
data/docs/QRCodePreSignInRequest.md CHANGED
@@ -4,9 +4,9 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **scopes** | **String** | | [optional] |
8
- | **remark** | **String** | | [optional] |
9
- | **scheme** | **String** | | [optional] |
7
+ | **scopes** | **String** | 授权范围，长度不能超过100个字符，只能包含字母、数字和逗号 | [optional] |
8
+ | **remark** | **String** | 备注，长度不能超过200个字符 | [optional] |
9
+ | **scheme** | **String** | 方案，长度不能超过50个字符，只能包含字母和数字 | [optional] |
10
10
 
11
11
  ## Example
12
12
 
data/docs/QRCodeScanRequest.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **sign_in_key** | **Integer** | | |
7
+ | **sign_in_key** | **Integer** | 登录密钥 | |
8
8
 
9
9
  ## Example
10
10
 
data/docs/QRCodeSignInRequest.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **sign_in_key** | **Integer** | | |
7
+ | **sign_in_key** | **Integer** | 登录密钥 | |
8
8
 
9
9
  ## Example
10
10
 
data/docs/QRCodeSignUpRequest.md CHANGED
@@ -4,15 +4,15 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **sign_in_key** | **Integer** | | [optional] |
8
- | **union_id** | **String** | | |
9
- | **nick_name** | **String** | 昵称 | [optional] |
10
- | **avatar** | **String** | 头像 | [optional] |
7
+ | **sign_in_key** | **Integer** | 登录密钥 | [optional] |
8
+ | **union_id** | **String** | UnionID，长度必须在1到50个字符之间，只能包含字母、数字、下划线和连字符 | |
9
+ | **nick_name** | **String** | 用户昵称 | [optional] |
10
+ | **avatar** | **String** | 用户头像URL | [optional] |
11
11
  | **data** | **String** | 自定义数据 | [optional] |
12
- | **email** | **String** | 邮箱 | [optional] |
13
- | **email_code** | **String** | 邮箱验证码（只有启用的邮箱验证码功能时，才需要传入） | [optional] |
14
- | **phone** | **String** | 手机号 | [optional] |
15
- | **phone_code** | **String** | 手机验证码（只有启用的手机验证码功能时，才需要传入） | [optional] |
12
+ | **email** | **String** | 用户邮箱 | [optional] |
13
+ | **email_code** | **String** | 邮箱验证码（只有启用的邮箱验证码功能时，才需要传入），长度为4到8位的数字 | [optional] |
14
+ | **phone** | **String** | 用户手机号，必须为11位数字 | [optional] |
15
+ | **phone_code** | **String** | 手机验证码（只有启用的手机验证码功能时，才需要传入），长度为4到8位的数字 | [optional] |
16
16
 
17
17
  ## Example
18
18