zsgf_client 1.0.25 → 2.0.0

data/docs/ExternalAccountApi.md

@@ -0,0 +1,373 @@
+# ZSGFClient::ExternalAccountApi
+
+All URIs are relative to *https://api-dev.zashigaofa.cn*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**external_account_sign_in**](ExternalAccountApi.md#external_account_sign_in) | **POST** /ExternalAccount/{appKey}/SignIn | 外部账号登录 |
+| [**user_external_account_bind**](ExternalAccountApi.md#user_external_account_bind) | **POST** /ExternalAccount/{appKey} | 绑定外部账号 |
+| [**user_o_auth_accounts**](ExternalAccountApi.md#user_o_auth_accounts) | **GET** /ExternalAccount/{appKey} | 外部账号列表 |
+| [**user_o_auth_accounts_put_bind**](ExternalAccountApi.md#user_o_auth_accounts_put_bind) | **PUT** /ExternalAccount/{appKey}/{id} | 更新绑定账号 |
+| [**user_o_auth_accounts_un_bind**](ExternalAccountApi.md#user_o_auth_accounts_un_bind) | **DELETE** /ExternalAccount/{appKey}/{id} | 删除绑定账号 |
+
+
+## external_account_sign_in
+
+> <TokenModelApiResponse> external_account_sign_in(app_key, 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::ExternalAccountApi.new
+app_key = 'app_key_example' # String | 
+opts = {
+  external_account_sign_in_request: ZSGFClient::ExternalAccountSignInRequest.new({union_id: 'union_id_example', platform: 'platform_example'}) # ExternalAccountSignInRequest | 登录请求参数
+}
+
+begin
+  # 外部账号登录
+  result = api_instance.external_account_sign_in(app_key, opts)
+  p result
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling ExternalAccountApi->external_account_sign_in: #{e}"
+end
+```
+
+#### Using the external_account_sign_in_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TokenModelApiResponse>, Integer, Hash)> external_account_sign_in_with_http_info(app_key, opts)
+
+```ruby
+begin
+  # 外部账号登录
+  data, status_code, headers = api_instance.external_account_sign_in_with_http_info(app_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TokenModelApiResponse>
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling ExternalAccountApi->external_account_sign_in_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_key** | **String** |  |  |
+| **external_account_sign_in_request** | [**ExternalAccountSignInRequest**](ExternalAccountSignInRequest.md) | 登录请求参数 | [optional] |
+
+### Return type
+
+[**TokenModelApiResponse**](TokenModelApiResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
+- **Accept**: application/json
+
+
+## user_external_account_bind
+
+> <BooleanApiResponse> user_external_account_bind(app_key, 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::ExternalAccountApi.new
+app_key = 'app_key_example' # String | 
+opts = {
+  external_account_bind_request: ZSGFClient::ExternalAccountBindRequest.new({union_id: 'union_id_example', platform: 'platform_example', platform_name: 'platform_name_example'}) # ExternalAccountBindRequest | 绑定请求参数
+}
+
+begin
+  # 绑定外部账号
+  result = api_instance.user_external_account_bind(app_key, opts)
+  p result
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling ExternalAccountApi->user_external_account_bind: #{e}"
+end
+```
+
+#### Using the user_external_account_bind_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BooleanApiResponse>, Integer, Hash)> user_external_account_bind_with_http_info(app_key, opts)
+
+```ruby
+begin
+  # 绑定外部账号
+  data, status_code, headers = api_instance.user_external_account_bind_with_http_info(app_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BooleanApiResponse>
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling ExternalAccountApi->user_external_account_bind_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_key** | **String** |  |  |
+| **external_account_bind_request** | [**ExternalAccountBindRequest**](ExternalAccountBindRequest.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
+
+
+## user_o_auth_accounts
+
+> <UserLoginsListApiResponse> user_o_auth_accounts(app_key)
+
+外部账号列表
+
+获取绑定成功的外部账号列表
+
+### 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::ExternalAccountApi.new
+app_key = 'app_key_example' # String | 
+
+begin
+  # 外部账号列表
+  result = api_instance.user_o_auth_accounts(app_key)
+  p result
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling ExternalAccountApi->user_o_auth_accounts: #{e}"
+end
+```
+
+#### Using the user_o_auth_accounts_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UserLoginsListApiResponse>, Integer, Hash)> user_o_auth_accounts_with_http_info(app_key)
+
+```ruby
+begin
+  # 外部账号列表
+  data, status_code, headers = api_instance.user_o_auth_accounts_with_http_info(app_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UserLoginsListApiResponse>
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling ExternalAccountApi->user_o_auth_accounts_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_key** | **String** |  |  |
+
+### Return type
+
+[**UserLoginsListApiResponse**](UserLoginsListApiResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## user_o_auth_accounts_put_bind
+
+> <BooleanApiResponse> user_o_auth_accounts_put_bind(id, app_key, 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::ExternalAccountApi.new
+id = 789 # Integer | 绑定ID
+app_key = 'app_key_example' # String | 
+opts = {
+  external_account_put_request: ZSGFClient::ExternalAccountPutRequest.new # ExternalAccountPutRequest | 更新请求参数
+}
+
+begin
+  # 更新绑定账号
+  result = api_instance.user_o_auth_accounts_put_bind(id, app_key, opts)
+  p result
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling ExternalAccountApi->user_o_auth_accounts_put_bind: #{e}"
+end
+```
+
+#### Using the user_o_auth_accounts_put_bind_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BooleanApiResponse>, Integer, Hash)> user_o_auth_accounts_put_bind_with_http_info(id, app_key, opts)
+
+```ruby
+begin
+  # 更新绑定账号
+  data, status_code, headers = api_instance.user_o_auth_accounts_put_bind_with_http_info(id, app_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BooleanApiResponse>
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling ExternalAccountApi->user_o_auth_accounts_put_bind_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | 绑定ID |  |
+| **app_key** | **String** |  |  |
+| **external_account_put_request** | [**ExternalAccountPutRequest**](ExternalAccountPutRequest.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
+
+
+## user_o_auth_accounts_un_bind
+
+> <BooleanApiResponse> user_o_auth_accounts_un_bind(id, app_key)
+
+删除绑定账号
+
+删除绑定的外部账号
+
+### 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::ExternalAccountApi.new
+id = 789 # Integer | 绑定ID
+app_key = 'app_key_example' # String | 
+
+begin
+  # 删除绑定账号
+  result = api_instance.user_o_auth_accounts_un_bind(id, app_key)
+  p result
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling ExternalAccountApi->user_o_auth_accounts_un_bind: #{e}"
+end
+```
+
+#### Using the user_o_auth_accounts_un_bind_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BooleanApiResponse>, Integer, Hash)> user_o_auth_accounts_un_bind_with_http_info(id, app_key)
+
+```ruby
+begin
+  # 删除绑定账号
+  data, status_code, headers = api_instance.user_o_auth_accounts_un_bind_with_http_info(id, app_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BooleanApiResponse>
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling ExternalAccountApi->user_o_auth_accounts_un_bind_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | 绑定ID |  |
+| **app_key** | **String** |  |  |
+
+### Return type
+
+[**BooleanApiResponse**](BooleanApiResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/{OAuthAccountBindRequest.md → ExternalAccountBindRequest.md}

@@ -1,4 +1,4 @@
-# ZSGFClient::OAuthAccountBindRequest
+# ZSGFClient::ExternalAccountBindRequest
 
 ## Properties
 
@@ -15,7 +15,7 @@
 ```ruby
 require 'zsgf_client'
 
-instance = ZSGFClient::OAuthAccountBindRequest.new(
+instance = ZSGFClient::ExternalAccountBindRequest.new(
   union_id: null,
   platform: null,
   platform_name: null,

data/docs/{OAuthAccountPutBindRequest.md → ExternalAccountPutRequest.md}

@@ -1,4 +1,4 @@
-# ZSGFClient::OAuthAccountPutBindRequest
+# ZSGFClient::ExternalAccountPutRequest
 
 ## Properties
 
@@ -13,7 +13,7 @@
 ```ruby
 require 'zsgf_client'
 
-instance = ZSGFClient::OAuthAccountPutBindRequest.new(
+instance = ZSGFClient::ExternalAccountPutRequest.new(
   avatar: null,
   data: null,
   enable: null

data/docs/{OAuthAccountSignInRequest.md → ExternalAccountSignInRequest.md}

@@ -1,4 +1,4 @@
-# ZSGFClient::OAuthAccountSignInRequest
+# ZSGFClient::ExternalAccountSignInRequest
 
 ## Properties
 
@@ -13,7 +13,7 @@
 ```ruby
 require 'zsgf_client'
 
-instance = ZSGFClient::OAuthAccountSignInRequest.new(
+instance = ZSGFClient::ExternalAccountSignInRequest.new(
   union_id: null,
   platform: null,
   two_factor_code: null

data/docs/FileApi.md

@@ -1,12 +1,12 @@
 # ZSGFClient::FileApi
 
-All URIs are relative to *https://api.zashigaofa.cn*
+All URIs are relative to *https://api-dev.zashigaofa.cn*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
 | [**file_create_folder**](FileApi.md#file_create_folder) | **POST** /File/{appKey}/CreateFolder | 创建文件夹 |
-| [**file_delete**](FileApi.md#file_delete) | **DELETE** /File/{appKey} | 删除文件或文件夹 |
-| [**file_rename**](FileApi.md#file_rename) | **POST** /File/{appKey}/Rename | 重命名文件或文件夹 |
+| [**file_delete**](FileApi.md#file_delete) | **DELETE** /File/{appKey} | 删除文件 / 文件夹 |
+| [**file_rename**](FileApi.md#file_rename) | **POST** /File/{appKey}/Rename | 重命名文件 / 文件夹 |
 | [**file_upload**](FileApi.md#file_upload) | **POST** /File/{appKey}/Upload | 上传文件 |
 | [**files**](FileApi.md#files) | **GET** /File/{appKey} | 获取文件列表 |
 
@@ -88,7 +88,7 @@ end
 
 > <BooleanApiResponse> file_delete(app_key, opts)
 
-删除文件或文件夹
+删除文件 / 文件夹
 
 根据指定路径删除文件或文件夹
 
@@ -106,11 +106,11 @@ end
 api_instance = ZSGFClient::FileApi.new
 app_key = 'app_key_example' # String | 
 opts = {
-  path: 'path_example' # String | 文件或文件夹路径
+  path: 'path_example' # String | 文件 / 文件夹路径
 }
 
 begin
-  # 删除文件或文件夹
+  # 删除文件 / 文件夹
   result = api_instance.file_delete(app_key, opts)
   p result
 rescue ZSGFClient::ApiError => e
@@ -126,7 +126,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # 删除文件或文件夹
+  # 删除文件 / 文件夹
   data, status_code, headers = api_instance.file_delete_with_http_info(app_key, opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -141,7 +141,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **app_key** | **String** |  |  |
-| **path** | **String** | 文件或文件夹路径 | [optional] |
+| **path** | **String** | 文件 / 文件夹路径 | [optional] |
 
 ### Return type
 
@@ -161,7 +161,7 @@ end
 
 > <BooleanApiResponse> file_rename(app_key, opts)
 
-重命名文件或文件夹
+重命名文件 / 文件夹
 
 将指定的文件或文件夹重命名
 
@@ -179,12 +179,12 @@ end
 api_instance = ZSGFClient::FileApi.new
 app_key = 'app_key_example' # String | 
 opts = {
-  source_name: 'source_name_example', # String | 原文件或文件夹名称
-  dest_name: 'dest_name_example' # String | 新文件或文件夹名称
+  source_name: 'source_name_example', # String | 原文件 / 文件夹名称
+  dest_name: 'dest_name_example' # String | 新文件 / 文件夹名称
 }
 
 begin
-  # 重命名文件或文件夹
+  # 重命名文件 / 文件夹
   result = api_instance.file_rename(app_key, opts)
   p result
 rescue ZSGFClient::ApiError => e
@@ -200,7 +200,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # 重命名文件或文件夹
+  # 重命名文件 / 文件夹
   data, status_code, headers = api_instance.file_rename_with_http_info(app_key, opts)
   p status_code # => 2xx
   p headers # => { ... }
@@ -215,8 +215,8 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **app_key** | **String** |  |  |
-| **source_name** | **String** | 原文件或文件夹名称 | [optional] |
-| **dest_name** | **String** | 新文件或文件夹名称 | [optional] |
+| **source_name** | **String** | 原文件 / 文件夹名称 | [optional] |
+| **dest_name** | **String** | 新文件 / 文件夹名称 | [optional] |
 
 ### Return type
 

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 |
 | ------ | ------------ | ----------- |