zsgf_client 1.0.18

data/docs/GoodsDetail.md

@@ -0,0 +1,38 @@
+# ZSGFClient::GoodsDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **alipay_goods_id** | **String** |  | [optional] |
+| **body** | **String** |  | [optional] |
+| **categories_tree** | **String** |  | [optional] |
+| **goods_category** | **String** |  | [optional] |
+| **goods_id** | **String** |  | [optional] |
+| **goods_name** | **String** |  | [optional] |
+| **out_item_id** | **String** |  | [optional] |
+| **out_sku_id** | **String** |  | [optional] |
+| **price** | **String** |  | [optional] |
+| **quantity** | **Integer** |  | [optional] |
+| **show_url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::GoodsDetail.new(
+  alipay_goods_id: null,
+  body: null,
+  categories_tree: null,
+  goods_category: null,
+  goods_id: null,
+  goods_name: null,
+  out_item_id: null,
+  out_sku_id: null,
+  price: null,
+  quantity: null,
+  show_url: null
+)
+```
+

data/docs/GrantRequest.md

@@ -0,0 +1,32 @@
+# ZSGFClient::GrantRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **redirect_uri** | **String** | 返回地址。默认无限制，也可在【安全-开放认证网址白名单】配置 | [optional] |
+| **grant_type** | **String** | 授权类型。可选：email、phone、unionid、account |  |
+| **scopes** | **String** | 自定义授权范围，用英文空格分隔 |  |
+| **user_name** | **String** | 用户名。授权类型为：email/phone/account必填 | [optional] |
+| **password** | **String** | 登录密码。授权类型为：email/phone/account必填 | [optional] |
+| **union_id** | **String** | unionId。授权类型为：unionid必填 | [optional] |
+| **platform** | **String** | 平台。授权类型为：unionid必填 | [optional] |
+| **expire_in_days** | **Integer** | 授权有效期。1~99天 | [optional] |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::GrantRequest.new(
+  redirect_uri: null,
+  grant_type: null,
+  scopes: null,
+  user_name: null,
+  password: null,
+  union_id: null,
+  platform: null,
+  expire_in_days: null
+)
+```
+

data/docs/GrantResult.md

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

data/docs/GrantResultApiResponse.md

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

data/docs/HbFqPayInfo.md

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

data/docs/Int64ApiResponse.md

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

data/docs/IntactChargeInfo.md

@@ -0,0 +1,40 @@
+# ZSGFClient::IntactChargeInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **actual_amount** | **String** |  | [optional] |
+| **bill_type** | **String** |  | [optional] |
+| **gmt_pay** | **String** |  | [optional] |
+| **is_refund** | **Boolean** |  | [optional] |
+| **out_biz_no** | **String** |  | [optional] |
+| **plan_amount** | **String** |  | [optional] |
+| **product_name** | **String** |  | [optional] |
+| **service_target** | **String** |  | [optional] |
+| **service_type** | **String** |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **target_account_no** | **String** |  | [optional] |
+| **target_user_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::IntactChargeInfo.new(
+  actual_amount: null,
+  bill_type: null,
+  gmt_pay: null,
+  is_refund: null,
+  out_biz_no: null,
+  plan_amount: null,
+  product_name: null,
+  service_target: null,
+  service_type: null,
+  status: null,
+  target_account_no: null,
+  target_user_id: null
+)
+```
+

data/docs/ListResponseItem.md

@@ -0,0 +1,36 @@
+# ZSGFClient::ListResponseItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [optional] |
+| **user_id** | **Integer** |  | [optional] |
+| **user_name** | **String** |  | [optional] |
+| **nick_name** | **String** |  | [optional] |
+| **avatar** | **String** |  | [optional] |
+| **email** | **String** |  | [optional] |
+| **phone** | **String** |  | [optional] |
+| **role** | **String** |  | [optional] |
+| **permission** | **String** |  | [optional] |
+| **last_update** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::ListResponseItem.new(
+  id: null,
+  user_id: null,
+  user_name: null,
+  nick_name: null,
+  avatar: null,
+  email: null,
+  phone: null,
+  role: null,
+  permission: null,
+  last_update: null
+)
+```
+

