zsgf_client 1.0.24 → 2.0.0

data/docs/GeoLocation.md

@@ -0,0 +1,62 @@
+# ZSGFClient::GeoLocation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | 唯一标识 | [optional] |
+| **biz_code** | **String** | 业务代码 |  |
+| **biz_id** | **Integer** | 业务ID |  |
+| **coordinates** | [**MySqlGeometry**](MySqlGeometry.md) |  |  |
+| **location_name** | **String** | 地点的名称 | [optional] |
+| **location_type** | **String** | 地点类型 | [optional] |
+| **recipient_name** | **String** | 收货人姓名 | [optional] |
+| **phone_number** | **String** | 收货人联系电话 | [optional] |
+| **email** | **String** | 收货人电子邮件 | [optional] |
+| **country** | **String** | 国家 | [optional] |
+| **state** | **String** | 州/省 | [optional] |
+| **city** | **String** | 城市 | [optional] |
+| **district** | **String** | 区/县 | [optional] |
+| **street** | **String** | 街道 | [optional] |
+| **zip_code** | **String** | 邮政编码 | [optional] |
+| **address** | **String** | 详细的地址信息 | [optional] |
+| **map_type** | **String** | 地址类型 | [optional] |
+| **remark** | **String** | 备注 | [optional] |
+| **tags** | **String** | 标签 | [optional] |
+| **enable** | **Boolean** | 是否启用 | [optional] |
+| **show_index** | **Integer** | 排序索引 | [optional] |
+| **create_date** | **Time** | 创建时间 | [optional] |
+| **last_update** | **Time** | 最后更新时间 | [optional] |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::GeoLocation.new(
+  id: null,
+  biz_code: null,
+  biz_id: null,
+  coordinates: null,
+  location_name: null,
+  location_type: null,
+  recipient_name: null,
+  phone_number: null,
+  email: null,
+  country: null,
+  state: null,
+  city: null,
+  district: null,
+  street: null,
+  zip_code: null,
+  address: null,
+  map_type: null,
+  remark: null,
+  tags: null,
+  enable: null,
+  show_index: null,
+  create_date: null,
+  last_update: null
+)
+```
+

data/docs/GeoLocationModel.md

@@ -4,10 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **latitude** | **Float** | 纬度 | [optional] |
-| **longitude** | **Float** | 经度 | [optional] |
 | **location_name** | **String** | 地点的名称 | [optional] |
-| **location_type** | **String** | 地点的类型，如家庭、工作、学校等 | [optional] |
+| **latitude** | **Float** | 纬度 |  |
+| **longitude** | **Float** | 经度 |  |
+| **location_type** | **String** | 地点的类型，如家庭、工作、学校等 |  |
 | **recipient_name** | **String** | 收货人姓名 | [optional] |
 | **phone_number** | **String** | 收货人联系电话 | [optional] |
 | **email** | **String** | 收货人电子邮件 | [optional] |
@@ -32,9 +32,9 @@
 require 'zsgf_client'
 
 instance = ZSGFClient::GeoLocationModel.new(
+  location_name: null,
   latitude: null,
   longitude: null,
-  location_name: null,
   location_type: null,
   recipient_name: null,
   phone_number: null,

data/docs/GeoLocationResponseModel.md

@@ -4,10 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **latitude** | **Float** | 纬度 | [optional] |
-| **longitude** | **Float** | 经度 | [optional] |
 | **location_name** | **String** | 地点的名称 | [optional] |
-| **location_type** | **String** | 地点的类型，如家庭、工作、学校等 | [optional] |
+| **latitude** | **Float** | 纬度 |  |
+| **longitude** | **Float** | 经度 |  |
+| **location_type** | **String** | 地点的类型，如家庭、工作、学校等 |  |
 | **recipient_name** | **String** | 收货人姓名 | [optional] |
 | **phone_number** | **String** | 收货人联系电话 | [optional] |
 | **email** | **String** | 收货人电子邮件 | [optional] |
@@ -33,9 +33,9 @@
 require 'zsgf_client'
 
 instance = ZSGFClient::GeoLocationResponseModel.new(
+  location_name: null,
   latitude: null,
   longitude: null,
-  location_name: null,
   location_type: null,
   recipient_name: null,
   phone_number: null,

data/docs/GetUserProfileResult.md

@@ -0,0 +1,24 @@
+# ZSGFClient::GetUserProfileResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user** | [**User**](User.md) |  | [optional] |
+| **currencies** | [**Array<UserCurrency>**](UserCurrency.md) |  | [optional] |
+| **role** | **String** |  | [optional] |
+| **location** | [**GeoLocation**](GeoLocation.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::GetUserProfileResult.new(
+  user: null,
+  currencies: null,
+  role: null,
+  location: null
+)
+```
+

