zsgf_client 1.0.18

data/docs/TeamApi.md

@@ -0,0 +1,297 @@
+# ZSGFClient::TeamApi
+
+All URIs are relative to *https://api.zashigaofa.cn*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**team_delete**](TeamApi.md#team_delete) | **DELETE** /Team/{id} | 删除团队 |
+| [**team_post**](TeamApi.md#team_post) | **POST** /Team | 创建团队 |
+| [**team_put**](TeamApi.md#team_put) | **PUT** /Team/{id} | 更新团队信息 |
+| [**teams**](TeamApi.md#teams) | **GET** /Team | 获取团队列表 |
+
+
+## team_delete
+
+> <BooleanApiResponse> team_delete(id)
+
+删除团队
+
+根据团队ID删除团队
+
+### 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::TeamApi.new
+id = 789 # Integer | 团队ID
+
+begin
+  # 删除团队
+  result = api_instance.team_delete(id)
+  p result
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling TeamApi->team_delete: #{e}"
+end
+```
+
+#### Using the team_delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BooleanApiResponse>, Integer, Hash)> team_delete_with_http_info(id)
+
+```ruby
+begin
+  # 删除团队
+  data, status_code, headers = api_instance.team_delete_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BooleanApiResponse>
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling TeamApi->team_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | 团队ID |  |
+
+### Return type
+
+[**BooleanApiResponse**](BooleanApiResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## team_post
+
+> <BooleanApiResponse> team_post(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::TeamApi.new
+opts = {
+  team: ZSGFClient::Team.new # Team | 团队信息
+}
+
+begin
+  # 创建团队
+  result = api_instance.team_post(opts)
+  p result
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling TeamApi->team_post: #{e}"
+end
+```
+
+#### Using the team_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BooleanApiResponse>, Integer, Hash)> team_post_with_http_info(opts)
+
+```ruby
+begin
+  # 创建团队
+  data, status_code, headers = api_instance.team_post_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BooleanApiResponse>
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling TeamApi->team_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **team** | [**Team**](Team.md) | 团队信息 | [optional] |
+
+### 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
+
+
+## team_put
+
+> <BooleanApiResponse> team_put(id, opts)
+
+更新团队信息
+
+根据团队ID更新团队信息
+
+### 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::TeamApi.new
+id = 789 # Integer | 团队ID
+opts = {
+  team: ZSGFClient::Team.new # Team | 团队信息
+}
+
+begin
+  # 更新团队信息
+  result = api_instance.team_put(id, opts)
+  p result
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling TeamApi->team_put: #{e}"
+end
+```
+
+#### Using the team_put_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BooleanApiResponse>, Integer, Hash)> team_put_with_http_info(id, opts)
+
+```ruby
+begin
+  # 更新团队信息
+  data, status_code, headers = api_instance.team_put_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BooleanApiResponse>
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling TeamApi->team_put_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | 团队ID |  |
+| **team** | [**Team**](Team.md) | 团队信息 | [optional] |
+
+### 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
+
+
+## teams
+
+> <ListResponseItemListApiResponse> teams(opts)
+
+获取团队列表
+
+根据渠道代码和渠道应用ID获取团队列表
+
+### 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::TeamApi.new
+opts = {
+  channel_code: 'channel_code_example', # String | 渠道代码
+  channel_app_id: 'channel_app_id_example' # String | 渠道应用ID
+}
+
+begin
+  # 获取团队列表
+  result = api_instance.teams(opts)
+  p result
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling TeamApi->teams: #{e}"
+end
+```
+
+#### Using the teams_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListResponseItemListApiResponse>, Integer, Hash)> teams_with_http_info(opts)
+
+```ruby
+begin
+  # 获取团队列表
+  data, status_code, headers = api_instance.teams_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListResponseItemListApiResponse>
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling TeamApi->teams_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **channel_code** | **String** | 渠道代码 | [optional] |
+| **channel_app_id** | **String** | 渠道应用ID | [optional] |
+
+### Return type
+
+[**ListResponseItemListApiResponse**](ListResponseItemListApiResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/TokenModel.md

@@ -0,0 +1,22 @@
+# ZSGFClient::TokenModel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_token** | **String** |  | [optional] |
+| **token_type** | **String** |  | [optional] |
+| **expires_in** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::TokenModel.new(
+  access_token: null,
+  token_type: null,
+  expires_in: null
+)
+```
+

data/docs/TokenModelApiResponse.md

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

data/docs/TradeFundBill.md

@@ -0,0 +1,26 @@
+# ZSGFClient::TradeFundBill
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **String** |  | [optional] |
+| **bank_code** | **String** |  | [optional] |
+| **fund_channel** | **String** |  | [optional] |
+| **fund_type** | **String** |  | [optional] |
+| **real_amount** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::TradeFundBill.new(
+  amount: null,
+  bank_code: null,
+  fund_channel: null,
+  fund_type: null,
+  real_amount: null
+)
+```
+

data/docs/TradeSettleDetail.md

@@ -0,0 +1,32 @@
+# ZSGFClient::TradeSettleDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **String** |  | [optional] |
+| **operation_dt** | **String** |  | [optional] |
+| **operation_serial_no** | **String** |  | [optional] |
+| **operation_type** | **String** |  | [optional] |
+| **ori_trans_in** | **String** |  | [optional] |
+| **ori_trans_out** | **String** |  | [optional] |
+| **trans_in** | **String** |  | [optional] |
+| **trans_out** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::TradeSettleDetail.new(
+  amount: null,
+  operation_dt: null,
+  operation_serial_no: null,
+  operation_type: null,
+  ori_trans_in: null,
+  ori_trans_out: null,
+  trans_in: null,
+  trans_out: null
+)
+```
+

data/docs/TradeSettleInfo.md

@@ -0,0 +1,20 @@
+# ZSGFClient::TradeSettleInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **trade_settle_detail_list** | [**Array<TradeSettleDetail>**](TradeSettleDetail.md) |  | [optional] |
+| **trade_unsettled_amount** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::TradeSettleInfo.new(
+  trade_settle_detail_list: null,
+  trade_unsettled_amount: null
+)
+```
+

data/docs/UnionIDSignInRequest.md

@@ -0,0 +1,22 @@
+# ZSGFClient::UnionIDSignInRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **union_id** | **String** |  |  |
+| **platform** | **String** |  |  |
+| **two_factor_code** | **String** | 如果启用双因素认证登录，则必填 | [optional] |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::UnionIDSignInRequest.new(
+  union_id: null,
+  platform: null,
+  two_factor_code: null
+)
+```
+

data/docs/UnionIDSignUpRequest.md

@@ -0,0 +1,38 @@
+# ZSGFClient::UnionIDSignUpRequest
+
+## Properties
+
+| 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] |
+| **data** | **String** | 自定义数据 | [optional] |
+| **email** | **String** | 邮箱 | [optional] |
+| **email_code** | **String** | 邮箱验证码（只有启用的邮箱验证码功能时，才需要传入） | [optional] |
+| **phone** | **String** | 手机号 | [optional] |
+| **phone_code** | **String** | 手机验证码（只有启用的手机验证码功能时，才需要传入） | [optional] |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::UnionIDSignUpRequest.new(
+  user_name: null,
+  union_id: null,
+  platform: null,
+  pwd: null,
+  nick_name: null,
+  avatar: null,
+  data: null,
+  email: null,
+  email_code: null,
+  phone: null,
+  phone_code: null
+)
+```
+

data/docs/UpdateProfileRequest.md

@@ -0,0 +1,50 @@
+# ZSGFClient::UpdateProfileRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **avatar** | **String** | 用户头像的链接或路径 | [optional] |
+| **data** | **String** | 用户的其他数据，可以是序列化后的对象或JSON字符串 | [optional] |
+| **nick_name** | **String** | 用户的昵称 | [optional] |
+| **interest_tags** | **String** | 兴趣标签 | [optional] |
+| **biography** | **String** | 个人简介 | [optional] |
+| **gender** | **String** | 性别 | [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] |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::UpdateProfileRequest.new(
+  avatar: null,
+  data: null,
+  nick_name: null,
+  interest_tags: null,
+  biography: null,
+  gender: null,
+  birthday: null,
+  occupation: null,
+  education: null,
+  contact: null,
+  languages: null,
+  social_links: null,
+  relationship_status: null,
+  company: null,
+  industry: null,
+  company_position: null,
+  private_settings: null
+)
+```
+

data/docs/User.md

@@ -0,0 +1,90 @@
+# ZSGFClient::User
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | 用户唯一标识 | [optional] |
+| **platform** | **String** | 用户所在平台 | [optional] |
+| **union_id** | **String** | 用户所在平台的唯一标识 | [optional] |
+| **nick_name** | **String** | 昵称 | [optional] |
+| **avatar** | **String** | 头像 | [optional] |
+| **data** | **String** | 其他数据 | [optional] |
+| **user_name** | **String** | 用户名 | [optional] |
+| **pwd** | **String** | 用户密码 | [optional] |
+| **email** | **String** | 邮箱地址 | [optional] |
+| **email_is_valid** | **Boolean** | 邮箱已验证 | [optional] |
+| **phone** | **String** | 手机号码 | [optional] |
+| **phone_is_valid** | **Boolean** | 手机号码已验证 | [optional] |
+| **relation_chain** | **String** | 关系链 | [optional] |
+| **interest_tags** | **String** | 兴趣标签 | [optional] |
+| **biography** | **String** | 个人简介 | [optional] |
+| **gender** | **String** | 性别 | [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] |
+| **is_lock** | **Boolean** | 账户是否锁定 | [optional] |
+| **lock_until** | **Time** | 账户锁定截止时间 | [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** | 能使用联合身份标识登录 | [optional] |
+| **enable_o_auth** | **Boolean** | 能使用OAuth认证方式登录 | [optional] |
+| **enable2_fa_auth** | **Boolean** | 启用双因素认证登录 | [optional] |
+| **create_date** | **Time** | 创建时间 | [optional] |
+| **last_update** | **Time** | 最后更新时间 | [optional] |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::User.new(
+  id: null,
+  platform: null,
+  union_id: null,
+  nick_name: null,
+  avatar: null,
+  data: null,
+  user_name: null,
+  pwd: null,
+  email: null,
+  email_is_valid: null,
+  phone: null,
+  phone_is_valid: null,
+  relation_chain: null,
+  interest_tags: null,
+  biography: null,
+  gender: null,
+  birthday: null,
+  occupation: null,
+  education: null,
+  contact: null,
+  languages: null,
+  social_links: null,
+  relationship_status: null,
+  company: null,
+  industry: null,
+  company_position: null,
+  private_settings: null,
+  is_lock: null,
+  lock_until: 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,
+  enable2_fa_auth: null,
+  create_date: null,
+  last_update: null
+)
+```
+

data/docs/UserAccessToken.md

@@ -0,0 +1,38 @@
+# ZSGFClient::UserAccessToken
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | 用户令牌的唯一标识符。 | [optional] |
+| **user_id** | **Integer** | 与令牌关联的用户ID。 | [optional] |
+| **enable** | **Boolean** | 指示令牌是否处于启用状态。 | [optional] |
+| **permissions** | **String** | 令牌拥有的权限列表，多个权限以逗号分隔。 | [optional] |
+| **title** | **String** | 令牌的标题或名称，用于标识令牌。 | [optional] |
+| **access_token** | **String** | 访问令牌的具体值，用于身份验证。 | [optional] |
+| **tags** | **String** | 用于分类或标记令牌的标签。 | [optional] |
+| **description** | **String** | 令牌的详细描述信息。 | [optional] |
+| **expire_time** | **Time** | 令牌的过期时间，超过该时间令牌将失效。 | [optional] |
+| **create_date** | **Time** | 令牌的创建日期，默认为当前时间。 | [optional] |
+| **last_update** | **Time** | 令牌的最后更新日期，默认为当前时间。 | [optional] |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::UserAccessToken.new(
+  id: null,
+  user_id: null,
+  enable: null,
+  permissions: null,
+  title: null,
+  access_token: null,
+  tags: null,
+  description: null,
+  expire_time: null,
+  create_date: null,
+  last_update: null
+)
+```
+