zsgf_client 1.0.25 → 2.0.0

data/docs/AppSettingApiResponse.md

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

data/docs/AppSettingGroupPostResult.md

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

data/docs/AppSettingGroupPostResultApiResponse.md

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

data/docs/AppSettingItemPostResult.md

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

data/docs/AppSettingItemPostResultApiResponse.md

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

data/docs/AppSettingListApiResponse.md

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

data/docs/AppSettingProviderPostResult.md

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

data/docs/AppSettingProviderPostResultApiResponse.md

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

data/docs/AppSettingSettingPostResult.md

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

data/docs/AppSettingSettingPostResultApiResponse.md

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

data/docs/AppUserListResponse.md

@@ -1,40 +0,0 @@
-# ZSGFClient::AppUserListResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **Integer** | 用户ID | [optional] |
-| **union_id** | **String** | 用户的联合ID | [optional] |
-| **platform** | **String** | 用户所在平台 | [optional] |
-| **user_name** | **String** | 用户名 | [optional] |
-| **nick_name** | **String** | 用户昵称 | [optional] |
-| **email** | **String** | 用户邮箱 | [optional] |
-| **phone** | **String** | 用户电话 | [optional] |
-| **avatar** | **String** | 用户头像URL | [optional] |
-| **role** | **String** | 用户角色 | [optional] |
-| **role_id** | **Integer** | 用户角色ID | [optional] |
-| **create_date** | **Time** | 用户创建日期 | [optional] |
-| **last_update** | **Time** | 用户最后更新日期 | [optional] |
-
-## Example
-
-```ruby
-require 'zsgf_client'
-
-instance = ZSGFClient::AppUserListResponse.new(
-  id: null,
-  union_id: null,
-  platform: null,
-  user_name: null,
-  nick_name: null,
-  email: null,
-  phone: null,
-  avatar: null,
-  role: null,
-  role_id: null,
-  create_date: null,
-  last_update: null
-)
-```
-

data/docs/AuthorizePolicy.md

@@ -1,28 +0,0 @@
-# ZSGFClient::AuthorizePolicy
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **Integer** | 鉴权策略的唯一标识符。 | [optional] |
-| **policy_name** | **String** | 鉴权策略的名称。根据鉴权类型填写不同的名称：角色类型填写角色名称，用户类型填写用户ID，访问令牌类型填写令牌ID。 | [optional] |
-| **authorize_type** | **String** | 鉴权策略的类型，可选值为 'access_token', 'user', 或 'role'。 | [optional] |
-| **policy_value** | **String** | 与鉴权策略关联的权限集合，多个权限可以用逗号分隔。 | [optional] |
-| **create_date** | **Time** | 鉴权策略的创建日期，默认为当前时间。 | [optional] |
-| **last_update** | **Time** | 鉴权策略的最后更新日期，默认为当前时间。 | [optional] |
-
-## Example
-
-```ruby
-require 'zsgf_client'
-
-instance = ZSGFClient::AuthorizePolicy.new(
-  id: null,
-  policy_name: null,
-  authorize_type: null,
-  policy_value: null,
-  create_date: null,
-  last_update: null
-)
-```
-

data/docs/AuthorizePolicyApi.md

@@ -1,377 +0,0 @@
-# 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

@@ -1,22 +0,0 @@
-# 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
-)
-```
-