data/docs/ListResponseItemListApiResponse.md

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

data/docs/OAuthAccountBindRequest.md

@@ -0,0 +1,26 @@
+# ZSGFClient::OAuthAccountBindRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **union_id** | **String** |  |  |
+| **platform** | **String** |  |  |
+| **platform_name** | **String** |  |  |
+| **avatar** | **String** |  | [optional] |
+| **data** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::OAuthAccountBindRequest.new(
+  union_id: null,
+  platform: null,
+  platform_name: null,
+  avatar: null,
+  data: null
+)
+```
+

data/docs/OAuthAccountPutBindRequest.md

@@ -0,0 +1,22 @@
+# ZSGFClient::OAuthAccountPutBindRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **avatar** | **String** | 头像 | [optional] |
+| **data** | **String** | 自定义数据 | [optional] |
+| **enable** | **Boolean** | 启用 | [optional] |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::OAuthAccountPutBindRequest.new(
+  avatar: null,
+  data: null,
+  enable: null
+)
+```
+

data/docs/OAuthAccountSignInRequest.md

@@ -0,0 +1,22 @@
+# ZSGFClient::OAuthAccountSignInRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **union_id** | **String** |  |  |
+| **platform** | **String** |  |  |
+| **two_factor_code** | **String** | 如果启用双因素认证登录，则必填 | [optional] |
+
+## Example
+
+```ruby
+require 'zsgf_client'
+
+instance = ZSGFClient::OAuthAccountSignInRequest.new(
+  union_id: null,
+  platform: null,
+  two_factor_code: null
+)
+```
+

data/docs/OAuthApi.md

