zsgf_client 1.0.18

data/docs/ProjectApi.md

@@ -0,0 +1,367 @@
+# ZSGFClient::ProjectApi
+
+All URIs are relative to *https://api.zashigaofa.cn*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**project**](ProjectApi.md#project) | **GET** /Project/{id} | 项目详情 |
+| [**project_delete**](ProjectApi.md#project_delete) | **DELETE** /Project/{id} | 删除项目 |
+| [**project_post**](ProjectApi.md#project_post) | **POST** /Project | 创建项目 |
+| [**project_put**](ProjectApi.md#project_put) | **PUT** /Project/{id} | 更新项目 |
+| [**projects**](ProjectApi.md#projects) | **GET** /Project | 项目列表 |
+
+
+## project
+
+> <ProjectApiResponse> project(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::ProjectApi.new
+id = 789 # Integer | 
+
+begin
+  # 项目详情
+  result = api_instance.project(id)
+  p result
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling ProjectApi->project: #{e}"
+end
+```
+
+#### Using the project_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ProjectApiResponse>, Integer, Hash)> project_with_http_info(id)
+
+```ruby
+begin
+  # 项目详情
+  data, status_code, headers = api_instance.project_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ProjectApiResponse>
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling ProjectApi->project_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+
+### Return type
+
+[**ProjectApiResponse**](ProjectApiResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## project_delete
+
+> <BooleanApiResponse> project_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::ProjectApi.new
+id = 789 # Integer | 
+
+begin
+  # 删除项目
+  result = api_instance.project_delete(id)
+  p result
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling ProjectApi->project_delete: #{e}"
+end
+```
+
+#### Using the project_delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BooleanApiResponse>, Integer, Hash)> project_delete_with_http_info(id)
+
+```ruby
+begin
+  # 删除项目
+  data, status_code, headers = api_instance.project_delete_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BooleanApiResponse>
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling ProjectApi->project_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+
+### Return type
+
+[**BooleanApiResponse**](BooleanApiResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## project_post
+
+> <PostResultApiResponse> project_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::ProjectApi.new
+opts = {
+  project: ZSGFClient::Project.new # Project | 
+}
+
+begin
+  # 创建项目
+  result = api_instance.project_post(opts)
+  p result
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling ProjectApi->project_post: #{e}"
+end
+```
+
+#### Using the project_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PostResultApiResponse>, Integer, Hash)> project_post_with_http_info(opts)
+
+```ruby
+begin
+  # 创建项目
+  data, status_code, headers = api_instance.project_post_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PostResultApiResponse>
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling ProjectApi->project_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project** | [**Project**](Project.md) |  | [optional] |
+
+### Return type
+
+[**PostResultApiResponse**](PostResultApiResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
+- **Accept**: application/json
+
+
+## project_put
+
+> <BooleanApiResponse> project_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::ProjectApi.new
+id = 'id_example' # String | 
+opts = {
+  project: ZSGFClient::Project.new # Project | 
+}
+
+begin
+  # 更新项目
+  result = api_instance.project_put(id, opts)
+  p result
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling ProjectApi->project_put: #{e}"
+end
+```
+
+#### Using the project_put_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BooleanApiResponse>, Integer, Hash)> project_put_with_http_info(id, opts)
+
+```ruby
+begin
+  # 更新项目
+  data, status_code, headers = api_instance.project_put_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BooleanApiResponse>
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling ProjectApi->project_put_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **project** | [**Project**](Project.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
+
+
+## projects
+
+> <ProjectListResultApiResponse> projects(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::ProjectApi.new
+opts = {
+  skip: 56, # Integer | 
+  take: 56 # Integer | 
+}
+
+begin
+  # 项目列表
+  result = api_instance.projects(opts)
+  p result
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling ProjectApi->projects: #{e}"
+end
+```
+
+#### Using the projects_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ProjectListResultApiResponse>, Integer, Hash)> projects_with_http_info(opts)
+
+```ruby
+begin
+  # 项目列表
+  data, status_code, headers = api_instance.projects_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ProjectListResultApiResponse>
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling ProjectApi->projects_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **skip** | **Integer** |  | [optional] |
+| **take** | **Integer** |  | [optional] |
+
+### Return type
+
+[**ProjectListResultApiResponse**](ProjectListResultApiResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ProjectApiResponse.md

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

data/docs/ProjectListResult.md

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

data/docs/ProjectListResultApiResponse.md

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

data/docs/QRCodePreSignInRequest.md

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

data/docs/QRCodeScanRequest.md

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

data/docs/QRCodeSignInRequest.md

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

data/docs/QRCodeSignUpRequest.md

@@ -0,0 +1,34 @@
+# ZSGFClient::QRCodeSignUpRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sign_in_key** | **Integer** |  | [optional] |
+| **union_id** | **String** |  |  |
+| **nick_name** | **String** | 昵称 | [optional] |
+| **avatar** | **String** | 头像 | [optional] |
+| **data** | **String** | 自定义数据 | [optional] |
+| **email** | **String** | 邮箱 | [optional] |
+| **email_code** | **String** | 邮箱验证码（只有启用的邮箱验证码功能时，才需要传入） | [optional] |
+| **phone** | **String** | 手机号 | [optional] |
+| **phone_code** | **String** | 手机验证码（只有启用的手机验证码功能时，才需要传入） | [optional] |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::QRCodeSignUpRequest.new(
+  sign_in_key: null,
+  union_id: null,
+  nick_name: null,
+  avatar: null,
+  data: null,
+  email: null,
+  email_code: null,
+  phone: null,
+  phone_code: null
+)
+```
+

data/docs/RechargePointRequest.md

@@ -0,0 +1,26 @@
+# ZSGFClient::RechargePointRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **currency** | **String** | 虚拟币代码 |  |
+| **balance** | **Integer** | 充值额 |  |
+| **remark** | **String** | 备注 | [optional] |
+| **description** | **String** | 描述 | [optional] |
+| **tags** | **String** | 标签 | [optional] |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::RechargePointRequest.new(
+  currency: null,
+  balance: null,
+  remark: null,
+  description: null,
+  tags: null
+)
+```
+

data/docs/RecommendFriend.md

@@ -0,0 +1,36 @@
+# ZSGFClient::RecommendFriend
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **Integer** |  | [optional] |
+| **nick_name** | **String** |  | [optional] |
+| **avatar** | **String** |  | [optional] |
+| **gender** | **String** |  | [optional] |
+| **age** | **Integer** |  | [optional] |
+| **interest_tags** | **String** |  | [optional] |
+| **location_name** | **String** |  | [optional] |
+| **latitude** | **Float** |  | [optional] |
+| **longitude** | **Float** |  | [optional] |
+| **distance** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::RecommendFriend.new(
+  user_id: null,
+  nick_name: null,
+  avatar: null,
+  gender: null,
+  age: null,
+  interest_tags: null,
+  location_name: null,
+  latitude: null,
+  longitude: null,
+  distance: null
+)
+```
+

data/docs/RefundChargeInfo.md

@@ -0,0 +1,24 @@
+# ZSGFClient::RefundChargeInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **charge_type** | **String** |  | [optional] |
+| **refund_charge_fee** | **String** |  | [optional] |
+| **refund_sub_fee_detail_list** | [**Array<RefundSubFee>**](RefundSubFee.md) |  | [optional] |
+| **switch_fee_rate** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::RefundChargeInfo.new(
+  charge_type: null,
+  refund_charge_fee: null,
+  refund_sub_fee_detail_list: null,
+  switch_fee_rate: null
+)
+```
+

data/docs/RefundSubFee.md

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

data/docs/ReturnPageNotifyRequest.md

@@ -0,0 +1,40 @@
+# ZSGFClient::ReturnPageNotifyRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | 应用ID | [optional] |
+| **auth_app_id** | **String** | 授权应用ID | [optional] |
+| **charset** | **String** | 字符集 | [optional] |
+| **method** | **String** | 接口名称 | [optional] |
+| **out_trade_no** | **String** | 商户订单号 | [optional] |
+| **seller_id** | **String** | 卖家支付宝用户号 | [optional] |
+| **sign** | **String** | 签名 | [optional] |
+| **sign_type** | **String** | 签名类型 | [optional] |
+| **timestamp** | **String** | 时间戳 | [optional] |
+| **total_amount** | **String** | 订单总金额 | [optional] |
+| **trade_no** | **String** | 支付宝交易号 | [optional] |
+| **version** | **String** | 接口版本 | [optional] |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::ReturnPageNotifyRequest.new(
+  app_id: null,
+  auth_app_id: null,
+  charset: null,
+  method: null,
+  out_trade_no: null,
+  seller_id: null,
+  sign: null,
+  sign_type: null,
+  timestamp: null,
+  total_amount: null,
+  trade_no: null,
+  version: null
+)
+```
+

data/docs/SendEmailCodeRequest.md

@@ -0,0 +1,20 @@
+# ZSGFClient::SendEmailCodeRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  |  |
+| **type** | **String** | 用途。可选值：signup/forgetpwd |  |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::SendEmailCodeRequest.new(
+  email: null,
+  type: null
+)
+```
+