zsgf_client 1.0.18

data/docs/AuthorizePolicyApi.md

@@ -0,0 +1,377 @@
+# ZSGFClient::AuthorizePolicyApi
+
+All URIs are relative to *https://api.zashigaofa.cn*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**authorize_policies**](AuthorizePolicyApi.md#authorize_policies) | **GET** /AuthorizePolicy/{appKey} | 获取鉴权策略列表 |
+| [**authorize_policy**](AuthorizePolicyApi.md#authorize_policy) | **GET** /AuthorizePolicy/{appKey}/{id} | 获取鉴权策略详情 |
+| [**authorize_policy_delete**](AuthorizePolicyApi.md#authorize_policy_delete) | **DELETE** /AuthorizePolicy/{appKey}/{id} | 删除鉴权策略 |
+| [**authorize_policy_post**](AuthorizePolicyApi.md#authorize_policy_post) | **POST** /AuthorizePolicy/{appKey} | 添加鉴权策略 |
+| [**authorize_policy_put**](AuthorizePolicyApi.md#authorize_policy_put) | **PUT** /AuthorizePolicy/{appKey}/{id} | 更新鉴权策略 |
+
+
+## authorize_policies
+
+> <AuthorizePolicyListApiResponse> authorize_policies(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::AuthorizePolicyApi.new
+app_key = 'app_key_example' # String | 
+opts = {
+  auth_type: 'auth_type_example', # String | 鉴权类型（access_token、user、role）
+  policy_name: 'policy_name_example' # String | 策略名称
+}
+
+begin
+  # 获取鉴权策略列表
+  result = api_instance.authorize_policies(app_key, opts)
+  p result
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling AuthorizePolicyApi->authorize_policies: #{e}"
+end
+```
+
+#### Using the authorize_policies_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AuthorizePolicyListApiResponse>, Integer, Hash)> authorize_policies_with_http_info(app_key, opts)
+
+```ruby
+begin
+  # 获取鉴权策略列表
+  data, status_code, headers = api_instance.authorize_policies_with_http_info(app_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AuthorizePolicyListApiResponse>
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling AuthorizePolicyApi->authorize_policies_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_key** | **String** |  |  |
+| **auth_type** | **String** | 鉴权类型（access_token、user、role） | [optional] |
+| **policy_name** | **String** | 策略名称 | [optional] |
+
+### Return type
+
+[**AuthorizePolicyListApiResponse**](AuthorizePolicyListApiResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## authorize_policy
+
+> <AuthorizePolicyApiResponse> authorize_policy(id, app_key)
+
+获取鉴权策略详情
+
+根据鉴权策略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::AuthorizePolicyApi.new
+id = 789 # Integer | 鉴权策略ID
+app_key = 'app_key_example' # String | 
+
+begin
+  # 获取鉴权策略详情
+  result = api_instance.authorize_policy(id, app_key)
+  p result
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling AuthorizePolicyApi->authorize_policy: #{e}"
+end
+```
+
+#### Using the authorize_policy_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AuthorizePolicyApiResponse>, Integer, Hash)> authorize_policy_with_http_info(id, app_key)
+
+```ruby
+begin
+  # 获取鉴权策略详情
+  data, status_code, headers = api_instance.authorize_policy_with_http_info(id, app_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AuthorizePolicyApiResponse>
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling AuthorizePolicyApi->authorize_policy_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | 鉴权策略ID |  |
+| **app_key** | **String** |  |  |
+
+### Return type
+
+[**AuthorizePolicyApiResponse**](AuthorizePolicyApiResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## authorize_policy_delete
+
+> <BooleanApiResponse> authorize_policy_delete(id, app_key)
+
+删除鉴权策略
+
+根据鉴权策略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::AuthorizePolicyApi.new
+id = 789 # Integer | 鉴权策略ID
+app_key = 'app_key_example' # String | 
+
+begin
+  # 删除鉴权策略
+  result = api_instance.authorize_policy_delete(id, app_key)
+  p result
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling AuthorizePolicyApi->authorize_policy_delete: #{e}"
+end
+```
+
+#### Using the authorize_policy_delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BooleanApiResponse>, Integer, Hash)> authorize_policy_delete_with_http_info(id, app_key)
+
+```ruby
+begin
+  # 删除鉴权策略
+  data, status_code, headers = api_instance.authorize_policy_delete_with_http_info(id, app_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BooleanApiResponse>
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling AuthorizePolicyApi->authorize_policy_delete_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
+
+
+## authorize_policy_post
+
+> <CreatePostResultApiResponse> authorize_policy_post(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::AuthorizePolicyApi.new
+app_key = 'app_key_example' # String | 
+opts = {
+  authorize_policy: ZSGFClient::AuthorizePolicy.new # AuthorizePolicy | 鉴权策略对象
+}
+
+begin
+  # 添加鉴权策略
+  result = api_instance.authorize_policy_post(app_key, opts)
+  p result
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling AuthorizePolicyApi->authorize_policy_post: #{e}"
+end
+```
+
+#### Using the authorize_policy_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreatePostResultApiResponse>, Integer, Hash)> authorize_policy_post_with_http_info(app_key, opts)
+
+```ruby
+begin
+  # 添加鉴权策略
+  data, status_code, headers = api_instance.authorize_policy_post_with_http_info(app_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreatePostResultApiResponse>
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling AuthorizePolicyApi->authorize_policy_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_key** | **String** |  |  |
+| **authorize_policy** | [**AuthorizePolicy**](AuthorizePolicy.md) | 鉴权策略对象 | [optional] |
+
+### Return type
+
+[**CreatePostResultApiResponse**](CreatePostResultApiResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
+- **Accept**: application/json
+
+
+## authorize_policy_put
+
+> <BooleanApiResponse> authorize_policy_put(id, app_key, 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::AuthorizePolicyApi.new
+id = 789 # Integer | 鉴权策略ID
+app_key = 'app_key_example' # String | 
+opts = {
+  authorize_policy: ZSGFClient::AuthorizePolicy.new # AuthorizePolicy | 鉴权策略对象
+}
+
+begin
+  # 更新鉴权策略
+  result = api_instance.authorize_policy_put(id, app_key, opts)
+  p result
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling AuthorizePolicyApi->authorize_policy_put: #{e}"
+end
+```
+
+#### Using the authorize_policy_put_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BooleanApiResponse>, Integer, Hash)> authorize_policy_put_with_http_info(id, app_key, opts)
+
+```ruby
+begin
+  # 更新鉴权策略
+  data, status_code, headers = api_instance.authorize_policy_put_with_http_info(id, app_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BooleanApiResponse>
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling AuthorizePolicyApi->authorize_policy_put_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | 鉴权策略ID |  |
+| **app_key** | **String** |  |  |
+| **authorize_policy** | [**AuthorizePolicy**](AuthorizePolicy.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
+

data/docs/AuthorizePolicyApiResponse.md

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

data/docs/AuthorizePolicyListApiResponse.md

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

data/docs/AuthorizeResult.md

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

data/docs/AuthorizeResultApiResponse.md

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

data/docs/BkAgentRespInfo.md

@@ -0,0 +1,26 @@
+# ZSGFClient::BkAgentRespInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bindclrissr_id** | **String** |  | [optional] |
+| **bindpyeracctbk_id** | **String** |  | [optional] |
+| **bindtrx_id** | **String** |  | [optional] |
+| **bkpyeruser_code** | **String** |  | [optional] |
+| **estter_location** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::BkAgentRespInfo.new(
+  bindclrissr_id: null,
+  bindpyeracctbk_id: null,
+  bindtrx_id: null,
+  bkpyeruser_code: null,
+  estter_location: null
+)
+```
+

data/docs/BooleanApiResponse.md

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

data/docs/ChargeInfo.md

@@ -0,0 +1,30 @@
+# ZSGFClient::ChargeInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **charge_fee** | **String** |  | [optional] |
+| **charge_type** | **String** |  | [optional] |
+| **is_rating_on_switch** | **String** |  | [optional] |
+| **is_rating_on_trade_receiver** | **String** |  | [optional] |
+| **original_charge_fee** | **String** |  | [optional] |
+| **sub_fee_detail_list** | [**Array<SubFee>**](SubFee.md) |  | [optional] |
+| **switch_fee_rate** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::ChargeInfo.new(
+  charge_fee: null,
+  charge_type: null,
+  is_rating_on_switch: null,
+  is_rating_on_trade_receiver: null,
+  original_charge_fee: null,
+  sub_fee_detail_list: null,
+  switch_fee_rate: null
+)
+```
+

data/docs/CommonFriendModel.md

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

data/docs/ContributeDetail.md

@@ -0,0 +1,20 @@
+# ZSGFClient::ContributeDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **contribute_amount** | **String** |  | [optional] |
+| **contribute_type** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::ContributeDetail.new(
+  contribute_amount: null,
+  contribute_type: null
+)
+```
+

data/docs/CreateOrderRequest.md

@@ -0,0 +1,24 @@
+# ZSGFClient::CreateOrderRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Float** |  |  |
+| **product_name** | **String** |  |  |
+| **product_type** | **String** |  |  |
+| **product_id** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::CreateOrderRequest.new(
+  amount: null,
+  product_name: null,
+  product_type: null,
+  product_id: null
+)
+```
+

data/docs/CreateOrderResult.md

@@ -0,0 +1,20 @@
+# ZSGFClient::CreateOrderResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [optional] |
+| **order_no** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::CreateOrderResult.new(
+  id: null,
+  order_no: null
+)
+```
+

data/docs/CreateOrderResultApiResponse.md

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

data/docs/CreatePostResult.md

@@ -0,0 +1,18 @@
+# ZSGFClient::CreatePostResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::CreatePostResult.new(
+  id: null
+)
+```
+