@@ -0,0 +1,361 @@
+# ZSGFClient::OAuthApi
+
+All URIs are relative to *https://api.zashigaofa.cn*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**o_auth_authorize**](OAuthApi.md#o_auth_authorize) | **POST** /OAuth/{appKey}/Authorize | 获取access_token |
+| [**o_auth_consents**](OAuthApi.md#o_auth_consents) | **GET** /OAuth/{appKey}/Consents | 授权记录 |
+| [**o_auth_delete_consent**](OAuthApi.md#o_auth_delete_consent) | **DELETE** /OAuth/{appKey}/Consents/{id} | 删除授权记录 |
+| [**o_auth_grant_code**](OAuthApi.md#o_auth_grant_code) | **POST** /OAuth/{appKey}/GrantCode | 申请授权码 |
+| [**o_auth_profile**](OAuthApi.md#o_auth_profile) | **GET** /OAuth/{appKey}/Profile | 获取个人资料 |
+
+
+## o_auth_authorize
+
+> <AuthorizeResultApiResponse> o_auth_authorize(app_key, opts)
+
+获取access_token
+
+### 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::OAuthApi.new
+app_key = 'app_key_example' # String | 
+opts = {
+  scheme: 'scheme_example', # String | 身份源
+  code: 'code_example' # String | 授权码
+}
+
+begin
+  # 获取access_token
+  result = api_instance.o_auth_authorize(app_key, opts)
+  p result
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling OAuthApi->o_auth_authorize: #{e}"
+end
+```
+
+#### Using the o_auth_authorize_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AuthorizeResultApiResponse>, Integer, Hash)> o_auth_authorize_with_http_info(app_key, opts)
+
+```ruby
+begin
+  # 获取access_token
+  data, status_code, headers = api_instance.o_auth_authorize_with_http_info(app_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AuthorizeResultApiResponse>
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling OAuthApi->o_auth_authorize_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_key** | **String** |  |  |
+| **scheme** | **String** | 身份源 | [optional] |
+| **code** | **String** | 授权码 | [optional] |
+
+### Return type
+
+[**AuthorizeResultApiResponse**](AuthorizeResultApiResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## o_auth_consents
+
+> <AppUserConsentModelListApiResponse> o_auth_consents(app_key)
+
+授权记录
+
+### 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::OAuthApi.new
+app_key = 'app_key_example' # String | 
+
+begin
+  # 授权记录
+  result = api_instance.o_auth_consents(app_key)
+  p result
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling OAuthApi->o_auth_consents: #{e}"
+end
+```
+
+#### Using the o_auth_consents_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AppUserConsentModelListApiResponse>, Integer, Hash)> o_auth_consents_with_http_info(app_key)
+
+```ruby
+begin
+  # 授权记录
+  data, status_code, headers = api_instance.o_auth_consents_with_http_info(app_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AppUserConsentModelListApiResponse>
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling OAuthApi->o_auth_consents_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_key** | **String** |  |  |
+
+### Return type
+
+[**AppUserConsentModelListApiResponse**](AppUserConsentModelListApiResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## o_auth_delete_consent
+
+> <BooleanApiResponse> o_auth_delete_consent(id, app_key)
+
+删除授权记录
+
+### 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::OAuthApi.new
+id = 789 # Integer | 
+app_key = 'app_key_example' # String | 
+
+begin
+  # 删除授权记录
+  result = api_instance.o_auth_delete_consent(id, app_key)
+  p result
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling OAuthApi->o_auth_delete_consent: #{e}"
+end
+```
+
+#### Using the o_auth_delete_consent_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BooleanApiResponse>, Integer, Hash)> o_auth_delete_consent_with_http_info(id, app_key)
+
+```ruby
+begin
+  # 删除授权记录
+  data, status_code, headers = api_instance.o_auth_delete_consent_with_http_info(id, app_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BooleanApiResponse>
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling OAuthApi->o_auth_delete_consent_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+| **app_key** | **String** |  |  |
+
+### Return type
+
+[**BooleanApiResponse**](BooleanApiResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## o_auth_grant_code
+
+> <GrantResultApiResponse> o_auth_grant_code(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::OAuthApi.new
+app_key = 'app_key_example' # String | 
+opts = {
+  scheme: 'scheme_example', # String | 身份源，固定填：app
+  grant_request: ZSGFClient::GrantRequest.new({grant_type: 'grant_type_example', scopes: 'scopes_example'}) # GrantRequest | 授权详情
+}
+
+begin
+  # 申请授权码
+  result = api_instance.o_auth_grant_code(app_key, opts)
+  p result
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling OAuthApi->o_auth_grant_code: #{e}"
+end
+```
+
+#### Using the o_auth_grant_code_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GrantResultApiResponse>, Integer, Hash)> o_auth_grant_code_with_http_info(app_key, opts)
+
+```ruby
+begin
+  # 申请授权码
+  data, status_code, headers = api_instance.o_auth_grant_code_with_http_info(app_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GrantResultApiResponse>
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling OAuthApi->o_auth_grant_code_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_key** | **String** |  |  |
+| **scheme** | **String** | 身份源，固定填：app | [optional] |
+| **grant_request** | [**GrantRequest**](GrantRequest.md) | 授权详情 | [optional] |
+
+### Return type
+
+[**GrantResultApiResponse**](GrantResultApiResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
+- **Accept**: application/json
+
+
+## o_auth_profile
+
+> <ProfileResultApiResponse> o_auth_profile(app_key)
+
+获取个人资料
+
+### 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::OAuthApi.new
+app_key = 'app_key_example' # String | 
+
+begin
+  # 获取个人资料
+  result = api_instance.o_auth_profile(app_key)
+  p result
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling OAuthApi->o_auth_profile: #{e}"
+end
+```
+
+#### Using the o_auth_profile_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ProfileResultApiResponse>, Integer, Hash)> o_auth_profile_with_http_info(app_key)
+
+```ruby
+begin
+  # 获取个人资料
+  data, status_code, headers = api_instance.o_auth_profile_with_http_info(app_key)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ProfileResultApiResponse>
+rescue ZSGFClient::ApiError => e
+  puts "Error when calling OAuthApi->o_auth_profile_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_key** | **String** |  |  |
+
+### Return type
+
+[**ProfileResultApiResponse**](ProfileResultApiResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+