zsgf_client 1.0.25 → 2.0.0

data/docs/SystemFileListResult.md

@@ -1,22 +0,0 @@
-# ZSGFClient::SystemFileListResult
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **directories** | [**Array<SystemDirectoryItem>**](SystemDirectoryItem.md) |  | [optional] |
-| **files** | [**Array<SystemFileItem>**](SystemFileItem.md) |  | [optional] |
-| **size** | **Integer** |  | [optional] |
-
-## Example
-
-```ruby
-require 'zsgf_client'
-
-instance = ZSGFClient::SystemFileListResult.new(
-  directories: null,
-  files: null,
-  size: null
-)
-```
-

data/docs/SystemFileListResultApiResponse.md

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

data/docs/Team.md

@@ -1,36 +0,0 @@
-# ZSGFClient::Team
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **Integer** | ID | [optional] |
-| **user_id** | **Integer** | 用户ID | [optional] |
-| **channel_code** | **String** | 渠道代码 | [optional] |
-| **channel_app_id** | **String** | 渠道应用ID | [optional] |
-| **role** | **String** | 角色 | [optional] |
-| **permission** | **String** | 权限 | [optional] |
-| **show** | **Boolean** | 是否显示 | [optional] |
-| **show_index** | **Integer** | 显示顺序 | [optional] |
-| **create_date** | **Time** | 创建日期 | [optional] |
-| **last_update** | **Time** | 最后更新日期 | [optional] |
-
-## Example
-
-```ruby
-require 'zsgf_client'
-
-instance = ZSGFClient::Team.new(
-  id: null,
-  user_id: null,
-  channel_code: null,
-  channel_app_id: null,
-  role: null,
-  permission: null,
-  show: null,
-  show_index: null,
-  create_date: null,
-  last_update: null
-)
-```
-

data/docs/TeamApi.md

@@ -1,297 +0,0 @@
-# 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/UserApiResponse.md

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

data/docs/UserListResult.md

@@ -1,20 +0,0 @@
-# ZSGFClient::UserListResult
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **total** | **Integer** |  | [optional] |
-| **data** | [**Array<AppUserListResponse>**](AppUserListResponse.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'zsgf_client'
-
-instance = ZSGFClient::UserListResult.new(
-  total: null,
-  data: null
-)
-```
-

data/docs/UserListResultApiResponse.md

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

data/docs/UserSetting.md

@@ -1,38 +0,0 @@
-# ZSGFClient::UserSetting
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **Integer** | 用户的唯一标识符。 | [optional] |
-| **user_id** | **Integer** | 关联的用户ID，表示该配置属于哪个用户。 |  |
-| **provider_code** | **String** | 提供商的唯一代码，用于标识服务提供者。 | [optional] |
-| **group_code** | **String** | 组的唯一代码，用于分类设置项。 | [optional] |
-| **code** | **String** | 设置项的唯一代码或键名，用于标识具体的配置项。 |  |
-| **value** | **String** | 设置项的具体值或选项。 |  |
-| **tags** | **String** | 用于对设置项进行分类或标记的标签。 | [optional] |
-| **description** | **String** | 设置项的详细描述，说明其作用或用途。 | [optional] |
-| **frontend_usable** | **Boolean** | 指示该设置项是否在前端界面中可用。 | [optional] |
-| **create_date** | **Time** | 设置项的创建时间。 | [optional] |
-| **last_update** | **Time** | 设置项的最后更新时间。 | [optional] |
-
-## Example
-
-```ruby
-require 'zsgf_client'
-
-instance = ZSGFClient::UserSetting.new(
-  id: null,
-  user_id: null,
-  provider_code: null,
-  group_code: null,
-  code: null,
-  value: null,
-  tags: null,
-  description: null,
-  frontend_usable: null,
-  create_date: null,
-  last_update: null
-)
-```
-