data/docs/{CurrencyExchangeRateApiResponse.md → GetUserProfileResultApiResponse.md}

@@ -1,11 +1,11 @@
-# ZSGFClient::CurrencyExchangeRateApiResponse
+# ZSGFClient::GetUserProfileResultApiResponse
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **code** | **Integer** | 状态码 | [optional][default to 200] |
-| **data** | [**CurrencyExchangeRate**](CurrencyExchangeRate.md) |  | [optional] |
+| **data** | [**GetUserProfileResult**](GetUserProfileResult.md) |  | [optional] |
 | **error** | **String** | 错误信息 | [optional][default to ''] |
 
 ## Example
@@ -13,7 +13,7 @@
 ```ruby
 require 'zsgf_client'
 
-instance = ZSGFClient::CurrencyExchangeRateApiResponse.new(
+instance = ZSGFClient::GetUserProfileResultApiResponse.new(
   code: null,
   data: null,
   error: null

data/docs/MySqlGeometry.md

@@ -0,0 +1,26 @@
+# ZSGFClient::MySqlGeometry
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_coordinate** | **Float** |  | [optional][readonly] |
+| **y_coordinate** | **Float** |  | [optional][readonly] |
+| **srid** | **Integer** |  | [optional][readonly] |
+| **is_null** | **Boolean** |  | [optional] |
+| **value** | **String** |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::MySqlGeometry.new(
+  x_coordinate: null,
+  y_coordinate: null,
+  srid: null,
+  is_null: null,
+  value: null
+)
+```
+

data/docs/OAuthApi.md

@@ -1,21 +1,21 @@
 # ZSGFClient::OAuthApi
 
