zsgf_client 1.0.20 → 1.0.25

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
 

data/docs/StorageApi.md

@@ -5,6 +5,7 @@ All URIs are relative to *https://api.zashigaofa.cn*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
 | [**storage_aggregate**](StorageApi.md#storage_aggregate) | **GET** /Storage/{appKey}/{table}/Aggregate | 聚合查询 |
+| [**storage_batch_update**](StorageApi.md#storage_batch_update) | **PUT** /Storage/{appKey}/{table}/batch-update | 批量更新指定条件的数据 |
 | [**storage_clear**](StorageApi.md#storage_clear) | **DELETE** /Storage/{appKey}/{table}/Clear | 清空表数据 |
 | [**storage_delete**](StorageApi.md#storage_delete) | **DELETE** /Storage/{appKey}/{table}/{id} | 删除数据 |
 | [**storage_delete_index**](StorageApi.md#storage_delete_index) | **DELETE** /Storage/{appKey}/{table}/indexes | 删除索引 |
@@ -97,6 +98,85 @@ end
 - **Accept**: application/json
 
 
+## storage_batch_update
+
+> <BooleanApiResponse> storage_batch_update(table, filter, app_key, request_body, opts)
+
+批量更新指定条件的数据
+
+批量更新指定表中符合条件的文档，可以动态指定查询条件和更新字段
+
+### Examples
+
+```ruby
+require 'time'
+require 'zsgf_client'
+# setup authorization
+ZSGFClient.configure do |config|
+  # Configure Bearer authorization: Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = ZSGFClient::StorageApi.new
+table = 'table_example' # String | 表名称
+filter = 'filter_example' # String | 查询条件
+app_key = 'app_key_example' # String | 
+request_body = [3.56] # Array<Object> | 更新的字段
+opts = {
+  replace: true # Boolean | 是否为全量替换，默认为 false
+}
+
+begin
+  # 批量更新指定条件的数据
+  result = api_instance.storage_batch_update(table, filter, app_key, request_body, opts)
+  p result
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling StorageApi->storage_batch_update: #{e}"
+end
+```
+
+#### Using the storage_batch_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BooleanApiResponse>, Integer, Hash)> storage_batch_update_with_http_info(table, filter, app_key, request_body, opts)
+
+```ruby
+begin
+  # 批量更新指定条件的数据
+  data, status_code, headers = api_instance.storage_batch_update_with_http_info(table, filter, app_key, request_body, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BooleanApiResponse>
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling StorageApi->storage_batch_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **table** | **String** | 表名称 |  |
+| **filter** | **String** | 查询条件 |  |
+| **app_key** | **String** |  |  |
+| **request_body** | [**Array&lt;Object&gt;**](Object.md) | 更新的字段 |  |
+| **replace** | **Boolean** | 是否为全量替换，默认为 false | [optional][default to false] |
+
+### Return type
+
+[**BooleanApiResponse**](BooleanApiResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
+- **Accept**: application/json
+
+
 ## storage_clear
 
 > <Int64ApiResponse> storage_clear(table, app_key, opts)
@@ -940,7 +1020,7 @@ end
 
 ## storage_put
 
-> <BooleanApiResponse> storage_put(table, id, app_key, body, opts)
+> <BooleanApiResponse> storage_put(table, id, app_key, request_body, opts)
 
 更新数据
 
@@ -961,14 +1041,14 @@ api_instance = ZSGFClient::StorageApi.new
 table = 'table_example' # String | 表名称
 id = 'id_example' # String | 数据ID
 app_key = 'app_key_example' # String | 
-body = 3.56 # Object | json格式
+request_body = [3.56] # Array<Object> | json格式
 opts = {
   replace: true # Boolean | 是否为全量更新，默认为false
 }
 
 begin
   # 更新数据
-  result = api_instance.storage_put(table, id, app_key, body, opts)
+  result = api_instance.storage_put(table, id, app_key, request_body, opts)
   p result
 rescue ZSGFClient::ApiError => e
   puts "Error when calling StorageApi->storage_put: #{e}"
@@ -979,12 +1059,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<BooleanApiResponse>, Integer, Hash)> storage_put_with_http_info(table, id, app_key, body, opts)
+> <Array(<BooleanApiResponse>, Integer, Hash)> storage_put_with_http_info(table, id, app_key, request_body, opts)
 
 ```ruby
 begin
   # 更新数据
-  data, status_code, headers = api_instance.storage_put_with_http_info(table, id, app_key, body, opts)
+  data, status_code, headers = api_instance.storage_put_with_http_info(table, id, app_key, request_body, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <BooleanApiResponse>
@@ -1000,7 +1080,7 @@ end
 | **table** | **String** | 表名称 |  |
 | **id** | **String** | 数据ID |  |
 | **app_key** | **String** |  |  |
-| **body** | **Object** | json格式 |  |
+| **request_body** | [**Array&lt;Object&gt;**](Object.md) | json格式 |  |
 | **replace** | **Boolean** | 是否为全量更新，默认为false | [optional][default to false] |
 
 ### Return type

data/docs/UnionIDSignInRequest.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **union_id** | **String** |  |  |
-| **platform** | **String** |  |  |
-| **two_factor_code** | **String** | 如果启用双因素认证登录，则必填 | [optional] |
+| **union_id** | **String** | UnionID，长度必须在1到99个字符之间，只能包含字母、数字、下划线和连字符 |  |
+| **platform** | **String** | 平台，长度必须在1到20个字符之间，只能包含字母和数字 |  |
+| **two_factor_code** | **String** | 双因素认证代码，如果启用双因素认证登录，则必填，长度必须为6个字符，只能包含数字 | [optional] |
 
 ## Example
 

data/docs/UnionIDSignUpRequest.md

@@ -4,17 +4,17 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **user_name** | **String** | 登录账号，可空 | [optional] |
-| **union_id** | **String** | UnionID |  |
-| **platform** | **String** | 平台标识 |  |
-| **pwd** | **String** | 密码，6~32位 |  |
-| **nick_name** | **String** | 昵称 | [optional] |
-| **avatar** | **String** | 头像 | [optional] |
+| **user_name** | **String** | 登录账号，可空，只能包含字母、数字、下划线和连字符 | [optional] |
+| **union_id** | **String** | UnionID，长度不能超过99个字符，只能包含字母、数字、下划线和连字符 |  |
+| **platform** | **String** | 平台标识，长度必须在1到20个字符之间，只能包含字母和数字 |  |
+| **pwd** | **String** | 密码，长度必须在6到32个字符之间，只允许英文大小写、数字、标点符号 |  |
+| **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/UpdateProfileRequest.md

@@ -4,23 +4,29 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **avatar** | **String** | 用户头像的链接或路径 | [optional] |
+| **avatar** | **String** | 用户头像的链接或路径，长度不能超过255个字符 | [optional] |
 | **data** | **String** | 用户的其他数据，可以是序列化后的对象或JSON字符串 | [optional] |
-| **nick_name** | **String** | 用户的昵称 | [optional] |
+| **nick_name** | **String** | 用户的昵称，长度不能超过50个字符 | [optional] |
 | **interest_tags** | **String** | 兴趣标签 | [optional] |
-| **biography** | **String** | 个人简介 | [optional] |
-| **gender** | **String** | 性别 | [optional] |
+| **biography** | **String** | 个人简介，长度不能超过500个字符 | [optional] |
+| **gender** | **String** | 性别，长度不能超过15个字符 | [optional] |
 | **birthday** | **Time** | 生日 | [optional] |
-| **occupation** | **String** | 职业 | [optional] |
-| **education** | **String** | 学历 | [optional] |
-| **contact** | **String** | 联系方式 | [optional] |
-| **languages** | **String** | 语言 | [optional] |
-| **social_links** | **String** | 社交网络链接 | [optional] |
-| **relationship_status** | **String** | 婚姻状态 | [optional] |
-| **company** | **String** | 公司 | [optional] |
-| **industry** | **String** | 行业 | [optional] |
-| **company_position** | **String** | 行业职位 | [optional] |
-| **private_settings** | **String** | 私密设置 | [optional] |
+| **occupation** | **String** | 职业，长度不能超过50个字符 | [optional] |
+| **education** | **String** | 学历，长度不能超过50个字符 | [optional] |
+| **contact** | **String** | 联系方式，长度不能超过255个字符 | [optional] |
+| **languages** | **String** | 语言，长度不能超过50个字符 | [optional] |
+| **social_links** | **String** | 社交网络链接，长度不能超过255个字符 | [optional] |
+| **relationship_status** | **String** | 婚姻状态，长度不能超过20个字符 | [optional] |
+| **company** | **String** | 公司，长度不能超过100个字符 | [optional] |
+| **industry** | **String** | 行业，长度不能超过50个字符 | [optional] |
+| **company_position** | **String** | 行业职位，长度不能超过50个字符 | [optional] |
+| **private_settings** | **String** | 私密设置，长度不能超过500个字符 | [optional] |
+| **enable2_fa_auth** | **Boolean** | 是否启用二步验证 | [optional] |
+| **enable_user_name_sign_in** | **Boolean** | 是否启用账号登录 | [optional] |
+| **enable_email_sign_in** | **Boolean** | 是否启用邮箱登录 | [optional] |
+| **enable_phone_sign_in** | **Boolean** | 是否启用手机登录 | [optional] |
+| **enable_union_id_sign_in** | **Boolean** | 是否启用UnionID登录 | [optional] |
+| **enable_o_auth** | **Boolean** | 是否启用OAuth2登录 | [optional] |
 
 ## Example
 
@@ -44,7 +50,13 @@ instance = ZSGFClient::UpdateProfileRequest.new(
   company: null,
   industry: null,
   company_position: null,
-  private_settings: null
+  private_settings: null,
+  enable2_fa_auth: null,
+  enable_user_name_sign_in: null,
+  enable_email_sign_in: null,
+  enable_phone_sign_in: null,
+  enable_union_id_sign_in: null,
+  enable_o_auth: null
 )
 ```