zsgf_client 1.0.18
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +430 -0
- data/Rakefile +10 -0
- data/docs/AccessTokenApi.md +307 -0
- data/docs/AccessTokenListResult.md +20 -0
- data/docs/AccessTokenListResultApiResponse.md +22 -0
- data/docs/AccessTokenPostRequest.md +28 -0
- data/docs/AccessTokenPutRequest.md +26 -0
- data/docs/AlipayApi.md +453 -0
- data/docs/AlipayCreateOrderPagePayRequest.md +24 -0
- data/docs/AlipayCreateOrderRequest.md +24 -0
- data/docs/AlipayCreateOrderWapPayRequest.md +24 -0
- data/docs/AlipayTradeQueryResponse.md +154 -0
- data/docs/AlipayTradeQueryResponseApiResponse.md +22 -0
- data/docs/AlipayTradeRefundResponse.md +76 -0
- data/docs/AlipayTradeRefundResponseApiResponse.md +22 -0
- data/docs/App.md +50 -0
- data/docs/AppApi.md +735 -0
- data/docs/AppApiResponse.md +22 -0
- data/docs/AppCheckVersionResult.md +20 -0
- data/docs/AppCheckVersionResultApiResponse.md +22 -0
- data/docs/AppInfoItem.md +32 -0
- data/docs/AppInfoResult.md +20 -0
- data/docs/AppInfoResultApiResponse.md +22 -0
- data/docs/AppListResult.md +20 -0
- data/docs/AppListResultApiResponse.md +22 -0
- data/docs/AppPostResult.md +20 -0
- data/docs/AppPostResultApiResponse.md +22 -0
- data/docs/AppProperty.md +22 -0
- data/docs/AppSetting.md +36 -0
- data/docs/AppSettingApi.md +1495 -0
- data/docs/AppSettingApiResponse.md +22 -0
- data/docs/AppSettingGroupPostResult.md +18 -0
- data/docs/AppSettingGroupPostResultApiResponse.md +22 -0
- data/docs/AppSettingItemPostResult.md +18 -0
- data/docs/AppSettingItemPostResultApiResponse.md +22 -0
- data/docs/AppSettingListApiResponse.md +22 -0
- data/docs/AppSettingProviderPostResult.md +18 -0
- data/docs/AppSettingProviderPostResultApiResponse.md +22 -0
- data/docs/AppSettingSettingPostResult.md +18 -0
- data/docs/AppSettingSettingPostResultApiResponse.md +22 -0
- data/docs/AppUserConsentModel.md +30 -0
- data/docs/AppUserConsentModelListApiResponse.md +22 -0
- data/docs/AppUserListResponse.md +40 -0
- data/docs/AppUserResetPwdRequest.md +24 -0
- data/docs/AuthorizePolicy.md +28 -0
- data/docs/AuthorizePolicyApi.md +377 -0
- data/docs/AuthorizePolicyApiResponse.md +22 -0
- data/docs/AuthorizePolicyListApiResponse.md +22 -0
- data/docs/AuthorizeResult.md +26 -0
- data/docs/AuthorizeResultApiResponse.md +22 -0
- data/docs/BkAgentRespInfo.md +26 -0
- data/docs/BooleanApiResponse.md +22 -0
- data/docs/ChargeInfo.md +30 -0
- data/docs/CommonFriendModel.md +22 -0
- data/docs/ContributeDetail.md +20 -0
- data/docs/CreateOrderRequest.md +24 -0
- data/docs/CreateOrderResult.md +20 -0
- data/docs/CreateOrderResultApiResponse.md +22 -0
- data/docs/CreatePostResult.md +18 -0
- data/docs/CreatePostResultApiResponse.md +22 -0
- data/docs/Currency.md +48 -0
- data/docs/CurrencyApi.md +677 -0
- data/docs/CurrencyApiResponse.md +22 -0
- data/docs/CurrencyConsumeRequest.md +26 -0
- data/docs/CurrencyExchangeRate.md +30 -0
- data/docs/CurrencyExchangeRateApiResponse.md +22 -0
- data/docs/CurrencyListApiResponse.md +22 -0
- data/docs/CurrencyTransaction.md +40 -0
- data/docs/CurrencyTransactionListApiResponse.md +22 -0
- data/docs/DingTalkApi.md +81 -0
- data/docs/DirectoryItem.md +24 -0
- data/docs/EmailSignInRequest.md +22 -0
- data/docs/EmailSignUpRequest.md +32 -0
- data/docs/EnterprisePayInfo.md +22 -0
- data/docs/ExchangeCurrencyRequest.md +28 -0
- data/docs/ExchangeRatePutRequest.md +22 -0
- data/docs/ExecuteFunctionRequest.md +18 -0
- data/docs/FileApi.md +385 -0
- data/docs/FileItem.md +24 -0
- data/docs/FileListResult.md +26 -0
- data/docs/FileListResultApiResponse.md +22 -0
- data/docs/FollowerModel.md +40 -0
- data/docs/FollowerPutModel.md +28 -0
- data/docs/FulfillmentDetail.md +22 -0
- data/docs/GeoLocationModel.md +58 -0
- data/docs/GeoLocationModelApiResponse.md +22 -0
- data/docs/GeoLocationResponseModel.md +60 -0
- data/docs/GoodsDetail.md +38 -0
- data/docs/GrantRequest.md +32 -0
- data/docs/GrantResult.md +24 -0
- data/docs/GrantResultApiResponse.md +22 -0
- data/docs/HbFqPayInfo.md +20 -0
- data/docs/Int64ApiResponse.md +22 -0
- data/docs/IntactChargeInfo.md +40 -0
- data/docs/ListResponseItem.md +36 -0
- data/docs/ListResponseItemListApiResponse.md +22 -0
- data/docs/OAuthAccountBindRequest.md +26 -0
- data/docs/OAuthAccountPutBindRequest.md +22 -0
- data/docs/OAuthAccountSignInRequest.md +22 -0
- data/docs/OAuthApi.md +361 -0
- data/docs/ObjectApiResponse.md +22 -0
- data/docs/ObjectListApiResponse.md +22 -0
- data/docs/Order.md +54 -0
- data/docs/OrderApi.md +243 -0
- data/docs/OrderApiResponse.md +22 -0
- data/docs/OrderListResult.md +20 -0
- data/docs/OrderListResultApiResponse.md +22 -0
- data/docs/PaymentInfoWithId.md +20 -0
- data/docs/PhoneSignInRequest.md +22 -0
- data/docs/PhoneSignUpRequest.md +32 -0
- data/docs/PostIndexRequest.md +20 -0
- data/docs/PostResult.md +18 -0
- data/docs/PostResultApiResponse.md +22 -0
- data/docs/PresetPayToolInfo.md +20 -0
- data/docs/ProfileResult.md +44 -0
- data/docs/ProfileResultApiResponse.md +22 -0
- data/docs/Project.md +34 -0
- data/docs/ProjectApi.md +367 -0
- data/docs/ProjectApiResponse.md +22 -0
- data/docs/ProjectListResult.md +20 -0
- data/docs/ProjectListResultApiResponse.md +22 -0
- data/docs/QRCodePreSignInRequest.md +22 -0
- data/docs/QRCodeScanRequest.md +18 -0
- data/docs/QRCodeSignInRequest.md +18 -0
- data/docs/QRCodeSignUpRequest.md +34 -0
- data/docs/RechargePointRequest.md +26 -0
- data/docs/RecommendFriend.md +36 -0
- data/docs/RefundChargeInfo.md +24 -0
- data/docs/RefundSubFee.md +20 -0
- data/docs/ReturnPageNotifyRequest.md +40 -0
- data/docs/SendEmailCodeRequest.md +20 -0
- data/docs/SendSMSCodeRequest.md +20 -0
- data/docs/ServiceGroup.md +36 -0
- data/docs/ServiceGroupApiResponse.md +22 -0
- data/docs/ServiceGroupListApiResponse.md +22 -0
- data/docs/ServiceItem.md +48 -0
- data/docs/ServiceItemApiResponse.md +22 -0
- data/docs/ServiceItemListApiResponse.md +22 -0
- data/docs/ServiceProvider.md +38 -0
- data/docs/ServiceProviderApiResponse.md +22 -0
- data/docs/ServiceProviderListApiResponse.md +22 -0
- data/docs/ServiceSettingApi.md +1459 -0
- data/docs/ServiceSettingGroupPostResult.md +18 -0
- data/docs/ServiceSettingGroupPostResultApiResponse.md +22 -0
- data/docs/ServiceSettingItemPostResult.md +18 -0
- data/docs/ServiceSettingItemPostResultApiResponse.md +22 -0
- data/docs/ServiceSettingProviderPostResult.md +18 -0
- data/docs/ServiceSettingProviderPostResultApiResponse.md +22 -0
- data/docs/ServiceSettingSettingPostResult.md +18 -0
- data/docs/ServiceSettingSettingPostResultApiResponse.md +22 -0
- data/docs/Settings.md +40 -0
- data/docs/SettingsApiResponse.md +22 -0
- data/docs/SettingsListApiResponse.md +22 -0
- data/docs/SetupCode.md +22 -0
- data/docs/SetupCodeApiResponse.md +22 -0
- data/docs/SignInRequest.md +22 -0
- data/docs/SignUpRequest.md +34 -0
- data/docs/StorageApi.md +1229 -0
- data/docs/StorageListResult.md +26 -0
- data/docs/StorageListResultApiResponse.md +22 -0
- data/docs/StringApiResponse.md +22 -0
- data/docs/StringListApiResponse.md +22 -0
- data/docs/SubFee.md +22 -0
- data/docs/SystemDirectoryItem.md +24 -0
- data/docs/SystemFileApi.md +371 -0
- data/docs/SystemFileItem.md +24 -0
- data/docs/SystemFileListResult.md +22 -0
- data/docs/SystemFileListResultApiResponse.md +22 -0
- data/docs/TapPayInfo.md +18 -0
- data/docs/Team.md +36 -0
- data/docs/TeamApi.md +297 -0
- data/docs/TokenModel.md +22 -0
- data/docs/TokenModelApiResponse.md +22 -0
- data/docs/TradeFundBill.md +26 -0
- data/docs/TradeSettleDetail.md +32 -0
- data/docs/TradeSettleInfo.md +20 -0
- data/docs/UnionIDSignInRequest.md +22 -0
- data/docs/UnionIDSignUpRequest.md +38 -0
- data/docs/UpdateProfileRequest.md +50 -0
- data/docs/User.md +90 -0
- data/docs/UserAccessToken.md +38 -0
- data/docs/UserApi.md +3303 -0
- data/docs/UserApiResponse.md +22 -0
- data/docs/UserCommonInterestsResult.md +20 -0
- data/docs/UserCommonInterestsResultApiResponse.md +22 -0
- data/docs/UserCurrency.md +24 -0
- data/docs/UserCurrencyApi.md +403 -0
- data/docs/UserCurrencyCurrencyTransResult.md +20 -0
- data/docs/UserCurrencyCurrencyTransResultApiResponse.md +22 -0
- data/docs/UserCurrencyListApiResponse.md +22 -0
- data/docs/UserFollowersResult.md +20 -0
- data/docs/UserFollowersResultApiResponse.md +22 -0
- data/docs/UserFollowingResult.md +20 -0
- data/docs/UserFollowingResultApiResponse.md +22 -0
- data/docs/UserFriendsNearByResult.md +20 -0
- data/docs/UserFriendsNearByResultApiResponse.md +22 -0
- data/docs/UserListResult.md +20 -0
- data/docs/UserListResultApiResponse.md +22 -0
- data/docs/UserLocationPostResult.md +18 -0
- data/docs/UserLocationPostResultApiResponse.md +22 -0
- data/docs/UserLocationsResult.md +20 -0
- data/docs/UserLocationsResultApiResponse.md +22 -0
- data/docs/UserLogins.md +36 -0
- data/docs/UserLoginsListApiResponse.md +22 -0
- data/docs/UserMutualFollowersResult.md +20 -0
- data/docs/UserMutualFollowersResultApiResponse.md +22 -0
- data/docs/UserMutualFollowingsResult.md +20 -0
- data/docs/UserMutualFollowingsResultApiResponse.md +22 -0
- data/docs/UserProfileResult.md +48 -0
- data/docs/UserProfileResultApiResponse.md +22 -0
- data/docs/UserQRCodeScanResult.md +34 -0
- data/docs/UserQRCodeScanResultApiResponse.md +22 -0
- data/docs/UserSetting.md +38 -0
- data/docs/UserSettingApi.md +379 -0
- data/docs/UserSettingApiResponse.md +22 -0
- data/docs/UserSettingListApiResponse.md +22 -0
- data/docs/UserSettingPostResult.md +18 -0
- data/docs/UserSettingPostResultApiResponse.md +22 -0
- data/docs/VoucherDetail.md +40 -0
- data/docs/WechatApi.md +751 -0
- data/docs/WechatJSConfigResult.md +26 -0
- data/docs/WechatJSConfigResultApiResponse.md +22 -0
- data/lib/zsgf_client/api/access_token_api.rb +309 -0
- data/lib/zsgf_client/api/alipay_api.rb +437 -0
- data/lib/zsgf_client/api/app_api.rb +675 -0
- data/lib/zsgf_client/api/app_setting_api.rb +1446 -0
- data/lib/zsgf_client/api/authorize_policy_api.rb +375 -0
- data/lib/zsgf_client/api/currency_api.rb +667 -0
- data/lib/zsgf_client/api/ding_talk_api.rb +88 -0
- data/lib/zsgf_client/api/file_api.rb +369 -0
- data/lib/zsgf_client/api/o_auth_api.rb +349 -0
- data/lib/zsgf_client/api/order_api.rb +251 -0
- data/lib/zsgf_client/api/project_api.rb +345 -0
- data/lib/zsgf_client/api/service_setting_api.rb +1340 -0
- data/lib/zsgf_client/api/storage_api.rb +1311 -0
- data/lib/zsgf_client/api/system_file_api.rb +333 -0
- data/lib/zsgf_client/api/team_api.rb +282 -0
- data/lib/zsgf_client/api/user_api.rb +3164 -0
- data/lib/zsgf_client/api/user_currency_api.rb +445 -0
- data/lib/zsgf_client/api/user_setting_api.rb +378 -0
- data/lib/zsgf_client/api/wechat_api.rb +712 -0
- data/lib/zsgf_client/api_client.rb +393 -0
- data/lib/zsgf_client/api_error.rb +58 -0
- data/lib/zsgf_client/configuration.rb +312 -0
- data/lib/zsgf_client/models/access_token_list_result.rb +232 -0
- data/lib/zsgf_client/models/access_token_list_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/access_token_post_request.rb +322 -0
- data/lib/zsgf_client/models/access_token_put_request.rb +299 -0
- data/lib/zsgf_client/models/alipay_create_order_page_pay_request.rb +330 -0
- data/lib/zsgf_client/models/alipay_create_order_request.rb +330 -0
- data/lib/zsgf_client/models/alipay_create_order_wap_pay_request.rb +330 -0
- data/lib/zsgf_client/models/alipay_trade_query_response.rb +909 -0
- data/lib/zsgf_client/models/alipay_trade_query_response_api_response.rb +245 -0
- data/lib/zsgf_client/models/alipay_trade_refund_response.rb +515 -0
- data/lib/zsgf_client/models/alipay_trade_refund_response_api_response.rb +245 -0
- data/lib/zsgf_client/models/app.rb +583 -0
- data/lib/zsgf_client/models/app_api_response.rb +245 -0
- data/lib/zsgf_client/models/app_check_version_result.rb +235 -0
- data/lib/zsgf_client/models/app_check_version_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/app_info_item.rb +289 -0
- data/lib/zsgf_client/models/app_info_result.rb +232 -0
- data/lib/zsgf_client/models/app_info_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/app_list_result.rb +232 -0
- data/lib/zsgf_client/models/app_list_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/app_post_result.rb +230 -0
- data/lib/zsgf_client/models/app_post_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/app_property.rb +241 -0
- data/lib/zsgf_client/models/app_setting.rb +437 -0
- data/lib/zsgf_client/models/app_setting_api_response.rb +245 -0
- data/lib/zsgf_client/models/app_setting_group_post_result.rb +220 -0
- data/lib/zsgf_client/models/app_setting_group_post_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/app_setting_item_post_result.rb +220 -0
- data/lib/zsgf_client/models/app_setting_item_post_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/app_setting_list_api_response.rb +249 -0
- data/lib/zsgf_client/models/app_setting_provider_post_result.rb +220 -0
- data/lib/zsgf_client/models/app_setting_provider_post_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/app_setting_setting_post_result.rb +220 -0
- data/lib/zsgf_client/models/app_setting_setting_post_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/app_user_consent_model.rb +278 -0
- data/lib/zsgf_client/models/app_user_consent_model_list_api_response.rb +249 -0
- data/lib/zsgf_client/models/app_user_list_response.rb +327 -0
- data/lib/zsgf_client/models/app_user_reset_pwd_request.rb +323 -0
- data/lib/zsgf_client/models/authorize_policy.rb +290 -0
- data/lib/zsgf_client/models/authorize_policy_api_response.rb +245 -0
- data/lib/zsgf_client/models/authorize_policy_list_api_response.rb +249 -0
- data/lib/zsgf_client/models/authorize_result.rb +259 -0
- data/lib/zsgf_client/models/authorize_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/bk_agent_resp_info.rb +261 -0
- data/lib/zsgf_client/models/boolean_api_response.rb +246 -0
- data/lib/zsgf_client/models/charge_info.rb +283 -0
- data/lib/zsgf_client/models/common_friend_model.rb +240 -0
- data/lib/zsgf_client/models/contribute_detail.rb +231 -0
- data/lib/zsgf_client/models/create_order_request.rb +351 -0
- data/lib/zsgf_client/models/create_order_result.rb +230 -0
- data/lib/zsgf_client/models/create_order_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/create_post_result.rb +220 -0
- data/lib/zsgf_client/models/create_post_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/currency.rb +484 -0
- data/lib/zsgf_client/models/currency_api_response.rb +245 -0
- data/lib/zsgf_client/models/currency_consume_request.rb +307 -0
- data/lib/zsgf_client/models/currency_exchange_rate.rb +330 -0
- data/lib/zsgf_client/models/currency_exchange_rate_api_response.rb +245 -0
- data/lib/zsgf_client/models/currency_list_api_response.rb +249 -0
- data/lib/zsgf_client/models/currency_transaction.rb +413 -0
- data/lib/zsgf_client/models/currency_transaction_list_api_response.rb +249 -0
- data/lib/zsgf_client/models/directory_item.rb +249 -0
- data/lib/zsgf_client/models/email_sign_in_request.rb +303 -0
- data/lib/zsgf_client/models/email_sign_up_request.rb +452 -0
- data/lib/zsgf_client/models/enterprise_pay_info.rb +240 -0
- data/lib/zsgf_client/models/exchange_currency_request.rb +343 -0
- data/lib/zsgf_client/models/exchange_rate_put_request.rb +240 -0
- data/lib/zsgf_client/models/execute_function_request.rb +222 -0
- data/lib/zsgf_client/models/file_item.rb +249 -0
- data/lib/zsgf_client/models/file_list_result.rb +262 -0
- data/lib/zsgf_client/models/file_list_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/follower_model.rb +325 -0
- data/lib/zsgf_client/models/follower_put_model.rb +269 -0
- data/lib/zsgf_client/models/fulfillment_detail.rb +241 -0
- data/lib/zsgf_client/models/geo_location_model.rb +436 -0
- data/lib/zsgf_client/models/geo_location_model_api_response.rb +245 -0
- data/lib/zsgf_client/models/geo_location_response_model.rb +446 -0
- data/lib/zsgf_client/models/goods_detail.rb +320 -0
- data/lib/zsgf_client/models/grant_request.rb +387 -0
- data/lib/zsgf_client/models/grant_result.rb +249 -0
- data/lib/zsgf_client/models/grant_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/hb_fq_pay_info.rb +231 -0
- data/lib/zsgf_client/models/int64_api_response.rb +246 -0
- data/lib/zsgf_client/models/intact_charge_info.rb +330 -0
- data/lib/zsgf_client/models/list_response_item.rb +308 -0
- data/lib/zsgf_client/models/list_response_item_list_api_response.rb +249 -0
- data/lib/zsgf_client/models/o_auth_account_bind_request.rb +336 -0
- data/lib/zsgf_client/models/o_auth_account_put_bind_request.rb +243 -0
- data/lib/zsgf_client/models/o_auth_account_sign_in_request.rb +292 -0
- data/lib/zsgf_client/models/object_api_response.rb +247 -0
- data/lib/zsgf_client/models/object_list_api_response.rb +249 -0
- data/lib/zsgf_client/models/order.rb +547 -0
- data/lib/zsgf_client/models/order_api_response.rb +245 -0
- data/lib/zsgf_client/models/order_list_result.rb +232 -0
- data/lib/zsgf_client/models/order_list_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/payment_info_with_id.rb +233 -0
- data/lib/zsgf_client/models/phone_sign_in_request.rb +292 -0
- data/lib/zsgf_client/models/phone_sign_up_request.rb +471 -0
- data/lib/zsgf_client/models/post_index_request.rb +251 -0
- data/lib/zsgf_client/models/post_result.rb +220 -0
- data/lib/zsgf_client/models/post_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/preset_pay_tool_info.rb +233 -0
- data/lib/zsgf_client/models/profile_result.rb +346 -0
- data/lib/zsgf_client/models/profile_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/project.rb +353 -0
- data/lib/zsgf_client/models/project_api_response.rb +245 -0
- data/lib/zsgf_client/models/project_list_result.rb +232 -0
- data/lib/zsgf_client/models/project_list_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/qr_code_pre_sign_in_request.rb +241 -0
- data/lib/zsgf_client/models/qr_code_scan_request.rb +237 -0
- data/lib/zsgf_client/models/qr_code_sign_in_request.rb +237 -0
- data/lib/zsgf_client/models/qr_code_sign_up_request.rb +454 -0
- data/lib/zsgf_client/models/recharge_point_request.rb +307 -0
- data/lib/zsgf_client/models/recommend_friend.rb +306 -0
- data/lib/zsgf_client/models/refund_charge_info.rb +253 -0
- data/lib/zsgf_client/models/refund_sub_fee.rb +231 -0
- data/lib/zsgf_client/models/return_page_notify_request.rb +344 -0
- data/lib/zsgf_client/models/send_email_code_request.rb +282 -0
- data/lib/zsgf_client/models/send_sms_code_request.rb +283 -0
- data/lib/zsgf_client/models/service_group.rb +361 -0
- data/lib/zsgf_client/models/service_group_api_response.rb +245 -0
- data/lib/zsgf_client/models/service_group_list_api_response.rb +249 -0
- data/lib/zsgf_client/models/service_item.rb +502 -0
- data/lib/zsgf_client/models/service_item_api_response.rb +245 -0
- data/lib/zsgf_client/models/service_item_list_api_response.rb +249 -0
- data/lib/zsgf_client/models/service_provider.rb +403 -0
- data/lib/zsgf_client/models/service_provider_api_response.rb +245 -0
- data/lib/zsgf_client/models/service_provider_list_api_response.rb +249 -0
- data/lib/zsgf_client/models/service_setting_group_post_result.rb +220 -0
- data/lib/zsgf_client/models/service_setting_group_post_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/service_setting_item_post_result.rb +220 -0
- data/lib/zsgf_client/models/service_setting_item_post_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/service_setting_provider_post_result.rb +220 -0
- data/lib/zsgf_client/models/service_setting_provider_post_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/service_setting_setting_post_result.rb +220 -0
- data/lib/zsgf_client/models/service_setting_setting_post_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/settings.rb +445 -0
- data/lib/zsgf_client/models/settings_api_response.rb +245 -0
- data/lib/zsgf_client/models/settings_list_api_response.rb +249 -0
- data/lib/zsgf_client/models/setup_code.rb +241 -0
- data/lib/zsgf_client/models/setup_code_api_response.rb +245 -0
- data/lib/zsgf_client/models/sign_in_request.rb +292 -0
- data/lib/zsgf_client/models/sign_up_request.rb +482 -0
- data/lib/zsgf_client/models/storage_list_result.rb +258 -0
- data/lib/zsgf_client/models/storage_list_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/string_api_response.rb +247 -0
- data/lib/zsgf_client/models/string_list_api_response.rb +249 -0
- data/lib/zsgf_client/models/sub_fee.rb +241 -0
- data/lib/zsgf_client/models/system_directory_item.rb +249 -0
- data/lib/zsgf_client/models/system_file_item.rb +249 -0
- data/lib/zsgf_client/models/system_file_list_result.rb +244 -0
- data/lib/zsgf_client/models/system_file_list_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/tap_pay_info.rb +221 -0
- data/lib/zsgf_client/models/team.rb +376 -0
- data/lib/zsgf_client/models/token_model.rb +240 -0
- data/lib/zsgf_client/models/token_model_api_response.rb +245 -0
- data/lib/zsgf_client/models/trade_fund_bill.rb +261 -0
- data/lib/zsgf_client/models/trade_settle_detail.rb +291 -0
- data/lib/zsgf_client/models/trade_settle_info.rb +233 -0
- data/lib/zsgf_client/models/union_id_sign_in_request.rb +292 -0
- data/lib/zsgf_client/models/union_id_sign_up_request.rb +549 -0
- data/lib/zsgf_client/models/update_profile_request.rb +608 -0
- data/lib/zsgf_client/models/user.rb +906 -0
- data/lib/zsgf_client/models/user_access_token.rb +357 -0
- data/lib/zsgf_client/models/user_api_response.rb +245 -0
- data/lib/zsgf_client/models/user_common_interests_result.rb +232 -0
- data/lib/zsgf_client/models/user_common_interests_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/user_currency.rb +268 -0
- data/lib/zsgf_client/models/user_currency_currency_trans_result.rb +232 -0
- data/lib/zsgf_client/models/user_currency_currency_trans_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/user_currency_list_api_response.rb +249 -0
- data/lib/zsgf_client/models/user_followers_result.rb +232 -0
- data/lib/zsgf_client/models/user_followers_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/user_following_result.rb +232 -0
- data/lib/zsgf_client/models/user_following_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/user_friends_near_by_result.rb +232 -0
- data/lib/zsgf_client/models/user_friends_near_by_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/user_list_result.rb +232 -0
- data/lib/zsgf_client/models/user_list_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/user_location_post_result.rb +220 -0
- data/lib/zsgf_client/models/user_location_post_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/user_locations_result.rb +232 -0
- data/lib/zsgf_client/models/user_locations_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/user_logins.rb +377 -0
- data/lib/zsgf_client/models/user_logins_list_api_response.rb +249 -0
- data/lib/zsgf_client/models/user_mutual_followers_result.rb +232 -0
- data/lib/zsgf_client/models/user_mutual_followers_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/user_mutual_followings_result.rb +232 -0
- data/lib/zsgf_client/models/user_mutual_followings_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/user_profile_result.rb +368 -0
- data/lib/zsgf_client/models/user_profile_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/user_qr_code_scan_result.rb +300 -0
- data/lib/zsgf_client/models/user_qr_code_scan_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/user_setting.rb +464 -0
- data/lib/zsgf_client/models/user_setting_api_response.rb +245 -0
- data/lib/zsgf_client/models/user_setting_list_api_response.rb +249 -0
- data/lib/zsgf_client/models/user_setting_post_result.rb +220 -0
- data/lib/zsgf_client/models/user_setting_post_result_api_response.rb +245 -0
- data/lib/zsgf_client/models/voucher_detail.rb +333 -0
- data/lib/zsgf_client/models/wechat_js_config_result.rb +263 -0
- data/lib/zsgf_client/models/wechat_js_config_result_api_response.rb +245 -0
- data/lib/zsgf_client/version.rb +15 -0
- data/lib/zsgf_client.rb +259 -0
- data/spec/api/access_token_api_spec.rb +90 -0
- data/spec/api/alipay_api_spec.rb +114 -0
- data/spec/api/app_api_spec.rb +162 -0
- data/spec/api/app_setting_api_spec.rb +307 -0
- data/spec/api/authorize_policy_api_spec.rb +102 -0
- data/spec/api/currency_api_spec.rb +159 -0
- data/spec/api/ding_talk_api_spec.rb +48 -0
- data/spec/api/file_api_spec.rb +104 -0
- data/spec/api/o_auth_api_spec.rb +95 -0
- data/spec/api/order_api_spec.rb +82 -0
- data/spec/api/project_api_spec.rb +97 -0
- data/spec/api/service_setting_api_spec.rb +289 -0
- data/spec/api/storage_api_spec.rb +268 -0
- data/spec/api/system_file_api_spec.rb +97 -0
- data/spec/api/team_api_spec.rb +85 -0
- data/spec/api/user_api_spec.rb +639 -0
- data/spec/api/user_currency_api_spec.rb +114 -0
- data/spec/api/user_setting_api_spec.rb +103 -0
- data/spec/api/wechat_api_spec.rb +167 -0
- data/spec/models/access_token_list_result_api_response_spec.rb +48 -0
- data/spec/models/access_token_list_result_spec.rb +42 -0
- data/spec/models/access_token_post_request_spec.rb +66 -0
- data/spec/models/access_token_put_request_spec.rb +60 -0
- data/spec/models/alipay_create_order_page_pay_request_spec.rb +54 -0
- data/spec/models/alipay_create_order_request_spec.rb +54 -0
- data/spec/models/alipay_create_order_wap_pay_request_spec.rb +54 -0
- data/spec/models/alipay_trade_query_response_api_response_spec.rb +48 -0
- data/spec/models/alipay_trade_query_response_spec.rb +444 -0
- data/spec/models/alipay_trade_refund_response_api_response_spec.rb +48 -0
- data/spec/models/alipay_trade_refund_response_spec.rb +210 -0
- data/spec/models/app_api_response_spec.rb +48 -0
- data/spec/models/app_check_version_result_api_response_spec.rb +48 -0
- data/spec/models/app_check_version_result_spec.rb +42 -0
- data/spec/models/app_info_item_spec.rb +78 -0
- data/spec/models/app_info_result_api_response_spec.rb +48 -0
- data/spec/models/app_info_result_spec.rb +42 -0
- data/spec/models/app_list_result_api_response_spec.rb +48 -0
- data/spec/models/app_list_result_spec.rb +42 -0
- data/spec/models/app_post_result_api_response_spec.rb +48 -0
- data/spec/models/app_post_result_spec.rb +42 -0
- data/spec/models/app_property_spec.rb +48 -0
- data/spec/models/app_setting_api_response_spec.rb +48 -0
- data/spec/models/app_setting_group_post_result_api_response_spec.rb +48 -0
- data/spec/models/app_setting_group_post_result_spec.rb +36 -0
- data/spec/models/app_setting_item_post_result_api_response_spec.rb +48 -0
- data/spec/models/app_setting_item_post_result_spec.rb +36 -0
- data/spec/models/app_setting_list_api_response_spec.rb +48 -0
- data/spec/models/app_setting_provider_post_result_api_response_spec.rb +48 -0
- data/spec/models/app_setting_provider_post_result_spec.rb +36 -0
- data/spec/models/app_setting_setting_post_result_api_response_spec.rb +48 -0
- data/spec/models/app_setting_setting_post_result_spec.rb +36 -0
- data/spec/models/app_setting_spec.rb +90 -0
- data/spec/models/app_spec.rb +132 -0
- data/spec/models/app_user_consent_model_list_api_response_spec.rb +48 -0
- data/spec/models/app_user_consent_model_spec.rb +72 -0
- data/spec/models/app_user_list_response_spec.rb +102 -0
- data/spec/models/app_user_reset_pwd_request_spec.rb +54 -0
- data/spec/models/authorize_policy_api_response_spec.rb +48 -0
- data/spec/models/authorize_policy_list_api_response_spec.rb +48 -0
- data/spec/models/authorize_policy_spec.rb +66 -0
- data/spec/models/authorize_result_api_response_spec.rb +48 -0
- data/spec/models/authorize_result_spec.rb +60 -0
- data/spec/models/bk_agent_resp_info_spec.rb +60 -0
- data/spec/models/boolean_api_response_spec.rb +48 -0
- data/spec/models/charge_info_spec.rb +72 -0
- data/spec/models/common_friend_model_spec.rb +48 -0
- data/spec/models/contribute_detail_spec.rb +42 -0
- data/spec/models/create_order_request_spec.rb +54 -0
- data/spec/models/create_order_result_api_response_spec.rb +48 -0
- data/spec/models/create_order_result_spec.rb +42 -0
- data/spec/models/create_post_result_api_response_spec.rb +48 -0
- data/spec/models/create_post_result_spec.rb +36 -0
- data/spec/models/currency_api_response_spec.rb +48 -0
- data/spec/models/currency_consume_request_spec.rb +60 -0
- data/spec/models/currency_exchange_rate_api_response_spec.rb +48 -0
- data/spec/models/currency_exchange_rate_spec.rb +72 -0
- data/spec/models/currency_list_api_response_spec.rb +48 -0
- data/spec/models/currency_spec.rb +126 -0
- data/spec/models/currency_transaction_list_api_response_spec.rb +48 -0
- data/spec/models/currency_transaction_spec.rb +102 -0
- data/spec/models/directory_item_spec.rb +54 -0
- data/spec/models/email_sign_in_request_spec.rb +48 -0
- data/spec/models/email_sign_up_request_spec.rb +78 -0
- data/spec/models/enterprise_pay_info_spec.rb +48 -0
- data/spec/models/exchange_currency_request_spec.rb +66 -0
- data/spec/models/exchange_rate_put_request_spec.rb +48 -0
- data/spec/models/execute_function_request_spec.rb +36 -0
- data/spec/models/file_item_spec.rb +54 -0
- data/spec/models/file_list_result_api_response_spec.rb +48 -0
- data/spec/models/file_list_result_spec.rb +60 -0
- data/spec/models/follower_model_spec.rb +102 -0
- data/spec/models/follower_put_model_spec.rb +66 -0
- data/spec/models/fulfillment_detail_spec.rb +48 -0
- data/spec/models/geo_location_model_api_response_spec.rb +48 -0
- data/spec/models/geo_location_model_spec.rb +156 -0
- data/spec/models/geo_location_response_model_spec.rb +162 -0
- data/spec/models/goods_detail_spec.rb +96 -0
- data/spec/models/grant_request_spec.rb +78 -0
- data/spec/models/grant_result_api_response_spec.rb +48 -0
- data/spec/models/grant_result_spec.rb +54 -0
- data/spec/models/hb_fq_pay_info_spec.rb +42 -0
- data/spec/models/int64_api_response_spec.rb +48 -0
- data/spec/models/intact_charge_info_spec.rb +102 -0
- data/spec/models/list_response_item_list_api_response_spec.rb +48 -0
- data/spec/models/list_response_item_spec.rb +90 -0
- data/spec/models/o_auth_account_bind_request_spec.rb +60 -0
- data/spec/models/o_auth_account_put_bind_request_spec.rb +48 -0
- data/spec/models/o_auth_account_sign_in_request_spec.rb +48 -0
- data/spec/models/object_api_response_spec.rb +48 -0
- data/spec/models/object_list_api_response_spec.rb +48 -0
- data/spec/models/order_api_response_spec.rb +48 -0
- data/spec/models/order_list_result_api_response_spec.rb +48 -0
- data/spec/models/order_list_result_spec.rb +42 -0
- data/spec/models/order_spec.rb +144 -0
- data/spec/models/payment_info_with_id_spec.rb +42 -0
- data/spec/models/phone_sign_in_request_spec.rb +48 -0
- data/spec/models/phone_sign_up_request_spec.rb +78 -0
- data/spec/models/post_index_request_spec.rb +42 -0
- data/spec/models/post_result_api_response_spec.rb +48 -0
- data/spec/models/post_result_spec.rb +36 -0
- data/spec/models/preset_pay_tool_info_spec.rb +42 -0
- data/spec/models/profile_result_api_response_spec.rb +48 -0
- data/spec/models/profile_result_spec.rb +114 -0
- data/spec/models/project_api_response_spec.rb +48 -0
- data/spec/models/project_list_result_api_response_spec.rb +48 -0
- data/spec/models/project_list_result_spec.rb +42 -0
- data/spec/models/project_spec.rb +84 -0
- data/spec/models/qr_code_pre_sign_in_request_spec.rb +48 -0
- data/spec/models/qr_code_scan_request_spec.rb +36 -0
- data/spec/models/qr_code_sign_in_request_spec.rb +36 -0
- data/spec/models/qr_code_sign_up_request_spec.rb +84 -0
- data/spec/models/recharge_point_request_spec.rb +60 -0
- data/spec/models/recommend_friend_spec.rb +90 -0
- data/spec/models/refund_charge_info_spec.rb +54 -0
- data/spec/models/refund_sub_fee_spec.rb +42 -0
- data/spec/models/return_page_notify_request_spec.rb +102 -0
- data/spec/models/send_email_code_request_spec.rb +42 -0
- data/spec/models/send_sms_code_request_spec.rb +42 -0
- data/spec/models/service_group_api_response_spec.rb +48 -0
- data/spec/models/service_group_list_api_response_spec.rb +48 -0
- data/spec/models/service_group_spec.rb +90 -0
- data/spec/models/service_item_api_response_spec.rb +48 -0
- data/spec/models/service_item_list_api_response_spec.rb +48 -0
- data/spec/models/service_item_spec.rb +126 -0
- data/spec/models/service_provider_api_response_spec.rb +48 -0
- data/spec/models/service_provider_list_api_response_spec.rb +48 -0
- data/spec/models/service_provider_spec.rb +96 -0
- data/spec/models/service_setting_group_post_result_api_response_spec.rb +48 -0
- data/spec/models/service_setting_group_post_result_spec.rb +36 -0
- data/spec/models/service_setting_item_post_result_api_response_spec.rb +48 -0
- data/spec/models/service_setting_item_post_result_spec.rb +36 -0
- data/spec/models/service_setting_provider_post_result_api_response_spec.rb +48 -0
- data/spec/models/service_setting_provider_post_result_spec.rb +36 -0
- data/spec/models/service_setting_setting_post_result_api_response_spec.rb +48 -0
- data/spec/models/service_setting_setting_post_result_spec.rb +36 -0
- data/spec/models/settings_api_response_spec.rb +48 -0
- data/spec/models/settings_list_api_response_spec.rb +48 -0
- data/spec/models/settings_spec.rb +102 -0
- data/spec/models/setup_code_api_response_spec.rb +48 -0
- data/spec/models/setup_code_spec.rb +48 -0
- data/spec/models/sign_in_request_spec.rb +48 -0
- data/spec/models/sign_up_request_spec.rb +84 -0
- data/spec/models/storage_list_result_api_response_spec.rb +48 -0
- data/spec/models/storage_list_result_spec.rb +60 -0
- data/spec/models/string_api_response_spec.rb +48 -0
- data/spec/models/string_list_api_response_spec.rb +48 -0
- data/spec/models/sub_fee_spec.rb +48 -0
- data/spec/models/system_directory_item_spec.rb +54 -0
- data/spec/models/system_file_item_spec.rb +54 -0
- data/spec/models/system_file_list_result_api_response_spec.rb +48 -0
- data/spec/models/system_file_list_result_spec.rb +48 -0
- data/spec/models/tap_pay_info_spec.rb +36 -0
- data/spec/models/team_spec.rb +90 -0
- data/spec/models/token_model_api_response_spec.rb +48 -0
- data/spec/models/token_model_spec.rb +48 -0
- data/spec/models/trade_fund_bill_spec.rb +60 -0
- data/spec/models/trade_settle_detail_spec.rb +78 -0
- data/spec/models/trade_settle_info_spec.rb +42 -0
- data/spec/models/union_id_sign_in_request_spec.rb +48 -0
- data/spec/models/union_id_sign_up_request_spec.rb +96 -0
- data/spec/models/update_profile_request_spec.rb +132 -0
- data/spec/models/user_access_token_spec.rb +96 -0
- data/spec/models/user_api_response_spec.rb +48 -0
- data/spec/models/user_common_interests_result_api_response_spec.rb +48 -0
- data/spec/models/user_common_interests_result_spec.rb +42 -0
- data/spec/models/user_currency_currency_trans_result_api_response_spec.rb +48 -0
- data/spec/models/user_currency_currency_trans_result_spec.rb +42 -0
- data/spec/models/user_currency_list_api_response_spec.rb +48 -0
- data/spec/models/user_currency_spec.rb +54 -0
- data/spec/models/user_followers_result_api_response_spec.rb +48 -0
- data/spec/models/user_followers_result_spec.rb +42 -0
- data/spec/models/user_following_result_api_response_spec.rb +48 -0
- data/spec/models/user_following_result_spec.rb +42 -0
- data/spec/models/user_friends_near_by_result_api_response_spec.rb +48 -0
- data/spec/models/user_friends_near_by_result_spec.rb +42 -0
- data/spec/models/user_list_result_api_response_spec.rb +48 -0
- data/spec/models/user_list_result_spec.rb +42 -0
- data/spec/models/user_location_post_result_api_response_spec.rb +48 -0
- data/spec/models/user_location_post_result_spec.rb +36 -0
- data/spec/models/user_locations_result_api_response_spec.rb +48 -0
- data/spec/models/user_locations_result_spec.rb +42 -0
- data/spec/models/user_logins_list_api_response_spec.rb +48 -0
- data/spec/models/user_logins_spec.rb +90 -0
- data/spec/models/user_mutual_followers_result_api_response_spec.rb +48 -0
- data/spec/models/user_mutual_followers_result_spec.rb +42 -0
- data/spec/models/user_mutual_followings_result_api_response_spec.rb +48 -0
- data/spec/models/user_mutual_followings_result_spec.rb +42 -0
- data/spec/models/user_profile_result_api_response_spec.rb +48 -0
- data/spec/models/user_profile_result_spec.rb +126 -0
- data/spec/models/user_qr_code_scan_result_api_response_spec.rb +48 -0
- data/spec/models/user_qr_code_scan_result_spec.rb +84 -0
- data/spec/models/user_setting_api_response_spec.rb +48 -0
- data/spec/models/user_setting_list_api_response_spec.rb +48 -0
- data/spec/models/user_setting_post_result_api_response_spec.rb +48 -0
- data/spec/models/user_setting_post_result_spec.rb +36 -0
- data/spec/models/user_setting_spec.rb +96 -0
- data/spec/models/user_spec.rb +252 -0
- data/spec/models/voucher_detail_spec.rb +102 -0
- data/spec/models/wechat_js_config_result_api_response_spec.rb +48 -0
- data/spec/models/wechat_js_config_result_spec.rb +60 -0
- data/spec/spec_helper.rb +111 -0
- data/zsgf_client.gemspec +39 -0
- metadata +974 -0
data/docs/UserApi.md
ADDED
|
@@ -0,0 +1,3303 @@
|
|
|
1
|
+
# ZSGFClient::UserApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.zashigaofa.cn*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**user**](UserApi.md#user) | **GET** /User/{appKey}/{id} | 获取用户详情 |
|
|
8
|
+
| [**user_clear**](UserApi.md#user_clear) | **DELETE** /User/{appKey}/Clear | 清空用户数据 |
|
|
9
|
+
| [**user_common_interests**](UserApi.md#user_common_interests) | **GET** /User/{appKey}/Friends/CommonInterests | 有共同爱好的用户推荐 |
|
|
10
|
+
| [**user_delete**](UserApi.md#user_delete) | **DELETE** /User/{appKey}/{id} | 删除用户 |
|
|
11
|
+
| [**user_email_sign_in**](UserApi.md#user_email_sign_in) | **POST** /User/{appKey}/EmailSignIn | 邮箱登录 |
|
|
12
|
+
| [**user_email_sign_up**](UserApi.md#user_email_sign_up) | **POST** /User/{appKey}/EmailSignUp | 邮箱注册 |
|
|
13
|
+
| [**user_export**](UserApi.md#user_export) | **GET** /User/{appKey}/Export | 导出用户数据 |
|
|
14
|
+
| [**user_follow_user**](UserApi.md#user_follow_user) | **POST** /User/{appKey}/Follower/{userId} | 关注用户 |
|
|
15
|
+
| [**user_follower_put**](UserApi.md#user_follower_put) | **PUT** /User/{appKey}/Follower/{id} | 更新粉丝 |
|
|
16
|
+
| [**user_followers**](UserApi.md#user_followers) | **GET** /User/{appKey}/Followers | 获取我的粉丝列表 |
|
|
17
|
+
| [**user_following**](UserApi.md#user_following) | **GET** /User/{appKey}/Following | 获取我的关注列表 |
|
|
18
|
+
| [**user_friends_near_by**](UserApi.md#user_friends_near_by) | **GET** /User/{appKey}/Friends/NearBy | 附近的用户推荐 |
|
|
19
|
+
| [**user_import**](UserApi.md#user_import) | **POST** /User/{appKey}/Import | 导入用户数据 |
|
|
20
|
+
| [**user_location**](UserApi.md#user_location) | **GET** /User/{appKey}/Location/{id} | 获取位置详情 |
|
|
21
|
+
| [**user_location_delete**](UserApi.md#user_location_delete) | **DELETE** /User/{appKey}/Location/{id} | 删除位置 |
|
|
22
|
+
| [**user_location_post**](UserApi.md#user_location_post) | **POST** /User/{appKey}/Location | 添加位置 |
|
|
23
|
+
| [**user_location_put**](UserApi.md#user_location_put) | **PUT** /User/{appKey}/Location/{id} | 更新位置 |
|
|
24
|
+
| [**user_locations**](UserApi.md#user_locations) | **GET** /User/{appKey}/Locations | 获取位置列表 |
|
|
25
|
+
| [**user_mutual_followers**](UserApi.md#user_mutual_followers) | **GET** /User/{appKey}/Friends/MutualFollowers | 有共同粉丝的用户推荐 |
|
|
26
|
+
| [**user_mutual_followings**](UserApi.md#user_mutual_followings) | **GET** /User/{appKey}/Friends/MutualFollowings | 有共同关注的用户推荐 |
|
|
27
|
+
| [**user_o_auth_account_bind**](UserApi.md#user_o_auth_account_bind) | **POST** /User/{appKey}/OAuthAccountBind | 外部账号 绑定 |
|
|
28
|
+
| [**user_o_auth_account_sign_in**](UserApi.md#user_o_auth_account_sign_in) | **POST** /User/{appKey}/OAuthAccountSignIn | 外部账号 登录 |
|
|
29
|
+
| [**user_o_auth_accounts**](UserApi.md#user_o_auth_accounts) | **GET** /User/{appKey}/OAuthAccounts | 外部账号 绑定列表 |
|
|
30
|
+
| [**user_o_auth_accounts_put_bind**](UserApi.md#user_o_auth_accounts_put_bind) | **PUT** /User/{appKey}/OAuthAccounts/{id} | 外部账号 更新绑定 |
|
|
31
|
+
| [**user_o_auth_accounts_un_bind**](UserApi.md#user_o_auth_accounts_un_bind) | **DELETE** /User/{appKey}/OAuthAccounts/{id} | 外部账号 删除绑定 |
|
|
32
|
+
| [**user_phone_sign_in**](UserApi.md#user_phone_sign_in) | **POST** /User/{appKey}/PhoneSignIn | 手机登录 |
|
|
33
|
+
| [**user_phone_sign_up**](UserApi.md#user_phone_sign_up) | **POST** /User/{appKey}/PhoneSignUp | 手机注册 |
|
|
34
|
+
| [**user_profile**](UserApi.md#user_profile) | **GET** /User/{appKey}/Profile | 获取个人资料 |
|
|
35
|
+
| [**user_put**](UserApi.md#user_put) | **PUT** /User/{appKey}/{id} | 更新用户信息 |
|
|
36
|
+
| [**user_qr_code_pre_sign_in**](UserApi.md#user_qr_code_pre_sign_in) | **POST** /User/{appKey}/QRCodePreSignIn | 微信小程序 - 预登陆 |
|
|
37
|
+
| [**user_qr_code_scan**](UserApi.md#user_qr_code_scan) | **POST** /User/{appKey}/QRCodeScan | 微信小程序 - 扫码 |
|
|
38
|
+
| [**user_qr_code_sign_in**](UserApi.md#user_qr_code_sign_in) | **POST** /User/{appKey}/QRCodeSignIn | 微信小程序 - 网页登录 |
|
|
39
|
+
| [**user_qr_code_sign_up**](UserApi.md#user_qr_code_sign_up) | **POST** /User/{appKey}/QRCodeSignUp | 微信小程序 - 注册 |
|
|
40
|
+
| [**user_reset_pwd**](UserApi.md#user_reset_pwd) | **POST** /User/{appKey}/ResetPwd | 重置密码 |
|
|
41
|
+
| [**user_send_email_code**](UserApi.md#user_send_email_code) | **POST** /User/{appKey}/SendEmailCode | 发送邮箱验证码 |
|
|
42
|
+
| [**user_send_sms_code**](UserApi.md#user_send_sms_code) | **POST** /User/{appKey}/SendSMSCode | 发送手机验证码 |
|
|
43
|
+
| [**user_sign_in**](UserApi.md#user_sign_in) | **POST** /User/{appKey}/SignIn | 账号密码 登录 |
|
|
44
|
+
| [**user_sign_up**](UserApi.md#user_sign_up) | **POST** /User/{appKey}/SignUp | 账号密码 注册 |
|
|
45
|
+
| [**user_two_factor_auth**](UserApi.md#user_two_factor_auth) | **GET** /User/{appKey}/TwoFactorAuth | 双因素验证 |
|
|
46
|
+
| [**user_unfollow_user**](UserApi.md#user_unfollow_user) | **DELETE** /User/{appKey}/Follower/{userId} | 取消关注 |
|
|
47
|
+
| [**user_union_id_sign_in**](UserApi.md#user_union_id_sign_in) | **POST** /User/{appKey}/UnionIDSignIn | UnionID登录 |
|
|
48
|
+
| [**user_union_id_sign_up**](UserApi.md#user_union_id_sign_up) | **POST** /User/{appKey}/UnionIDSignUp | UnionID注册 |
|
|
49
|
+
| [**user_update_profile**](UserApi.md#user_update_profile) | **PUT** /User/{appKey}/Profile | 更新个人资料 |
|
|
50
|
+
| [**users**](UserApi.md#users) | **GET** /User/{appKey} | 获取用户列表 |
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
## user
|
|
54
|
+
|
|
55
|
+
> <UserApiResponse> user(id, app_key)
|
|
56
|
+
|
|
57
|
+
获取用户详情
|
|
58
|
+
|
|
59
|
+
根据用户ID获取用户详情
|
|
60
|
+
|
|
61
|
+
### Examples
|
|
62
|
+
|
|
63
|
+
```ruby
|
|
64
|
+
require 'time'
|
|
65
|
+
require 'zsgf_client'
|
|
66
|
+
# setup authorization
|
|
67
|
+
ZSGFClient.configure do |config|
|
|
68
|
+
# Configure Bearer authorization: Bearer
|
|
69
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
70
|
+
end
|
|
71
|
+
|
|
72
|
+
api_instance = ZSGFClient::UserApi.new
|
|
73
|
+
id = 789 # Integer | 用户ID
|
|
74
|
+
app_key = 'app_key_example' # String |
|
|
75
|
+
|
|
76
|
+
begin
|
|
77
|
+
# 获取用户详情
|
|
78
|
+
result = api_instance.user(id, app_key)
|
|
79
|
+
p result
|
|
80
|
+
rescue ZSGFClient::ApiError => e
|
|
81
|
+
puts "Error when calling UserApi->user: #{e}"
|
|
82
|
+
end
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
#### Using the user_with_http_info variant
|
|
86
|
+
|
|
87
|
+
This returns an Array which contains the response data, status code and headers.
|
|
88
|
+
|
|
89
|
+
> <Array(<UserApiResponse>, Integer, Hash)> user_with_http_info(id, app_key)
|
|
90
|
+
|
|
91
|
+
```ruby
|
|
92
|
+
begin
|
|
93
|
+
# 获取用户详情
|
|
94
|
+
data, status_code, headers = api_instance.user_with_http_info(id, app_key)
|
|
95
|
+
p status_code # => 2xx
|
|
96
|
+
p headers # => { ... }
|
|
97
|
+
p data # => <UserApiResponse>
|
|
98
|
+
rescue ZSGFClient::ApiError => e
|
|
99
|
+
puts "Error when calling UserApi->user_with_http_info: #{e}"
|
|
100
|
+
end
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
### Parameters
|
|
104
|
+
|
|
105
|
+
| Name | Type | Description | Notes |
|
|
106
|
+
| ---- | ---- | ----------- | ----- |
|
|
107
|
+
| **id** | **Integer** | 用户ID | |
|
|
108
|
+
| **app_key** | **String** | | |
|
|
109
|
+
|
|
110
|
+
### Return type
|
|
111
|
+
|
|
112
|
+
[**UserApiResponse**](UserApiResponse.md)
|
|
113
|
+
|
|
114
|
+
### Authorization
|
|
115
|
+
|
|
116
|
+
[Bearer](../README.md#Bearer)
|
|
117
|
+
|
|
118
|
+
### HTTP request headers
|
|
119
|
+
|
|
120
|
+
- **Content-Type**: Not defined
|
|
121
|
+
- **Accept**: application/json
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
## user_clear
|
|
125
|
+
|
|
126
|
+
> <BooleanApiResponse> user_clear(app_key)
|
|
127
|
+
|
|
128
|
+
清空用户数据
|
|
129
|
+
|
|
130
|
+
清空用户数据
|
|
131
|
+
|
|
132
|
+
### Examples
|
|
133
|
+
|
|
134
|
+
```ruby
|
|
135
|
+
require 'time'
|
|
136
|
+
require 'zsgf_client'
|
|
137
|
+
# setup authorization
|
|
138
|
+
ZSGFClient.configure do |config|
|
|
139
|
+
# Configure Bearer authorization: Bearer
|
|
140
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
141
|
+
end
|
|
142
|
+
|
|
143
|
+
api_instance = ZSGFClient::UserApi.new
|
|
144
|
+
app_key = 'app_key_example' # String |
|
|
145
|
+
|
|
146
|
+
begin
|
|
147
|
+
# 清空用户数据
|
|
148
|
+
result = api_instance.user_clear(app_key)
|
|
149
|
+
p result
|
|
150
|
+
rescue ZSGFClient::ApiError => e
|
|
151
|
+
puts "Error when calling UserApi->user_clear: #{e}"
|
|
152
|
+
end
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
#### Using the user_clear_with_http_info variant
|
|
156
|
+
|
|
157
|
+
This returns an Array which contains the response data, status code and headers.
|
|
158
|
+
|
|
159
|
+
> <Array(<BooleanApiResponse>, Integer, Hash)> user_clear_with_http_info(app_key)
|
|
160
|
+
|
|
161
|
+
```ruby
|
|
162
|
+
begin
|
|
163
|
+
# 清空用户数据
|
|
164
|
+
data, status_code, headers = api_instance.user_clear_with_http_info(app_key)
|
|
165
|
+
p status_code # => 2xx
|
|
166
|
+
p headers # => { ... }
|
|
167
|
+
p data # => <BooleanApiResponse>
|
|
168
|
+
rescue ZSGFClient::ApiError => e
|
|
169
|
+
puts "Error when calling UserApi->user_clear_with_http_info: #{e}"
|
|
170
|
+
end
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
### Parameters
|
|
174
|
+
|
|
175
|
+
| Name | Type | Description | Notes |
|
|
176
|
+
| ---- | ---- | ----------- | ----- |
|
|
177
|
+
| **app_key** | **String** | | |
|
|
178
|
+
|
|
179
|
+
### Return type
|
|
180
|
+
|
|
181
|
+
[**BooleanApiResponse**](BooleanApiResponse.md)
|
|
182
|
+
|
|
183
|
+
### Authorization
|
|
184
|
+
|
|
185
|
+
[Bearer](../README.md#Bearer)
|
|
186
|
+
|
|
187
|
+
### HTTP request headers
|
|
188
|
+
|
|
189
|
+
- **Content-Type**: Not defined
|
|
190
|
+
- **Accept**: application/json
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
## user_common_interests
|
|
194
|
+
|
|
195
|
+
> <UserCommonInterestsResultApiResponse> user_common_interests(app_key, opts)
|
|
196
|
+
|
|
197
|
+
有共同爱好的用户推荐
|
|
198
|
+
|
|
199
|
+
推荐有共同爱好的用户
|
|
200
|
+
|
|
201
|
+
### Examples
|
|
202
|
+
|
|
203
|
+
```ruby
|
|
204
|
+
require 'time'
|
|
205
|
+
require 'zsgf_client'
|
|
206
|
+
# setup authorization
|
|
207
|
+
ZSGFClient.configure do |config|
|
|
208
|
+
# Configure Bearer authorization: Bearer
|
|
209
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
210
|
+
end
|
|
211
|
+
|
|
212
|
+
api_instance = ZSGFClient::UserApi.new
|
|
213
|
+
app_key = 'app_key_example' # String |
|
|
214
|
+
opts = {
|
|
215
|
+
tag: 'tag_example', # String | 兴趣标签
|
|
216
|
+
skip: 56, # Integer | 跳过的记录数
|
|
217
|
+
take: 56 # Integer | 获取的记录数
|
|
218
|
+
}
|
|
219
|
+
|
|
220
|
+
begin
|
|
221
|
+
# 有共同爱好的用户推荐
|
|
222
|
+
result = api_instance.user_common_interests(app_key, opts)
|
|
223
|
+
p result
|
|
224
|
+
rescue ZSGFClient::ApiError => e
|
|
225
|
+
puts "Error when calling UserApi->user_common_interests: #{e}"
|
|
226
|
+
end
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
#### Using the user_common_interests_with_http_info variant
|
|
230
|
+
|
|
231
|
+
This returns an Array which contains the response data, status code and headers.
|
|
232
|
+
|
|
233
|
+
> <Array(<UserCommonInterestsResultApiResponse>, Integer, Hash)> user_common_interests_with_http_info(app_key, opts)
|
|
234
|
+
|
|
235
|
+
```ruby
|
|
236
|
+
begin
|
|
237
|
+
# 有共同爱好的用户推荐
|
|
238
|
+
data, status_code, headers = api_instance.user_common_interests_with_http_info(app_key, opts)
|
|
239
|
+
p status_code # => 2xx
|
|
240
|
+
p headers # => { ... }
|
|
241
|
+
p data # => <UserCommonInterestsResultApiResponse>
|
|
242
|
+
rescue ZSGFClient::ApiError => e
|
|
243
|
+
puts "Error when calling UserApi->user_common_interests_with_http_info: #{e}"
|
|
244
|
+
end
|
|
245
|
+
```
|
|
246
|
+
|
|
247
|
+
### Parameters
|
|
248
|
+
|
|
249
|
+
| Name | Type | Description | Notes |
|
|
250
|
+
| ---- | ---- | ----------- | ----- |
|
|
251
|
+
| **app_key** | **String** | | |
|
|
252
|
+
| **tag** | **String** | 兴趣标签 | [optional] |
|
|
253
|
+
| **skip** | **Integer** | 跳过的记录数 | [optional][default to 0] |
|
|
254
|
+
| **take** | **Integer** | 获取的记录数 | [optional][default to 10] |
|
|
255
|
+
|
|
256
|
+
### Return type
|
|
257
|
+
|
|
258
|
+
[**UserCommonInterestsResultApiResponse**](UserCommonInterestsResultApiResponse.md)
|
|
259
|
+
|
|
260
|
+
### Authorization
|
|
261
|
+
|
|
262
|
+
[Bearer](../README.md#Bearer)
|
|
263
|
+
|
|
264
|
+
### HTTP request headers
|
|
265
|
+
|
|
266
|
+
- **Content-Type**: Not defined
|
|
267
|
+
- **Accept**: application/json
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
## user_delete
|
|
271
|
+
|
|
272
|
+
> <BooleanApiResponse> user_delete(id, app_key)
|
|
273
|
+
|
|
274
|
+
删除用户
|
|
275
|
+
|
|
276
|
+
根据用户ID删除用户
|
|
277
|
+
|
|
278
|
+
### Examples
|
|
279
|
+
|
|
280
|
+
```ruby
|
|
281
|
+
require 'time'
|
|
282
|
+
require 'zsgf_client'
|
|
283
|
+
# setup authorization
|
|
284
|
+
ZSGFClient.configure do |config|
|
|
285
|
+
# Configure Bearer authorization: Bearer
|
|
286
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
287
|
+
end
|
|
288
|
+
|
|
289
|
+
api_instance = ZSGFClient::UserApi.new
|
|
290
|
+
id = 789 # Integer | 用户ID
|
|
291
|
+
app_key = 'app_key_example' # String |
|
|
292
|
+
|
|
293
|
+
begin
|
|
294
|
+
# 删除用户
|
|
295
|
+
result = api_instance.user_delete(id, app_key)
|
|
296
|
+
p result
|
|
297
|
+
rescue ZSGFClient::ApiError => e
|
|
298
|
+
puts "Error when calling UserApi->user_delete: #{e}"
|
|
299
|
+
end
|
|
300
|
+
```
|
|
301
|
+
|
|
302
|
+
#### Using the user_delete_with_http_info variant
|
|
303
|
+
|
|
304
|
+
This returns an Array which contains the response data, status code and headers.
|
|
305
|
+
|
|
306
|
+
> <Array(<BooleanApiResponse>, Integer, Hash)> user_delete_with_http_info(id, app_key)
|
|
307
|
+
|
|
308
|
+
```ruby
|
|
309
|
+
begin
|
|
310
|
+
# 删除用户
|
|
311
|
+
data, status_code, headers = api_instance.user_delete_with_http_info(id, app_key)
|
|
312
|
+
p status_code # => 2xx
|
|
313
|
+
p headers # => { ... }
|
|
314
|
+
p data # => <BooleanApiResponse>
|
|
315
|
+
rescue ZSGFClient::ApiError => e
|
|
316
|
+
puts "Error when calling UserApi->user_delete_with_http_info: #{e}"
|
|
317
|
+
end
|
|
318
|
+
```
|
|
319
|
+
|
|
320
|
+
### Parameters
|
|
321
|
+
|
|
322
|
+
| Name | Type | Description | Notes |
|
|
323
|
+
| ---- | ---- | ----------- | ----- |
|
|
324
|
+
| **id** | **Integer** | 用户ID | |
|
|
325
|
+
| **app_key** | **String** | | |
|
|
326
|
+
|
|
327
|
+
### Return type
|
|
328
|
+
|
|
329
|
+
[**BooleanApiResponse**](BooleanApiResponse.md)
|
|
330
|
+
|
|
331
|
+
### Authorization
|
|
332
|
+
|
|
333
|
+
[Bearer](../README.md#Bearer)
|
|
334
|
+
|
|
335
|
+
### HTTP request headers
|
|
336
|
+
|
|
337
|
+
- **Content-Type**: Not defined
|
|
338
|
+
- **Accept**: application/json
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
## user_email_sign_in
|
|
342
|
+
|
|
343
|
+
> <TokenModelApiResponse> user_email_sign_in(app_key, opts)
|
|
344
|
+
|
|
345
|
+
邮箱登录
|
|
346
|
+
|
|
347
|
+
使用邮箱进行登录
|
|
348
|
+
|
|
349
|
+
### Examples
|
|
350
|
+
|
|
351
|
+
```ruby
|
|
352
|
+
require 'time'
|
|
353
|
+
require 'zsgf_client'
|
|
354
|
+
# setup authorization
|
|
355
|
+
ZSGFClient.configure do |config|
|
|
356
|
+
# Configure Bearer authorization: Bearer
|
|
357
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
358
|
+
end
|
|
359
|
+
|
|
360
|
+
api_instance = ZSGFClient::UserApi.new
|
|
361
|
+
app_key = 'app_key_example' # String |
|
|
362
|
+
opts = {
|
|
363
|
+
email_sign_in_request: ZSGFClient::EmailSignInRequest.new({email: 'email_example', verify_code: 'verify_code_example'}) # EmailSignInRequest | 登录请求参数
|
|
364
|
+
}
|
|
365
|
+
|
|
366
|
+
begin
|
|
367
|
+
# 邮箱登录
|
|
368
|
+
result = api_instance.user_email_sign_in(app_key, opts)
|
|
369
|
+
p result
|
|
370
|
+
rescue ZSGFClient::ApiError => e
|
|
371
|
+
puts "Error when calling UserApi->user_email_sign_in: #{e}"
|
|
372
|
+
end
|
|
373
|
+
```
|
|
374
|
+
|
|
375
|
+
#### Using the user_email_sign_in_with_http_info variant
|
|
376
|
+
|
|
377
|
+
This returns an Array which contains the response data, status code and headers.
|
|
378
|
+
|
|
379
|
+
> <Array(<TokenModelApiResponse>, Integer, Hash)> user_email_sign_in_with_http_info(app_key, opts)
|
|
380
|
+
|
|
381
|
+
```ruby
|
|
382
|
+
begin
|
|
383
|
+
# 邮箱登录
|
|
384
|
+
data, status_code, headers = api_instance.user_email_sign_in_with_http_info(app_key, opts)
|
|
385
|
+
p status_code # => 2xx
|
|
386
|
+
p headers # => { ... }
|
|
387
|
+
p data # => <TokenModelApiResponse>
|
|
388
|
+
rescue ZSGFClient::ApiError => e
|
|
389
|
+
puts "Error when calling UserApi->user_email_sign_in_with_http_info: #{e}"
|
|
390
|
+
end
|
|
391
|
+
```
|
|
392
|
+
|
|
393
|
+
### Parameters
|
|
394
|
+
|
|
395
|
+
| Name | Type | Description | Notes |
|
|
396
|
+
| ---- | ---- | ----------- | ----- |
|
|
397
|
+
| **app_key** | **String** | | |
|
|
398
|
+
| **email_sign_in_request** | [**EmailSignInRequest**](EmailSignInRequest.md) | 登录请求参数 | [optional] |
|
|
399
|
+
|
|
400
|
+
### Return type
|
|
401
|
+
|
|
402
|
+
[**TokenModelApiResponse**](TokenModelApiResponse.md)
|
|
403
|
+
|
|
404
|
+
### Authorization
|
|
405
|
+
|
|
406
|
+
[Bearer](../README.md#Bearer)
|
|
407
|
+
|
|
408
|
+
### HTTP request headers
|
|
409
|
+
|
|
410
|
+
- **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
|
|
411
|
+
- **Accept**: application/json
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
## user_email_sign_up
|
|
415
|
+
|
|
416
|
+
> <TokenModelApiResponse> user_email_sign_up(app_key, opts)
|
|
417
|
+
|
|
418
|
+
邮箱注册
|
|
419
|
+
|
|
420
|
+
使用邮箱进行注册
|
|
421
|
+
|
|
422
|
+
### Examples
|
|
423
|
+
|
|
424
|
+
```ruby
|
|
425
|
+
require 'time'
|
|
426
|
+
require 'zsgf_client'
|
|
427
|
+
# setup authorization
|
|
428
|
+
ZSGFClient.configure do |config|
|
|
429
|
+
# Configure Bearer authorization: Bearer
|
|
430
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
431
|
+
end
|
|
432
|
+
|
|
433
|
+
api_instance = ZSGFClient::UserApi.new
|
|
434
|
+
app_key = 'app_key_example' # String |
|
|
435
|
+
opts = {
|
|
436
|
+
email_sign_up_request: ZSGFClient::EmailSignUpRequest.new({email: 'email_example', pwd: 'pwd_example'}) # EmailSignUpRequest | 注册请求参数
|
|
437
|
+
}
|
|
438
|
+
|
|
439
|
+
begin
|
|
440
|
+
# 邮箱注册
|
|
441
|
+
result = api_instance.user_email_sign_up(app_key, opts)
|
|
442
|
+
p result
|
|
443
|
+
rescue ZSGFClient::ApiError => e
|
|
444
|
+
puts "Error when calling UserApi->user_email_sign_up: #{e}"
|
|
445
|
+
end
|
|
446
|
+
```
|
|
447
|
+
|
|
448
|
+
#### Using the user_email_sign_up_with_http_info variant
|
|
449
|
+
|
|
450
|
+
This returns an Array which contains the response data, status code and headers.
|
|
451
|
+
|
|
452
|
+
> <Array(<TokenModelApiResponse>, Integer, Hash)> user_email_sign_up_with_http_info(app_key, opts)
|
|
453
|
+
|
|
454
|
+
```ruby
|
|
455
|
+
begin
|
|
456
|
+
# 邮箱注册
|
|
457
|
+
data, status_code, headers = api_instance.user_email_sign_up_with_http_info(app_key, opts)
|
|
458
|
+
p status_code # => 2xx
|
|
459
|
+
p headers # => { ... }
|
|
460
|
+
p data # => <TokenModelApiResponse>
|
|
461
|
+
rescue ZSGFClient::ApiError => e
|
|
462
|
+
puts "Error when calling UserApi->user_email_sign_up_with_http_info: #{e}"
|
|
463
|
+
end
|
|
464
|
+
```
|
|
465
|
+
|
|
466
|
+
### Parameters
|
|
467
|
+
|
|
468
|
+
| Name | Type | Description | Notes |
|
|
469
|
+
| ---- | ---- | ----------- | ----- |
|
|
470
|
+
| **app_key** | **String** | | |
|
|
471
|
+
| **email_sign_up_request** | [**EmailSignUpRequest**](EmailSignUpRequest.md) | 注册请求参数 | [optional] |
|
|
472
|
+
|
|
473
|
+
### Return type
|
|
474
|
+
|
|
475
|
+
[**TokenModelApiResponse**](TokenModelApiResponse.md)
|
|
476
|
+
|
|
477
|
+
### Authorization
|
|
478
|
+
|
|
479
|
+
[Bearer](../README.md#Bearer)
|
|
480
|
+
|
|
481
|
+
### HTTP request headers
|
|
482
|
+
|
|
483
|
+
- **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
|
|
484
|
+
- **Accept**: application/json
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
## user_export
|
|
488
|
+
|
|
489
|
+
> File user_export(app_key)
|
|
490
|
+
|
|
491
|
+
导出用户数据
|
|
492
|
+
|
|
493
|
+
导出所有用户数据为Excel文件
|
|
494
|
+
|
|
495
|
+
### Examples
|
|
496
|
+
|
|
497
|
+
```ruby
|
|
498
|
+
require 'time'
|
|
499
|
+
require 'zsgf_client'
|
|
500
|
+
# setup authorization
|
|
501
|
+
ZSGFClient.configure do |config|
|
|
502
|
+
# Configure Bearer authorization: Bearer
|
|
503
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
504
|
+
end
|
|
505
|
+
|
|
506
|
+
api_instance = ZSGFClient::UserApi.new
|
|
507
|
+
app_key = 'app_key_example' # String |
|
|
508
|
+
|
|
509
|
+
begin
|
|
510
|
+
# 导出用户数据
|
|
511
|
+
result = api_instance.user_export(app_key)
|
|
512
|
+
p result
|
|
513
|
+
rescue ZSGFClient::ApiError => e
|
|
514
|
+
puts "Error when calling UserApi->user_export: #{e}"
|
|
515
|
+
end
|
|
516
|
+
```
|
|
517
|
+
|
|
518
|
+
#### Using the user_export_with_http_info variant
|
|
519
|
+
|
|
520
|
+
This returns an Array which contains the response data, status code and headers.
|
|
521
|
+
|
|
522
|
+
> <Array(File, Integer, Hash)> user_export_with_http_info(app_key)
|
|
523
|
+
|
|
524
|
+
```ruby
|
|
525
|
+
begin
|
|
526
|
+
# 导出用户数据
|
|
527
|
+
data, status_code, headers = api_instance.user_export_with_http_info(app_key)
|
|
528
|
+
p status_code # => 2xx
|
|
529
|
+
p headers # => { ... }
|
|
530
|
+
p data # => File
|
|
531
|
+
rescue ZSGFClient::ApiError => e
|
|
532
|
+
puts "Error when calling UserApi->user_export_with_http_info: #{e}"
|
|
533
|
+
end
|
|
534
|
+
```
|
|
535
|
+
|
|
536
|
+
### Parameters
|
|
537
|
+
|
|
538
|
+
| Name | Type | Description | Notes |
|
|
539
|
+
| ---- | ---- | ----------- | ----- |
|
|
540
|
+
| **app_key** | **String** | | |
|
|
541
|
+
|
|
542
|
+
### Return type
|
|
543
|
+
|
|
544
|
+
**File**
|
|
545
|
+
|
|
546
|
+
### Authorization
|
|
547
|
+
|
|
548
|
+
[Bearer](../README.md#Bearer)
|
|
549
|
+
|
|
550
|
+
### HTTP request headers
|
|
551
|
+
|
|
552
|
+
- **Content-Type**: Not defined
|
|
553
|
+
- **Accept**: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
## user_follow_user
|
|
557
|
+
|
|
558
|
+
> <BooleanApiResponse> user_follow_user(user_id, app_key)
|
|
559
|
+
|
|
560
|
+
关注用户
|
|
561
|
+
|
|
562
|
+
关注指定用户
|
|
563
|
+
|
|
564
|
+
### Examples
|
|
565
|
+
|
|
566
|
+
```ruby
|
|
567
|
+
require 'time'
|
|
568
|
+
require 'zsgf_client'
|
|
569
|
+
# setup authorization
|
|
570
|
+
ZSGFClient.configure do |config|
|
|
571
|
+
# Configure Bearer authorization: Bearer
|
|
572
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
573
|
+
end
|
|
574
|
+
|
|
575
|
+
api_instance = ZSGFClient::UserApi.new
|
|
576
|
+
user_id = 789 # Integer | 要关注的用户ID
|
|
577
|
+
app_key = 'app_key_example' # String |
|
|
578
|
+
|
|
579
|
+
begin
|
|
580
|
+
# 关注用户
|
|
581
|
+
result = api_instance.user_follow_user(user_id, app_key)
|
|
582
|
+
p result
|
|
583
|
+
rescue ZSGFClient::ApiError => e
|
|
584
|
+
puts "Error when calling UserApi->user_follow_user: #{e}"
|
|
585
|
+
end
|
|
586
|
+
```
|
|
587
|
+
|
|
588
|
+
#### Using the user_follow_user_with_http_info variant
|
|
589
|
+
|
|
590
|
+
This returns an Array which contains the response data, status code and headers.
|
|
591
|
+
|
|
592
|
+
> <Array(<BooleanApiResponse>, Integer, Hash)> user_follow_user_with_http_info(user_id, app_key)
|
|
593
|
+
|
|
594
|
+
```ruby
|
|
595
|
+
begin
|
|
596
|
+
# 关注用户
|
|
597
|
+
data, status_code, headers = api_instance.user_follow_user_with_http_info(user_id, app_key)
|
|
598
|
+
p status_code # => 2xx
|
|
599
|
+
p headers # => { ... }
|
|
600
|
+
p data # => <BooleanApiResponse>
|
|
601
|
+
rescue ZSGFClient::ApiError => e
|
|
602
|
+
puts "Error when calling UserApi->user_follow_user_with_http_info: #{e}"
|
|
603
|
+
end
|
|
604
|
+
```
|
|
605
|
+
|
|
606
|
+
### Parameters
|
|
607
|
+
|
|
608
|
+
| Name | Type | Description | Notes |
|
|
609
|
+
| ---- | ---- | ----------- | ----- |
|
|
610
|
+
| **user_id** | **Integer** | 要关注的用户ID | |
|
|
611
|
+
| **app_key** | **String** | | |
|
|
612
|
+
|
|
613
|
+
### Return type
|
|
614
|
+
|
|
615
|
+
[**BooleanApiResponse**](BooleanApiResponse.md)
|
|
616
|
+
|
|
617
|
+
### Authorization
|
|
618
|
+
|
|
619
|
+
[Bearer](../README.md#Bearer)
|
|
620
|
+
|
|
621
|
+
### HTTP request headers
|
|
622
|
+
|
|
623
|
+
- **Content-Type**: Not defined
|
|
624
|
+
- **Accept**: application/json
|
|
625
|
+
|
|
626
|
+
|
|
627
|
+
## user_follower_put
|
|
628
|
+
|
|
629
|
+
> <BooleanApiResponse> user_follower_put(id, app_key, opts)
|
|
630
|
+
|
|
631
|
+
更新粉丝
|
|
632
|
+
|
|
633
|
+
根据粉丝ID更新粉丝信息
|
|
634
|
+
|
|
635
|
+
### Examples
|
|
636
|
+
|
|
637
|
+
```ruby
|
|
638
|
+
require 'time'
|
|
639
|
+
require 'zsgf_client'
|
|
640
|
+
# setup authorization
|
|
641
|
+
ZSGFClient.configure do |config|
|
|
642
|
+
# Configure Bearer authorization: Bearer
|
|
643
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
644
|
+
end
|
|
645
|
+
|
|
646
|
+
api_instance = ZSGFClient::UserApi.new
|
|
647
|
+
id = 789 # Integer | 粉丝ID
|
|
648
|
+
app_key = 'app_key_example' # String |
|
|
649
|
+
opts = {
|
|
650
|
+
follower_put_model: ZSGFClient::FollowerPutModel.new # FollowerPutModel | 更新粉丝的请求参数
|
|
651
|
+
}
|
|
652
|
+
|
|
653
|
+
begin
|
|
654
|
+
# 更新粉丝
|
|
655
|
+
result = api_instance.user_follower_put(id, app_key, opts)
|
|
656
|
+
p result
|
|
657
|
+
rescue ZSGFClient::ApiError => e
|
|
658
|
+
puts "Error when calling UserApi->user_follower_put: #{e}"
|
|
659
|
+
end
|
|
660
|
+
```
|
|
661
|
+
|
|
662
|
+
#### Using the user_follower_put_with_http_info variant
|
|
663
|
+
|
|
664
|
+
This returns an Array which contains the response data, status code and headers.
|
|
665
|
+
|
|
666
|
+
> <Array(<BooleanApiResponse>, Integer, Hash)> user_follower_put_with_http_info(id, app_key, opts)
|
|
667
|
+
|
|
668
|
+
```ruby
|
|
669
|
+
begin
|
|
670
|
+
# 更新粉丝
|
|
671
|
+
data, status_code, headers = api_instance.user_follower_put_with_http_info(id, app_key, opts)
|
|
672
|
+
p status_code # => 2xx
|
|
673
|
+
p headers # => { ... }
|
|
674
|
+
p data # => <BooleanApiResponse>
|
|
675
|
+
rescue ZSGFClient::ApiError => e
|
|
676
|
+
puts "Error when calling UserApi->user_follower_put_with_http_info: #{e}"
|
|
677
|
+
end
|
|
678
|
+
```
|
|
679
|
+
|
|
680
|
+
### Parameters
|
|
681
|
+
|
|
682
|
+
| Name | Type | Description | Notes |
|
|
683
|
+
| ---- | ---- | ----------- | ----- |
|
|
684
|
+
| **id** | **Integer** | 粉丝ID | |
|
|
685
|
+
| **app_key** | **String** | | |
|
|
686
|
+
| **follower_put_model** | [**FollowerPutModel**](FollowerPutModel.md) | 更新粉丝的请求参数 | [optional] |
|
|
687
|
+
|
|
688
|
+
### Return type
|
|
689
|
+
|
|
690
|
+
[**BooleanApiResponse**](BooleanApiResponse.md)
|
|
691
|
+
|
|
692
|
+
### Authorization
|
|
693
|
+
|
|
694
|
+
[Bearer](../README.md#Bearer)
|
|
695
|
+
|
|
696
|
+
### HTTP request headers
|
|
697
|
+
|
|
698
|
+
- **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
|
|
699
|
+
- **Accept**: application/json
|
|
700
|
+
|
|
701
|
+
|
|
702
|
+
## user_followers
|
|
703
|
+
|
|
704
|
+
> <UserFollowersResultApiResponse> user_followers(app_key, opts)
|
|
705
|
+
|
|
706
|
+
获取我的粉丝列表
|
|
707
|
+
|
|
708
|
+
根据条件获取我的粉丝列表
|
|
709
|
+
|
|
710
|
+
### Examples
|
|
711
|
+
|
|
712
|
+
```ruby
|
|
713
|
+
require 'time'
|
|
714
|
+
require 'zsgf_client'
|
|
715
|
+
# setup authorization
|
|
716
|
+
ZSGFClient.configure do |config|
|
|
717
|
+
# Configure Bearer authorization: Bearer
|
|
718
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
719
|
+
end
|
|
720
|
+
|
|
721
|
+
api_instance = ZSGFClient::UserApi.new
|
|
722
|
+
app_key = 'app_key_example' # String |
|
|
723
|
+
opts = {
|
|
724
|
+
tag: 'tag_example', # String | 标签
|
|
725
|
+
status: 'status_example', # String | 状态
|
|
726
|
+
skip: 56, # Integer | 跳过的记录数
|
|
727
|
+
take: 56 # Integer | 获取的记录数
|
|
728
|
+
}
|
|
729
|
+
|
|
730
|
+
begin
|
|
731
|
+
# 获取我的粉丝列表
|
|
732
|
+
result = api_instance.user_followers(app_key, opts)
|
|
733
|
+
p result
|
|
734
|
+
rescue ZSGFClient::ApiError => e
|
|
735
|
+
puts "Error when calling UserApi->user_followers: #{e}"
|
|
736
|
+
end
|
|
737
|
+
```
|
|
738
|
+
|
|
739
|
+
#### Using the user_followers_with_http_info variant
|
|
740
|
+
|
|
741
|
+
This returns an Array which contains the response data, status code and headers.
|
|
742
|
+
|
|
743
|
+
> <Array(<UserFollowersResultApiResponse>, Integer, Hash)> user_followers_with_http_info(app_key, opts)
|
|
744
|
+
|
|
745
|
+
```ruby
|
|
746
|
+
begin
|
|
747
|
+
# 获取我的粉丝列表
|
|
748
|
+
data, status_code, headers = api_instance.user_followers_with_http_info(app_key, opts)
|
|
749
|
+
p status_code # => 2xx
|
|
750
|
+
p headers # => { ... }
|
|
751
|
+
p data # => <UserFollowersResultApiResponse>
|
|
752
|
+
rescue ZSGFClient::ApiError => e
|
|
753
|
+
puts "Error when calling UserApi->user_followers_with_http_info: #{e}"
|
|
754
|
+
end
|
|
755
|
+
```
|
|
756
|
+
|
|
757
|
+
### Parameters
|
|
758
|
+
|
|
759
|
+
| Name | Type | Description | Notes |
|
|
760
|
+
| ---- | ---- | ----------- | ----- |
|
|
761
|
+
| **app_key** | **String** | | |
|
|
762
|
+
| **tag** | **String** | 标签 | [optional] |
|
|
763
|
+
| **status** | **String** | 状态 | [optional] |
|
|
764
|
+
| **skip** | **Integer** | 跳过的记录数 | [optional][default to 0] |
|
|
765
|
+
| **take** | **Integer** | 获取的记录数 | [optional][default to 10] |
|
|
766
|
+
|
|
767
|
+
### Return type
|
|
768
|
+
|
|
769
|
+
[**UserFollowersResultApiResponse**](UserFollowersResultApiResponse.md)
|
|
770
|
+
|
|
771
|
+
### Authorization
|
|
772
|
+
|
|
773
|
+
[Bearer](../README.md#Bearer)
|
|
774
|
+
|
|
775
|
+
### HTTP request headers
|
|
776
|
+
|
|
777
|
+
- **Content-Type**: Not defined
|
|
778
|
+
- **Accept**: application/json
|
|
779
|
+
|
|
780
|
+
|
|
781
|
+
## user_following
|
|
782
|
+
|
|
783
|
+
> <UserFollowingResultApiResponse> user_following(app_key, opts)
|
|
784
|
+
|
|
785
|
+
获取我的关注列表
|
|
786
|
+
|
|
787
|
+
根据条件获取我的关注列表
|
|
788
|
+
|
|
789
|
+
### Examples
|
|
790
|
+
|
|
791
|
+
```ruby
|
|
792
|
+
require 'time'
|
|
793
|
+
require 'zsgf_client'
|
|
794
|
+
# setup authorization
|
|
795
|
+
ZSGFClient.configure do |config|
|
|
796
|
+
# Configure Bearer authorization: Bearer
|
|
797
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
798
|
+
end
|
|
799
|
+
|
|
800
|
+
api_instance = ZSGFClient::UserApi.new
|
|
801
|
+
app_key = 'app_key_example' # String |
|
|
802
|
+
opts = {
|
|
803
|
+
tag: 'tag_example', # String | 标签
|
|
804
|
+
status: 'status_example', # String | 状态
|
|
805
|
+
skip: 56, # Integer | 跳过的记录数
|
|
806
|
+
take: 56 # Integer | 获取的记录数
|
|
807
|
+
}
|
|
808
|
+
|
|
809
|
+
begin
|
|
810
|
+
# 获取我的关注列表
|
|
811
|
+
result = api_instance.user_following(app_key, opts)
|
|
812
|
+
p result
|
|
813
|
+
rescue ZSGFClient::ApiError => e
|
|
814
|
+
puts "Error when calling UserApi->user_following: #{e}"
|
|
815
|
+
end
|
|
816
|
+
```
|
|
817
|
+
|
|
818
|
+
#### Using the user_following_with_http_info variant
|
|
819
|
+
|
|
820
|
+
This returns an Array which contains the response data, status code and headers.
|
|
821
|
+
|
|
822
|
+
> <Array(<UserFollowingResultApiResponse>, Integer, Hash)> user_following_with_http_info(app_key, opts)
|
|
823
|
+
|
|
824
|
+
```ruby
|
|
825
|
+
begin
|
|
826
|
+
# 获取我的关注列表
|
|
827
|
+
data, status_code, headers = api_instance.user_following_with_http_info(app_key, opts)
|
|
828
|
+
p status_code # => 2xx
|
|
829
|
+
p headers # => { ... }
|
|
830
|
+
p data # => <UserFollowingResultApiResponse>
|
|
831
|
+
rescue ZSGFClient::ApiError => e
|
|
832
|
+
puts "Error when calling UserApi->user_following_with_http_info: #{e}"
|
|
833
|
+
end
|
|
834
|
+
```
|
|
835
|
+
|
|
836
|
+
### Parameters
|
|
837
|
+
|
|
838
|
+
| Name | Type | Description | Notes |
|
|
839
|
+
| ---- | ---- | ----------- | ----- |
|
|
840
|
+
| **app_key** | **String** | | |
|
|
841
|
+
| **tag** | **String** | 标签 | [optional] |
|
|
842
|
+
| **status** | **String** | 状态 | [optional] |
|
|
843
|
+
| **skip** | **Integer** | 跳过的记录数 | [optional][default to 0] |
|
|
844
|
+
| **take** | **Integer** | 获取的记录数 | [optional][default to 10] |
|
|
845
|
+
|
|
846
|
+
### Return type
|
|
847
|
+
|
|
848
|
+
[**UserFollowingResultApiResponse**](UserFollowingResultApiResponse.md)
|
|
849
|
+
|
|
850
|
+
### Authorization
|
|
851
|
+
|
|
852
|
+
[Bearer](../README.md#Bearer)
|
|
853
|
+
|
|
854
|
+
### HTTP request headers
|
|
855
|
+
|
|
856
|
+
- **Content-Type**: Not defined
|
|
857
|
+
- **Accept**: application/json
|
|
858
|
+
|
|
859
|
+
|
|
860
|
+
## user_friends_near_by
|
|
861
|
+
|
|
862
|
+
> <UserFriendsNearByResultApiResponse> user_friends_near_by(x, y, distance, app_key, opts)
|
|
863
|
+
|
|
864
|
+
附近的用户推荐
|
|
865
|
+
|
|
866
|
+
推荐附近的用户
|
|
867
|
+
|
|
868
|
+
### Examples
|
|
869
|
+
|
|
870
|
+
```ruby
|
|
871
|
+
require 'time'
|
|
872
|
+
require 'zsgf_client'
|
|
873
|
+
# setup authorization
|
|
874
|
+
ZSGFClient.configure do |config|
|
|
875
|
+
# Configure Bearer authorization: Bearer
|
|
876
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
877
|
+
end
|
|
878
|
+
|
|
879
|
+
api_instance = ZSGFClient::UserApi.new
|
|
880
|
+
x = 1.2 # Float | 纬度
|
|
881
|
+
y = 1.2 # Float | 经度
|
|
882
|
+
distance = 789 # Integer | 附近距离,单位:米
|
|
883
|
+
app_key = 'app_key_example' # String |
|
|
884
|
+
opts = {
|
|
885
|
+
gender: 'gender_example', # String | 性别
|
|
886
|
+
age_s: 56, # Integer | 年龄段起始
|
|
887
|
+
age_e: 56, # Integer | 年龄段结束
|
|
888
|
+
tag: 'tag_example', # String | 兴趣标签
|
|
889
|
+
type: 'type_example', # String | 分类
|
|
890
|
+
skip: 56, # Integer | 跳过的记录数
|
|
891
|
+
take: 56 # Integer | 获取的记录数
|
|
892
|
+
}
|
|
893
|
+
|
|
894
|
+
begin
|
|
895
|
+
# 附近的用户推荐
|
|
896
|
+
result = api_instance.user_friends_near_by(x, y, distance, app_key, opts)
|
|
897
|
+
p result
|
|
898
|
+
rescue ZSGFClient::ApiError => e
|
|
899
|
+
puts "Error when calling UserApi->user_friends_near_by: #{e}"
|
|
900
|
+
end
|
|
901
|
+
```
|
|
902
|
+
|
|
903
|
+
#### Using the user_friends_near_by_with_http_info variant
|
|
904
|
+
|
|
905
|
+
This returns an Array which contains the response data, status code and headers.
|
|
906
|
+
|
|
907
|
+
> <Array(<UserFriendsNearByResultApiResponse>, Integer, Hash)> user_friends_near_by_with_http_info(x, y, distance, app_key, opts)
|
|
908
|
+
|
|
909
|
+
```ruby
|
|
910
|
+
begin
|
|
911
|
+
# 附近的用户推荐
|
|
912
|
+
data, status_code, headers = api_instance.user_friends_near_by_with_http_info(x, y, distance, app_key, opts)
|
|
913
|
+
p status_code # => 2xx
|
|
914
|
+
p headers # => { ... }
|
|
915
|
+
p data # => <UserFriendsNearByResultApiResponse>
|
|
916
|
+
rescue ZSGFClient::ApiError => e
|
|
917
|
+
puts "Error when calling UserApi->user_friends_near_by_with_http_info: #{e}"
|
|
918
|
+
end
|
|
919
|
+
```
|
|
920
|
+
|
|
921
|
+
### Parameters
|
|
922
|
+
|
|
923
|
+
| Name | Type | Description | Notes |
|
|
924
|
+
| ---- | ---- | ----------- | ----- |
|
|
925
|
+
| **x** | **Float** | 纬度 | |
|
|
926
|
+
| **y** | **Float** | 经度 | |
|
|
927
|
+
| **distance** | **Integer** | 附近距离,单位:米 | |
|
|
928
|
+
| **app_key** | **String** | | |
|
|
929
|
+
| **gender** | **String** | 性别 | [optional] |
|
|
930
|
+
| **age_s** | **Integer** | 年龄段起始 | [optional] |
|
|
931
|
+
| **age_e** | **Integer** | 年龄段结束 | [optional] |
|
|
932
|
+
| **tag** | **String** | 兴趣标签 | [optional] |
|
|
933
|
+
| **type** | **String** | 分类 | [optional] |
|
|
934
|
+
| **skip** | **Integer** | 跳过的记录数 | [optional][default to 0] |
|
|
935
|
+
| **take** | **Integer** | 获取的记录数 | [optional][default to 10] |
|
|
936
|
+
|
|
937
|
+
### Return type
|
|
938
|
+
|
|
939
|
+
[**UserFriendsNearByResultApiResponse**](UserFriendsNearByResultApiResponse.md)
|
|
940
|
+
|
|
941
|
+
### Authorization
|
|
942
|
+
|
|
943
|
+
[Bearer](../README.md#Bearer)
|
|
944
|
+
|
|
945
|
+
### HTTP request headers
|
|
946
|
+
|
|
947
|
+
- **Content-Type**: Not defined
|
|
948
|
+
- **Accept**: application/json
|
|
949
|
+
|
|
950
|
+
|
|
951
|
+
## user_import
|
|
952
|
+
|
|
953
|
+
> <BooleanApiResponse> user_import(app_key, opts)
|
|
954
|
+
|
|
955
|
+
导入用户数据
|
|
956
|
+
|
|
957
|
+
导入用户数据
|
|
958
|
+
|
|
959
|
+
### Examples
|
|
960
|
+
|
|
961
|
+
```ruby
|
|
962
|
+
require 'time'
|
|
963
|
+
require 'zsgf_client'
|
|
964
|
+
# setup authorization
|
|
965
|
+
ZSGFClient.configure do |config|
|
|
966
|
+
# Configure Bearer authorization: Bearer
|
|
967
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
968
|
+
end
|
|
969
|
+
|
|
970
|
+
api_instance = ZSGFClient::UserApi.new
|
|
971
|
+
app_key = 'app_key_example' # String |
|
|
972
|
+
opts = {
|
|
973
|
+
check: true, # Boolean | 是否进行检查
|
|
974
|
+
file: File.new('/path/to/some/file') # File | 导入的文件
|
|
975
|
+
}
|
|
976
|
+
|
|
977
|
+
begin
|
|
978
|
+
# 导入用户数据
|
|
979
|
+
result = api_instance.user_import(app_key, opts)
|
|
980
|
+
p result
|
|
981
|
+
rescue ZSGFClient::ApiError => e
|
|
982
|
+
puts "Error when calling UserApi->user_import: #{e}"
|
|
983
|
+
end
|
|
984
|
+
```
|
|
985
|
+
|
|
986
|
+
#### Using the user_import_with_http_info variant
|
|
987
|
+
|
|
988
|
+
This returns an Array which contains the response data, status code and headers.
|
|
989
|
+
|
|
990
|
+
> <Array(<BooleanApiResponse>, Integer, Hash)> user_import_with_http_info(app_key, opts)
|
|
991
|
+
|
|
992
|
+
```ruby
|
|
993
|
+
begin
|
|
994
|
+
# 导入用户数据
|
|
995
|
+
data, status_code, headers = api_instance.user_import_with_http_info(app_key, opts)
|
|
996
|
+
p status_code # => 2xx
|
|
997
|
+
p headers # => { ... }
|
|
998
|
+
p data # => <BooleanApiResponse>
|
|
999
|
+
rescue ZSGFClient::ApiError => e
|
|
1000
|
+
puts "Error when calling UserApi->user_import_with_http_info: #{e}"
|
|
1001
|
+
end
|
|
1002
|
+
```
|
|
1003
|
+
|
|
1004
|
+
### Parameters
|
|
1005
|
+
|
|
1006
|
+
| Name | Type | Description | Notes |
|
|
1007
|
+
| ---- | ---- | ----------- | ----- |
|
|
1008
|
+
| **app_key** | **String** | | |
|
|
1009
|
+
| **check** | **Boolean** | 是否进行检查 | [optional] |
|
|
1010
|
+
| **file** | **File** | 导入的文件 | [optional] |
|
|
1011
|
+
|
|
1012
|
+
### Return type
|
|
1013
|
+
|
|
1014
|
+
[**BooleanApiResponse**](BooleanApiResponse.md)
|
|
1015
|
+
|
|
1016
|
+
### Authorization
|
|
1017
|
+
|
|
1018
|
+
[Bearer](../README.md#Bearer)
|
|
1019
|
+
|
|
1020
|
+
### HTTP request headers
|
|
1021
|
+
|
|
1022
|
+
- **Content-Type**: multipart/form-data
|
|
1023
|
+
- **Accept**: application/json
|
|
1024
|
+
|
|
1025
|
+
|
|
1026
|
+
## user_location
|
|
1027
|
+
|
|
1028
|
+
> <GeoLocationModelApiResponse> user_location(id, app_key)
|
|
1029
|
+
|
|
1030
|
+
获取位置详情
|
|
1031
|
+
|
|
1032
|
+
根据位置ID获取位置详情
|
|
1033
|
+
|
|
1034
|
+
### Examples
|
|
1035
|
+
|
|
1036
|
+
```ruby
|
|
1037
|
+
require 'time'
|
|
1038
|
+
require 'zsgf_client'
|
|
1039
|
+
# setup authorization
|
|
1040
|
+
ZSGFClient.configure do |config|
|
|
1041
|
+
# Configure Bearer authorization: Bearer
|
|
1042
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1043
|
+
end
|
|
1044
|
+
|
|
1045
|
+
api_instance = ZSGFClient::UserApi.new
|
|
1046
|
+
id = 789 # Integer | 位置ID
|
|
1047
|
+
app_key = 'app_key_example' # String |
|
|
1048
|
+
|
|
1049
|
+
begin
|
|
1050
|
+
# 获取位置详情
|
|
1051
|
+
result = api_instance.user_location(id, app_key)
|
|
1052
|
+
p result
|
|
1053
|
+
rescue ZSGFClient::ApiError => e
|
|
1054
|
+
puts "Error when calling UserApi->user_location: #{e}"
|
|
1055
|
+
end
|
|
1056
|
+
```
|
|
1057
|
+
|
|
1058
|
+
#### Using the user_location_with_http_info variant
|
|
1059
|
+
|
|
1060
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1061
|
+
|
|
1062
|
+
> <Array(<GeoLocationModelApiResponse>, Integer, Hash)> user_location_with_http_info(id, app_key)
|
|
1063
|
+
|
|
1064
|
+
```ruby
|
|
1065
|
+
begin
|
|
1066
|
+
# 获取位置详情
|
|
1067
|
+
data, status_code, headers = api_instance.user_location_with_http_info(id, app_key)
|
|
1068
|
+
p status_code # => 2xx
|
|
1069
|
+
p headers # => { ... }
|
|
1070
|
+
p data # => <GeoLocationModelApiResponse>
|
|
1071
|
+
rescue ZSGFClient::ApiError => e
|
|
1072
|
+
puts "Error when calling UserApi->user_location_with_http_info: #{e}"
|
|
1073
|
+
end
|
|
1074
|
+
```
|
|
1075
|
+
|
|
1076
|
+
### Parameters
|
|
1077
|
+
|
|
1078
|
+
| Name | Type | Description | Notes |
|
|
1079
|
+
| ---- | ---- | ----------- | ----- |
|
|
1080
|
+
| **id** | **Integer** | 位置ID | |
|
|
1081
|
+
| **app_key** | **String** | | |
|
|
1082
|
+
|
|
1083
|
+
### Return type
|
|
1084
|
+
|
|
1085
|
+
[**GeoLocationModelApiResponse**](GeoLocationModelApiResponse.md)
|
|
1086
|
+
|
|
1087
|
+
### Authorization
|
|
1088
|
+
|
|
1089
|
+
[Bearer](../README.md#Bearer)
|
|
1090
|
+
|
|
1091
|
+
### HTTP request headers
|
|
1092
|
+
|
|
1093
|
+
- **Content-Type**: Not defined
|
|
1094
|
+
- **Accept**: application/json
|
|
1095
|
+
|
|
1096
|
+
|
|
1097
|
+
## user_location_delete
|
|
1098
|
+
|
|
1099
|
+
> <BooleanApiResponse> user_location_delete(id, app_key)
|
|
1100
|
+
|
|
1101
|
+
删除位置
|
|
1102
|
+
|
|
1103
|
+
根据位置ID删除位置信息
|
|
1104
|
+
|
|
1105
|
+
### Examples
|
|
1106
|
+
|
|
1107
|
+
```ruby
|
|
1108
|
+
require 'time'
|
|
1109
|
+
require 'zsgf_client'
|
|
1110
|
+
# setup authorization
|
|
1111
|
+
ZSGFClient.configure do |config|
|
|
1112
|
+
# Configure Bearer authorization: Bearer
|
|
1113
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1114
|
+
end
|
|
1115
|
+
|
|
1116
|
+
api_instance = ZSGFClient::UserApi.new
|
|
1117
|
+
id = 789 # Integer | 位置ID
|
|
1118
|
+
app_key = 'app_key_example' # String |
|
|
1119
|
+
|
|
1120
|
+
begin
|
|
1121
|
+
# 删除位置
|
|
1122
|
+
result = api_instance.user_location_delete(id, app_key)
|
|
1123
|
+
p result
|
|
1124
|
+
rescue ZSGFClient::ApiError => e
|
|
1125
|
+
puts "Error when calling UserApi->user_location_delete: #{e}"
|
|
1126
|
+
end
|
|
1127
|
+
```
|
|
1128
|
+
|
|
1129
|
+
#### Using the user_location_delete_with_http_info variant
|
|
1130
|
+
|
|
1131
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1132
|
+
|
|
1133
|
+
> <Array(<BooleanApiResponse>, Integer, Hash)> user_location_delete_with_http_info(id, app_key)
|
|
1134
|
+
|
|
1135
|
+
```ruby
|
|
1136
|
+
begin
|
|
1137
|
+
# 删除位置
|
|
1138
|
+
data, status_code, headers = api_instance.user_location_delete_with_http_info(id, app_key)
|
|
1139
|
+
p status_code # => 2xx
|
|
1140
|
+
p headers # => { ... }
|
|
1141
|
+
p data # => <BooleanApiResponse>
|
|
1142
|
+
rescue ZSGFClient::ApiError => e
|
|
1143
|
+
puts "Error when calling UserApi->user_location_delete_with_http_info: #{e}"
|
|
1144
|
+
end
|
|
1145
|
+
```
|
|
1146
|
+
|
|
1147
|
+
### Parameters
|
|
1148
|
+
|
|
1149
|
+
| Name | Type | Description | Notes |
|
|
1150
|
+
| ---- | ---- | ----------- | ----- |
|
|
1151
|
+
| **id** | **Integer** | 位置ID | |
|
|
1152
|
+
| **app_key** | **String** | | |
|
|
1153
|
+
|
|
1154
|
+
### Return type
|
|
1155
|
+
|
|
1156
|
+
[**BooleanApiResponse**](BooleanApiResponse.md)
|
|
1157
|
+
|
|
1158
|
+
### Authorization
|
|
1159
|
+
|
|
1160
|
+
[Bearer](../README.md#Bearer)
|
|
1161
|
+
|
|
1162
|
+
### HTTP request headers
|
|
1163
|
+
|
|
1164
|
+
- **Content-Type**: Not defined
|
|
1165
|
+
- **Accept**: application/json
|
|
1166
|
+
|
|
1167
|
+
|
|
1168
|
+
## user_location_post
|
|
1169
|
+
|
|
1170
|
+
> <UserLocationPostResultApiResponse> user_location_post(app_key, opts)
|
|
1171
|
+
|
|
1172
|
+
添加位置
|
|
1173
|
+
|
|
1174
|
+
添加新的位置信息
|
|
1175
|
+
|
|
1176
|
+
### Examples
|
|
1177
|
+
|
|
1178
|
+
```ruby
|
|
1179
|
+
require 'time'
|
|
1180
|
+
require 'zsgf_client'
|
|
1181
|
+
# setup authorization
|
|
1182
|
+
ZSGFClient.configure do |config|
|
|
1183
|
+
# Configure Bearer authorization: Bearer
|
|
1184
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1185
|
+
end
|
|
1186
|
+
|
|
1187
|
+
api_instance = ZSGFClient::UserApi.new
|
|
1188
|
+
app_key = 'app_key_example' # String |
|
|
1189
|
+
opts = {
|
|
1190
|
+
geo_location_model: ZSGFClient::GeoLocationModel.new # GeoLocationModel | 位置信息
|
|
1191
|
+
}
|
|
1192
|
+
|
|
1193
|
+
begin
|
|
1194
|
+
# 添加位置
|
|
1195
|
+
result = api_instance.user_location_post(app_key, opts)
|
|
1196
|
+
p result
|
|
1197
|
+
rescue ZSGFClient::ApiError => e
|
|
1198
|
+
puts "Error when calling UserApi->user_location_post: #{e}"
|
|
1199
|
+
end
|
|
1200
|
+
```
|
|
1201
|
+
|
|
1202
|
+
#### Using the user_location_post_with_http_info variant
|
|
1203
|
+
|
|
1204
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1205
|
+
|
|
1206
|
+
> <Array(<UserLocationPostResultApiResponse>, Integer, Hash)> user_location_post_with_http_info(app_key, opts)
|
|
1207
|
+
|
|
1208
|
+
```ruby
|
|
1209
|
+
begin
|
|
1210
|
+
# 添加位置
|
|
1211
|
+
data, status_code, headers = api_instance.user_location_post_with_http_info(app_key, opts)
|
|
1212
|
+
p status_code # => 2xx
|
|
1213
|
+
p headers # => { ... }
|
|
1214
|
+
p data # => <UserLocationPostResultApiResponse>
|
|
1215
|
+
rescue ZSGFClient::ApiError => e
|
|
1216
|
+
puts "Error when calling UserApi->user_location_post_with_http_info: #{e}"
|
|
1217
|
+
end
|
|
1218
|
+
```
|
|
1219
|
+
|
|
1220
|
+
### Parameters
|
|
1221
|
+
|
|
1222
|
+
| Name | Type | Description | Notes |
|
|
1223
|
+
| ---- | ---- | ----------- | ----- |
|
|
1224
|
+
| **app_key** | **String** | | |
|
|
1225
|
+
| **geo_location_model** | [**GeoLocationModel**](GeoLocationModel.md) | 位置信息 | [optional] |
|
|
1226
|
+
|
|
1227
|
+
### Return type
|
|
1228
|
+
|
|
1229
|
+
[**UserLocationPostResultApiResponse**](UserLocationPostResultApiResponse.md)
|
|
1230
|
+
|
|
1231
|
+
### Authorization
|
|
1232
|
+
|
|
1233
|
+
[Bearer](../README.md#Bearer)
|
|
1234
|
+
|
|
1235
|
+
### HTTP request headers
|
|
1236
|
+
|
|
1237
|
+
- **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
|
|
1238
|
+
- **Accept**: application/json
|
|
1239
|
+
|
|
1240
|
+
|
|
1241
|
+
## user_location_put
|
|
1242
|
+
|
|
1243
|
+
> <BooleanApiResponse> user_location_put(id, app_key, opts)
|
|
1244
|
+
|
|
1245
|
+
更新位置
|
|
1246
|
+
|
|
1247
|
+
根据位置ID更新位置信息
|
|
1248
|
+
|
|
1249
|
+
### Examples
|
|
1250
|
+
|
|
1251
|
+
```ruby
|
|
1252
|
+
require 'time'
|
|
1253
|
+
require 'zsgf_client'
|
|
1254
|
+
# setup authorization
|
|
1255
|
+
ZSGFClient.configure do |config|
|
|
1256
|
+
# Configure Bearer authorization: Bearer
|
|
1257
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1258
|
+
end
|
|
1259
|
+
|
|
1260
|
+
api_instance = ZSGFClient::UserApi.new
|
|
1261
|
+
id = 789 # Integer | 位置ID
|
|
1262
|
+
app_key = 'app_key_example' # String |
|
|
1263
|
+
opts = {
|
|
1264
|
+
geo_location_model: ZSGFClient::GeoLocationModel.new # GeoLocationModel | 位置信息
|
|
1265
|
+
}
|
|
1266
|
+
|
|
1267
|
+
begin
|
|
1268
|
+
# 更新位置
|
|
1269
|
+
result = api_instance.user_location_put(id, app_key, opts)
|
|
1270
|
+
p result
|
|
1271
|
+
rescue ZSGFClient::ApiError => e
|
|
1272
|
+
puts "Error when calling UserApi->user_location_put: #{e}"
|
|
1273
|
+
end
|
|
1274
|
+
```
|
|
1275
|
+
|
|
1276
|
+
#### Using the user_location_put_with_http_info variant
|
|
1277
|
+
|
|
1278
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1279
|
+
|
|
1280
|
+
> <Array(<BooleanApiResponse>, Integer, Hash)> user_location_put_with_http_info(id, app_key, opts)
|
|
1281
|
+
|
|
1282
|
+
```ruby
|
|
1283
|
+
begin
|
|
1284
|
+
# 更新位置
|
|
1285
|
+
data, status_code, headers = api_instance.user_location_put_with_http_info(id, app_key, opts)
|
|
1286
|
+
p status_code # => 2xx
|
|
1287
|
+
p headers # => { ... }
|
|
1288
|
+
p data # => <BooleanApiResponse>
|
|
1289
|
+
rescue ZSGFClient::ApiError => e
|
|
1290
|
+
puts "Error when calling UserApi->user_location_put_with_http_info: #{e}"
|
|
1291
|
+
end
|
|
1292
|
+
```
|
|
1293
|
+
|
|
1294
|
+
### Parameters
|
|
1295
|
+
|
|
1296
|
+
| Name | Type | Description | Notes |
|
|
1297
|
+
| ---- | ---- | ----------- | ----- |
|
|
1298
|
+
| **id** | **Integer** | 位置ID | |
|
|
1299
|
+
| **app_key** | **String** | | |
|
|
1300
|
+
| **geo_location_model** | [**GeoLocationModel**](GeoLocationModel.md) | 位置信息 | [optional] |
|
|
1301
|
+
|
|
1302
|
+
### Return type
|
|
1303
|
+
|
|
1304
|
+
[**BooleanApiResponse**](BooleanApiResponse.md)
|
|
1305
|
+
|
|
1306
|
+
### Authorization
|
|
1307
|
+
|
|
1308
|
+
[Bearer](../README.md#Bearer)
|
|
1309
|
+
|
|
1310
|
+
### HTTP request headers
|
|
1311
|
+
|
|
1312
|
+
- **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
|
|
1313
|
+
- **Accept**: application/json
|
|
1314
|
+
|
|
1315
|
+
|
|
1316
|
+
## user_locations
|
|
1317
|
+
|
|
1318
|
+
> <UserLocationsResultApiResponse> user_locations(app_key, opts)
|
|
1319
|
+
|
|
1320
|
+
获取位置列表
|
|
1321
|
+
|
|
1322
|
+
根据条件获取位置列表
|
|
1323
|
+
|
|
1324
|
+
### Examples
|
|
1325
|
+
|
|
1326
|
+
```ruby
|
|
1327
|
+
require 'time'
|
|
1328
|
+
require 'zsgf_client'
|
|
1329
|
+
# setup authorization
|
|
1330
|
+
ZSGFClient.configure do |config|
|
|
1331
|
+
# Configure Bearer authorization: Bearer
|
|
1332
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1333
|
+
end
|
|
1334
|
+
|
|
1335
|
+
api_instance = ZSGFClient::UserApi.new
|
|
1336
|
+
app_key = 'app_key_example' # String |
|
|
1337
|
+
opts = {
|
|
1338
|
+
tag: 'tag_example', # String | 标签
|
|
1339
|
+
type: 'type_example', # String | 分类
|
|
1340
|
+
x: 1.2, # Float | 纬度
|
|
1341
|
+
y: 1.2, # Float | 经度
|
|
1342
|
+
sphere: 789, # Integer | 附近距离,单位:米
|
|
1343
|
+
skip: 56, # Integer | 跳过的记录数
|
|
1344
|
+
take: 56 # Integer | 获取的记录数
|
|
1345
|
+
}
|
|
1346
|
+
|
|
1347
|
+
begin
|
|
1348
|
+
# 获取位置列表
|
|
1349
|
+
result = api_instance.user_locations(app_key, opts)
|
|
1350
|
+
p result
|
|
1351
|
+
rescue ZSGFClient::ApiError => e
|
|
1352
|
+
puts "Error when calling UserApi->user_locations: #{e}"
|
|
1353
|
+
end
|
|
1354
|
+
```
|
|
1355
|
+
|
|
1356
|
+
#### Using the user_locations_with_http_info variant
|
|
1357
|
+
|
|
1358
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1359
|
+
|
|
1360
|
+
> <Array(<UserLocationsResultApiResponse>, Integer, Hash)> user_locations_with_http_info(app_key, opts)
|
|
1361
|
+
|
|
1362
|
+
```ruby
|
|
1363
|
+
begin
|
|
1364
|
+
# 获取位置列表
|
|
1365
|
+
data, status_code, headers = api_instance.user_locations_with_http_info(app_key, opts)
|
|
1366
|
+
p status_code # => 2xx
|
|
1367
|
+
p headers # => { ... }
|
|
1368
|
+
p data # => <UserLocationsResultApiResponse>
|
|
1369
|
+
rescue ZSGFClient::ApiError => e
|
|
1370
|
+
puts "Error when calling UserApi->user_locations_with_http_info: #{e}"
|
|
1371
|
+
end
|
|
1372
|
+
```
|
|
1373
|
+
|
|
1374
|
+
### Parameters
|
|
1375
|
+
|
|
1376
|
+
| Name | Type | Description | Notes |
|
|
1377
|
+
| ---- | ---- | ----------- | ----- |
|
|
1378
|
+
| **app_key** | **String** | | |
|
|
1379
|
+
| **tag** | **String** | 标签 | [optional] |
|
|
1380
|
+
| **type** | **String** | 分类 | [optional] |
|
|
1381
|
+
| **x** | **Float** | 纬度 | [optional] |
|
|
1382
|
+
| **y** | **Float** | 经度 | [optional] |
|
|
1383
|
+
| **sphere** | **Integer** | 附近距离,单位:米 | [optional] |
|
|
1384
|
+
| **skip** | **Integer** | 跳过的记录数 | [optional] |
|
|
1385
|
+
| **take** | **Integer** | 获取的记录数 | [optional][default to 10] |
|
|
1386
|
+
|
|
1387
|
+
### Return type
|
|
1388
|
+
|
|
1389
|
+
[**UserLocationsResultApiResponse**](UserLocationsResultApiResponse.md)
|
|
1390
|
+
|
|
1391
|
+
### Authorization
|
|
1392
|
+
|
|
1393
|
+
[Bearer](../README.md#Bearer)
|
|
1394
|
+
|
|
1395
|
+
### HTTP request headers
|
|
1396
|
+
|
|
1397
|
+
- **Content-Type**: Not defined
|
|
1398
|
+
- **Accept**: application/json
|
|
1399
|
+
|
|
1400
|
+
|
|
1401
|
+
## user_mutual_followers
|
|
1402
|
+
|
|
1403
|
+
> <UserMutualFollowersResultApiResponse> user_mutual_followers(app_key, opts)
|
|
1404
|
+
|
|
1405
|
+
有共同粉丝的用户推荐
|
|
1406
|
+
|
|
1407
|
+
推荐有共同粉丝的用户
|
|
1408
|
+
|
|
1409
|
+
### Examples
|
|
1410
|
+
|
|
1411
|
+
```ruby
|
|
1412
|
+
require 'time'
|
|
1413
|
+
require 'zsgf_client'
|
|
1414
|
+
# setup authorization
|
|
1415
|
+
ZSGFClient.configure do |config|
|
|
1416
|
+
# Configure Bearer authorization: Bearer
|
|
1417
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1418
|
+
end
|
|
1419
|
+
|
|
1420
|
+
api_instance = ZSGFClient::UserApi.new
|
|
1421
|
+
app_key = 'app_key_example' # String |
|
|
1422
|
+
opts = {
|
|
1423
|
+
skip: 56, # Integer | 跳过的记录数
|
|
1424
|
+
take: 56 # Integer | 获取的记录数
|
|
1425
|
+
}
|
|
1426
|
+
|
|
1427
|
+
begin
|
|
1428
|
+
# 有共同粉丝的用户推荐
|
|
1429
|
+
result = api_instance.user_mutual_followers(app_key, opts)
|
|
1430
|
+
p result
|
|
1431
|
+
rescue ZSGFClient::ApiError => e
|
|
1432
|
+
puts "Error when calling UserApi->user_mutual_followers: #{e}"
|
|
1433
|
+
end
|
|
1434
|
+
```
|
|
1435
|
+
|
|
1436
|
+
#### Using the user_mutual_followers_with_http_info variant
|
|
1437
|
+
|
|
1438
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1439
|
+
|
|
1440
|
+
> <Array(<UserMutualFollowersResultApiResponse>, Integer, Hash)> user_mutual_followers_with_http_info(app_key, opts)
|
|
1441
|
+
|
|
1442
|
+
```ruby
|
|
1443
|
+
begin
|
|
1444
|
+
# 有共同粉丝的用户推荐
|
|
1445
|
+
data, status_code, headers = api_instance.user_mutual_followers_with_http_info(app_key, opts)
|
|
1446
|
+
p status_code # => 2xx
|
|
1447
|
+
p headers # => { ... }
|
|
1448
|
+
p data # => <UserMutualFollowersResultApiResponse>
|
|
1449
|
+
rescue ZSGFClient::ApiError => e
|
|
1450
|
+
puts "Error when calling UserApi->user_mutual_followers_with_http_info: #{e}"
|
|
1451
|
+
end
|
|
1452
|
+
```
|
|
1453
|
+
|
|
1454
|
+
### Parameters
|
|
1455
|
+
|
|
1456
|
+
| Name | Type | Description | Notes |
|
|
1457
|
+
| ---- | ---- | ----------- | ----- |
|
|
1458
|
+
| **app_key** | **String** | | |
|
|
1459
|
+
| **skip** | **Integer** | 跳过的记录数 | [optional][default to 0] |
|
|
1460
|
+
| **take** | **Integer** | 获取的记录数 | [optional][default to 10] |
|
|
1461
|
+
|
|
1462
|
+
### Return type
|
|
1463
|
+
|
|
1464
|
+
[**UserMutualFollowersResultApiResponse**](UserMutualFollowersResultApiResponse.md)
|
|
1465
|
+
|
|
1466
|
+
### Authorization
|
|
1467
|
+
|
|
1468
|
+
[Bearer](../README.md#Bearer)
|
|
1469
|
+
|
|
1470
|
+
### HTTP request headers
|
|
1471
|
+
|
|
1472
|
+
- **Content-Type**: Not defined
|
|
1473
|
+
- **Accept**: application/json
|
|
1474
|
+
|
|
1475
|
+
|
|
1476
|
+
## user_mutual_followings
|
|
1477
|
+
|
|
1478
|
+
> <UserMutualFollowingsResultApiResponse> user_mutual_followings(app_key, opts)
|
|
1479
|
+
|
|
1480
|
+
有共同关注的用户推荐
|
|
1481
|
+
|
|
1482
|
+
推荐有共同关注的用户
|
|
1483
|
+
|
|
1484
|
+
### Examples
|
|
1485
|
+
|
|
1486
|
+
```ruby
|
|
1487
|
+
require 'time'
|
|
1488
|
+
require 'zsgf_client'
|
|
1489
|
+
# setup authorization
|
|
1490
|
+
ZSGFClient.configure do |config|
|
|
1491
|
+
# Configure Bearer authorization: Bearer
|
|
1492
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1493
|
+
end
|
|
1494
|
+
|
|
1495
|
+
api_instance = ZSGFClient::UserApi.new
|
|
1496
|
+
app_key = 'app_key_example' # String |
|
|
1497
|
+
opts = {
|
|
1498
|
+
skip: 56, # Integer | 跳过的记录数
|
|
1499
|
+
take: 56 # Integer | 获取的记录数
|
|
1500
|
+
}
|
|
1501
|
+
|
|
1502
|
+
begin
|
|
1503
|
+
# 有共同关注的用户推荐
|
|
1504
|
+
result = api_instance.user_mutual_followings(app_key, opts)
|
|
1505
|
+
p result
|
|
1506
|
+
rescue ZSGFClient::ApiError => e
|
|
1507
|
+
puts "Error when calling UserApi->user_mutual_followings: #{e}"
|
|
1508
|
+
end
|
|
1509
|
+
```
|
|
1510
|
+
|
|
1511
|
+
#### Using the user_mutual_followings_with_http_info variant
|
|
1512
|
+
|
|
1513
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1514
|
+
|
|
1515
|
+
> <Array(<UserMutualFollowingsResultApiResponse>, Integer, Hash)> user_mutual_followings_with_http_info(app_key, opts)
|
|
1516
|
+
|
|
1517
|
+
```ruby
|
|
1518
|
+
begin
|
|
1519
|
+
# 有共同关注的用户推荐
|
|
1520
|
+
data, status_code, headers = api_instance.user_mutual_followings_with_http_info(app_key, opts)
|
|
1521
|
+
p status_code # => 2xx
|
|
1522
|
+
p headers # => { ... }
|
|
1523
|
+
p data # => <UserMutualFollowingsResultApiResponse>
|
|
1524
|
+
rescue ZSGFClient::ApiError => e
|
|
1525
|
+
puts "Error when calling UserApi->user_mutual_followings_with_http_info: #{e}"
|
|
1526
|
+
end
|
|
1527
|
+
```
|
|
1528
|
+
|
|
1529
|
+
### Parameters
|
|
1530
|
+
|
|
1531
|
+
| Name | Type | Description | Notes |
|
|
1532
|
+
| ---- | ---- | ----------- | ----- |
|
|
1533
|
+
| **app_key** | **String** | | |
|
|
1534
|
+
| **skip** | **Integer** | 跳过的记录数 | [optional][default to 0] |
|
|
1535
|
+
| **take** | **Integer** | 获取的记录数 | [optional][default to 10] |
|
|
1536
|
+
|
|
1537
|
+
### Return type
|
|
1538
|
+
|
|
1539
|
+
[**UserMutualFollowingsResultApiResponse**](UserMutualFollowingsResultApiResponse.md)
|
|
1540
|
+
|
|
1541
|
+
### Authorization
|
|
1542
|
+
|
|
1543
|
+
[Bearer](../README.md#Bearer)
|
|
1544
|
+
|
|
1545
|
+
### HTTP request headers
|
|
1546
|
+
|
|
1547
|
+
- **Content-Type**: Not defined
|
|
1548
|
+
- **Accept**: application/json
|
|
1549
|
+
|
|
1550
|
+
|
|
1551
|
+
## user_o_auth_account_bind
|
|
1552
|
+
|
|
1553
|
+
> <BooleanApiResponse> user_o_auth_account_bind(app_key, opts)
|
|
1554
|
+
|
|
1555
|
+
外部账号 绑定
|
|
1556
|
+
|
|
1557
|
+
绑定外部账号
|
|
1558
|
+
|
|
1559
|
+
### Examples
|
|
1560
|
+
|
|
1561
|
+
```ruby
|
|
1562
|
+
require 'time'
|
|
1563
|
+
require 'zsgf_client'
|
|
1564
|
+
# setup authorization
|
|
1565
|
+
ZSGFClient.configure do |config|
|
|
1566
|
+
# Configure Bearer authorization: Bearer
|
|
1567
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1568
|
+
end
|
|
1569
|
+
|
|
1570
|
+
api_instance = ZSGFClient::UserApi.new
|
|
1571
|
+
app_key = 'app_key_example' # String |
|
|
1572
|
+
opts = {
|
|
1573
|
+
o_auth_account_bind_request: ZSGFClient::OAuthAccountBindRequest.new({union_id: 'union_id_example', platform: 'platform_example', platform_name: 'platform_name_example'}) # OAuthAccountBindRequest | 绑定请求参数
|
|
1574
|
+
}
|
|
1575
|
+
|
|
1576
|
+
begin
|
|
1577
|
+
# 外部账号 绑定
|
|
1578
|
+
result = api_instance.user_o_auth_account_bind(app_key, opts)
|
|
1579
|
+
p result
|
|
1580
|
+
rescue ZSGFClient::ApiError => e
|
|
1581
|
+
puts "Error when calling UserApi->user_o_auth_account_bind: #{e}"
|
|
1582
|
+
end
|
|
1583
|
+
```
|
|
1584
|
+
|
|
1585
|
+
#### Using the user_o_auth_account_bind_with_http_info variant
|
|
1586
|
+
|
|
1587
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1588
|
+
|
|
1589
|
+
> <Array(<BooleanApiResponse>, Integer, Hash)> user_o_auth_account_bind_with_http_info(app_key, opts)
|
|
1590
|
+
|
|
1591
|
+
```ruby
|
|
1592
|
+
begin
|
|
1593
|
+
# 外部账号 绑定
|
|
1594
|
+
data, status_code, headers = api_instance.user_o_auth_account_bind_with_http_info(app_key, opts)
|
|
1595
|
+
p status_code # => 2xx
|
|
1596
|
+
p headers # => { ... }
|
|
1597
|
+
p data # => <BooleanApiResponse>
|
|
1598
|
+
rescue ZSGFClient::ApiError => e
|
|
1599
|
+
puts "Error when calling UserApi->user_o_auth_account_bind_with_http_info: #{e}"
|
|
1600
|
+
end
|
|
1601
|
+
```
|
|
1602
|
+
|
|
1603
|
+
### Parameters
|
|
1604
|
+
|
|
1605
|
+
| Name | Type | Description | Notes |
|
|
1606
|
+
| ---- | ---- | ----------- | ----- |
|
|
1607
|
+
| **app_key** | **String** | | |
|
|
1608
|
+
| **o_auth_account_bind_request** | [**OAuthAccountBindRequest**](OAuthAccountBindRequest.md) | 绑定请求参数 | [optional] |
|
|
1609
|
+
|
|
1610
|
+
### Return type
|
|
1611
|
+
|
|
1612
|
+
[**BooleanApiResponse**](BooleanApiResponse.md)
|
|
1613
|
+
|
|
1614
|
+
### Authorization
|
|
1615
|
+
|
|
1616
|
+
[Bearer](../README.md#Bearer)
|
|
1617
|
+
|
|
1618
|
+
### HTTP request headers
|
|
1619
|
+
|
|
1620
|
+
- **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
|
|
1621
|
+
- **Accept**: application/json
|
|
1622
|
+
|
|
1623
|
+
|
|
1624
|
+
## user_o_auth_account_sign_in
|
|
1625
|
+
|
|
1626
|
+
> <TokenModelApiResponse> user_o_auth_account_sign_in(app_key, opts)
|
|
1627
|
+
|
|
1628
|
+
外部账号 登录
|
|
1629
|
+
|
|
1630
|
+
使用外部账号进行登录
|
|
1631
|
+
|
|
1632
|
+
### Examples
|
|
1633
|
+
|
|
1634
|
+
```ruby
|
|
1635
|
+
require 'time'
|
|
1636
|
+
require 'zsgf_client'
|
|
1637
|
+
# setup authorization
|
|
1638
|
+
ZSGFClient.configure do |config|
|
|
1639
|
+
# Configure Bearer authorization: Bearer
|
|
1640
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1641
|
+
end
|
|
1642
|
+
|
|
1643
|
+
api_instance = ZSGFClient::UserApi.new
|
|
1644
|
+
app_key = 'app_key_example' # String |
|
|
1645
|
+
opts = {
|
|
1646
|
+
o_auth_account_sign_in_request: ZSGFClient::OAuthAccountSignInRequest.new({union_id: 'union_id_example', platform: 'platform_example'}) # OAuthAccountSignInRequest | 登录请求参数
|
|
1647
|
+
}
|
|
1648
|
+
|
|
1649
|
+
begin
|
|
1650
|
+
# 外部账号 登录
|
|
1651
|
+
result = api_instance.user_o_auth_account_sign_in(app_key, opts)
|
|
1652
|
+
p result
|
|
1653
|
+
rescue ZSGFClient::ApiError => e
|
|
1654
|
+
puts "Error when calling UserApi->user_o_auth_account_sign_in: #{e}"
|
|
1655
|
+
end
|
|
1656
|
+
```
|
|
1657
|
+
|
|
1658
|
+
#### Using the user_o_auth_account_sign_in_with_http_info variant
|
|
1659
|
+
|
|
1660
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1661
|
+
|
|
1662
|
+
> <Array(<TokenModelApiResponse>, Integer, Hash)> user_o_auth_account_sign_in_with_http_info(app_key, opts)
|
|
1663
|
+
|
|
1664
|
+
```ruby
|
|
1665
|
+
begin
|
|
1666
|
+
# 外部账号 登录
|
|
1667
|
+
data, status_code, headers = api_instance.user_o_auth_account_sign_in_with_http_info(app_key, opts)
|
|
1668
|
+
p status_code # => 2xx
|
|
1669
|
+
p headers # => { ... }
|
|
1670
|
+
p data # => <TokenModelApiResponse>
|
|
1671
|
+
rescue ZSGFClient::ApiError => e
|
|
1672
|
+
puts "Error when calling UserApi->user_o_auth_account_sign_in_with_http_info: #{e}"
|
|
1673
|
+
end
|
|
1674
|
+
```
|
|
1675
|
+
|
|
1676
|
+
### Parameters
|
|
1677
|
+
|
|
1678
|
+
| Name | Type | Description | Notes |
|
|
1679
|
+
| ---- | ---- | ----------- | ----- |
|
|
1680
|
+
| **app_key** | **String** | | |
|
|
1681
|
+
| **o_auth_account_sign_in_request** | [**OAuthAccountSignInRequest**](OAuthAccountSignInRequest.md) | 登录请求参数 | [optional] |
|
|
1682
|
+
|
|
1683
|
+
### Return type
|
|
1684
|
+
|
|
1685
|
+
[**TokenModelApiResponse**](TokenModelApiResponse.md)
|
|
1686
|
+
|
|
1687
|
+
### Authorization
|
|
1688
|
+
|
|
1689
|
+
[Bearer](../README.md#Bearer)
|
|
1690
|
+
|
|
1691
|
+
### HTTP request headers
|
|
1692
|
+
|
|
1693
|
+
- **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
|
|
1694
|
+
- **Accept**: application/json
|
|
1695
|
+
|
|
1696
|
+
|
|
1697
|
+
## user_o_auth_accounts
|
|
1698
|
+
|
|
1699
|
+
> <UserLoginsListApiResponse> user_o_auth_accounts(app_key)
|
|
1700
|
+
|
|
1701
|
+
外部账号 绑定列表
|
|
1702
|
+
|
|
1703
|
+
获取外部账号绑定列表
|
|
1704
|
+
|
|
1705
|
+
### Examples
|
|
1706
|
+
|
|
1707
|
+
```ruby
|
|
1708
|
+
require 'time'
|
|
1709
|
+
require 'zsgf_client'
|
|
1710
|
+
# setup authorization
|
|
1711
|
+
ZSGFClient.configure do |config|
|
|
1712
|
+
# Configure Bearer authorization: Bearer
|
|
1713
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1714
|
+
end
|
|
1715
|
+
|
|
1716
|
+
api_instance = ZSGFClient::UserApi.new
|
|
1717
|
+
app_key = 'app_key_example' # String |
|
|
1718
|
+
|
|
1719
|
+
begin
|
|
1720
|
+
# 外部账号 绑定列表
|
|
1721
|
+
result = api_instance.user_o_auth_accounts(app_key)
|
|
1722
|
+
p result
|
|
1723
|
+
rescue ZSGFClient::ApiError => e
|
|
1724
|
+
puts "Error when calling UserApi->user_o_auth_accounts: #{e}"
|
|
1725
|
+
end
|
|
1726
|
+
```
|
|
1727
|
+
|
|
1728
|
+
#### Using the user_o_auth_accounts_with_http_info variant
|
|
1729
|
+
|
|
1730
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1731
|
+
|
|
1732
|
+
> <Array(<UserLoginsListApiResponse>, Integer, Hash)> user_o_auth_accounts_with_http_info(app_key)
|
|
1733
|
+
|
|
1734
|
+
```ruby
|
|
1735
|
+
begin
|
|
1736
|
+
# 外部账号 绑定列表
|
|
1737
|
+
data, status_code, headers = api_instance.user_o_auth_accounts_with_http_info(app_key)
|
|
1738
|
+
p status_code # => 2xx
|
|
1739
|
+
p headers # => { ... }
|
|
1740
|
+
p data # => <UserLoginsListApiResponse>
|
|
1741
|
+
rescue ZSGFClient::ApiError => e
|
|
1742
|
+
puts "Error when calling UserApi->user_o_auth_accounts_with_http_info: #{e}"
|
|
1743
|
+
end
|
|
1744
|
+
```
|
|
1745
|
+
|
|
1746
|
+
### Parameters
|
|
1747
|
+
|
|
1748
|
+
| Name | Type | Description | Notes |
|
|
1749
|
+
| ---- | ---- | ----------- | ----- |
|
|
1750
|
+
| **app_key** | **String** | | |
|
|
1751
|
+
|
|
1752
|
+
### Return type
|
|
1753
|
+
|
|
1754
|
+
[**UserLoginsListApiResponse**](UserLoginsListApiResponse.md)
|
|
1755
|
+
|
|
1756
|
+
### Authorization
|
|
1757
|
+
|
|
1758
|
+
[Bearer](../README.md#Bearer)
|
|
1759
|
+
|
|
1760
|
+
### HTTP request headers
|
|
1761
|
+
|
|
1762
|
+
- **Content-Type**: Not defined
|
|
1763
|
+
- **Accept**: application/json
|
|
1764
|
+
|
|
1765
|
+
|
|
1766
|
+
## user_o_auth_accounts_put_bind
|
|
1767
|
+
|
|
1768
|
+
> <BooleanApiResponse> user_o_auth_accounts_put_bind(id, app_key, opts)
|
|
1769
|
+
|
|
1770
|
+
外部账号 更新绑定
|
|
1771
|
+
|
|
1772
|
+
更新外部账号绑定信息
|
|
1773
|
+
|
|
1774
|
+
### Examples
|
|
1775
|
+
|
|
1776
|
+
```ruby
|
|
1777
|
+
require 'time'
|
|
1778
|
+
require 'zsgf_client'
|
|
1779
|
+
# setup authorization
|
|
1780
|
+
ZSGFClient.configure do |config|
|
|
1781
|
+
# Configure Bearer authorization: Bearer
|
|
1782
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1783
|
+
end
|
|
1784
|
+
|
|
1785
|
+
api_instance = ZSGFClient::UserApi.new
|
|
1786
|
+
id = 789 # Integer | 绑定ID
|
|
1787
|
+
app_key = 'app_key_example' # String |
|
|
1788
|
+
opts = {
|
|
1789
|
+
o_auth_account_put_bind_request: ZSGFClient::OAuthAccountPutBindRequest.new # OAuthAccountPutBindRequest | 更新请求参数
|
|
1790
|
+
}
|
|
1791
|
+
|
|
1792
|
+
begin
|
|
1793
|
+
# 外部账号 更新绑定
|
|
1794
|
+
result = api_instance.user_o_auth_accounts_put_bind(id, app_key, opts)
|
|
1795
|
+
p result
|
|
1796
|
+
rescue ZSGFClient::ApiError => e
|
|
1797
|
+
puts "Error when calling UserApi->user_o_auth_accounts_put_bind: #{e}"
|
|
1798
|
+
end
|
|
1799
|
+
```
|
|
1800
|
+
|
|
1801
|
+
#### Using the user_o_auth_accounts_put_bind_with_http_info variant
|
|
1802
|
+
|
|
1803
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1804
|
+
|
|
1805
|
+
> <Array(<BooleanApiResponse>, Integer, Hash)> user_o_auth_accounts_put_bind_with_http_info(id, app_key, opts)
|
|
1806
|
+
|
|
1807
|
+
```ruby
|
|
1808
|
+
begin
|
|
1809
|
+
# 外部账号 更新绑定
|
|
1810
|
+
data, status_code, headers = api_instance.user_o_auth_accounts_put_bind_with_http_info(id, app_key, opts)
|
|
1811
|
+
p status_code # => 2xx
|
|
1812
|
+
p headers # => { ... }
|
|
1813
|
+
p data # => <BooleanApiResponse>
|
|
1814
|
+
rescue ZSGFClient::ApiError => e
|
|
1815
|
+
puts "Error when calling UserApi->user_o_auth_accounts_put_bind_with_http_info: #{e}"
|
|
1816
|
+
end
|
|
1817
|
+
```
|
|
1818
|
+
|
|
1819
|
+
### Parameters
|
|
1820
|
+
|
|
1821
|
+
| Name | Type | Description | Notes |
|
|
1822
|
+
| ---- | ---- | ----------- | ----- |
|
|
1823
|
+
| **id** | **Integer** | 绑定ID | |
|
|
1824
|
+
| **app_key** | **String** | | |
|
|
1825
|
+
| **o_auth_account_put_bind_request** | [**OAuthAccountPutBindRequest**](OAuthAccountPutBindRequest.md) | 更新请求参数 | [optional] |
|
|
1826
|
+
|
|
1827
|
+
### Return type
|
|
1828
|
+
|
|
1829
|
+
[**BooleanApiResponse**](BooleanApiResponse.md)
|
|
1830
|
+
|
|
1831
|
+
### Authorization
|
|
1832
|
+
|
|
1833
|
+
[Bearer](../README.md#Bearer)
|
|
1834
|
+
|
|
1835
|
+
### HTTP request headers
|
|
1836
|
+
|
|
1837
|
+
- **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
|
|
1838
|
+
- **Accept**: application/json
|
|
1839
|
+
|
|
1840
|
+
|
|
1841
|
+
## user_o_auth_accounts_un_bind
|
|
1842
|
+
|
|
1843
|
+
> <BooleanApiResponse> user_o_auth_accounts_un_bind(id, app_key)
|
|
1844
|
+
|
|
1845
|
+
外部账号 删除绑定
|
|
1846
|
+
|
|
1847
|
+
删除外部账号绑定
|
|
1848
|
+
|
|
1849
|
+
### Examples
|
|
1850
|
+
|
|
1851
|
+
```ruby
|
|
1852
|
+
require 'time'
|
|
1853
|
+
require 'zsgf_client'
|
|
1854
|
+
# setup authorization
|
|
1855
|
+
ZSGFClient.configure do |config|
|
|
1856
|
+
# Configure Bearer authorization: Bearer
|
|
1857
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1858
|
+
end
|
|
1859
|
+
|
|
1860
|
+
api_instance = ZSGFClient::UserApi.new
|
|
1861
|
+
id = 789 # Integer | 绑定ID
|
|
1862
|
+
app_key = 'app_key_example' # String |
|
|
1863
|
+
|
|
1864
|
+
begin
|
|
1865
|
+
# 外部账号 删除绑定
|
|
1866
|
+
result = api_instance.user_o_auth_accounts_un_bind(id, app_key)
|
|
1867
|
+
p result
|
|
1868
|
+
rescue ZSGFClient::ApiError => e
|
|
1869
|
+
puts "Error when calling UserApi->user_o_auth_accounts_un_bind: #{e}"
|
|
1870
|
+
end
|
|
1871
|
+
```
|
|
1872
|
+
|
|
1873
|
+
#### Using the user_o_auth_accounts_un_bind_with_http_info variant
|
|
1874
|
+
|
|
1875
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1876
|
+
|
|
1877
|
+
> <Array(<BooleanApiResponse>, Integer, Hash)> user_o_auth_accounts_un_bind_with_http_info(id, app_key)
|
|
1878
|
+
|
|
1879
|
+
```ruby
|
|
1880
|
+
begin
|
|
1881
|
+
# 外部账号 删除绑定
|
|
1882
|
+
data, status_code, headers = api_instance.user_o_auth_accounts_un_bind_with_http_info(id, app_key)
|
|
1883
|
+
p status_code # => 2xx
|
|
1884
|
+
p headers # => { ... }
|
|
1885
|
+
p data # => <BooleanApiResponse>
|
|
1886
|
+
rescue ZSGFClient::ApiError => e
|
|
1887
|
+
puts "Error when calling UserApi->user_o_auth_accounts_un_bind_with_http_info: #{e}"
|
|
1888
|
+
end
|
|
1889
|
+
```
|
|
1890
|
+
|
|
1891
|
+
### Parameters
|
|
1892
|
+
|
|
1893
|
+
| Name | Type | Description | Notes |
|
|
1894
|
+
| ---- | ---- | ----------- | ----- |
|
|
1895
|
+
| **id** | **Integer** | 绑定ID | |
|
|
1896
|
+
| **app_key** | **String** | | |
|
|
1897
|
+
|
|
1898
|
+
### Return type
|
|
1899
|
+
|
|
1900
|
+
[**BooleanApiResponse**](BooleanApiResponse.md)
|
|
1901
|
+
|
|
1902
|
+
### Authorization
|
|
1903
|
+
|
|
1904
|
+
[Bearer](../README.md#Bearer)
|
|
1905
|
+
|
|
1906
|
+
### HTTP request headers
|
|
1907
|
+
|
|
1908
|
+
- **Content-Type**: Not defined
|
|
1909
|
+
- **Accept**: application/json
|
|
1910
|
+
|
|
1911
|
+
|
|
1912
|
+
## user_phone_sign_in
|
|
1913
|
+
|
|
1914
|
+
> <TokenModelApiResponse> user_phone_sign_in(app_key, opts)
|
|
1915
|
+
|
|
1916
|
+
手机登录
|
|
1917
|
+
|
|
1918
|
+
使用手机号码进行登录
|
|
1919
|
+
|
|
1920
|
+
### Examples
|
|
1921
|
+
|
|
1922
|
+
```ruby
|
|
1923
|
+
require 'time'
|
|
1924
|
+
require 'zsgf_client'
|
|
1925
|
+
# setup authorization
|
|
1926
|
+
ZSGFClient.configure do |config|
|
|
1927
|
+
# Configure Bearer authorization: Bearer
|
|
1928
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1929
|
+
end
|
|
1930
|
+
|
|
1931
|
+
api_instance = ZSGFClient::UserApi.new
|
|
1932
|
+
app_key = 'app_key_example' # String |
|
|
1933
|
+
opts = {
|
|
1934
|
+
phone_sign_in_request: ZSGFClient::PhoneSignInRequest.new({phone: 'phone_example', verify_code: 'verify_code_example'}) # PhoneSignInRequest | 登录请求参数
|
|
1935
|
+
}
|
|
1936
|
+
|
|
1937
|
+
begin
|
|
1938
|
+
# 手机登录
|
|
1939
|
+
result = api_instance.user_phone_sign_in(app_key, opts)
|
|
1940
|
+
p result
|
|
1941
|
+
rescue ZSGFClient::ApiError => e
|
|
1942
|
+
puts "Error when calling UserApi->user_phone_sign_in: #{e}"
|
|
1943
|
+
end
|
|
1944
|
+
```
|
|
1945
|
+
|
|
1946
|
+
#### Using the user_phone_sign_in_with_http_info variant
|
|
1947
|
+
|
|
1948
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1949
|
+
|
|
1950
|
+
> <Array(<TokenModelApiResponse>, Integer, Hash)> user_phone_sign_in_with_http_info(app_key, opts)
|
|
1951
|
+
|
|
1952
|
+
```ruby
|
|
1953
|
+
begin
|
|
1954
|
+
# 手机登录
|
|
1955
|
+
data, status_code, headers = api_instance.user_phone_sign_in_with_http_info(app_key, opts)
|
|
1956
|
+
p status_code # => 2xx
|
|
1957
|
+
p headers # => { ... }
|
|
1958
|
+
p data # => <TokenModelApiResponse>
|
|
1959
|
+
rescue ZSGFClient::ApiError => e
|
|
1960
|
+
puts "Error when calling UserApi->user_phone_sign_in_with_http_info: #{e}"
|
|
1961
|
+
end
|
|
1962
|
+
```
|
|
1963
|
+
|
|
1964
|
+
### Parameters
|
|
1965
|
+
|
|
1966
|
+
| Name | Type | Description | Notes |
|
|
1967
|
+
| ---- | ---- | ----------- | ----- |
|
|
1968
|
+
| **app_key** | **String** | | |
|
|
1969
|
+
| **phone_sign_in_request** | [**PhoneSignInRequest**](PhoneSignInRequest.md) | 登录请求参数 | [optional] |
|
|
1970
|
+
|
|
1971
|
+
### Return type
|
|
1972
|
+
|
|
1973
|
+
[**TokenModelApiResponse**](TokenModelApiResponse.md)
|
|
1974
|
+
|
|
1975
|
+
### Authorization
|
|
1976
|
+
|
|
1977
|
+
[Bearer](../README.md#Bearer)
|
|
1978
|
+
|
|
1979
|
+
### HTTP request headers
|
|
1980
|
+
|
|
1981
|
+
- **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
|
|
1982
|
+
- **Accept**: application/json
|
|
1983
|
+
|
|
1984
|
+
|
|
1985
|
+
## user_phone_sign_up
|
|
1986
|
+
|
|
1987
|
+
> <TokenModelApiResponse> user_phone_sign_up(app_key, opts)
|
|
1988
|
+
|
|
1989
|
+
手机注册
|
|
1990
|
+
|
|
1991
|
+
使用手机号码进行注册
|
|
1992
|
+
|
|
1993
|
+
### Examples
|
|
1994
|
+
|
|
1995
|
+
```ruby
|
|
1996
|
+
require 'time'
|
|
1997
|
+
require 'zsgf_client'
|
|
1998
|
+
# setup authorization
|
|
1999
|
+
ZSGFClient.configure do |config|
|
|
2000
|
+
# Configure Bearer authorization: Bearer
|
|
2001
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2002
|
+
end
|
|
2003
|
+
|
|
2004
|
+
api_instance = ZSGFClient::UserApi.new
|
|
2005
|
+
app_key = 'app_key_example' # String |
|
|
2006
|
+
opts = {
|
|
2007
|
+
phone_sign_up_request: ZSGFClient::PhoneSignUpRequest.new({phone: 'phone_example', phone_code: 'phone_code_example', pwd: 'pwd_example'}) # PhoneSignUpRequest | 注册请求参数
|
|
2008
|
+
}
|
|
2009
|
+
|
|
2010
|
+
begin
|
|
2011
|
+
# 手机注册
|
|
2012
|
+
result = api_instance.user_phone_sign_up(app_key, opts)
|
|
2013
|
+
p result
|
|
2014
|
+
rescue ZSGFClient::ApiError => e
|
|
2015
|
+
puts "Error when calling UserApi->user_phone_sign_up: #{e}"
|
|
2016
|
+
end
|
|
2017
|
+
```
|
|
2018
|
+
|
|
2019
|
+
#### Using the user_phone_sign_up_with_http_info variant
|
|
2020
|
+
|
|
2021
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2022
|
+
|
|
2023
|
+
> <Array(<TokenModelApiResponse>, Integer, Hash)> user_phone_sign_up_with_http_info(app_key, opts)
|
|
2024
|
+
|
|
2025
|
+
```ruby
|
|
2026
|
+
begin
|
|
2027
|
+
# 手机注册
|
|
2028
|
+
data, status_code, headers = api_instance.user_phone_sign_up_with_http_info(app_key, opts)
|
|
2029
|
+
p status_code # => 2xx
|
|
2030
|
+
p headers # => { ... }
|
|
2031
|
+
p data # => <TokenModelApiResponse>
|
|
2032
|
+
rescue ZSGFClient::ApiError => e
|
|
2033
|
+
puts "Error when calling UserApi->user_phone_sign_up_with_http_info: #{e}"
|
|
2034
|
+
end
|
|
2035
|
+
```
|
|
2036
|
+
|
|
2037
|
+
### Parameters
|
|
2038
|
+
|
|
2039
|
+
| Name | Type | Description | Notes |
|
|
2040
|
+
| ---- | ---- | ----------- | ----- |
|
|
2041
|
+
| **app_key** | **String** | | |
|
|
2042
|
+
| **phone_sign_up_request** | [**PhoneSignUpRequest**](PhoneSignUpRequest.md) | 注册请求参数 | [optional] |
|
|
2043
|
+
|
|
2044
|
+
### Return type
|
|
2045
|
+
|
|
2046
|
+
[**TokenModelApiResponse**](TokenModelApiResponse.md)
|
|
2047
|
+
|
|
2048
|
+
### Authorization
|
|
2049
|
+
|
|
2050
|
+
[Bearer](../README.md#Bearer)
|
|
2051
|
+
|
|
2052
|
+
### HTTP request headers
|
|
2053
|
+
|
|
2054
|
+
- **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
|
|
2055
|
+
- **Accept**: application/json
|
|
2056
|
+
|
|
2057
|
+
|
|
2058
|
+
## user_profile
|
|
2059
|
+
|
|
2060
|
+
> <UserProfileResultApiResponse> user_profile(app_key)
|
|
2061
|
+
|
|
2062
|
+
获取个人资料
|
|
2063
|
+
|
|
2064
|
+
获取当前用户的个人资料
|
|
2065
|
+
|
|
2066
|
+
### Examples
|
|
2067
|
+
|
|
2068
|
+
```ruby
|
|
2069
|
+
require 'time'
|
|
2070
|
+
require 'zsgf_client'
|
|
2071
|
+
# setup authorization
|
|
2072
|
+
ZSGFClient.configure do |config|
|
|
2073
|
+
# Configure Bearer authorization: Bearer
|
|
2074
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2075
|
+
end
|
|
2076
|
+
|
|
2077
|
+
api_instance = ZSGFClient::UserApi.new
|
|
2078
|
+
app_key = 'app_key_example' # String |
|
|
2079
|
+
|
|
2080
|
+
begin
|
|
2081
|
+
# 获取个人资料
|
|
2082
|
+
result = api_instance.user_profile(app_key)
|
|
2083
|
+
p result
|
|
2084
|
+
rescue ZSGFClient::ApiError => e
|
|
2085
|
+
puts "Error when calling UserApi->user_profile: #{e}"
|
|
2086
|
+
end
|
|
2087
|
+
```
|
|
2088
|
+
|
|
2089
|
+
#### Using the user_profile_with_http_info variant
|
|
2090
|
+
|
|
2091
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2092
|
+
|
|
2093
|
+
> <Array(<UserProfileResultApiResponse>, Integer, Hash)> user_profile_with_http_info(app_key)
|
|
2094
|
+
|
|
2095
|
+
```ruby
|
|
2096
|
+
begin
|
|
2097
|
+
# 获取个人资料
|
|
2098
|
+
data, status_code, headers = api_instance.user_profile_with_http_info(app_key)
|
|
2099
|
+
p status_code # => 2xx
|
|
2100
|
+
p headers # => { ... }
|
|
2101
|
+
p data # => <UserProfileResultApiResponse>
|
|
2102
|
+
rescue ZSGFClient::ApiError => e
|
|
2103
|
+
puts "Error when calling UserApi->user_profile_with_http_info: #{e}"
|
|
2104
|
+
end
|
|
2105
|
+
```
|
|
2106
|
+
|
|
2107
|
+
### Parameters
|
|
2108
|
+
|
|
2109
|
+
| Name | Type | Description | Notes |
|
|
2110
|
+
| ---- | ---- | ----------- | ----- |
|
|
2111
|
+
| **app_key** | **String** | | |
|
|
2112
|
+
|
|
2113
|
+
### Return type
|
|
2114
|
+
|
|
2115
|
+
[**UserProfileResultApiResponse**](UserProfileResultApiResponse.md)
|
|
2116
|
+
|
|
2117
|
+
### Authorization
|
|
2118
|
+
|
|
2119
|
+
[Bearer](../README.md#Bearer)
|
|
2120
|
+
|
|
2121
|
+
### HTTP request headers
|
|
2122
|
+
|
|
2123
|
+
- **Content-Type**: Not defined
|
|
2124
|
+
- **Accept**: application/json
|
|
2125
|
+
|
|
2126
|
+
|
|
2127
|
+
## user_put
|
|
2128
|
+
|
|
2129
|
+
> <BooleanApiResponse> user_put(id, app_key, opts)
|
|
2130
|
+
|
|
2131
|
+
更新用户信息
|
|
2132
|
+
|
|
2133
|
+
根据用户ID更新用户信息
|
|
2134
|
+
|
|
2135
|
+
### Examples
|
|
2136
|
+
|
|
2137
|
+
```ruby
|
|
2138
|
+
require 'time'
|
|
2139
|
+
require 'zsgf_client'
|
|
2140
|
+
# setup authorization
|
|
2141
|
+
ZSGFClient.configure do |config|
|
|
2142
|
+
# Configure Bearer authorization: Bearer
|
|
2143
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2144
|
+
end
|
|
2145
|
+
|
|
2146
|
+
api_instance = ZSGFClient::UserApi.new
|
|
2147
|
+
id = 789 # Integer | 用户ID
|
|
2148
|
+
app_key = 'app_key_example' # String |
|
|
2149
|
+
opts = {
|
|
2150
|
+
user: ZSGFClient::User.new # User | 用户信息
|
|
2151
|
+
}
|
|
2152
|
+
|
|
2153
|
+
begin
|
|
2154
|
+
# 更新用户信息
|
|
2155
|
+
result = api_instance.user_put(id, app_key, opts)
|
|
2156
|
+
p result
|
|
2157
|
+
rescue ZSGFClient::ApiError => e
|
|
2158
|
+
puts "Error when calling UserApi->user_put: #{e}"
|
|
2159
|
+
end
|
|
2160
|
+
```
|
|
2161
|
+
|
|
2162
|
+
#### Using the user_put_with_http_info variant
|
|
2163
|
+
|
|
2164
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2165
|
+
|
|
2166
|
+
> <Array(<BooleanApiResponse>, Integer, Hash)> user_put_with_http_info(id, app_key, opts)
|
|
2167
|
+
|
|
2168
|
+
```ruby
|
|
2169
|
+
begin
|
|
2170
|
+
# 更新用户信息
|
|
2171
|
+
data, status_code, headers = api_instance.user_put_with_http_info(id, app_key, opts)
|
|
2172
|
+
p status_code # => 2xx
|
|
2173
|
+
p headers # => { ... }
|
|
2174
|
+
p data # => <BooleanApiResponse>
|
|
2175
|
+
rescue ZSGFClient::ApiError => e
|
|
2176
|
+
puts "Error when calling UserApi->user_put_with_http_info: #{e}"
|
|
2177
|
+
end
|
|
2178
|
+
```
|
|
2179
|
+
|
|
2180
|
+
### Parameters
|
|
2181
|
+
|
|
2182
|
+
| Name | Type | Description | Notes |
|
|
2183
|
+
| ---- | ---- | ----------- | ----- |
|
|
2184
|
+
| **id** | **Integer** | 用户ID | |
|
|
2185
|
+
| **app_key** | **String** | | |
|
|
2186
|
+
| **user** | [**User**](User.md) | 用户信息 | [optional] |
|
|
2187
|
+
|
|
2188
|
+
### Return type
|
|
2189
|
+
|
|
2190
|
+
[**BooleanApiResponse**](BooleanApiResponse.md)
|
|
2191
|
+
|
|
2192
|
+
### Authorization
|
|
2193
|
+
|
|
2194
|
+
[Bearer](../README.md#Bearer)
|
|
2195
|
+
|
|
2196
|
+
### HTTP request headers
|
|
2197
|
+
|
|
2198
|
+
- **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
|
|
2199
|
+
- **Accept**: application/json
|
|
2200
|
+
|
|
2201
|
+
|
|
2202
|
+
## user_qr_code_pre_sign_in
|
|
2203
|
+
|
|
2204
|
+
> <Int64ApiResponse> user_qr_code_pre_sign_in(app_key, opts)
|
|
2205
|
+
|
|
2206
|
+
微信小程序 - 预登陆
|
|
2207
|
+
|
|
2208
|
+
使用微信小程序二维码进行预登陆
|
|
2209
|
+
|
|
2210
|
+
### Examples
|
|
2211
|
+
|
|
2212
|
+
```ruby
|
|
2213
|
+
require 'time'
|
|
2214
|
+
require 'zsgf_client'
|
|
2215
|
+
# setup authorization
|
|
2216
|
+
ZSGFClient.configure do |config|
|
|
2217
|
+
# Configure Bearer authorization: Bearer
|
|
2218
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2219
|
+
end
|
|
2220
|
+
|
|
2221
|
+
api_instance = ZSGFClient::UserApi.new
|
|
2222
|
+
app_key = 'app_key_example' # String |
|
|
2223
|
+
opts = {
|
|
2224
|
+
qr_code_pre_sign_in_request: ZSGFClient::QRCodePreSignInRequest.new # QRCodePreSignInRequest | 预登陆请求参数
|
|
2225
|
+
}
|
|
2226
|
+
|
|
2227
|
+
begin
|
|
2228
|
+
# 微信小程序 - 预登陆
|
|
2229
|
+
result = api_instance.user_qr_code_pre_sign_in(app_key, opts)
|
|
2230
|
+
p result
|
|
2231
|
+
rescue ZSGFClient::ApiError => e
|
|
2232
|
+
puts "Error when calling UserApi->user_qr_code_pre_sign_in: #{e}"
|
|
2233
|
+
end
|
|
2234
|
+
```
|
|
2235
|
+
|
|
2236
|
+
#### Using the user_qr_code_pre_sign_in_with_http_info variant
|
|
2237
|
+
|
|
2238
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2239
|
+
|
|
2240
|
+
> <Array(<Int64ApiResponse>, Integer, Hash)> user_qr_code_pre_sign_in_with_http_info(app_key, opts)
|
|
2241
|
+
|
|
2242
|
+
```ruby
|
|
2243
|
+
begin
|
|
2244
|
+
# 微信小程序 - 预登陆
|
|
2245
|
+
data, status_code, headers = api_instance.user_qr_code_pre_sign_in_with_http_info(app_key, opts)
|
|
2246
|
+
p status_code # => 2xx
|
|
2247
|
+
p headers # => { ... }
|
|
2248
|
+
p data # => <Int64ApiResponse>
|
|
2249
|
+
rescue ZSGFClient::ApiError => e
|
|
2250
|
+
puts "Error when calling UserApi->user_qr_code_pre_sign_in_with_http_info: #{e}"
|
|
2251
|
+
end
|
|
2252
|
+
```
|
|
2253
|
+
|
|
2254
|
+
### Parameters
|
|
2255
|
+
|
|
2256
|
+
| Name | Type | Description | Notes |
|
|
2257
|
+
| ---- | ---- | ----------- | ----- |
|
|
2258
|
+
| **app_key** | **String** | | |
|
|
2259
|
+
| **qr_code_pre_sign_in_request** | [**QRCodePreSignInRequest**](QRCodePreSignInRequest.md) | 预登陆请求参数 | [optional] |
|
|
2260
|
+
|
|
2261
|
+
### Return type
|
|
2262
|
+
|
|
2263
|
+
[**Int64ApiResponse**](Int64ApiResponse.md)
|
|
2264
|
+
|
|
2265
|
+
### Authorization
|
|
2266
|
+
|
|
2267
|
+
[Bearer](../README.md#Bearer)
|
|
2268
|
+
|
|
2269
|
+
### HTTP request headers
|
|
2270
|
+
|
|
2271
|
+
- **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
|
|
2272
|
+
- **Accept**: application/json
|
|
2273
|
+
|
|
2274
|
+
|
|
2275
|
+
## user_qr_code_scan
|
|
2276
|
+
|
|
2277
|
+
> <UserQRCodeScanResultApiResponse> user_qr_code_scan(app_key, opts)
|
|
2278
|
+
|
|
2279
|
+
微信小程序 - 扫码
|
|
2280
|
+
|
|
2281
|
+
使用微信小程序二维码进行扫码
|
|
2282
|
+
|
|
2283
|
+
### Examples
|
|
2284
|
+
|
|
2285
|
+
```ruby
|
|
2286
|
+
require 'time'
|
|
2287
|
+
require 'zsgf_client'
|
|
2288
|
+
# setup authorization
|
|
2289
|
+
ZSGFClient.configure do |config|
|
|
2290
|
+
# Configure Bearer authorization: Bearer
|
|
2291
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2292
|
+
end
|
|
2293
|
+
|
|
2294
|
+
api_instance = ZSGFClient::UserApi.new
|
|
2295
|
+
app_key = 'app_key_example' # String |
|
|
2296
|
+
opts = {
|
|
2297
|
+
qr_code_scan_request: ZSGFClient::QRCodeScanRequest.new({sign_in_key: 3.56}) # QRCodeScanRequest | 扫码请求参数
|
|
2298
|
+
}
|
|
2299
|
+
|
|
2300
|
+
begin
|
|
2301
|
+
# 微信小程序 - 扫码
|
|
2302
|
+
result = api_instance.user_qr_code_scan(app_key, opts)
|
|
2303
|
+
p result
|
|
2304
|
+
rescue ZSGFClient::ApiError => e
|
|
2305
|
+
puts "Error when calling UserApi->user_qr_code_scan: #{e}"
|
|
2306
|
+
end
|
|
2307
|
+
```
|
|
2308
|
+
|
|
2309
|
+
#### Using the user_qr_code_scan_with_http_info variant
|
|
2310
|
+
|
|
2311
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2312
|
+
|
|
2313
|
+
> <Array(<UserQRCodeScanResultApiResponse>, Integer, Hash)> user_qr_code_scan_with_http_info(app_key, opts)
|
|
2314
|
+
|
|
2315
|
+
```ruby
|
|
2316
|
+
begin
|
|
2317
|
+
# 微信小程序 - 扫码
|
|
2318
|
+
data, status_code, headers = api_instance.user_qr_code_scan_with_http_info(app_key, opts)
|
|
2319
|
+
p status_code # => 2xx
|
|
2320
|
+
p headers # => { ... }
|
|
2321
|
+
p data # => <UserQRCodeScanResultApiResponse>
|
|
2322
|
+
rescue ZSGFClient::ApiError => e
|
|
2323
|
+
puts "Error when calling UserApi->user_qr_code_scan_with_http_info: #{e}"
|
|
2324
|
+
end
|
|
2325
|
+
```
|
|
2326
|
+
|
|
2327
|
+
### Parameters
|
|
2328
|
+
|
|
2329
|
+
| Name | Type | Description | Notes |
|
|
2330
|
+
| ---- | ---- | ----------- | ----- |
|
|
2331
|
+
| **app_key** | **String** | | |
|
|
2332
|
+
| **qr_code_scan_request** | [**QRCodeScanRequest**](QRCodeScanRequest.md) | 扫码请求参数 | [optional] |
|
|
2333
|
+
|
|
2334
|
+
### Return type
|
|
2335
|
+
|
|
2336
|
+
[**UserQRCodeScanResultApiResponse**](UserQRCodeScanResultApiResponse.md)
|
|
2337
|
+
|
|
2338
|
+
### Authorization
|
|
2339
|
+
|
|
2340
|
+
[Bearer](../README.md#Bearer)
|
|
2341
|
+
|
|
2342
|
+
### HTTP request headers
|
|
2343
|
+
|
|
2344
|
+
- **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
|
|
2345
|
+
- **Accept**: application/json
|
|
2346
|
+
|
|
2347
|
+
|
|
2348
|
+
## user_qr_code_sign_in
|
|
2349
|
+
|
|
2350
|
+
> <TokenModelApiResponse> user_qr_code_sign_in(app_key, opts)
|
|
2351
|
+
|
|
2352
|
+
微信小程序 - 网页登录
|
|
2353
|
+
|
|
2354
|
+
使用微信小程序二维码进行网页登录
|
|
2355
|
+
|
|
2356
|
+
### Examples
|
|
2357
|
+
|
|
2358
|
+
```ruby
|
|
2359
|
+
require 'time'
|
|
2360
|
+
require 'zsgf_client'
|
|
2361
|
+
# setup authorization
|
|
2362
|
+
ZSGFClient.configure do |config|
|
|
2363
|
+
# Configure Bearer authorization: Bearer
|
|
2364
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2365
|
+
end
|
|
2366
|
+
|
|
2367
|
+
api_instance = ZSGFClient::UserApi.new
|
|
2368
|
+
app_key = 'app_key_example' # String |
|
|
2369
|
+
opts = {
|
|
2370
|
+
qr_code_sign_in_request: ZSGFClient::QRCodeSignInRequest.new({sign_in_key: 3.56}) # QRCodeSignInRequest | 登录请求参数
|
|
2371
|
+
}
|
|
2372
|
+
|
|
2373
|
+
begin
|
|
2374
|
+
# 微信小程序 - 网页登录
|
|
2375
|
+
result = api_instance.user_qr_code_sign_in(app_key, opts)
|
|
2376
|
+
p result
|
|
2377
|
+
rescue ZSGFClient::ApiError => e
|
|
2378
|
+
puts "Error when calling UserApi->user_qr_code_sign_in: #{e}"
|
|
2379
|
+
end
|
|
2380
|
+
```
|
|
2381
|
+
|
|
2382
|
+
#### Using the user_qr_code_sign_in_with_http_info variant
|
|
2383
|
+
|
|
2384
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2385
|
+
|
|
2386
|
+
> <Array(<TokenModelApiResponse>, Integer, Hash)> user_qr_code_sign_in_with_http_info(app_key, opts)
|
|
2387
|
+
|
|
2388
|
+
```ruby
|
|
2389
|
+
begin
|
|
2390
|
+
# 微信小程序 - 网页登录
|
|
2391
|
+
data, status_code, headers = api_instance.user_qr_code_sign_in_with_http_info(app_key, opts)
|
|
2392
|
+
p status_code # => 2xx
|
|
2393
|
+
p headers # => { ... }
|
|
2394
|
+
p data # => <TokenModelApiResponse>
|
|
2395
|
+
rescue ZSGFClient::ApiError => e
|
|
2396
|
+
puts "Error when calling UserApi->user_qr_code_sign_in_with_http_info: #{e}"
|
|
2397
|
+
end
|
|
2398
|
+
```
|
|
2399
|
+
|
|
2400
|
+
### Parameters
|
|
2401
|
+
|
|
2402
|
+
| Name | Type | Description | Notes |
|
|
2403
|
+
| ---- | ---- | ----------- | ----- |
|
|
2404
|
+
| **app_key** | **String** | | |
|
|
2405
|
+
| **qr_code_sign_in_request** | [**QRCodeSignInRequest**](QRCodeSignInRequest.md) | 登录请求参数 | [optional] |
|
|
2406
|
+
|
|
2407
|
+
### Return type
|
|
2408
|
+
|
|
2409
|
+
[**TokenModelApiResponse**](TokenModelApiResponse.md)
|
|
2410
|
+
|
|
2411
|
+
### Authorization
|
|
2412
|
+
|
|
2413
|
+
[Bearer](../README.md#Bearer)
|
|
2414
|
+
|
|
2415
|
+
### HTTP request headers
|
|
2416
|
+
|
|
2417
|
+
- **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
|
|
2418
|
+
- **Accept**: application/json
|
|
2419
|
+
|
|
2420
|
+
|
|
2421
|
+
## user_qr_code_sign_up
|
|
2422
|
+
|
|
2423
|
+
> <TokenModelApiResponse> user_qr_code_sign_up(app_key, opts)
|
|
2424
|
+
|
|
2425
|
+
微信小程序 - 注册
|
|
2426
|
+
|
|
2427
|
+
使用微信小程序二维码进行注册
|
|
2428
|
+
|
|
2429
|
+
### Examples
|
|
2430
|
+
|
|
2431
|
+
```ruby
|
|
2432
|
+
require 'time'
|
|
2433
|
+
require 'zsgf_client'
|
|
2434
|
+
# setup authorization
|
|
2435
|
+
ZSGFClient.configure do |config|
|
|
2436
|
+
# Configure Bearer authorization: Bearer
|
|
2437
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2438
|
+
end
|
|
2439
|
+
|
|
2440
|
+
api_instance = ZSGFClient::UserApi.new
|
|
2441
|
+
app_key = 'app_key_example' # String |
|
|
2442
|
+
opts = {
|
|
2443
|
+
qr_code_sign_up_request: ZSGFClient::QRCodeSignUpRequest.new({union_id: 'union_id_example'}) # QRCodeSignUpRequest | 注册请求参数
|
|
2444
|
+
}
|
|
2445
|
+
|
|
2446
|
+
begin
|
|
2447
|
+
# 微信小程序 - 注册
|
|
2448
|
+
result = api_instance.user_qr_code_sign_up(app_key, opts)
|
|
2449
|
+
p result
|
|
2450
|
+
rescue ZSGFClient::ApiError => e
|
|
2451
|
+
puts "Error when calling UserApi->user_qr_code_sign_up: #{e}"
|
|
2452
|
+
end
|
|
2453
|
+
```
|
|
2454
|
+
|
|
2455
|
+
#### Using the user_qr_code_sign_up_with_http_info variant
|
|
2456
|
+
|
|
2457
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2458
|
+
|
|
2459
|
+
> <Array(<TokenModelApiResponse>, Integer, Hash)> user_qr_code_sign_up_with_http_info(app_key, opts)
|
|
2460
|
+
|
|
2461
|
+
```ruby
|
|
2462
|
+
begin
|
|
2463
|
+
# 微信小程序 - 注册
|
|
2464
|
+
data, status_code, headers = api_instance.user_qr_code_sign_up_with_http_info(app_key, opts)
|
|
2465
|
+
p status_code # => 2xx
|
|
2466
|
+
p headers # => { ... }
|
|
2467
|
+
p data # => <TokenModelApiResponse>
|
|
2468
|
+
rescue ZSGFClient::ApiError => e
|
|
2469
|
+
puts "Error when calling UserApi->user_qr_code_sign_up_with_http_info: #{e}"
|
|
2470
|
+
end
|
|
2471
|
+
```
|
|
2472
|
+
|
|
2473
|
+
### Parameters
|
|
2474
|
+
|
|
2475
|
+
| Name | Type | Description | Notes |
|
|
2476
|
+
| ---- | ---- | ----------- | ----- |
|
|
2477
|
+
| **app_key** | **String** | | |
|
|
2478
|
+
| **qr_code_sign_up_request** | [**QRCodeSignUpRequest**](QRCodeSignUpRequest.md) | 注册请求参数 | [optional] |
|
|
2479
|
+
|
|
2480
|
+
### Return type
|
|
2481
|
+
|
|
2482
|
+
[**TokenModelApiResponse**](TokenModelApiResponse.md)
|
|
2483
|
+
|
|
2484
|
+
### Authorization
|
|
2485
|
+
|
|
2486
|
+
[Bearer](../README.md#Bearer)
|
|
2487
|
+
|
|
2488
|
+
### HTTP request headers
|
|
2489
|
+
|
|
2490
|
+
- **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
|
|
2491
|
+
- **Accept**: application/json
|
|
2492
|
+
|
|
2493
|
+
|
|
2494
|
+
## user_reset_pwd
|
|
2495
|
+
|
|
2496
|
+
> <BooleanApiResponse> user_reset_pwd(app_key, opts)
|
|
2497
|
+
|
|
2498
|
+
重置密码
|
|
2499
|
+
|
|
2500
|
+
通过手机号或邮箱重置密码
|
|
2501
|
+
|
|
2502
|
+
### Examples
|
|
2503
|
+
|
|
2504
|
+
```ruby
|
|
2505
|
+
require 'time'
|
|
2506
|
+
require 'zsgf_client'
|
|
2507
|
+
# setup authorization
|
|
2508
|
+
ZSGFClient.configure do |config|
|
|
2509
|
+
# Configure Bearer authorization: Bearer
|
|
2510
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2511
|
+
end
|
|
2512
|
+
|
|
2513
|
+
api_instance = ZSGFClient::UserApi.new
|
|
2514
|
+
app_key = 'app_key_example' # String |
|
|
2515
|
+
opts = {
|
|
2516
|
+
app_user_reset_pwd_request: ZSGFClient::AppUserResetPwdRequest.new({code: 'code_example', pwd: 'pwd_example'}) # AppUserResetPwdRequest | 重置密码的请求参数
|
|
2517
|
+
}
|
|
2518
|
+
|
|
2519
|
+
begin
|
|
2520
|
+
# 重置密码
|
|
2521
|
+
result = api_instance.user_reset_pwd(app_key, opts)
|
|
2522
|
+
p result
|
|
2523
|
+
rescue ZSGFClient::ApiError => e
|
|
2524
|
+
puts "Error when calling UserApi->user_reset_pwd: #{e}"
|
|
2525
|
+
end
|
|
2526
|
+
```
|
|
2527
|
+
|
|
2528
|
+
#### Using the user_reset_pwd_with_http_info variant
|
|
2529
|
+
|
|
2530
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2531
|
+
|
|
2532
|
+
> <Array(<BooleanApiResponse>, Integer, Hash)> user_reset_pwd_with_http_info(app_key, opts)
|
|
2533
|
+
|
|
2534
|
+
```ruby
|
|
2535
|
+
begin
|
|
2536
|
+
# 重置密码
|
|
2537
|
+
data, status_code, headers = api_instance.user_reset_pwd_with_http_info(app_key, opts)
|
|
2538
|
+
p status_code # => 2xx
|
|
2539
|
+
p headers # => { ... }
|
|
2540
|
+
p data # => <BooleanApiResponse>
|
|
2541
|
+
rescue ZSGFClient::ApiError => e
|
|
2542
|
+
puts "Error when calling UserApi->user_reset_pwd_with_http_info: #{e}"
|
|
2543
|
+
end
|
|
2544
|
+
```
|
|
2545
|
+
|
|
2546
|
+
### Parameters
|
|
2547
|
+
|
|
2548
|
+
| Name | Type | Description | Notes |
|
|
2549
|
+
| ---- | ---- | ----------- | ----- |
|
|
2550
|
+
| **app_key** | **String** | | |
|
|
2551
|
+
| **app_user_reset_pwd_request** | [**AppUserResetPwdRequest**](AppUserResetPwdRequest.md) | 重置密码的请求参数 | [optional] |
|
|
2552
|
+
|
|
2553
|
+
### Return type
|
|
2554
|
+
|
|
2555
|
+
[**BooleanApiResponse**](BooleanApiResponse.md)
|
|
2556
|
+
|
|
2557
|
+
### Authorization
|
|
2558
|
+
|
|
2559
|
+
[Bearer](../README.md#Bearer)
|
|
2560
|
+
|
|
2561
|
+
### HTTP request headers
|
|
2562
|
+
|
|
2563
|
+
- **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
|
|
2564
|
+
- **Accept**: application/json
|
|
2565
|
+
|
|
2566
|
+
|
|
2567
|
+
## user_send_email_code
|
|
2568
|
+
|
|
2569
|
+
> <BooleanApiResponse> user_send_email_code(app_key, opts)
|
|
2570
|
+
|
|
2571
|
+
发送邮箱验证码
|
|
2572
|
+
|
|
2573
|
+
发送邮箱验证码用于注册或找回密码
|
|
2574
|
+
|
|
2575
|
+
### Examples
|
|
2576
|
+
|
|
2577
|
+
```ruby
|
|
2578
|
+
require 'time'
|
|
2579
|
+
require 'zsgf_client'
|
|
2580
|
+
# setup authorization
|
|
2581
|
+
ZSGFClient.configure do |config|
|
|
2582
|
+
# Configure Bearer authorization: Bearer
|
|
2583
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2584
|
+
end
|
|
2585
|
+
|
|
2586
|
+
api_instance = ZSGFClient::UserApi.new
|
|
2587
|
+
app_key = 'app_key_example' # String |
|
|
2588
|
+
opts = {
|
|
2589
|
+
send_email_code_request: ZSGFClient::SendEmailCodeRequest.new({email: 'email_example', type: 'type_example'}) # SendEmailCodeRequest | 发送邮箱验证码的请求参数
|
|
2590
|
+
}
|
|
2591
|
+
|
|
2592
|
+
begin
|
|
2593
|
+
# 发送邮箱验证码
|
|
2594
|
+
result = api_instance.user_send_email_code(app_key, opts)
|
|
2595
|
+
p result
|
|
2596
|
+
rescue ZSGFClient::ApiError => e
|
|
2597
|
+
puts "Error when calling UserApi->user_send_email_code: #{e}"
|
|
2598
|
+
end
|
|
2599
|
+
```
|
|
2600
|
+
|
|
2601
|
+
#### Using the user_send_email_code_with_http_info variant
|
|
2602
|
+
|
|
2603
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2604
|
+
|
|
2605
|
+
> <Array(<BooleanApiResponse>, Integer, Hash)> user_send_email_code_with_http_info(app_key, opts)
|
|
2606
|
+
|
|
2607
|
+
```ruby
|
|
2608
|
+
begin
|
|
2609
|
+
# 发送邮箱验证码
|
|
2610
|
+
data, status_code, headers = api_instance.user_send_email_code_with_http_info(app_key, opts)
|
|
2611
|
+
p status_code # => 2xx
|
|
2612
|
+
p headers # => { ... }
|
|
2613
|
+
p data # => <BooleanApiResponse>
|
|
2614
|
+
rescue ZSGFClient::ApiError => e
|
|
2615
|
+
puts "Error when calling UserApi->user_send_email_code_with_http_info: #{e}"
|
|
2616
|
+
end
|
|
2617
|
+
```
|
|
2618
|
+
|
|
2619
|
+
### Parameters
|
|
2620
|
+
|
|
2621
|
+
| Name | Type | Description | Notes |
|
|
2622
|
+
| ---- | ---- | ----------- | ----- |
|
|
2623
|
+
| **app_key** | **String** | | |
|
|
2624
|
+
| **send_email_code_request** | [**SendEmailCodeRequest**](SendEmailCodeRequest.md) | 发送邮箱验证码的请求参数 | [optional] |
|
|
2625
|
+
|
|
2626
|
+
### Return type
|
|
2627
|
+
|
|
2628
|
+
[**BooleanApiResponse**](BooleanApiResponse.md)
|
|
2629
|
+
|
|
2630
|
+
### Authorization
|
|
2631
|
+
|
|
2632
|
+
[Bearer](../README.md#Bearer)
|
|
2633
|
+
|
|
2634
|
+
### HTTP request headers
|
|
2635
|
+
|
|
2636
|
+
- **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
|
|
2637
|
+
- **Accept**: application/json
|
|
2638
|
+
|
|
2639
|
+
|
|
2640
|
+
## user_send_sms_code
|
|
2641
|
+
|
|
2642
|
+
> <BooleanApiResponse> user_send_sms_code(app_key, opts)
|
|
2643
|
+
|
|
2644
|
+
发送手机验证码
|
|
2645
|
+
|
|
2646
|
+
发送手机验证码用于注册或找回密码
|
|
2647
|
+
|
|
2648
|
+
### Examples
|
|
2649
|
+
|
|
2650
|
+
```ruby
|
|
2651
|
+
require 'time'
|
|
2652
|
+
require 'zsgf_client'
|
|
2653
|
+
# setup authorization
|
|
2654
|
+
ZSGFClient.configure do |config|
|
|
2655
|
+
# Configure Bearer authorization: Bearer
|
|
2656
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2657
|
+
end
|
|
2658
|
+
|
|
2659
|
+
api_instance = ZSGFClient::UserApi.new
|
|
2660
|
+
app_key = 'app_key_example' # String |
|
|
2661
|
+
opts = {
|
|
2662
|
+
send_sms_code_request: ZSGFClient::SendSMSCodeRequest.new({phone: 'phone_example', type: 'type_example'}) # SendSMSCodeRequest | 发送手机验证码的请求参数
|
|
2663
|
+
}
|
|
2664
|
+
|
|
2665
|
+
begin
|
|
2666
|
+
# 发送手机验证码
|
|
2667
|
+
result = api_instance.user_send_sms_code(app_key, opts)
|
|
2668
|
+
p result
|
|
2669
|
+
rescue ZSGFClient::ApiError => e
|
|
2670
|
+
puts "Error when calling UserApi->user_send_sms_code: #{e}"
|
|
2671
|
+
end
|
|
2672
|
+
```
|
|
2673
|
+
|
|
2674
|
+
#### Using the user_send_sms_code_with_http_info variant
|
|
2675
|
+
|
|
2676
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2677
|
+
|
|
2678
|
+
> <Array(<BooleanApiResponse>, Integer, Hash)> user_send_sms_code_with_http_info(app_key, opts)
|
|
2679
|
+
|
|
2680
|
+
```ruby
|
|
2681
|
+
begin
|
|
2682
|
+
# 发送手机验证码
|
|
2683
|
+
data, status_code, headers = api_instance.user_send_sms_code_with_http_info(app_key, opts)
|
|
2684
|
+
p status_code # => 2xx
|
|
2685
|
+
p headers # => { ... }
|
|
2686
|
+
p data # => <BooleanApiResponse>
|
|
2687
|
+
rescue ZSGFClient::ApiError => e
|
|
2688
|
+
puts "Error when calling UserApi->user_send_sms_code_with_http_info: #{e}"
|
|
2689
|
+
end
|
|
2690
|
+
```
|
|
2691
|
+
|
|
2692
|
+
### Parameters
|
|
2693
|
+
|
|
2694
|
+
| Name | Type | Description | Notes |
|
|
2695
|
+
| ---- | ---- | ----------- | ----- |
|
|
2696
|
+
| **app_key** | **String** | | |
|
|
2697
|
+
| **send_sms_code_request** | [**SendSMSCodeRequest**](SendSMSCodeRequest.md) | 发送手机验证码的请求参数 | [optional] |
|
|
2698
|
+
|
|
2699
|
+
### Return type
|
|
2700
|
+
|
|
2701
|
+
[**BooleanApiResponse**](BooleanApiResponse.md)
|
|
2702
|
+
|
|
2703
|
+
### Authorization
|
|
2704
|
+
|
|
2705
|
+
[Bearer](../README.md#Bearer)
|
|
2706
|
+
|
|
2707
|
+
### HTTP request headers
|
|
2708
|
+
|
|
2709
|
+
- **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
|
|
2710
|
+
- **Accept**: application/json
|
|
2711
|
+
|
|
2712
|
+
|
|
2713
|
+
## user_sign_in
|
|
2714
|
+
|
|
2715
|
+
> <TokenModelApiResponse> user_sign_in(app_key, opts)
|
|
2716
|
+
|
|
2717
|
+
账号密码 登录
|
|
2718
|
+
|
|
2719
|
+
使用账号密码进行登录
|
|
2720
|
+
|
|
2721
|
+
### Examples
|
|
2722
|
+
|
|
2723
|
+
```ruby
|
|
2724
|
+
require 'time'
|
|
2725
|
+
require 'zsgf_client'
|
|
2726
|
+
# setup authorization
|
|
2727
|
+
ZSGFClient.configure do |config|
|
|
2728
|
+
# Configure Bearer authorization: Bearer
|
|
2729
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2730
|
+
end
|
|
2731
|
+
|
|
2732
|
+
api_instance = ZSGFClient::UserApi.new
|
|
2733
|
+
app_key = 'app_key_example' # String |
|
|
2734
|
+
opts = {
|
|
2735
|
+
sign_in_request: ZSGFClient::SignInRequest.new({user_name: 'user_name_example', pwd: 'pwd_example'}) # SignInRequest | 登录请求参数
|
|
2736
|
+
}
|
|
2737
|
+
|
|
2738
|
+
begin
|
|
2739
|
+
# 账号密码 登录
|
|
2740
|
+
result = api_instance.user_sign_in(app_key, opts)
|
|
2741
|
+
p result
|
|
2742
|
+
rescue ZSGFClient::ApiError => e
|
|
2743
|
+
puts "Error when calling UserApi->user_sign_in: #{e}"
|
|
2744
|
+
end
|
|
2745
|
+
```
|
|
2746
|
+
|
|
2747
|
+
#### Using the user_sign_in_with_http_info variant
|
|
2748
|
+
|
|
2749
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2750
|
+
|
|
2751
|
+
> <Array(<TokenModelApiResponse>, Integer, Hash)> user_sign_in_with_http_info(app_key, opts)
|
|
2752
|
+
|
|
2753
|
+
```ruby
|
|
2754
|
+
begin
|
|
2755
|
+
# 账号密码 登录
|
|
2756
|
+
data, status_code, headers = api_instance.user_sign_in_with_http_info(app_key, opts)
|
|
2757
|
+
p status_code # => 2xx
|
|
2758
|
+
p headers # => { ... }
|
|
2759
|
+
p data # => <TokenModelApiResponse>
|
|
2760
|
+
rescue ZSGFClient::ApiError => e
|
|
2761
|
+
puts "Error when calling UserApi->user_sign_in_with_http_info: #{e}"
|
|
2762
|
+
end
|
|
2763
|
+
```
|
|
2764
|
+
|
|
2765
|
+
### Parameters
|
|
2766
|
+
|
|
2767
|
+
| Name | Type | Description | Notes |
|
|
2768
|
+
| ---- | ---- | ----------- | ----- |
|
|
2769
|
+
| **app_key** | **String** | | |
|
|
2770
|
+
| **sign_in_request** | [**SignInRequest**](SignInRequest.md) | 登录请求参数 | [optional] |
|
|
2771
|
+
|
|
2772
|
+
### Return type
|
|
2773
|
+
|
|
2774
|
+
[**TokenModelApiResponse**](TokenModelApiResponse.md)
|
|
2775
|
+
|
|
2776
|
+
### Authorization
|
|
2777
|
+
|
|
2778
|
+
[Bearer](../README.md#Bearer)
|
|
2779
|
+
|
|
2780
|
+
### HTTP request headers
|
|
2781
|
+
|
|
2782
|
+
- **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
|
|
2783
|
+
- **Accept**: application/json
|
|
2784
|
+
|
|
2785
|
+
|
|
2786
|
+
## user_sign_up
|
|
2787
|
+
|
|
2788
|
+
> <TokenModelApiResponse> user_sign_up(app_key, opts)
|
|
2789
|
+
|
|
2790
|
+
账号密码 注册
|
|
2791
|
+
|
|
2792
|
+
使用账号密码进行注册
|
|
2793
|
+
|
|
2794
|
+
### Examples
|
|
2795
|
+
|
|
2796
|
+
```ruby
|
|
2797
|
+
require 'time'
|
|
2798
|
+
require 'zsgf_client'
|
|
2799
|
+
# setup authorization
|
|
2800
|
+
ZSGFClient.configure do |config|
|
|
2801
|
+
# Configure Bearer authorization: Bearer
|
|
2802
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2803
|
+
end
|
|
2804
|
+
|
|
2805
|
+
api_instance = ZSGFClient::UserApi.new
|
|
2806
|
+
app_key = 'app_key_example' # String |
|
|
2807
|
+
opts = {
|
|
2808
|
+
sign_up_request: ZSGFClient::SignUpRequest.new({user_name: 'user_name_example', pwd: 'pwd_example'}) # SignUpRequest | 注册请求参数
|
|
2809
|
+
}
|
|
2810
|
+
|
|
2811
|
+
begin
|
|
2812
|
+
# 账号密码 注册
|
|
2813
|
+
result = api_instance.user_sign_up(app_key, opts)
|
|
2814
|
+
p result
|
|
2815
|
+
rescue ZSGFClient::ApiError => e
|
|
2816
|
+
puts "Error when calling UserApi->user_sign_up: #{e}"
|
|
2817
|
+
end
|
|
2818
|
+
```
|
|
2819
|
+
|
|
2820
|
+
#### Using the user_sign_up_with_http_info variant
|
|
2821
|
+
|
|
2822
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2823
|
+
|
|
2824
|
+
> <Array(<TokenModelApiResponse>, Integer, Hash)> user_sign_up_with_http_info(app_key, opts)
|
|
2825
|
+
|
|
2826
|
+
```ruby
|
|
2827
|
+
begin
|
|
2828
|
+
# 账号密码 注册
|
|
2829
|
+
data, status_code, headers = api_instance.user_sign_up_with_http_info(app_key, opts)
|
|
2830
|
+
p status_code # => 2xx
|
|
2831
|
+
p headers # => { ... }
|
|
2832
|
+
p data # => <TokenModelApiResponse>
|
|
2833
|
+
rescue ZSGFClient::ApiError => e
|
|
2834
|
+
puts "Error when calling UserApi->user_sign_up_with_http_info: #{e}"
|
|
2835
|
+
end
|
|
2836
|
+
```
|
|
2837
|
+
|
|
2838
|
+
### Parameters
|
|
2839
|
+
|
|
2840
|
+
| Name | Type | Description | Notes |
|
|
2841
|
+
| ---- | ---- | ----------- | ----- |
|
|
2842
|
+
| **app_key** | **String** | | |
|
|
2843
|
+
| **sign_up_request** | [**SignUpRequest**](SignUpRequest.md) | 注册请求参数 | [optional] |
|
|
2844
|
+
|
|
2845
|
+
### Return type
|
|
2846
|
+
|
|
2847
|
+
[**TokenModelApiResponse**](TokenModelApiResponse.md)
|
|
2848
|
+
|
|
2849
|
+
### Authorization
|
|
2850
|
+
|
|
2851
|
+
[Bearer](../README.md#Bearer)
|
|
2852
|
+
|
|
2853
|
+
### HTTP request headers
|
|
2854
|
+
|
|
2855
|
+
- **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
|
|
2856
|
+
- **Accept**: application/json
|
|
2857
|
+
|
|
2858
|
+
|
|
2859
|
+
## user_two_factor_auth
|
|
2860
|
+
|
|
2861
|
+
> <SetupCodeApiResponse> user_two_factor_auth(app_key)
|
|
2862
|
+
|
|
2863
|
+
双因素验证
|
|
2864
|
+
|
|
2865
|
+
获取双因素验证的设置信息
|
|
2866
|
+
|
|
2867
|
+
### Examples
|
|
2868
|
+
|
|
2869
|
+
```ruby
|
|
2870
|
+
require 'time'
|
|
2871
|
+
require 'zsgf_client'
|
|
2872
|
+
# setup authorization
|
|
2873
|
+
ZSGFClient.configure do |config|
|
|
2874
|
+
# Configure Bearer authorization: Bearer
|
|
2875
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2876
|
+
end
|
|
2877
|
+
|
|
2878
|
+
api_instance = ZSGFClient::UserApi.new
|
|
2879
|
+
app_key = 'app_key_example' # String |
|
|
2880
|
+
|
|
2881
|
+
begin
|
|
2882
|
+
# 双因素验证
|
|
2883
|
+
result = api_instance.user_two_factor_auth(app_key)
|
|
2884
|
+
p result
|
|
2885
|
+
rescue ZSGFClient::ApiError => e
|
|
2886
|
+
puts "Error when calling UserApi->user_two_factor_auth: #{e}"
|
|
2887
|
+
end
|
|
2888
|
+
```
|
|
2889
|
+
|
|
2890
|
+
#### Using the user_two_factor_auth_with_http_info variant
|
|
2891
|
+
|
|
2892
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2893
|
+
|
|
2894
|
+
> <Array(<SetupCodeApiResponse>, Integer, Hash)> user_two_factor_auth_with_http_info(app_key)
|
|
2895
|
+
|
|
2896
|
+
```ruby
|
|
2897
|
+
begin
|
|
2898
|
+
# 双因素验证
|
|
2899
|
+
data, status_code, headers = api_instance.user_two_factor_auth_with_http_info(app_key)
|
|
2900
|
+
p status_code # => 2xx
|
|
2901
|
+
p headers # => { ... }
|
|
2902
|
+
p data # => <SetupCodeApiResponse>
|
|
2903
|
+
rescue ZSGFClient::ApiError => e
|
|
2904
|
+
puts "Error when calling UserApi->user_two_factor_auth_with_http_info: #{e}"
|
|
2905
|
+
end
|
|
2906
|
+
```
|
|
2907
|
+
|
|
2908
|
+
### Parameters
|
|
2909
|
+
|
|
2910
|
+
| Name | Type | Description | Notes |
|
|
2911
|
+
| ---- | ---- | ----------- | ----- |
|
|
2912
|
+
| **app_key** | **String** | | |
|
|
2913
|
+
|
|
2914
|
+
### Return type
|
|
2915
|
+
|
|
2916
|
+
[**SetupCodeApiResponse**](SetupCodeApiResponse.md)
|
|
2917
|
+
|
|
2918
|
+
### Authorization
|
|
2919
|
+
|
|
2920
|
+
[Bearer](../README.md#Bearer)
|
|
2921
|
+
|
|
2922
|
+
### HTTP request headers
|
|
2923
|
+
|
|
2924
|
+
- **Content-Type**: Not defined
|
|
2925
|
+
- **Accept**: application/json
|
|
2926
|
+
|
|
2927
|
+
|
|
2928
|
+
## user_unfollow_user
|
|
2929
|
+
|
|
2930
|
+
> <BooleanApiResponse> user_unfollow_user(user_id, app_key)
|
|
2931
|
+
|
|
2932
|
+
取消关注
|
|
2933
|
+
|
|
2934
|
+
取消关注指定用户
|
|
2935
|
+
|
|
2936
|
+
### Examples
|
|
2937
|
+
|
|
2938
|
+
```ruby
|
|
2939
|
+
require 'time'
|
|
2940
|
+
require 'zsgf_client'
|
|
2941
|
+
# setup authorization
|
|
2942
|
+
ZSGFClient.configure do |config|
|
|
2943
|
+
# Configure Bearer authorization: Bearer
|
|
2944
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2945
|
+
end
|
|
2946
|
+
|
|
2947
|
+
api_instance = ZSGFClient::UserApi.new
|
|
2948
|
+
user_id = 789 # Integer | 要取消关注的用户ID
|
|
2949
|
+
app_key = 'app_key_example' # String |
|
|
2950
|
+
|
|
2951
|
+
begin
|
|
2952
|
+
# 取消关注
|
|
2953
|
+
result = api_instance.user_unfollow_user(user_id, app_key)
|
|
2954
|
+
p result
|
|
2955
|
+
rescue ZSGFClient::ApiError => e
|
|
2956
|
+
puts "Error when calling UserApi->user_unfollow_user: #{e}"
|
|
2957
|
+
end
|
|
2958
|
+
```
|
|
2959
|
+
|
|
2960
|
+
#### Using the user_unfollow_user_with_http_info variant
|
|
2961
|
+
|
|
2962
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2963
|
+
|
|
2964
|
+
> <Array(<BooleanApiResponse>, Integer, Hash)> user_unfollow_user_with_http_info(user_id, app_key)
|
|
2965
|
+
|
|
2966
|
+
```ruby
|
|
2967
|
+
begin
|
|
2968
|
+
# 取消关注
|
|
2969
|
+
data, status_code, headers = api_instance.user_unfollow_user_with_http_info(user_id, app_key)
|
|
2970
|
+
p status_code # => 2xx
|
|
2971
|
+
p headers # => { ... }
|
|
2972
|
+
p data # => <BooleanApiResponse>
|
|
2973
|
+
rescue ZSGFClient::ApiError => e
|
|
2974
|
+
puts "Error when calling UserApi->user_unfollow_user_with_http_info: #{e}"
|
|
2975
|
+
end
|
|
2976
|
+
```
|
|
2977
|
+
|
|
2978
|
+
### Parameters
|
|
2979
|
+
|
|
2980
|
+
| Name | Type | Description | Notes |
|
|
2981
|
+
| ---- | ---- | ----------- | ----- |
|
|
2982
|
+
| **user_id** | **Integer** | 要取消关注的用户ID | |
|
|
2983
|
+
| **app_key** | **String** | | |
|
|
2984
|
+
|
|
2985
|
+
### Return type
|
|
2986
|
+
|
|
2987
|
+
[**BooleanApiResponse**](BooleanApiResponse.md)
|
|
2988
|
+
|
|
2989
|
+
### Authorization
|
|
2990
|
+
|
|
2991
|
+
[Bearer](../README.md#Bearer)
|
|
2992
|
+
|
|
2993
|
+
### HTTP request headers
|
|
2994
|
+
|
|
2995
|
+
- **Content-Type**: Not defined
|
|
2996
|
+
- **Accept**: application/json
|
|
2997
|
+
|
|
2998
|
+
|
|
2999
|
+
## user_union_id_sign_in
|
|
3000
|
+
|
|
3001
|
+
> <TokenModelApiResponse> user_union_id_sign_in(app_key, opts)
|
|
3002
|
+
|
|
3003
|
+
UnionID登录
|
|
3004
|
+
|
|
3005
|
+
使用UnionID进行登录
|
|
3006
|
+
|
|
3007
|
+
### Examples
|
|
3008
|
+
|
|
3009
|
+
```ruby
|
|
3010
|
+
require 'time'
|
|
3011
|
+
require 'zsgf_client'
|
|
3012
|
+
# setup authorization
|
|
3013
|
+
ZSGFClient.configure do |config|
|
|
3014
|
+
# Configure Bearer authorization: Bearer
|
|
3015
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
3016
|
+
end
|
|
3017
|
+
|
|
3018
|
+
api_instance = ZSGFClient::UserApi.new
|
|
3019
|
+
app_key = 'app_key_example' # String |
|
|
3020
|
+
opts = {
|
|
3021
|
+
union_id_sign_in_request: ZSGFClient::UnionIDSignInRequest.new({union_id: 'union_id_example', platform: 'platform_example'}) # UnionIDSignInRequest | 登录请求参数
|
|
3022
|
+
}
|
|
3023
|
+
|
|
3024
|
+
begin
|
|
3025
|
+
# UnionID登录
|
|
3026
|
+
result = api_instance.user_union_id_sign_in(app_key, opts)
|
|
3027
|
+
p result
|
|
3028
|
+
rescue ZSGFClient::ApiError => e
|
|
3029
|
+
puts "Error when calling UserApi->user_union_id_sign_in: #{e}"
|
|
3030
|
+
end
|
|
3031
|
+
```
|
|
3032
|
+
|
|
3033
|
+
#### Using the user_union_id_sign_in_with_http_info variant
|
|
3034
|
+
|
|
3035
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3036
|
+
|
|
3037
|
+
> <Array(<TokenModelApiResponse>, Integer, Hash)> user_union_id_sign_in_with_http_info(app_key, opts)
|
|
3038
|
+
|
|
3039
|
+
```ruby
|
|
3040
|
+
begin
|
|
3041
|
+
# UnionID登录
|
|
3042
|
+
data, status_code, headers = api_instance.user_union_id_sign_in_with_http_info(app_key, opts)
|
|
3043
|
+
p status_code # => 2xx
|
|
3044
|
+
p headers # => { ... }
|
|
3045
|
+
p data # => <TokenModelApiResponse>
|
|
3046
|
+
rescue ZSGFClient::ApiError => e
|
|
3047
|
+
puts "Error when calling UserApi->user_union_id_sign_in_with_http_info: #{e}"
|
|
3048
|
+
end
|
|
3049
|
+
```
|
|
3050
|
+
|
|
3051
|
+
### Parameters
|
|
3052
|
+
|
|
3053
|
+
| Name | Type | Description | Notes |
|
|
3054
|
+
| ---- | ---- | ----------- | ----- |
|
|
3055
|
+
| **app_key** | **String** | | |
|
|
3056
|
+
| **union_id_sign_in_request** | [**UnionIDSignInRequest**](UnionIDSignInRequest.md) | 登录请求参数 | [optional] |
|
|
3057
|
+
|
|
3058
|
+
### Return type
|
|
3059
|
+
|
|
3060
|
+
[**TokenModelApiResponse**](TokenModelApiResponse.md)
|
|
3061
|
+
|
|
3062
|
+
### Authorization
|
|
3063
|
+
|
|
3064
|
+
[Bearer](../README.md#Bearer)
|
|
3065
|
+
|
|
3066
|
+
### HTTP request headers
|
|
3067
|
+
|
|
3068
|
+
- **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
|
|
3069
|
+
- **Accept**: application/json
|
|
3070
|
+
|
|
3071
|
+
|
|
3072
|
+
## user_union_id_sign_up
|
|
3073
|
+
|
|
3074
|
+
> <TokenModelApiResponse> user_union_id_sign_up(app_key, opts)
|
|
3075
|
+
|
|
3076
|
+
UnionID注册
|
|
3077
|
+
|
|
3078
|
+
使用UnionID进行注册
|
|
3079
|
+
|
|
3080
|
+
### Examples
|
|
3081
|
+
|
|
3082
|
+
```ruby
|
|
3083
|
+
require 'time'
|
|
3084
|
+
require 'zsgf_client'
|
|
3085
|
+
# setup authorization
|
|
3086
|
+
ZSGFClient.configure do |config|
|
|
3087
|
+
# Configure Bearer authorization: Bearer
|
|
3088
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
3089
|
+
end
|
|
3090
|
+
|
|
3091
|
+
api_instance = ZSGFClient::UserApi.new
|
|
3092
|
+
app_key = 'app_key_example' # String |
|
|
3093
|
+
opts = {
|
|
3094
|
+
union_id_sign_up_request: ZSGFClient::UnionIDSignUpRequest.new({union_id: 'union_id_example', platform: 'platform_example', pwd: 'pwd_example'}) # UnionIDSignUpRequest | 注册请求参数
|
|
3095
|
+
}
|
|
3096
|
+
|
|
3097
|
+
begin
|
|
3098
|
+
# UnionID注册
|
|
3099
|
+
result = api_instance.user_union_id_sign_up(app_key, opts)
|
|
3100
|
+
p result
|
|
3101
|
+
rescue ZSGFClient::ApiError => e
|
|
3102
|
+
puts "Error when calling UserApi->user_union_id_sign_up: #{e}"
|
|
3103
|
+
end
|
|
3104
|
+
```
|
|
3105
|
+
|
|
3106
|
+
#### Using the user_union_id_sign_up_with_http_info variant
|
|
3107
|
+
|
|
3108
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3109
|
+
|
|
3110
|
+
> <Array(<TokenModelApiResponse>, Integer, Hash)> user_union_id_sign_up_with_http_info(app_key, opts)
|
|
3111
|
+
|
|
3112
|
+
```ruby
|
|
3113
|
+
begin
|
|
3114
|
+
# UnionID注册
|
|
3115
|
+
data, status_code, headers = api_instance.user_union_id_sign_up_with_http_info(app_key, opts)
|
|
3116
|
+
p status_code # => 2xx
|
|
3117
|
+
p headers # => { ... }
|
|
3118
|
+
p data # => <TokenModelApiResponse>
|
|
3119
|
+
rescue ZSGFClient::ApiError => e
|
|
3120
|
+
puts "Error when calling UserApi->user_union_id_sign_up_with_http_info: #{e}"
|
|
3121
|
+
end
|
|
3122
|
+
```
|
|
3123
|
+
|
|
3124
|
+
### Parameters
|
|
3125
|
+
|
|
3126
|
+
| Name | Type | Description | Notes |
|
|
3127
|
+
| ---- | ---- | ----------- | ----- |
|
|
3128
|
+
| **app_key** | **String** | | |
|
|
3129
|
+
| **union_id_sign_up_request** | [**UnionIDSignUpRequest**](UnionIDSignUpRequest.md) | 注册请求参数 | [optional] |
|
|
3130
|
+
|
|
3131
|
+
### Return type
|
|
3132
|
+
|
|
3133
|
+
[**TokenModelApiResponse**](TokenModelApiResponse.md)
|
|
3134
|
+
|
|
3135
|
+
### Authorization
|
|
3136
|
+
|
|
3137
|
+
[Bearer](../README.md#Bearer)
|
|
3138
|
+
|
|
3139
|
+
### HTTP request headers
|
|
3140
|
+
|
|
3141
|
+
- **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
|
|
3142
|
+
- **Accept**: application/json
|
|
3143
|
+
|
|
3144
|
+
|
|
3145
|
+
## user_update_profile
|
|
3146
|
+
|
|
3147
|
+
> <BooleanApiResponse> user_update_profile(app_key, opts)
|
|
3148
|
+
|
|
3149
|
+
更新个人资料
|
|
3150
|
+
|
|
3151
|
+
更新当前用户的个人资料
|
|
3152
|
+
|
|
3153
|
+
### Examples
|
|
3154
|
+
|
|
3155
|
+
```ruby
|
|
3156
|
+
require 'time'
|
|
3157
|
+
require 'zsgf_client'
|
|
3158
|
+
# setup authorization
|
|
3159
|
+
ZSGFClient.configure do |config|
|
|
3160
|
+
# Configure Bearer authorization: Bearer
|
|
3161
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
3162
|
+
end
|
|
3163
|
+
|
|
3164
|
+
api_instance = ZSGFClient::UserApi.new
|
|
3165
|
+
app_key = 'app_key_example' # String |
|
|
3166
|
+
opts = {
|
|
3167
|
+
update_profile_request: ZSGFClient::UpdateProfileRequest.new # UpdateProfileRequest | 更新个人资料的请求参数
|
|
3168
|
+
}
|
|
3169
|
+
|
|
3170
|
+
begin
|
|
3171
|
+
# 更新个人资料
|
|
3172
|
+
result = api_instance.user_update_profile(app_key, opts)
|
|
3173
|
+
p result
|
|
3174
|
+
rescue ZSGFClient::ApiError => e
|
|
3175
|
+
puts "Error when calling UserApi->user_update_profile: #{e}"
|
|
3176
|
+
end
|
|
3177
|
+
```
|
|
3178
|
+
|
|
3179
|
+
#### Using the user_update_profile_with_http_info variant
|
|
3180
|
+
|
|
3181
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3182
|
+
|
|
3183
|
+
> <Array(<BooleanApiResponse>, Integer, Hash)> user_update_profile_with_http_info(app_key, opts)
|
|
3184
|
+
|
|
3185
|
+
```ruby
|
|
3186
|
+
begin
|
|
3187
|
+
# 更新个人资料
|
|
3188
|
+
data, status_code, headers = api_instance.user_update_profile_with_http_info(app_key, opts)
|
|
3189
|
+
p status_code # => 2xx
|
|
3190
|
+
p headers # => { ... }
|
|
3191
|
+
p data # => <BooleanApiResponse>
|
|
3192
|
+
rescue ZSGFClient::ApiError => e
|
|
3193
|
+
puts "Error when calling UserApi->user_update_profile_with_http_info: #{e}"
|
|
3194
|
+
end
|
|
3195
|
+
```
|
|
3196
|
+
|
|
3197
|
+
### Parameters
|
|
3198
|
+
|
|
3199
|
+
| Name | Type | Description | Notes |
|
|
3200
|
+
| ---- | ---- | ----------- | ----- |
|
|
3201
|
+
| **app_key** | **String** | | |
|
|
3202
|
+
| **update_profile_request** | [**UpdateProfileRequest**](UpdateProfileRequest.md) | 更新个人资料的请求参数 | [optional] |
|
|
3203
|
+
|
|
3204
|
+
### Return type
|
|
3205
|
+
|
|
3206
|
+
[**BooleanApiResponse**](BooleanApiResponse.md)
|
|
3207
|
+
|
|
3208
|
+
### Authorization
|
|
3209
|
+
|
|
3210
|
+
[Bearer](../README.md#Bearer)
|
|
3211
|
+
|
|
3212
|
+
### HTTP request headers
|
|
3213
|
+
|
|
3214
|
+
- **Content-Type**: application/json-patch+json, application/json, text/json, application/*+json
|
|
3215
|
+
- **Accept**: application/json
|
|
3216
|
+
|
|
3217
|
+
|
|
3218
|
+
## users
|
|
3219
|
+
|
|
3220
|
+
> <UserListResultApiResponse> users(app_key, opts)
|
|
3221
|
+
|
|
3222
|
+
获取用户列表
|
|
3223
|
+
|
|
3224
|
+
根据条件获取用户列表
|
|
3225
|
+
|
|
3226
|
+
### Examples
|
|
3227
|
+
|
|
3228
|
+
```ruby
|
|
3229
|
+
require 'time'
|
|
3230
|
+
require 'zsgf_client'
|
|
3231
|
+
# setup authorization
|
|
3232
|
+
ZSGFClient.configure do |config|
|
|
3233
|
+
# Configure Bearer authorization: Bearer
|
|
3234
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
3235
|
+
end
|
|
3236
|
+
|
|
3237
|
+
api_instance = ZSGFClient::UserApi.new
|
|
3238
|
+
app_key = 'app_key_example' # String |
|
|
3239
|
+
opts = {
|
|
3240
|
+
user_name: 'user_name_example', # String | 用户名
|
|
3241
|
+
email: 'email_example', # String | 邮箱
|
|
3242
|
+
phone: 'phone_example', # String | 电话
|
|
3243
|
+
platform: 'platform_example', # String | 平台
|
|
3244
|
+
union_id: 'union_id_example', # String | 联合ID
|
|
3245
|
+
role: 'role_example', # String | 角色
|
|
3246
|
+
skip: 56, # Integer | 跳过的记录数
|
|
3247
|
+
take: 56 # Integer | 获取的记录数
|
|
3248
|
+
}
|
|
3249
|
+
|
|
3250
|
+
begin
|
|
3251
|
+
# 获取用户列表
|
|
3252
|
+
result = api_instance.users(app_key, opts)
|
|
3253
|
+
p result
|
|
3254
|
+
rescue ZSGFClient::ApiError => e
|
|
3255
|
+
puts "Error when calling UserApi->users: #{e}"
|
|
3256
|
+
end
|
|
3257
|
+
```
|
|
3258
|
+
|
|
3259
|
+
#### Using the users_with_http_info variant
|
|
3260
|
+
|
|
3261
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3262
|
+
|
|
3263
|
+
> <Array(<UserListResultApiResponse>, Integer, Hash)> users_with_http_info(app_key, opts)
|
|
3264
|
+
|
|
3265
|
+
```ruby
|
|
3266
|
+
begin
|
|
3267
|
+
# 获取用户列表
|
|
3268
|
+
data, status_code, headers = api_instance.users_with_http_info(app_key, opts)
|
|
3269
|
+
p status_code # => 2xx
|
|
3270
|
+
p headers # => { ... }
|
|
3271
|
+
p data # => <UserListResultApiResponse>
|
|
3272
|
+
rescue ZSGFClient::ApiError => e
|
|
3273
|
+
puts "Error when calling UserApi->users_with_http_info: #{e}"
|
|
3274
|
+
end
|
|
3275
|
+
```
|
|
3276
|
+
|
|
3277
|
+
### Parameters
|
|
3278
|
+
|
|
3279
|
+
| Name | Type | Description | Notes |
|
|
3280
|
+
| ---- | ---- | ----------- | ----- |
|
|
3281
|
+
| **app_key** | **String** | | |
|
|
3282
|
+
| **user_name** | **String** | 用户名 | [optional] |
|
|
3283
|
+
| **email** | **String** | 邮箱 | [optional] |
|
|
3284
|
+
| **phone** | **String** | 电话 | [optional] |
|
|
3285
|
+
| **platform** | **String** | 平台 | [optional] |
|
|
3286
|
+
| **union_id** | **String** | 联合ID | [optional] |
|
|
3287
|
+
| **role** | **String** | 角色 | [optional] |
|
|
3288
|
+
| **skip** | **Integer** | 跳过的记录数 | [optional] |
|
|
3289
|
+
| **take** | **Integer** | 获取的记录数 | [optional] |
|
|
3290
|
+
|
|
3291
|
+
### Return type
|
|
3292
|
+
|
|
3293
|
+
[**UserListResultApiResponse**](UserListResultApiResponse.md)
|
|
3294
|
+
|
|
3295
|
+
### Authorization
|
|
3296
|
+
|
|
3297
|
+
[Bearer](../README.md#Bearer)
|
|
3298
|
+
|
|
3299
|
+
### HTTP request headers
|
|
3300
|
+
|
|
3301
|
+
- **Content-Type**: Not defined
|
|
3302
|
+
- **Accept**: application/json
|
|
3303
|
+
|