-All URIs are relative to *https://api.zashigaofa.cn*
+All URIs are relative to *https://api-dev.zashigaofa.cn*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**o_auth_authorize**](OAuthApi.md#o_auth_authorize) | **POST** /OAuth/{appKey}/Authorize | 获取access_token |
-| [**o_auth_consents**](OAuthApi.md#o_auth_consents) | **GET** /OAuth/{appKey}/Consents | 授权记录 |
+| [**o_auth_authorize**](OAuthApi.md#o_auth_authorize) | **POST** /OAuth/{appKey}/Authorize | 获取访问令牌 |
+| [**o_auth_consents**](OAuthApi.md#o_auth_consents) | **GET** /OAuth/{appKey}/Consents | 获取授权记录 |
 | [**o_auth_delete_consent**](OAuthApi.md#o_auth_delete_consent) | **DELETE** /OAuth/{appKey}/Consents/{id} | 删除授权记录 |
-| [**o_auth_grant_code**](OAuthApi.md#o_auth_grant_code) | **POST** /OAuth/{appKey}/GrantCode | 申请授权码 |
-| [**o_auth_profile**](OAuthApi.md#o_auth_profile) | **GET** /OAuth/{appKey}/Profile | 获取个人资料 |
+| [**o_auth_grant_code**](OAuthApi.md#o_auth_grant_code) | **POST** /OAuth/{appKey}/GrantCode | 获取授权码 |
+| [**o_auth_profile**](OAuthApi.md#o_auth_profile) | **GET** /OAuth/{appKey}/Profile | 获取用户资料 |
 
 
 ## o_auth_authorize
 
 > <AuthorizeResultApiResponse> o_auth_authorize(app_key, opts)
 
-获取access_token
+获取访问令牌
 
 ### Examples
 
@@ -36,7 +36,7 @@ opts = {
 }
 
 begin
-  # 获取access_token
+  # 获取访问令牌
   result = api_instance.o_auth_authorize(app_key, opts)
   p result
 rescue ZSGFClient::ApiError => e
@@ -52,7 +52,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # 获取access_token
+  # 获取访问令牌
   data, status_code, headers = api_instance.o_auth_authorize_with_http_info(app_key, opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -88,7 +88,7 @@ end
 
 > <AppUserConsentModelListApiResponse> o_auth_consents(app_key)
 
-授权记录
+获取授权记录
 
 ### Examples
 
@@ -105,7 +105,7 @@ api_instance = ZSGFClient::OAuthApi.new
 app_key = 'app_key_example' # String | 
 
 begin
-  # 授权记录
+  # 获取授权记录
   result = api_instance.o_auth_consents(app_key)
   p result
 rescue ZSGFClient::ApiError => e
@@ -121,7 +121,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # 授权记录
+  # 获取授权记录
   data, status_code, headers = api_instance.o_auth_consents_with_http_info(app_key)
   p status_code # => 2xx
   p headers # => { ... }
@@ -224,7 +224,7 @@ end
 
 > <GrantResultApiResponse> o_auth_grant_code(app_key, opts)
 
-申请授权码
+获取授权码
 
 ### Examples
 
@@ -245,7 +245,7 @@ opts = {
 }
 
 begin
-  # 申请授权码
+  # 获取授权码
   result = api_instance.o_auth_grant_code(app_key, opts)
   p result
 rescue ZSGFClient::ApiError => e
@@ -261,7 +261,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # 申请授权码
+  # 获取授权码
   data, status_code, headers = api_instance.o_auth_grant_code_with_http_info(app_key, opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -297,7 +297,7 @@ end
 
 > <ProfileResultApiResponse> o_auth_profile(app_key)
 
-获取个人资料
+获取用户资料
 
 ### Examples
 
@@ -314,7 +314,7 @@ api_instance = ZSGFClient::OAuthApi.new
 app_key = 'app_key_example' # String | 
 
 begin
-  # 获取个人资料
+  # 获取用户资料
   result = api_instance.o_auth_profile(app_key)
   p result
 rescue ZSGFClient::ApiError => e
@@ -330,7 +330,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # 获取个人资料
+  # 获取用户资料
   data, status_code, headers = api_instance.o_auth_profile_with_http_info(app_key)
   p status_code # => 2xx
   p headers # => { ... }

data/docs/OrderApi.md

@@ -1,6 +1,6 @@
 # ZSGFClient::OrderApi
 
-All URIs are relative to *https://api.zashigaofa.cn*
+All URIs are relative to *https://api-dev.zashigaofa.cn*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |

data/docs/PhoneSignInRequest.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **phone** | **String** |  |  |
-| **verify_code** | **String** |  |  |
-| **two_factor_code** | **String** | 如果启用双因素认证登录，则必填 | [optional] |
+| **phone** | **String** | 用户手机号 |  |
+| **verify_code** | **String** | 验证码，长度为4到8位的数字 |  |
+| **two_factor_code** | **String** | 双因素认证代码，如果启用双因素认证登录，则必填，长度必须为6个字符，只能包含数字 | [optional] |
 
 ## Example
 

data/docs/PhoneSignUpRequest.md

@@ -4,13 +4,13 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **phone** | **String** |  |  |
-| **phone_code** | **String** | 手机验证码 |  |
-| **pwd** | **String** |  |  |
-| **email** | **String** | 邮箱 | [optional] |
-| **email_code** | **String** | 邮箱验证码（只有启用的邮箱验证码功能时，才需要传入） | [optional] |
-| **nick_name** | **String** | 昵称 | [optional] |
-| **avatar** | **String** | 头像 | [optional] |
+| **phone** | **String** | 用户手机号 |  |
+| **phone_code** | **String** | 手机验证码，长度为4到8位的数字 |  |
+| **pwd** | **String** | 用户密码，长度为6到32个字符 |  |
+| **email** | **String** | 用户邮箱 | [optional] |
+| **email_code** | **String** | 邮箱验证码（只有启用的邮箱验证码功能时，才需要传入），长度为4到8位的数字 | [optional] |
+| **nick_name** | **String** | 用户昵称 | [optional] |
+| **avatar** | **String** | 用户头像URL | [optional] |
 | **data** | **String** | 自定义数据 | [optional] |
 
 ## Example

data/docs/QRCodePreSignInRequest.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **scopes** | **String** |  | [optional] |
-| **remark** | **String** |  | [optional] |
-| **scheme** | **String** |  | [optional] |
+| **scopes** | **String** | 授权范围，长度不能超过100个字符，只能包含字母、数字和逗号 | [optional] |
+| **remark** | **String** | 备注，长度不能超过200个字符 | [optional] |
+| **scheme** | **String** | 方案，长度不能超过50个字符，只能包含字母和数字 | [optional] |
 
 ## Example
 

data/docs/QRCodeScanRequest.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **sign_in_key** | **Integer** |  |  |
+| **sign_in_key** | **Integer** | 登录密钥 |  |
 
 ## Example
 

data/docs/QRCodeSignInRequest.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **sign_in_key** | **Integer** |  |  |
+| **sign_in_key** | **Integer** | 登录密钥 |  |
 
 ## Example
 

data/docs/QRCodeSignUpRequest.md

@@ -4,15 +4,15 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **sign_in_key** | **Integer** |  | [optional] |
-| **union_id** | **String** |  |  |
-| **nick_name** | **String** | 昵称 | [optional] |
-| **avatar** | **String** | 头像 | [optional] |
+| **sign_in_key** | **Integer** | 登录密钥 | [optional] |
+| **union_id** | **String** | UnionID，长度必须在1到50个字符之间，只能包含字母、数字、下划线和连字符 |  |
+| **nick_name** | **String** | 用户昵称 | [optional] |
+| **avatar** | **String** | 用户头像URL | [optional] |
 | **data** | **String** | 自定义数据 | [optional] |
-| **email** | **String** | 邮箱 | [optional] |
-| **email_code** | **String** | 邮箱验证码（只有启用的邮箱验证码功能时，才需要传入） | [optional] |
-| **phone** | **String** | 手机号 | [optional] |
-| **phone_code** | **String** | 手机验证码（只有启用的手机验证码功能时，才需要传入） | [optional] |
+| **email** | **String** | 用户邮箱 | [optional] |
+| **email_code** | **String** | 邮箱验证码（只有启用的邮箱验证码功能时，才需要传入），长度为4到8位的数字 | [optional] |
+| **phone** | **String** | 用户手机号，必须为11位数字 | [optional] |
+| **phone_code** | **String** | 手机验证码（只有启用的手机验证码功能时，才需要传入），长度为4到8位的数字 | [optional] |
 
 ## Example
 

data/docs/RecommendFriend.md

@@ -4,16 +4,21 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **user_id** | **Integer** |  | [optional] |
-| **nick_name** | **String** |  | [optional] |
-| **avatar** | **String** |  | [optional] |
-| **gender** | **String** |  | [optional] |
-| **age** | **Integer** |  | [optional] |
-| **interest_tags** | **String** |  | [optional] |
-| **location_name** | **String** |  | [optional] |
-| **latitude** | **Float** |  | [optional] |
-| **longitude** | **Float** |  | [optional] |
-| **distance** | **Integer** |  | [optional] |
+| **user_id** | **Integer** | 用户ID | [optional] |
+| **nick_name** | **String** | 昵称 | [optional] |
+| **avatar** | **String** | 头像 | [optional] |
+| **gender** | **String** | 性别 | [optional] |
+| **age** | **Integer** | 年龄 | [optional] |
+| **interest_tags** | **String** | 兴趣标签 | [optional] |
+| **location_name** | **String** | 位置名称 | [optional] |
+| **latitude** | **Float** | 纬度 | [optional] |
+| **longitude** | **Float** | 经度 | [optional] |
+| **distance** | **Integer** | 距离 | [optional] |
+| **biography** | **String** | 个人简介 | [optional] |
+| **country** | **String** | 国家 | [optional] |
+| **state** | **String** | 省份 | [optional] |
+| **city** | **String** | 城市 | [optional] |
+| **district** | **String** | 区县 | [optional] |
 
 ## Example
 
@@ -30,7 +35,12 @@ instance = ZSGFClient::RecommendFriend.new(
   location_name: null,
   latitude: null,
   longitude: null,
-  distance: null
+  distance: null,
+  biography: null,
+  country: null,
+  state: null,
+  city: null,
+  district: null
 )
 ```
 

data/docs/SendEmailCodeRequest.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **email** | **String** |  |  |
-| **type** | **String** | 用途。可选值：signup/forgetpwd |  |
+| **email** | **String** | 用户邮箱地址 |  |
+| **type** | **String** | 用途。可选值：signup（注册）/forgetpwd（忘记密码） |  |
 
 ## Example
 

data/docs/SendSMSCodeRequest.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **phone** | **String** | 手机号 |  |
-| **type** | **String** | 用途。可选值：signup/forgetpwd |  |
+| **phone** | **String** | 用户手机号 |  |
+| **type** | **String** | 用途。可选值：signup（注册）/forgetpwd（忘记密码） |  |
 
 ## Example
 

data/docs/SignInRequest.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **user_name** | **String** |  |  |
-| **pwd** | **String** |  |  |
-| **two_factor_code** | **String** | 如果启用双因素认证登录，则必填 | [optional] |
+| **user_name** | **String** | 用户名，长度必须在6到32个字符之间，只能包含字母、数字、下划线和连字符 |  |
+| **pwd** | **String** | 用户密码，长度必须在6到50个字符之间，可以包含数字、大小写字母、下划线、连字符和特殊符号 |  |
+| **two_factor_code** | **String** | 双因素认证代码，如果启用双因素认证登录，则必填，长度必须为6个字符，只能包含数字 | [optional] |
 
 ## Example
 

data/docs/SignUpRequest.md

@@ -4,15 +4,15 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **user_name** | **String** | 登录账号，4~18位 |  |
-| **pwd** | **String** | 登录密码，6~32位 |  |
-| **nick_name** | **String** | 昵称 | [optional] |
-| **avatar** | **String** | 头像 | [optional] |
+| **user_name** | **String** | 用户名，长度必须在6到32个字符之间，只能包含字母、数字、下划线和连字符 |  |
+| **pwd** | **String** | 登录密码，长度必须在6到32个字符之间，只能包含字母和数字 |  |
+| **nick_name** | **String** | 用户昵称，长度不能超过20个字符 | [optional] |
+| **avatar** | **String** | 用户头像URL | [optional] |
 | **data** | **String** | 自定义数据 | [optional] |
-| **email** | **String** | 邮箱 | [optional] |
-| **email_code** | **String** | 邮箱验证码（只有启用的邮箱验证码功能时，才需要传入） | [optional] |
-| **phone** | **String** | 手机号 | [optional] |
-| **phone_code** | **String** | 手机验证码（只有启用的手机验证码功能时，才需要传入） | [optional] |
+| **email** | **String** | 用户邮箱 | [optional] |
+| **email_code** | **String** | 邮箱验证码（只有启用的邮箱验证码功能时，才需要传入），长度为4到8位的数字 | [optional] |
+| **phone** | **String** | 用户手机号，必须为11位数字 | [optional] |
+| **phone_code** | **String** | 手机验证码（只有启用的手机验证码功能时，才需要传入），长度为4到8位的数字 | [optional] |
 
 ## Example