zsgf_client 1.0.18

data/docs/FileApi.md

@@ -0,0 +1,385 @@
+# ZSGFClient::FileApi
+
+All URIs are relative to *https://api.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_upload**](FileApi.md#file_upload) | **POST** /File/{appKey}/Upload | 上传文件 |
+| [**files**](FileApi.md#files) | **GET** /File/{appKey} | 获取文件列表 |
+
+
+## file_create_folder
+
+> <BooleanApiResponse> file_create_folder(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::FileApi.new
+app_key = 'app_key_example' # String | 
+opts = {
+  path: 'path_example' # String | 文件夹路径
+}
+
+begin
+  # 创建文件夹
+  result = api_instance.file_create_folder(app_key, opts)
+  p result
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling FileApi->file_create_folder: #{e}"
+end
+```
+
+#### Using the file_create_folder_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BooleanApiResponse>, Integer, Hash)> file_create_folder_with_http_info(app_key, opts)
+
+```ruby
+begin
+  # 创建文件夹
+  data, status_code, headers = api_instance.file_create_folder_with_http_info(app_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BooleanApiResponse>
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling FileApi->file_create_folder_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_key** | **String** |  |  |
+| **path** | **String** | 文件夹路径 | [optional] |
+
+### Return type
+
+[**BooleanApiResponse**](BooleanApiResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## file_delete
+
+> <BooleanApiResponse> file_delete(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::FileApi.new
+app_key = 'app_key_example' # String | 
+opts = {
+  path: 'path_example' # String | 文件或文件夹路径
+}
+
+begin
+  # 删除文件或文件夹
+  result = api_instance.file_delete(app_key, opts)
+  p result
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling FileApi->file_delete: #{e}"
+end
+```
+
+#### Using the file_delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BooleanApiResponse>, Integer, Hash)> file_delete_with_http_info(app_key, opts)
+
+```ruby
+begin
+  # 删除文件或文件夹
+  data, status_code, headers = api_instance.file_delete_with_http_info(app_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BooleanApiResponse>
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling FileApi->file_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_key** | **String** |  |  |
+| **path** | **String** | 文件或文件夹路径 | [optional] |
+
+### Return type
+
+[**BooleanApiResponse**](BooleanApiResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## file_rename
+
+> <BooleanApiResponse> file_rename(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::FileApi.new
+app_key = 'app_key_example' # String | 
+opts = {
+  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
+  puts "Error when calling FileApi->file_rename: #{e}"
+end
+```
+
+#### Using the file_rename_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BooleanApiResponse>, Integer, Hash)> file_rename_with_http_info(app_key, opts)
+
+```ruby
+begin
+  # 重命名文件或文件夹
+  data, status_code, headers = api_instance.file_rename_with_http_info(app_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BooleanApiResponse>
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling FileApi->file_rename_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_key** | **String** |  |  |
+| **source_name** | **String** | 原文件或文件夹名称 | [optional] |
+| **dest_name** | **String** | 新文件或文件夹名称 | [optional] |
+
+### Return type
+
+[**BooleanApiResponse**](BooleanApiResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## file_upload
+
+> <BooleanApiResponse> file_upload(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::FileApi.new
+app_key = 'app_key_example' # String | 
+opts = {
+  path: 'path_example', # String | 文件夹路径
+  file: File.new('/path/to/some/file') # File | 上传的文件
+}
+
+begin
+  # 上传文件
+  result = api_instance.file_upload(app_key, opts)
+  p result
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling FileApi->file_upload: #{e}"
+end
+```
+
+#### Using the file_upload_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BooleanApiResponse>, Integer, Hash)> file_upload_with_http_info(app_key, opts)
+
+```ruby
+begin
+  # 上传文件
+  data, status_code, headers = api_instance.file_upload_with_http_info(app_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BooleanApiResponse>
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling FileApi->file_upload_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_key** | **String** |  |  |
+| **path** | **String** | 文件夹路径 | [optional] |
+| **file** | **File** | 上传的文件 | [optional] |
+
+### Return type
+
+[**BooleanApiResponse**](BooleanApiResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data
+- **Accept**: application/json
+
+
+## files
+
+> <FileListResultApiResponse> files(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::FileApi.new
+app_key = 'app_key_example' # String | 
+opts = {
+  path: 'path_example', # String | 文件路径
+  skip: 56, # Integer | 跳过的记录数
+  take: 56 # Integer | 获取的记录数
+}
+
+begin
+  # 获取文件列表
+  result = api_instance.files(app_key, opts)
+  p result
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling FileApi->files: #{e}"
+end
+```
+
+#### Using the files_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FileListResultApiResponse>, Integer, Hash)> files_with_http_info(app_key, opts)
+
+```ruby
+begin
+  # 获取文件列表
+  data, status_code, headers = api_instance.files_with_http_info(app_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FileListResultApiResponse>
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling FileApi->files_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_key** | **String** |  |  |
+| **path** | **String** | 文件路径 | [optional] |
+| **skip** | **Integer** | 跳过的记录数 | [optional][default to 0] |
+| **take** | **Integer** | 获取的记录数 | [optional][default to 100] |
+
+### Return type
+
+[**FileListResultApiResponse**](FileListResultApiResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/FileItem.md

@@ -0,0 +1,24 @@
+# ZSGFClient::FileItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **create_date** | **Time** |  | [optional] |
+| **last_update** | **Time** |  | [optional] |
+| **file_size** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::FileItem.new(
+  name: null,
+  create_date: null,
+  last_update: null,
+  file_size: null
+)
+```
+

data/docs/FileListResult.md

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

data/docs/FileListResultApiResponse.md

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

data/docs/FollowerModel.md

@@ -0,0 +1,40 @@
+# ZSGFClient::FollowerModel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [optional] |
+| **target_user_id** | **Integer** |  | [optional] |
+| **_alias** | **String** |  | [optional] |
+| **nick_name** | **String** |  | [optional] |
+| **avatar** | **String** |  | [optional] |
+| **is_mutual** | **Boolean** |  | [optional] |
+| **closeness_score** | **Integer** |  | [optional] |
+| **attention_score** | **Integer** |  | [optional] |
+| **tags** | **String** |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **remark** | **String** |  | [optional] |
+| **create_date** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::FollowerModel.new(
+  id: null,
+  target_user_id: null,
+  _alias: null,
+  nick_name: null,
+  avatar: null,
+  is_mutual: null,
+  closeness_score: null,
+  attention_score: null,
+  tags: null,
+  status: null,
+  remark: null,
+  create_date: null
+)
+```
+

data/docs/FollowerPutModel.md

@@ -0,0 +1,28 @@
+# ZSGFClient::FollowerPutModel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_alias** | **String** |  | [optional] |
+| **closeness_score** | **Integer** |  | [optional] |
+| **attention_score** | **Integer** |  | [optional] |
+| **tags** | **String** |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **remark** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::FollowerPutModel.new(
+  _alias: null,
+  closeness_score: null,
+  attention_score: null,
+  tags: null,
+  status: null,
+  remark: null
+)
+```
+

data/docs/FulfillmentDetail.md

@@ -0,0 +1,22 @@
+# ZSGFClient::FulfillmentDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **fulfillment_amount** | **String** |  | [optional] |
+| **gmt_payment** | **String** |  | [optional] |
+| **out_request_no** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::FulfillmentDetail.new(
+  fulfillment_amount: null,
+  gmt_payment: null,
+  out_request_no: null
+)
+```
+

data/docs/GeoLocationModel.md

@@ -0,0 +1,58 @@
+# ZSGFClient::GeoLocationModel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **latitude** | **Float** | 纬度 | [optional] |
+| **longitude** | **Float** | 经度 | [optional] |
+| **location_name** | **String** | 地点的名称 | [optional] |
+| **location_type** | **String** | 地点的类型，如家庭、工作、学校等 | [optional] |
+| **recipient_name** | **String** | 收货人姓名 | [optional] |
+| **phone_number** | **String** | 收货人联系电话 | [optional] |
+| **email** | **String** | 收货人电子邮件 | [optional] |
+| **country** | **String** | 国家 | [optional] |
+| **state** | **String** | 州/省 | [optional] |
+| **city** | **String** | 城市 | [optional] |
+| **district** | **String** | 区/县 | [optional] |
+| **street** | **String** | 街道 | [optional] |
+| **zip_code** | **String** | 邮政编码 | [optional] |
+| **address** | **String** | 详细的地址信息 | [optional] |
+| **map_type** | **String** | 地址类型，百度、高德、谷歌 | [optional] |
+| **remark** | **String** | 备注 | [optional] |
+| **tags** | **String** | 标签 | [optional] |
+| **enable** | **Boolean** | 启用 | [optional] |
+| **show_index** | **Integer** | 排序 | [optional] |
+| **create_date** | **Time** | 创建时间 | [optional] |
+| **last_update** | **Time** | 最后更新的时间 | [optional] |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::GeoLocationModel.new(
+  latitude: null,
+  longitude: null,
+  location_name: null,
+  location_type: null,
+  recipient_name: null,
+  phone_number: null,
+  email: null,
+  country: null,
+  state: null,
+  city: null,
+  district: null,
+  street: null,
+  zip_code: null,
+  address: null,
+  map_type: null,
+  remark: null,
+  tags: null,
+  enable: null,
+  show_index: null,
+  create_date: null,
+  last_update: null
+)
+```
+

data/docs/GeoLocationModelApiResponse.md

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

data/docs/GeoLocationResponseModel.md

@@ -0,0 +1,60 @@
+# ZSGFClient::GeoLocationResponseModel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **latitude** | **Float** | 纬度 | [optional] |
+| **longitude** | **Float** | 经度 | [optional] |
+| **location_name** | **String** | 地点的名称 | [optional] |
+| **location_type** | **String** | 地点的类型，如家庭、工作、学校等 | [optional] |
+| **recipient_name** | **String** | 收货人姓名 | [optional] |
+| **phone_number** | **String** | 收货人联系电话 | [optional] |
+| **email** | **String** | 收货人电子邮件 | [optional] |
+| **country** | **String** | 国家 | [optional] |
+| **state** | **String** | 州/省 | [optional] |
+| **city** | **String** | 城市 | [optional] |
+| **district** | **String** | 区/县 | [optional] |
+| **street** | **String** | 街道 | [optional] |
+| **zip_code** | **String** | 邮政编码 | [optional] |
+| **address** | **String** | 详细的地址信息 | [optional] |
+| **map_type** | **String** | 地址类型，百度、高德、谷歌 | [optional] |
+| **remark** | **String** | 备注 | [optional] |
+| **tags** | **String** | 标签 | [optional] |
+| **enable** | **Boolean** | 启用 | [optional] |
+| **show_index** | **Integer** | 排序 | [optional] |
+| **create_date** | **Time** | 创建时间 | [optional] |
+| **last_update** | **Time** | 最后更新的时间 | [optional] |
+| **id** | **Integer** | ID | [optional] |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::GeoLocationResponseModel.new(
+  latitude: null,
+  longitude: null,
+  location_name: null,
+  location_type: null,
+  recipient_name: null,
+  phone_number: null,
+  email: null,
+  country: null,
+  state: null,
+  city: null,
+  district: null,
+  street: null,
+  zip_code: null,
+  address: null,
+  map_type: null,
+  remark: null,
+  tags: null,
+  enable: null,
+  show_index: null,
+  create_date: null,
+  last_update: null,
+  id: null
+)
+```
+