ejabberd_http_client 1.0.0
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 +13 -0
- data/Gemfile.lock +72 -0
- data/README.md +411 -0
- data/Rakefile +10 -0
- data/docs/AbortDeleteOldMamMessages200Response.md +18 -0
- data/docs/AbortDeleteOldMamMessagesRequest.md +18 -0
- data/docs/AccountsApi.md +640 -0
- data/docs/AcmeApi.md +197 -0
- data/docs/AddOAuthClientImplicitRequest.md +22 -0
- data/docs/AddOAuthClientPasswordRequest.md +22 -0
- data/docs/AddRosterItemRequest.md +30 -0
- data/docs/BackupRequest.md +18 -0
- data/docs/BanAccountRequest.md +22 -0
- data/docs/BookmarksToPepRequest.md +20 -0
- data/docs/ChangeNodeNameRequest.md +24 -0
- data/docs/ChangePasswordRequest.md +22 -0
- data/docs/ChangeRoomOptionRequest.md +24 -0
- data/docs/CheckAccountRequest.md +20 -0
- data/docs/CheckModuleRequest.md +18 -0
- data/docs/CheckPasswordHashRequest.md +24 -0
- data/docs/CheckPasswordRequest.md +22 -0
- data/docs/ClusterApi.md +256 -0
- data/docs/CompileRequest.md +18 -0
- data/docs/ConfigApi.md +192 -0
- data/docs/ConnectedUsersInfo200ResponseInner.md +36 -0
- data/docs/ConnectedUsersNumber200Response.md +18 -0
- data/docs/ConnectedUsersVHostRequest.md +18 -0
- data/docs/ConvertToScramRequest.md +18 -0
- data/docs/ConvertToYamlRequest.md +20 -0
- data/docs/CreateRoomRequest.md +22 -0
- data/docs/CreateRoomWithOptionsRequest.md +24 -0
- data/docs/CreateRoomWithOptionsRequestOptionsInner.md +20 -0
- data/docs/CreateRoomsFileRequest.md +18 -0
- data/docs/DeleteMnesiaRequest.md +18 -0
- data/docs/DeleteOldMAMMessagesBatchRequest.md +26 -0
- data/docs/DeleteOldMAMMessagesRequest.md +20 -0
- data/docs/DeleteOldMAMMessagesStatusRequest.md +18 -0
- data/docs/DeleteOldMessagesBatchRequest.md +24 -0
- data/docs/DeleteOldMessagesRequest.md +18 -0
- data/docs/DeleteOldPubsubItemsRequest.md +18 -0
- data/docs/DeleteOldUsersRequest.md +18 -0
- data/docs/DocumentationApi.md +255 -0
- data/docs/DumpConfigRequest.md +18 -0
- data/docs/DumpRequest.md +18 -0
- data/docs/DumpTableRequest.md +20 -0
- data/docs/ErlangApi.md +194 -0
- data/docs/Export2sqlRequest.md +20 -0
- data/docs/ExportPiefxisHostRequest.md +20 -0
- data/docs/ExportPiefxisRequest.md +18 -0
- data/docs/GenHtmlDocForCommandsRequest.md +22 -0
- data/docs/GenMarkdownDocForTagsRequest.md +18 -0
- data/docs/GetCookie200Response.md +18 -0
- data/docs/GetLast200Response.md +20 -0
- data/docs/GetLastRequest.md +20 -0
- data/docs/GetLoglevel200Response.md +18 -0
- data/docs/GetNumResources200Response.md +18 -0
- data/docs/GetOfflineCount200Response.md +18 -0
- data/docs/GetOfflineCountRequest.md +20 -0
- data/docs/GetOutgoingS2sNumber200Response.md +18 -0
- data/docs/GetPresence200Response.md +22 -0
- data/docs/GetRoomAffiliation200Response.md +18 -0
- data/docs/GetRoomAffiliationRequest.md +22 -0
- data/docs/GetRoomAffiliations200ResponseInner.md +24 -0
- data/docs/GetRoomAffiliationsRequest.md +20 -0
- data/docs/GetRoomHistory200ResponseInner.md +20 -0
- data/docs/GetRoomOccupants200ResponseInner.md +22 -0
- data/docs/GetRoomOccupantsNumber200Response.md +18 -0
- data/docs/GetRoomOptions200ResponseInner.md +20 -0
- data/docs/GetRoster200ResponseInner.md +26 -0
- data/docs/GetStats200Response.md +18 -0
- data/docs/GetStatsHostRequest.md +20 -0
- data/docs/GetStatsRequest.md +18 -0
- data/docs/GetStatusList200ResponseInner.md +26 -0
- data/docs/GetStatusListHostRequest.md +20 -0
- data/docs/GetStatusListRequest.md +18 -0
- data/docs/GetStatusNum200Response.md +18 -0
- data/docs/GetUserRoomsRequest.md +20 -0
- data/docs/GetUserSessionsInfo200ResponseInner.md +34 -0
- data/docs/GetUserSubscriptions200ResponseInner.md +22 -0
- data/docs/GetVcard200Response.md +18 -0
- data/docs/GetVcard2MultiRequest.md +24 -0
- data/docs/GetVcard2Request.md +24 -0
- data/docs/GetVcardRequest.md +22 -0
- data/docs/ImportDir200Response.md +18 -0
- data/docs/ImportDirRequest.md +18 -0
- data/docs/ImportFileRequest.md +18 -0
- data/docs/ImportPiefxisRequest.md +18 -0
- data/docs/ImportProsodyRequest.md +18 -0
- data/docs/IncomingS2sNumber200Response.md +18 -0
- data/docs/InstallFallbackRequest.md +18 -0
- data/docs/IssueOAuthToken200Response.md +22 -0
- data/docs/IssueOAuthTokenRequest.md +22 -0
- data/docs/JoinClusterRequest.md +18 -0
- data/docs/KickSessionRequest.md +24 -0
- data/docs/KickUser200Response.md +18 -0
- data/docs/LastApi.md +135 -0
- data/docs/LeaveClusterRequest.md +18 -0
- data/docs/ListCertificates200ResponseInner.md +22 -0
- data/docs/ListMucOnlineRoomsByRegex200ResponseInner.md +22 -0
- data/docs/ListMucOnlineRoomsByRegexRequest.md +20 -0
- data/docs/ListMucOnlineRoomsRequest.md +18 -0
- data/docs/ListOAuthTokens200ResponseInner.md +24 -0
- data/docs/LoadDatabaseRequest.md +18 -0
- data/docs/LogsApi.md +252 -0
- data/docs/MamApi.md +137 -0
- data/docs/MnesiaApi.md +1071 -0
- data/docs/ModulesApi.md +434 -0
- data/docs/MucApi.md +705 -0
- data/docs/MucRoomApi.md +959 -0
- data/docs/OauthApi.md +378 -0
- data/docs/OfflineApi.md +70 -0
- data/docs/PrivacySetRequest.md +22 -0
- data/docs/PrivateApi.md +199 -0
- data/docs/PrivateGetRequest.md +24 -0
- data/docs/PrivateSetRequest.md +22 -0
- data/docs/ProcessRosterItems200ResponseInner.md +20 -0
- data/docs/ProcessRosterItemsRequest.md +26 -0
- data/docs/PurgeApi.md +815 -0
- data/docs/PushAllToAllRequest.md +20 -0
- data/docs/PushRosterAllRequest.md +18 -0
- data/docs/PushRosterRequest.md +22 -0
- data/docs/RegisterMucNickRequest.md +22 -0
- data/docs/RegisterRequest.md +22 -0
- data/docs/RegisteredUsersRequest.md +18 -0
- data/docs/RemoveMamForUserWithPeerRequest.md +22 -0
- data/docs/RemoveOAuthClientRequest.md +18 -0
- data/docs/RequestCertificateRequest.md +18 -0
- data/docs/ResourceNum200Response.md +18 -0
- data/docs/ResourceNumRequest.md +22 -0
- data/docs/RestartModule200Response.md +18 -0
- data/docs/RestartModuleRequest.md +20 -0
- data/docs/RestoreRequest.md +18 -0
- data/docs/RevokeCertificateRequest.md +18 -0
- data/docs/RevokeOAuthTokenRequest.md +18 -0
- data/docs/RoomsEmptyDestroyRequest.md +18 -0
- data/docs/RoomsUnusedDestroyRequest.md +20 -0
- data/docs/RosterApi.md +392 -0
- data/docs/S2sApi.md +187 -0
- data/docs/SendDirectInvitationRequest.md +26 -0
- data/docs/SendMessageRequest.md +26 -0
- data/docs/SendStanzaC2SRequest.md +24 -0
- data/docs/SendStanzaRequest.md +22 -0
- data/docs/ServerApi.md +615 -0
- data/docs/SessionApi.md +1021 -0
- data/docs/SetLastRequest.md +24 -0
- data/docs/SetLoglevelRequest.md +18 -0
- data/docs/SetMasterRequest.md +18 -0
- data/docs/SetNicknameRequest.md +22 -0
- data/docs/SetPresenceRequest.md +30 -0
- data/docs/SetRoomAffiliationRequest.md +24 -0
- data/docs/SetVcard2MultiRequest.md +26 -0
- data/docs/SetVcard2Request.md +26 -0
- data/docs/SetVcardRequest.md +24 -0
- data/docs/SharedRosterGroupApi.md +462 -0
- data/docs/SqlApi.md +191 -0
- data/docs/SrgCreateRequest.md +26 -0
- data/docs/SrgDeleteRequest.md +20 -0
- data/docs/SrgGetInfo200ResponseInner.md +20 -0
- data/docs/SrgUserAddRequest.md +24 -0
- data/docs/StanzaApi.md +267 -0
- data/docs/StatisticsApi.md +447 -0
- data/docs/StopKindlyRequest.md +20 -0
- data/docs/SubscribeToRoomManyRequest.md +22 -0
- data/docs/SubscribeToRoomManyRequestUsersInner.md +20 -0
- data/docs/SubscribeToRoomRequest.md +24 -0
- data/docs/TableMnesiaInfoRequest.md +18 -0
- data/docs/UnbanIp200Response.md +18 -0
- data/docs/UnbanIpRequest.md +18 -0
- data/docs/UnregisterMucNickRequest.md +20 -0
- data/docs/UnregisterUserRequest.md +20 -0
- data/docs/UnsubscribeFromRoomRequest.md +20 -0
- data/docs/VcardApi.md +456 -0
- data/ejabberd_http_client.gemspec +37 -0
- data/git_push.sh +57 -0
- data/lib/ejabberd_http_client/api/accounts_api.rb +656 -0
- data/lib/ejabberd_http_client/api/acme_api.rb +201 -0
- data/lib/ejabberd_http_client/api/cluster_api.rb +267 -0
- data/lib/ejabberd_http_client/api/config_api.rb +207 -0
- data/lib/ejabberd_http_client/api/documentation_api.rb +273 -0
- data/lib/ejabberd_http_client/api/erlang_api.rb +203 -0
- data/lib/ejabberd_http_client/api/last_api.rb +150 -0
- data/lib/ejabberd_http_client/api/logs_api.rb +249 -0
- data/lib/ejabberd_http_client/api/mam_api.rb +146 -0
- data/lib/ejabberd_http_client/api/mnesia_api.rb +1119 -0
- data/lib/ejabberd_http_client/api/modules_api.rb +441 -0
- data/lib/ejabberd_http_client/api/muc_api.rb +726 -0
- data/lib/ejabberd_http_client/api/muc_room_api.rb +986 -0
- data/lib/ejabberd_http_client/api/oauth_api.rb +399 -0
- data/lib/ejabberd_http_client/api/offline_api.rb +88 -0
- data/lib/ejabberd_http_client/api/private_api.rb +212 -0
- data/lib/ejabberd_http_client/api/purge_api.rb +848 -0
- data/lib/ejabberd_http_client/api/roster_api.rb +400 -0
- data/lib/ejabberd_http_client/api/s2s_api.rb +187 -0
- data/lib/ejabberd_http_client/api/server_api.rb +582 -0
- data/lib/ejabberd_http_client/api/session_api.rb +1011 -0
- data/lib/ejabberd_http_client/api/shared_roster_group_api.rb +456 -0
- data/lib/ejabberd_http_client/api/sql_api.rb +205 -0
- data/lib/ejabberd_http_client/api/stanza_api.rb +270 -0
- data/lib/ejabberd_http_client/api/statistics_api.rb +435 -0
- data/lib/ejabberd_http_client/api/vcard_api.rb +468 -0
- data/lib/ejabberd_http_client/api_client.rb +391 -0
- data/lib/ejabberd_http_client/api_error.rb +58 -0
- data/lib/ejabberd_http_client/configuration.rb +290 -0
- data/lib/ejabberd_http_client/models/abort_delete_old_mam_messages200_response.rb +215 -0
- data/lib/ejabberd_http_client/models/abort_delete_old_mam_messages_request.rb +215 -0
- data/lib/ejabberd_http_client/models/add_o_auth_client_implicit_request.rb +235 -0
- data/lib/ejabberd_http_client/models/add_o_auth_client_password_request.rb +235 -0
- data/lib/ejabberd_http_client/models/add_roster_item_request.rb +275 -0
- data/lib/ejabberd_http_client/models/backup_request.rb +215 -0
- data/lib/ejabberd_http_client/models/ban_account_request.rb +235 -0
- data/lib/ejabberd_http_client/models/bookmarks_to_pep_request.rb +225 -0
- data/lib/ejabberd_http_client/models/change_node_name_request.rb +245 -0
- data/lib/ejabberd_http_client/models/change_password_request.rb +235 -0
- data/lib/ejabberd_http_client/models/change_room_option_request.rb +245 -0
- data/lib/ejabberd_http_client/models/check_account_request.rb +225 -0
- data/lib/ejabberd_http_client/models/check_module_request.rb +215 -0
- data/lib/ejabberd_http_client/models/check_password_hash_request.rb +245 -0
- data/lib/ejabberd_http_client/models/check_password_request.rb +235 -0
- data/lib/ejabberd_http_client/models/compile_request.rb +215 -0
- data/lib/ejabberd_http_client/models/connected_users_info200_response_inner.rb +305 -0
- data/lib/ejabberd_http_client/models/connected_users_number200_response.rb +215 -0
- data/lib/ejabberd_http_client/models/connected_users_v_host_request.rb +215 -0
- data/lib/ejabberd_http_client/models/convert_to_scram_request.rb +215 -0
- data/lib/ejabberd_http_client/models/convert_to_yaml_request.rb +225 -0
- data/lib/ejabberd_http_client/models/create_room_request.rb +235 -0
- data/lib/ejabberd_http_client/models/create_room_with_options_request.rb +246 -0
- data/lib/ejabberd_http_client/models/create_room_with_options_request_options_inner.rb +225 -0
- data/lib/ejabberd_http_client/models/create_rooms_file_request.rb +215 -0
- data/lib/ejabberd_http_client/models/delete_mnesia_request.rb +215 -0
- data/lib/ejabberd_http_client/models/delete_old_mam_messages_batch_request.rb +255 -0
- data/lib/ejabberd_http_client/models/delete_old_mam_messages_request.rb +225 -0
- data/lib/ejabberd_http_client/models/delete_old_mam_messages_status_request.rb +215 -0
- data/lib/ejabberd_http_client/models/delete_old_messages_batch_request.rb +245 -0
- data/lib/ejabberd_http_client/models/delete_old_messages_request.rb +215 -0
- data/lib/ejabberd_http_client/models/delete_old_pubsub_items_request.rb +215 -0
- data/lib/ejabberd_http_client/models/delete_old_users_request.rb +215 -0
- data/lib/ejabberd_http_client/models/dump_config_request.rb +215 -0
- data/lib/ejabberd_http_client/models/dump_request.rb +215 -0
- data/lib/ejabberd_http_client/models/dump_table_request.rb +225 -0
- data/lib/ejabberd_http_client/models/export2sql_request.rb +225 -0
- data/lib/ejabberd_http_client/models/export_piefxis_host_request.rb +225 -0
- data/lib/ejabberd_http_client/models/export_piefxis_request.rb +215 -0
- data/lib/ejabberd_http_client/models/gen_html_doc_for_commands_request.rb +235 -0
- data/lib/ejabberd_http_client/models/gen_markdown_doc_for_tags_request.rb +215 -0
- data/lib/ejabberd_http_client/models/get_cookie200_response.rb +215 -0
- data/lib/ejabberd_http_client/models/get_last200_response.rb +225 -0
- data/lib/ejabberd_http_client/models/get_last_request.rb +225 -0
- data/lib/ejabberd_http_client/models/get_loglevel200_response.rb +215 -0
- data/lib/ejabberd_http_client/models/get_num_resources200_response.rb +214 -0
- data/lib/ejabberd_http_client/models/get_offline_count200_response.rb +215 -0
- data/lib/ejabberd_http_client/models/get_offline_count_request.rb +223 -0
- data/lib/ejabberd_http_client/models/get_outgoing_s2s_number200_response.rb +214 -0
- data/lib/ejabberd_http_client/models/get_presence200_response.rb +235 -0
- data/lib/ejabberd_http_client/models/get_room_affiliation200_response.rb +215 -0
- data/lib/ejabberd_http_client/models/get_room_affiliation_request.rb +235 -0
- data/lib/ejabberd_http_client/models/get_room_affiliations200_response_inner.rb +241 -0
- data/lib/ejabberd_http_client/models/get_room_affiliations_request.rb +225 -0
- data/lib/ejabberd_http_client/models/get_room_history200_response_inner.rb +223 -0
- data/lib/ejabberd_http_client/models/get_room_occupants200_response_inner.rb +232 -0
- data/lib/ejabberd_http_client/models/get_room_occupants_number200_response.rb +214 -0
- data/lib/ejabberd_http_client/models/get_room_options200_response_inner.rb +223 -0
- data/lib/ejabberd_http_client/models/get_roster200_response_inner.rb +252 -0
- data/lib/ejabberd_http_client/models/get_stats200_response.rb +215 -0
- data/lib/ejabberd_http_client/models/get_stats_host_request.rb +225 -0
- data/lib/ejabberd_http_client/models/get_stats_request.rb +215 -0
- data/lib/ejabberd_http_client/models/get_status_list200_response_inner.rb +255 -0
- data/lib/ejabberd_http_client/models/get_status_list_host_request.rb +225 -0
- data/lib/ejabberd_http_client/models/get_status_list_request.rb +215 -0
- data/lib/ejabberd_http_client/models/get_status_num200_response.rb +215 -0
- data/lib/ejabberd_http_client/models/get_user_rooms_request.rb +225 -0
- data/lib/ejabberd_http_client/models/get_user_sessions_info200_response_inner.rb +295 -0
- data/lib/ejabberd_http_client/models/get_user_subscriptions200_response_inner.rb +234 -0
- data/lib/ejabberd_http_client/models/get_vcard200_response.rb +214 -0
- data/lib/ejabberd_http_client/models/get_vcard2_multi_request.rb +241 -0
- data/lib/ejabberd_http_client/models/get_vcard2_request.rb +245 -0
- data/lib/ejabberd_http_client/models/get_vcard_request.rb +235 -0
- data/lib/ejabberd_http_client/models/import_dir200_response.rb +214 -0
- data/lib/ejabberd_http_client/models/import_dir_request.rb +215 -0
- data/lib/ejabberd_http_client/models/import_file_request.rb +215 -0
- data/lib/ejabberd_http_client/models/import_piefxis_request.rb +215 -0
- data/lib/ejabberd_http_client/models/import_prosody_request.rb +215 -0
- data/lib/ejabberd_http_client/models/incoming_s2s_number200_response.rb +214 -0
- data/lib/ejabberd_http_client/models/install_fallback_request.rb +215 -0
- data/lib/ejabberd_http_client/models/issue_o_auth_token200_response.rb +232 -0
- data/lib/ejabberd_http_client/models/issue_o_auth_token_request.rb +235 -0
- data/lib/ejabberd_http_client/models/join_cluster_request.rb +215 -0
- data/lib/ejabberd_http_client/models/kick_session_request.rb +245 -0
- data/lib/ejabberd_http_client/models/kick_user200_response.rb +215 -0
- data/lib/ejabberd_http_client/models/leave_cluster_request.rb +215 -0
- data/lib/ejabberd_http_client/models/list_certificates200_response_inner.rb +235 -0
- data/lib/ejabberd_http_client/models/list_muc_online_rooms_by_regex200_response_inner.rb +232 -0
- data/lib/ejabberd_http_client/models/list_muc_online_rooms_by_regex_request.rb +225 -0
- data/lib/ejabberd_http_client/models/list_muc_online_rooms_request.rb +215 -0
- data/lib/ejabberd_http_client/models/list_o_auth_tokens200_response_inner.rb +241 -0
- data/lib/ejabberd_http_client/models/load_database_request.rb +215 -0
- data/lib/ejabberd_http_client/models/privacy_set_request.rb +232 -0
- data/lib/ejabberd_http_client/models/private_get_request.rb +241 -0
- data/lib/ejabberd_http_client/models/private_set_request.rb +232 -0
- data/lib/ejabberd_http_client/models/process_roster_items200_response_inner.rb +223 -0
- data/lib/ejabberd_http_client/models/process_roster_items_request.rb +250 -0
- data/lib/ejabberd_http_client/models/push_all_to_all_request.rb +223 -0
- data/lib/ejabberd_http_client/models/push_roster_all_request.rb +214 -0
- data/lib/ejabberd_http_client/models/push_roster_request.rb +232 -0
- data/lib/ejabberd_http_client/models/register_muc_nick_request.rb +235 -0
- data/lib/ejabberd_http_client/models/register_request.rb +232 -0
- data/lib/ejabberd_http_client/models/registered_users_request.rb +214 -0
- data/lib/ejabberd_http_client/models/remove_mam_for_user_with_peer_request.rb +232 -0
- data/lib/ejabberd_http_client/models/remove_o_auth_client_request.rb +215 -0
- data/lib/ejabberd_http_client/models/request_certificate_request.rb +215 -0
- data/lib/ejabberd_http_client/models/resource_num200_response.rb +214 -0
- data/lib/ejabberd_http_client/models/resource_num_request.rb +235 -0
- data/lib/ejabberd_http_client/models/restart_module200_response.rb +214 -0
- data/lib/ejabberd_http_client/models/restart_module_request.rb +225 -0
- data/lib/ejabberd_http_client/models/restore_request.rb +215 -0
- data/lib/ejabberd_http_client/models/revoke_certificate_request.rb +215 -0
- data/lib/ejabberd_http_client/models/revoke_o_auth_token_request.rb +215 -0
- data/lib/ejabberd_http_client/models/rooms_empty_destroy_request.rb +215 -0
- data/lib/ejabberd_http_client/models/rooms_unused_destroy_request.rb +225 -0
- data/lib/ejabberd_http_client/models/send_direct_invitation_request.rb +255 -0
- data/lib/ejabberd_http_client/models/send_message_request.rb +255 -0
- data/lib/ejabberd_http_client/models/send_stanza_c2_s_request.rb +245 -0
- data/lib/ejabberd_http_client/models/send_stanza_request.rb +235 -0
- data/lib/ejabberd_http_client/models/set_last_request.rb +245 -0
- data/lib/ejabberd_http_client/models/set_loglevel_request.rb +215 -0
- data/lib/ejabberd_http_client/models/set_master_request.rb +215 -0
- data/lib/ejabberd_http_client/models/set_nickname_request.rb +235 -0
- data/lib/ejabberd_http_client/models/set_presence_request.rb +275 -0
- data/lib/ejabberd_http_client/models/set_room_affiliation_request.rb +245 -0
- data/lib/ejabberd_http_client/models/set_vcard2_multi_request.rb +257 -0
- data/lib/ejabberd_http_client/models/set_vcard2_request.rb +255 -0
- data/lib/ejabberd_http_client/models/set_vcard_request.rb +245 -0
- data/lib/ejabberd_http_client/models/srg_create_request.rb +255 -0
- data/lib/ejabberd_http_client/models/srg_delete_request.rb +225 -0
- data/lib/ejabberd_http_client/models/srg_get_info200_response_inner.rb +225 -0
- data/lib/ejabberd_http_client/models/srg_user_add_request.rb +245 -0
- data/lib/ejabberd_http_client/models/stop_kindly_request.rb +225 -0
- data/lib/ejabberd_http_client/models/subscribe_to_room_many_request.rb +236 -0
- data/lib/ejabberd_http_client/models/subscribe_to_room_many_request_users_inner.rb +225 -0
- data/lib/ejabberd_http_client/models/subscribe_to_room_request.rb +245 -0
- data/lib/ejabberd_http_client/models/table_mnesia_info_request.rb +215 -0
- data/lib/ejabberd_http_client/models/unban_ip200_response.rb +215 -0
- data/lib/ejabberd_http_client/models/unban_ip_request.rb +215 -0
- data/lib/ejabberd_http_client/models/unregister_muc_nick_request.rb +225 -0
- data/lib/ejabberd_http_client/models/unregister_user_request.rb +225 -0
- data/lib/ejabberd_http_client/models/unsubscribe_from_room_request.rb +225 -0
- data/lib/ejabberd_http_client/version.rb +15 -0
- data/lib/ejabberd_http_client.rb +207 -0
- data/spec/api/accounts_api_spec.rb +145 -0
- data/spec/api/acme_api_spec.rb +67 -0
- data/spec/api/cluster_api_spec.rb +78 -0
- data/spec/api/config_api_spec.rb +67 -0
- data/spec/api/documentation_api_spec.rb +78 -0
- data/spec/api/erlang_api_spec.rb +67 -0
- data/spec/api/last_api_spec.rb +57 -0
- data/spec/api/logs_api_spec.rb +76 -0
- data/spec/api/mam_api_spec.rb +57 -0
- data/spec/api/mnesia_api_spec.rb +221 -0
- data/spec/api/modules_api_spec.rb +109 -0
- data/spec/api/muc_api_spec.rb +156 -0
- data/spec/api/muc_room_api_spec.rb +200 -0
- data/spec/api/oauth_api_spec.rb +100 -0
- data/spec/api/offline_api_spec.rb +46 -0
- data/spec/api/private_api_spec.rb +68 -0
- data/spec/api/purge_api_spec.rb +176 -0
- data/spec/api/roster_api_spec.rb +101 -0
- data/spec/api/s2s_api_spec.rb +65 -0
- data/spec/api/server_api_spec.rb +137 -0
- data/spec/api/session_api_spec.rb +208 -0
- data/spec/api/shared_roster_group_api_spec.rb +112 -0
- data/spec/api/sql_api_spec.rb +67 -0
- data/spec/api/stanza_api_spec.rb +79 -0
- data/spec/api/statistics_api_spec.rb +109 -0
- data/spec/api/vcard_api_spec.rb +112 -0
- data/spec/api_client_spec.rb +228 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/abort_delete_old_mam_messages200_response_spec.rb +34 -0
- data/spec/models/abort_delete_old_mam_messages_request_spec.rb +34 -0
- data/spec/models/add_o_auth_client_implicit_request_spec.rb +46 -0
- data/spec/models/add_o_auth_client_password_request_spec.rb +46 -0
- data/spec/models/add_roster_item_request_spec.rb +70 -0
- data/spec/models/backup_request_spec.rb +34 -0
- data/spec/models/ban_account_request_spec.rb +46 -0
- data/spec/models/bookmarks_to_pep_request_spec.rb +40 -0
- data/spec/models/change_node_name_request_spec.rb +52 -0
- data/spec/models/change_password_request_spec.rb +46 -0
- data/spec/models/change_room_option_request_spec.rb +52 -0
- data/spec/models/check_account_request_spec.rb +40 -0
- data/spec/models/check_module_request_spec.rb +34 -0
- data/spec/models/check_password_hash_request_spec.rb +52 -0
- data/spec/models/check_password_request_spec.rb +46 -0
- data/spec/models/compile_request_spec.rb +34 -0
- data/spec/models/connected_users_info200_response_inner_spec.rb +88 -0
- data/spec/models/connected_users_number200_response_spec.rb +34 -0
- data/spec/models/connected_users_v_host_request_spec.rb +34 -0
- data/spec/models/convert_to_scram_request_spec.rb +34 -0
- data/spec/models/convert_to_yaml_request_spec.rb +40 -0
- data/spec/models/create_room_request_spec.rb +46 -0
- data/spec/models/create_room_with_options_request_options_inner_spec.rb +40 -0
- data/spec/models/create_room_with_options_request_spec.rb +52 -0
- data/spec/models/create_rooms_file_request_spec.rb +34 -0
- data/spec/models/delete_mnesia_request_spec.rb +34 -0
- data/spec/models/delete_old_mam_messages_batch_request_spec.rb +58 -0
- data/spec/models/delete_old_mam_messages_request_spec.rb +40 -0
- data/spec/models/delete_old_mam_messages_status_request_spec.rb +34 -0
- data/spec/models/delete_old_messages_batch_request_spec.rb +52 -0
- data/spec/models/delete_old_messages_request_spec.rb +34 -0
- data/spec/models/delete_old_pubsub_items_request_spec.rb +34 -0
- data/spec/models/delete_old_users_request_spec.rb +34 -0
- data/spec/models/dump_config_request_spec.rb +34 -0
- data/spec/models/dump_request_spec.rb +34 -0
- data/spec/models/dump_table_request_spec.rb +40 -0
- data/spec/models/export2sql_request_spec.rb +40 -0
- data/spec/models/export_piefxis_host_request_spec.rb +40 -0
- data/spec/models/export_piefxis_request_spec.rb +34 -0
- data/spec/models/gen_html_doc_for_commands_request_spec.rb +46 -0
- data/spec/models/gen_markdown_doc_for_tags_request_spec.rb +34 -0
- data/spec/models/get_cookie200_response_spec.rb +34 -0
- data/spec/models/get_last200_response_spec.rb +40 -0
- data/spec/models/get_last_request_spec.rb +40 -0
- data/spec/models/get_loglevel200_response_spec.rb +34 -0
- data/spec/models/get_num_resources200_response_spec.rb +34 -0
- data/spec/models/get_offline_count200_response_spec.rb +34 -0
- data/spec/models/get_offline_count_request_spec.rb +40 -0
- data/spec/models/get_outgoing_s2s_number200_response_spec.rb +34 -0
- data/spec/models/get_presence200_response_spec.rb +46 -0
- data/spec/models/get_room_affiliation200_response_spec.rb +34 -0
- data/spec/models/get_room_affiliation_request_spec.rb +46 -0
- data/spec/models/get_room_affiliations200_response_inner_spec.rb +52 -0
- data/spec/models/get_room_affiliations_request_spec.rb +40 -0
- data/spec/models/get_room_history200_response_inner_spec.rb +40 -0
- data/spec/models/get_room_occupants200_response_inner_spec.rb +46 -0
- data/spec/models/get_room_occupants_number200_response_spec.rb +34 -0
- data/spec/models/get_room_options200_response_inner_spec.rb +40 -0
- data/spec/models/get_roster200_response_inner_spec.rb +58 -0
- data/spec/models/get_stats200_response_spec.rb +34 -0
- data/spec/models/get_stats_host_request_spec.rb +40 -0
- data/spec/models/get_stats_request_spec.rb +34 -0
- data/spec/models/get_status_list200_response_inner_spec.rb +58 -0
- data/spec/models/get_status_list_host_request_spec.rb +40 -0
- data/spec/models/get_status_list_request_spec.rb +34 -0
- data/spec/models/get_status_num200_response_spec.rb +34 -0
- data/spec/models/get_user_rooms_request_spec.rb +40 -0
- data/spec/models/get_user_sessions_info200_response_inner_spec.rb +82 -0
- data/spec/models/get_user_subscriptions200_response_inner_spec.rb +46 -0
- data/spec/models/get_vcard200_response_spec.rb +34 -0
- data/spec/models/get_vcard2_multi_request_spec.rb +52 -0
- data/spec/models/get_vcard2_request_spec.rb +52 -0
- data/spec/models/get_vcard_request_spec.rb +46 -0
- data/spec/models/import_dir200_response_spec.rb +34 -0
- data/spec/models/import_dir_request_spec.rb +34 -0
- data/spec/models/import_file_request_spec.rb +34 -0
- data/spec/models/import_piefxis_request_spec.rb +34 -0
- data/spec/models/import_prosody_request_spec.rb +34 -0
- data/spec/models/incoming_s2s_number200_response_spec.rb +34 -0
- data/spec/models/install_fallback_request_spec.rb +34 -0
- data/spec/models/issue_o_auth_token200_response_spec.rb +46 -0
- data/spec/models/issue_o_auth_token_request_spec.rb +46 -0
- data/spec/models/join_cluster_request_spec.rb +34 -0
- data/spec/models/kick_session_request_spec.rb +52 -0
- data/spec/models/kick_user200_response_spec.rb +34 -0
- data/spec/models/leave_cluster_request_spec.rb +34 -0
- data/spec/models/list_certificates200_response_inner_spec.rb +46 -0
- data/spec/models/list_muc_online_rooms_by_regex200_response_inner_spec.rb +46 -0
- data/spec/models/list_muc_online_rooms_by_regex_request_spec.rb +40 -0
- data/spec/models/list_muc_online_rooms_request_spec.rb +34 -0
- data/spec/models/list_o_auth_tokens200_response_inner_spec.rb +52 -0
- data/spec/models/load_database_request_spec.rb +34 -0
- data/spec/models/privacy_set_request_spec.rb +46 -0
- data/spec/models/private_get_request_spec.rb +52 -0
- data/spec/models/private_set_request_spec.rb +46 -0
- data/spec/models/process_roster_items200_response_inner_spec.rb +40 -0
- data/spec/models/process_roster_items_request_spec.rb +58 -0
- data/spec/models/push_all_to_all_request_spec.rb +40 -0
- data/spec/models/push_roster_all_request_spec.rb +34 -0
- data/spec/models/push_roster_request_spec.rb +46 -0
- data/spec/models/register_muc_nick_request_spec.rb +46 -0
- data/spec/models/register_request_spec.rb +46 -0
- data/spec/models/registered_users_request_spec.rb +34 -0
- data/spec/models/remove_mam_for_user_with_peer_request_spec.rb +46 -0
- data/spec/models/remove_o_auth_client_request_spec.rb +34 -0
- data/spec/models/request_certificate_request_spec.rb +34 -0
- data/spec/models/resource_num200_response_spec.rb +34 -0
- data/spec/models/resource_num_request_spec.rb +46 -0
- data/spec/models/restart_module200_response_spec.rb +34 -0
- data/spec/models/restart_module_request_spec.rb +40 -0
- data/spec/models/restore_request_spec.rb +34 -0
- data/spec/models/revoke_certificate_request_spec.rb +34 -0
- data/spec/models/revoke_o_auth_token_request_spec.rb +34 -0
- data/spec/models/rooms_empty_destroy_request_spec.rb +34 -0
- data/spec/models/rooms_unused_destroy_request_spec.rb +40 -0
- data/spec/models/send_direct_invitation_request_spec.rb +58 -0
- data/spec/models/send_message_request_spec.rb +58 -0
- data/spec/models/send_stanza_c2_s_request_spec.rb +52 -0
- data/spec/models/send_stanza_request_spec.rb +46 -0
- data/spec/models/set_last_request_spec.rb +52 -0
- data/spec/models/set_loglevel_request_spec.rb +34 -0
- data/spec/models/set_master_request_spec.rb +34 -0
- data/spec/models/set_nickname_request_spec.rb +46 -0
- data/spec/models/set_presence_request_spec.rb +70 -0
- data/spec/models/set_room_affiliation_request_spec.rb +52 -0
- data/spec/models/set_vcard2_multi_request_spec.rb +58 -0
- data/spec/models/set_vcard2_request_spec.rb +58 -0
- data/spec/models/set_vcard_request_spec.rb +52 -0
- data/spec/models/srg_create_request_spec.rb +58 -0
- data/spec/models/srg_delete_request_spec.rb +40 -0
- data/spec/models/srg_get_info200_response_inner_spec.rb +40 -0
- data/spec/models/srg_user_add_request_spec.rb +52 -0
- data/spec/models/stop_kindly_request_spec.rb +40 -0
- data/spec/models/subscribe_to_room_many_request_spec.rb +46 -0
- data/spec/models/subscribe_to_room_many_request_users_inner_spec.rb +40 -0
- data/spec/models/subscribe_to_room_request_spec.rb +52 -0
- data/spec/models/table_mnesia_info_request_spec.rb +34 -0
- data/spec/models/unban_ip200_response_spec.rb +34 -0
- data/spec/models/unban_ip_request_spec.rb +34 -0
- data/spec/models/unregister_muc_nick_request_spec.rb +40 -0
- data/spec/models/unregister_user_request_spec.rb +40 -0
- data/spec/models/unsubscribe_from_room_request_spec.rb +40 -0
- data/spec/spec_helper.rb +114 -0
- metadata +772 -0
data/docs/PurgeApi.md
ADDED
|
@@ -0,0 +1,815 @@
|
|
|
1
|
+
# EjabberdHttpClient::PurgeApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**abort_delete_old_mam_messages**](PurgeApi.md#abort_delete_old_mam_messages) | **POST** /api/abort_delete_old_mam_messages | Abort currently running delete old MAM messages operation. |
|
|
8
|
+
| [**abort_delete_old_messages**](PurgeApi.md#abort_delete_old_messages) | **POST** /api/abort_delete_old_messages | Abort currently running delete old offline messages operation. |
|
|
9
|
+
| [**delete_expired_messages**](PurgeApi.md#delete_expired_messages) | **POST** /api/delete_expired_messages | Delete expired offline messages from database. |
|
|
10
|
+
| [**delete_expired_pubsub_items**](PurgeApi.md#delete_expired_pubsub_items) | **POST** /api/delete_expired_pubsub_items | Delete expired PubSub items. |
|
|
11
|
+
| [**delete_old_mam_messages**](PurgeApi.md#delete_old_mam_messages) | **POST** /api/delete_old_mam_messages | Delete MAM messages older than DAYS. |
|
|
12
|
+
| [**delete_old_mam_messages_batch**](PurgeApi.md#delete_old_mam_messages_batch) | **POST** /api/delete_old_mam_messages_batch | Delete MAM messages older than DAYS in batches. |
|
|
13
|
+
| [**delete_old_mam_messages_status**](PurgeApi.md#delete_old_mam_messages_status) | **POST** /api/delete_old_mam_messages_status | Status of delete old MAM messages operation. |
|
|
14
|
+
| [**delete_old_messages**](PurgeApi.md#delete_old_messages) | **POST** /api/delete_old_messages | Delete offline messages older than DAYS. |
|
|
15
|
+
| [**delete_old_messages_batch**](PurgeApi.md#delete_old_messages_batch) | **POST** /api/delete_old_messages_batch | Delete offline messages older than DAYS. |
|
|
16
|
+
| [**delete_old_messages_status**](PurgeApi.md#delete_old_messages_status) | **POST** /api/delete_old_messages_status | Status of delete old offline messages operation. |
|
|
17
|
+
| [**delete_old_pubsub_items**](PurgeApi.md#delete_old_pubsub_items) | **POST** /api/delete_old_pubsub_items | Keep only NUMBER of PubSub items per node. |
|
|
18
|
+
| [**delete_old_push_sessions**](PurgeApi.md#delete_old_push_sessions) | **POST** /api/delete_old_push_sessions | Remove push sessions older than DAYS. |
|
|
19
|
+
| [**delete_old_users**](PurgeApi.md#delete_old_users) | **POST** /api/delete_old_users | Delete users that didn't log in last days, or that never logged. |
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
## abort_delete_old_mam_messages
|
|
23
|
+
|
|
24
|
+
> <AbortDeleteOldMamMessages200Response> abort_delete_old_mam_messages(abort_delete_old_mam_messages_request)
|
|
25
|
+
|
|
26
|
+
Abort currently running delete old MAM messages operation.
|
|
27
|
+
|
|
28
|
+
### Examples
|
|
29
|
+
|
|
30
|
+
```ruby
|
|
31
|
+
require 'time'
|
|
32
|
+
require 'ejabberd_http_client'
|
|
33
|
+
|
|
34
|
+
api_instance = EjabberdHttpClient::PurgeApi.new
|
|
35
|
+
abort_delete_old_mam_messages_request = EjabberdHttpClient::AbortDeleteOldMamMessagesRequest.new # AbortDeleteOldMamMessagesRequest |
|
|
36
|
+
|
|
37
|
+
begin
|
|
38
|
+
# Abort currently running delete old MAM messages operation.
|
|
39
|
+
result = api_instance.abort_delete_old_mam_messages(abort_delete_old_mam_messages_request)
|
|
40
|
+
p result
|
|
41
|
+
rescue EjabberdHttpClient::ApiError => e
|
|
42
|
+
puts "Error when calling PurgeApi->abort_delete_old_mam_messages: #{e}"
|
|
43
|
+
end
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
#### Using the abort_delete_old_mam_messages_with_http_info variant
|
|
47
|
+
|
|
48
|
+
This returns an Array which contains the response data, status code and headers.
|
|
49
|
+
|
|
50
|
+
> <Array(<AbortDeleteOldMamMessages200Response>, Integer, Hash)> abort_delete_old_mam_messages_with_http_info(abort_delete_old_mam_messages_request)
|
|
51
|
+
|
|
52
|
+
```ruby
|
|
53
|
+
begin
|
|
54
|
+
# Abort currently running delete old MAM messages operation.
|
|
55
|
+
data, status_code, headers = api_instance.abort_delete_old_mam_messages_with_http_info(abort_delete_old_mam_messages_request)
|
|
56
|
+
p status_code # => 2xx
|
|
57
|
+
p headers # => { ... }
|
|
58
|
+
p data # => <AbortDeleteOldMamMessages200Response>
|
|
59
|
+
rescue EjabberdHttpClient::ApiError => e
|
|
60
|
+
puts "Error when calling PurgeApi->abort_delete_old_mam_messages_with_http_info: #{e}"
|
|
61
|
+
end
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### Parameters
|
|
65
|
+
|
|
66
|
+
| Name | Type | Description | Notes |
|
|
67
|
+
| ---- | ---- | ----------- | ----- |
|
|
68
|
+
| **abort_delete_old_mam_messages_request** | [**AbortDeleteOldMamMessagesRequest**](AbortDeleteOldMamMessagesRequest.md) | | |
|
|
69
|
+
|
|
70
|
+
### Return type
|
|
71
|
+
|
|
72
|
+
[**AbortDeleteOldMamMessages200Response**](AbortDeleteOldMamMessages200Response.md)
|
|
73
|
+
|
|
74
|
+
### Authorization
|
|
75
|
+
|
|
76
|
+
No authorization required
|
|
77
|
+
|
|
78
|
+
### HTTP request headers
|
|
79
|
+
|
|
80
|
+
- **Content-Type**: application/json
|
|
81
|
+
- **Accept**: application/json
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
## abort_delete_old_messages
|
|
85
|
+
|
|
86
|
+
> <AbortDeleteOldMamMessages200Response> abort_delete_old_messages(abort_delete_old_mam_messages_request)
|
|
87
|
+
|
|
88
|
+
Abort currently running delete old offline messages operation.
|
|
89
|
+
|
|
90
|
+
### Examples
|
|
91
|
+
|
|
92
|
+
```ruby
|
|
93
|
+
require 'time'
|
|
94
|
+
require 'ejabberd_http_client'
|
|
95
|
+
|
|
96
|
+
api_instance = EjabberdHttpClient::PurgeApi.new
|
|
97
|
+
abort_delete_old_mam_messages_request = EjabberdHttpClient::AbortDeleteOldMamMessagesRequest.new # AbortDeleteOldMamMessagesRequest |
|
|
98
|
+
|
|
99
|
+
begin
|
|
100
|
+
# Abort currently running delete old offline messages operation.
|
|
101
|
+
result = api_instance.abort_delete_old_messages(abort_delete_old_mam_messages_request)
|
|
102
|
+
p result
|
|
103
|
+
rescue EjabberdHttpClient::ApiError => e
|
|
104
|
+
puts "Error when calling PurgeApi->abort_delete_old_messages: #{e}"
|
|
105
|
+
end
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
#### Using the abort_delete_old_messages_with_http_info variant
|
|
109
|
+
|
|
110
|
+
This returns an Array which contains the response data, status code and headers.
|
|
111
|
+
|
|
112
|
+
> <Array(<AbortDeleteOldMamMessages200Response>, Integer, Hash)> abort_delete_old_messages_with_http_info(abort_delete_old_mam_messages_request)
|
|
113
|
+
|
|
114
|
+
```ruby
|
|
115
|
+
begin
|
|
116
|
+
# Abort currently running delete old offline messages operation.
|
|
117
|
+
data, status_code, headers = api_instance.abort_delete_old_messages_with_http_info(abort_delete_old_mam_messages_request)
|
|
118
|
+
p status_code # => 2xx
|
|
119
|
+
p headers # => { ... }
|
|
120
|
+
p data # => <AbortDeleteOldMamMessages200Response>
|
|
121
|
+
rescue EjabberdHttpClient::ApiError => e
|
|
122
|
+
puts "Error when calling PurgeApi->abort_delete_old_messages_with_http_info: #{e}"
|
|
123
|
+
end
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
### Parameters
|
|
127
|
+
|
|
128
|
+
| Name | Type | Description | Notes |
|
|
129
|
+
| ---- | ---- | ----------- | ----- |
|
|
130
|
+
| **abort_delete_old_mam_messages_request** | [**AbortDeleteOldMamMessagesRequest**](AbortDeleteOldMamMessagesRequest.md) | | |
|
|
131
|
+
|
|
132
|
+
### Return type
|
|
133
|
+
|
|
134
|
+
[**AbortDeleteOldMamMessages200Response**](AbortDeleteOldMamMessages200Response.md)
|
|
135
|
+
|
|
136
|
+
### Authorization
|
|
137
|
+
|
|
138
|
+
No authorization required
|
|
139
|
+
|
|
140
|
+
### HTTP request headers
|
|
141
|
+
|
|
142
|
+
- **Content-Type**: application/json
|
|
143
|
+
- **Accept**: application/json
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
## delete_expired_messages
|
|
147
|
+
|
|
148
|
+
> delete_expired_messages
|
|
149
|
+
|
|
150
|
+
Delete expired offline messages from database.
|
|
151
|
+
|
|
152
|
+
### Examples
|
|
153
|
+
|
|
154
|
+
```ruby
|
|
155
|
+
require 'time'
|
|
156
|
+
require 'ejabberd_http_client'
|
|
157
|
+
|
|
158
|
+
api_instance = EjabberdHttpClient::PurgeApi.new
|
|
159
|
+
|
|
160
|
+
begin
|
|
161
|
+
# Delete expired offline messages from database.
|
|
162
|
+
api_instance.delete_expired_messages
|
|
163
|
+
rescue EjabberdHttpClient::ApiError => e
|
|
164
|
+
puts "Error when calling PurgeApi->delete_expired_messages: #{e}"
|
|
165
|
+
end
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
#### Using the delete_expired_messages_with_http_info variant
|
|
169
|
+
|
|
170
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
171
|
+
|
|
172
|
+
> <Array(nil, Integer, Hash)> delete_expired_messages_with_http_info
|
|
173
|
+
|
|
174
|
+
```ruby
|
|
175
|
+
begin
|
|
176
|
+
# Delete expired offline messages from database.
|
|
177
|
+
data, status_code, headers = api_instance.delete_expired_messages_with_http_info
|
|
178
|
+
p status_code # => 2xx
|
|
179
|
+
p headers # => { ... }
|
|
180
|
+
p data # => nil
|
|
181
|
+
rescue EjabberdHttpClient::ApiError => e
|
|
182
|
+
puts "Error when calling PurgeApi->delete_expired_messages_with_http_info: #{e}"
|
|
183
|
+
end
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
### Parameters
|
|
187
|
+
|
|
188
|
+
This endpoint does not need any parameter.
|
|
189
|
+
|
|
190
|
+
### Return type
|
|
191
|
+
|
|
192
|
+
nil (empty response body)
|
|
193
|
+
|
|
194
|
+
### Authorization
|
|
195
|
+
|
|
196
|
+
No authorization required
|
|
197
|
+
|
|
198
|
+
### HTTP request headers
|
|
199
|
+
|
|
200
|
+
- **Content-Type**: Not defined
|
|
201
|
+
- **Accept**: Not defined
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
## delete_expired_pubsub_items
|
|
205
|
+
|
|
206
|
+
> delete_expired_pubsub_items
|
|
207
|
+
|
|
208
|
+
Delete expired PubSub items.
|
|
209
|
+
|
|
210
|
+
### Examples
|
|
211
|
+
|
|
212
|
+
```ruby
|
|
213
|
+
require 'time'
|
|
214
|
+
require 'ejabberd_http_client'
|
|
215
|
+
|
|
216
|
+
api_instance = EjabberdHttpClient::PurgeApi.new
|
|
217
|
+
|
|
218
|
+
begin
|
|
219
|
+
# Delete expired PubSub items.
|
|
220
|
+
api_instance.delete_expired_pubsub_items
|
|
221
|
+
rescue EjabberdHttpClient::ApiError => e
|
|
222
|
+
puts "Error when calling PurgeApi->delete_expired_pubsub_items: #{e}"
|
|
223
|
+
end
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
#### Using the delete_expired_pubsub_items_with_http_info variant
|
|
227
|
+
|
|
228
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
229
|
+
|
|
230
|
+
> <Array(nil, Integer, Hash)> delete_expired_pubsub_items_with_http_info
|
|
231
|
+
|
|
232
|
+
```ruby
|
|
233
|
+
begin
|
|
234
|
+
# Delete expired PubSub items.
|
|
235
|
+
data, status_code, headers = api_instance.delete_expired_pubsub_items_with_http_info
|
|
236
|
+
p status_code # => 2xx
|
|
237
|
+
p headers # => { ... }
|
|
238
|
+
p data # => nil
|
|
239
|
+
rescue EjabberdHttpClient::ApiError => e
|
|
240
|
+
puts "Error when calling PurgeApi->delete_expired_pubsub_items_with_http_info: #{e}"
|
|
241
|
+
end
|
|
242
|
+
```
|
|
243
|
+
|
|
244
|
+
### Parameters
|
|
245
|
+
|
|
246
|
+
This endpoint does not need any parameter.
|
|
247
|
+
|
|
248
|
+
### Return type
|
|
249
|
+
|
|
250
|
+
nil (empty response body)
|
|
251
|
+
|
|
252
|
+
### Authorization
|
|
253
|
+
|
|
254
|
+
No authorization required
|
|
255
|
+
|
|
256
|
+
### HTTP request headers
|
|
257
|
+
|
|
258
|
+
- **Content-Type**: Not defined
|
|
259
|
+
- **Accept**: Not defined
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
## delete_old_mam_messages
|
|
263
|
+
|
|
264
|
+
> delete_old_mam_messages(delete_old_mam_messages_request)
|
|
265
|
+
|
|
266
|
+
Delete MAM messages older than DAYS.
|
|
267
|
+
|
|
268
|
+
### Examples
|
|
269
|
+
|
|
270
|
+
```ruby
|
|
271
|
+
require 'time'
|
|
272
|
+
require 'ejabberd_http_client'
|
|
273
|
+
|
|
274
|
+
api_instance = EjabberdHttpClient::PurgeApi.new
|
|
275
|
+
delete_old_mam_messages_request = EjabberdHttpClient::DeleteOldMAMMessagesRequest.new # DeleteOldMAMMessagesRequest |
|
|
276
|
+
|
|
277
|
+
begin
|
|
278
|
+
# Delete MAM messages older than DAYS.
|
|
279
|
+
api_instance.delete_old_mam_messages(delete_old_mam_messages_request)
|
|
280
|
+
rescue EjabberdHttpClient::ApiError => e
|
|
281
|
+
puts "Error when calling PurgeApi->delete_old_mam_messages: #{e}"
|
|
282
|
+
end
|
|
283
|
+
```
|
|
284
|
+
|
|
285
|
+
#### Using the delete_old_mam_messages_with_http_info variant
|
|
286
|
+
|
|
287
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
288
|
+
|
|
289
|
+
> <Array(nil, Integer, Hash)> delete_old_mam_messages_with_http_info(delete_old_mam_messages_request)
|
|
290
|
+
|
|
291
|
+
```ruby
|
|
292
|
+
begin
|
|
293
|
+
# Delete MAM messages older than DAYS.
|
|
294
|
+
data, status_code, headers = api_instance.delete_old_mam_messages_with_http_info(delete_old_mam_messages_request)
|
|
295
|
+
p status_code # => 2xx
|
|
296
|
+
p headers # => { ... }
|
|
297
|
+
p data # => nil
|
|
298
|
+
rescue EjabberdHttpClient::ApiError => e
|
|
299
|
+
puts "Error when calling PurgeApi->delete_old_mam_messages_with_http_info: #{e}"
|
|
300
|
+
end
|
|
301
|
+
```
|
|
302
|
+
|
|
303
|
+
### Parameters
|
|
304
|
+
|
|
305
|
+
| Name | Type | Description | Notes |
|
|
306
|
+
| ---- | ---- | ----------- | ----- |
|
|
307
|
+
| **delete_old_mam_messages_request** | [**DeleteOldMAMMessagesRequest**](DeleteOldMAMMessagesRequest.md) | | |
|
|
308
|
+
|
|
309
|
+
### Return type
|
|
310
|
+
|
|
311
|
+
nil (empty response body)
|
|
312
|
+
|
|
313
|
+
### Authorization
|
|
314
|
+
|
|
315
|
+
No authorization required
|
|
316
|
+
|
|
317
|
+
### HTTP request headers
|
|
318
|
+
|
|
319
|
+
- **Content-Type**: application/json
|
|
320
|
+
- **Accept**: Not defined
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
## delete_old_mam_messages_batch
|
|
324
|
+
|
|
325
|
+
> delete_old_mam_messages_batch(delete_old_mam_messages_batch_request)
|
|
326
|
+
|
|
327
|
+
Delete MAM messages older than DAYS in batches.
|
|
328
|
+
|
|
329
|
+
### Examples
|
|
330
|
+
|
|
331
|
+
```ruby
|
|
332
|
+
require 'time'
|
|
333
|
+
require 'ejabberd_http_client'
|
|
334
|
+
|
|
335
|
+
api_instance = EjabberdHttpClient::PurgeApi.new
|
|
336
|
+
delete_old_mam_messages_batch_request = EjabberdHttpClient::DeleteOldMAMMessagesBatchRequest.new # DeleteOldMAMMessagesBatchRequest |
|
|
337
|
+
|
|
338
|
+
begin
|
|
339
|
+
# Delete MAM messages older than DAYS in batches.
|
|
340
|
+
api_instance.delete_old_mam_messages_batch(delete_old_mam_messages_batch_request)
|
|
341
|
+
rescue EjabberdHttpClient::ApiError => e
|
|
342
|
+
puts "Error when calling PurgeApi->delete_old_mam_messages_batch: #{e}"
|
|
343
|
+
end
|
|
344
|
+
```
|
|
345
|
+
|
|
346
|
+
#### Using the delete_old_mam_messages_batch_with_http_info variant
|
|
347
|
+
|
|
348
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
349
|
+
|
|
350
|
+
> <Array(nil, Integer, Hash)> delete_old_mam_messages_batch_with_http_info(delete_old_mam_messages_batch_request)
|
|
351
|
+
|
|
352
|
+
```ruby
|
|
353
|
+
begin
|
|
354
|
+
# Delete MAM messages older than DAYS in batches.
|
|
355
|
+
data, status_code, headers = api_instance.delete_old_mam_messages_batch_with_http_info(delete_old_mam_messages_batch_request)
|
|
356
|
+
p status_code # => 2xx
|
|
357
|
+
p headers # => { ... }
|
|
358
|
+
p data # => nil
|
|
359
|
+
rescue EjabberdHttpClient::ApiError => e
|
|
360
|
+
puts "Error when calling PurgeApi->delete_old_mam_messages_batch_with_http_info: #{e}"
|
|
361
|
+
end
|
|
362
|
+
```
|
|
363
|
+
|
|
364
|
+
### Parameters
|
|
365
|
+
|
|
366
|
+
| Name | Type | Description | Notes |
|
|
367
|
+
| ---- | ---- | ----------- | ----- |
|
|
368
|
+
| **delete_old_mam_messages_batch_request** | [**DeleteOldMAMMessagesBatchRequest**](DeleteOldMAMMessagesBatchRequest.md) | | |
|
|
369
|
+
|
|
370
|
+
### Return type
|
|
371
|
+
|
|
372
|
+
nil (empty response body)
|
|
373
|
+
|
|
374
|
+
### Authorization
|
|
375
|
+
|
|
376
|
+
No authorization required
|
|
377
|
+
|
|
378
|
+
### HTTP request headers
|
|
379
|
+
|
|
380
|
+
- **Content-Type**: application/json
|
|
381
|
+
- **Accept**: Not defined
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
## delete_old_mam_messages_status
|
|
385
|
+
|
|
386
|
+
> <AbortDeleteOldMamMessages200Response> delete_old_mam_messages_status(delete_old_mam_messages_status_request)
|
|
387
|
+
|
|
388
|
+
Status of delete old MAM messages operation.
|
|
389
|
+
|
|
390
|
+
### Examples
|
|
391
|
+
|
|
392
|
+
```ruby
|
|
393
|
+
require 'time'
|
|
394
|
+
require 'ejabberd_http_client'
|
|
395
|
+
|
|
396
|
+
api_instance = EjabberdHttpClient::PurgeApi.new
|
|
397
|
+
delete_old_mam_messages_status_request = EjabberdHttpClient::DeleteOldMAMMessagesStatusRequest.new # DeleteOldMAMMessagesStatusRequest |
|
|
398
|
+
|
|
399
|
+
begin
|
|
400
|
+
# Status of delete old MAM messages operation.
|
|
401
|
+
result = api_instance.delete_old_mam_messages_status(delete_old_mam_messages_status_request)
|
|
402
|
+
p result
|
|
403
|
+
rescue EjabberdHttpClient::ApiError => e
|
|
404
|
+
puts "Error when calling PurgeApi->delete_old_mam_messages_status: #{e}"
|
|
405
|
+
end
|
|
406
|
+
```
|
|
407
|
+
|
|
408
|
+
#### Using the delete_old_mam_messages_status_with_http_info variant
|
|
409
|
+
|
|
410
|
+
This returns an Array which contains the response data, status code and headers.
|
|
411
|
+
|
|
412
|
+
> <Array(<AbortDeleteOldMamMessages200Response>, Integer, Hash)> delete_old_mam_messages_status_with_http_info(delete_old_mam_messages_status_request)
|
|
413
|
+
|
|
414
|
+
```ruby
|
|
415
|
+
begin
|
|
416
|
+
# Status of delete old MAM messages operation.
|
|
417
|
+
data, status_code, headers = api_instance.delete_old_mam_messages_status_with_http_info(delete_old_mam_messages_status_request)
|
|
418
|
+
p status_code # => 2xx
|
|
419
|
+
p headers # => { ... }
|
|
420
|
+
p data # => <AbortDeleteOldMamMessages200Response>
|
|
421
|
+
rescue EjabberdHttpClient::ApiError => e
|
|
422
|
+
puts "Error when calling PurgeApi->delete_old_mam_messages_status_with_http_info: #{e}"
|
|
423
|
+
end
|
|
424
|
+
```
|
|
425
|
+
|
|
426
|
+
### Parameters
|
|
427
|
+
|
|
428
|
+
| Name | Type | Description | Notes |
|
|
429
|
+
| ---- | ---- | ----------- | ----- |
|
|
430
|
+
| **delete_old_mam_messages_status_request** | [**DeleteOldMAMMessagesStatusRequest**](DeleteOldMAMMessagesStatusRequest.md) | | |
|
|
431
|
+
|
|
432
|
+
### Return type
|
|
433
|
+
|
|
434
|
+
[**AbortDeleteOldMamMessages200Response**](AbortDeleteOldMamMessages200Response.md)
|
|
435
|
+
|
|
436
|
+
### Authorization
|
|
437
|
+
|
|
438
|
+
No authorization required
|
|
439
|
+
|
|
440
|
+
### HTTP request headers
|
|
441
|
+
|
|
442
|
+
- **Content-Type**: application/json
|
|
443
|
+
- **Accept**: application/json
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
## delete_old_messages
|
|
447
|
+
|
|
448
|
+
> delete_old_messages(delete_old_messages_request)
|
|
449
|
+
|
|
450
|
+
Delete offline messages older than DAYS.
|
|
451
|
+
|
|
452
|
+
### Examples
|
|
453
|
+
|
|
454
|
+
```ruby
|
|
455
|
+
require 'time'
|
|
456
|
+
require 'ejabberd_http_client'
|
|
457
|
+
|
|
458
|
+
api_instance = EjabberdHttpClient::PurgeApi.new
|
|
459
|
+
delete_old_messages_request = EjabberdHttpClient::DeleteOldMessagesRequest.new # DeleteOldMessagesRequest |
|
|
460
|
+
|
|
461
|
+
begin
|
|
462
|
+
# Delete offline messages older than DAYS.
|
|
463
|
+
api_instance.delete_old_messages(delete_old_messages_request)
|
|
464
|
+
rescue EjabberdHttpClient::ApiError => e
|
|
465
|
+
puts "Error when calling PurgeApi->delete_old_messages: #{e}"
|
|
466
|
+
end
|
|
467
|
+
```
|
|
468
|
+
|
|
469
|
+
#### Using the delete_old_messages_with_http_info variant
|
|
470
|
+
|
|
471
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
472
|
+
|
|
473
|
+
> <Array(nil, Integer, Hash)> delete_old_messages_with_http_info(delete_old_messages_request)
|
|
474
|
+
|
|
475
|
+
```ruby
|
|
476
|
+
begin
|
|
477
|
+
# Delete offline messages older than DAYS.
|
|
478
|
+
data, status_code, headers = api_instance.delete_old_messages_with_http_info(delete_old_messages_request)
|
|
479
|
+
p status_code # => 2xx
|
|
480
|
+
p headers # => { ... }
|
|
481
|
+
p data # => nil
|
|
482
|
+
rescue EjabberdHttpClient::ApiError => e
|
|
483
|
+
puts "Error when calling PurgeApi->delete_old_messages_with_http_info: #{e}"
|
|
484
|
+
end
|
|
485
|
+
```
|
|
486
|
+
|
|
487
|
+
### Parameters
|
|
488
|
+
|
|
489
|
+
| Name | Type | Description | Notes |
|
|
490
|
+
| ---- | ---- | ----------- | ----- |
|
|
491
|
+
| **delete_old_messages_request** | [**DeleteOldMessagesRequest**](DeleteOldMessagesRequest.md) | | |
|
|
492
|
+
|
|
493
|
+
### Return type
|
|
494
|
+
|
|
495
|
+
nil (empty response body)
|
|
496
|
+
|
|
497
|
+
### Authorization
|
|
498
|
+
|
|
499
|
+
No authorization required
|
|
500
|
+
|
|
501
|
+
### HTTP request headers
|
|
502
|
+
|
|
503
|
+
- **Content-Type**: application/json
|
|
504
|
+
- **Accept**: Not defined
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
## delete_old_messages_batch
|
|
508
|
+
|
|
509
|
+
> String delete_old_messages_batch(delete_old_messages_batch_request)
|
|
510
|
+
|
|
511
|
+
Delete offline messages older than DAYS.
|
|
512
|
+
|
|
513
|
+
### Examples
|
|
514
|
+
|
|
515
|
+
```ruby
|
|
516
|
+
require 'time'
|
|
517
|
+
require 'ejabberd_http_client'
|
|
518
|
+
|
|
519
|
+
api_instance = EjabberdHttpClient::PurgeApi.new
|
|
520
|
+
delete_old_messages_batch_request = EjabberdHttpClient::DeleteOldMessagesBatchRequest.new # DeleteOldMessagesBatchRequest |
|
|
521
|
+
|
|
522
|
+
begin
|
|
523
|
+
# Delete offline messages older than DAYS.
|
|
524
|
+
result = api_instance.delete_old_messages_batch(delete_old_messages_batch_request)
|
|
525
|
+
p result
|
|
526
|
+
rescue EjabberdHttpClient::ApiError => e
|
|
527
|
+
puts "Error when calling PurgeApi->delete_old_messages_batch: #{e}"
|
|
528
|
+
end
|
|
529
|
+
```
|
|
530
|
+
|
|
531
|
+
#### Using the delete_old_messages_batch_with_http_info variant
|
|
532
|
+
|
|
533
|
+
This returns an Array which contains the response data, status code and headers.
|
|
534
|
+
|
|
535
|
+
> <Array(String, Integer, Hash)> delete_old_messages_batch_with_http_info(delete_old_messages_batch_request)
|
|
536
|
+
|
|
537
|
+
```ruby
|
|
538
|
+
begin
|
|
539
|
+
# Delete offline messages older than DAYS.
|
|
540
|
+
data, status_code, headers = api_instance.delete_old_messages_batch_with_http_info(delete_old_messages_batch_request)
|
|
541
|
+
p status_code # => 2xx
|
|
542
|
+
p headers # => { ... }
|
|
543
|
+
p data # => String
|
|
544
|
+
rescue EjabberdHttpClient::ApiError => e
|
|
545
|
+
puts "Error when calling PurgeApi->delete_old_messages_batch_with_http_info: #{e}"
|
|
546
|
+
end
|
|
547
|
+
```
|
|
548
|
+
|
|
549
|
+
### Parameters
|
|
550
|
+
|
|
551
|
+
| Name | Type | Description | Notes |
|
|
552
|
+
| ---- | ---- | ----------- | ----- |
|
|
553
|
+
| **delete_old_messages_batch_request** | [**DeleteOldMessagesBatchRequest**](DeleteOldMessagesBatchRequest.md) | | |
|
|
554
|
+
|
|
555
|
+
### Return type
|
|
556
|
+
|
|
557
|
+
**String**
|
|
558
|
+
|
|
559
|
+
### Authorization
|
|
560
|
+
|
|
561
|
+
No authorization required
|
|
562
|
+
|
|
563
|
+
### HTTP request headers
|
|
564
|
+
|
|
565
|
+
- **Content-Type**: application/json
|
|
566
|
+
- **Accept**: application/json
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
## delete_old_messages_status
|
|
570
|
+
|
|
571
|
+
> <AbortDeleteOldMamMessages200Response> delete_old_messages_status(delete_old_mam_messages_status_request)
|
|
572
|
+
|
|
573
|
+
Status of delete old offline messages operation.
|
|
574
|
+
|
|
575
|
+
### Examples
|
|
576
|
+
|
|
577
|
+
```ruby
|
|
578
|
+
require 'time'
|
|
579
|
+
require 'ejabberd_http_client'
|
|
580
|
+
|
|
581
|
+
api_instance = EjabberdHttpClient::PurgeApi.new
|
|
582
|
+
delete_old_mam_messages_status_request = EjabberdHttpClient::DeleteOldMAMMessagesStatusRequest.new # DeleteOldMAMMessagesStatusRequest |
|
|
583
|
+
|
|
584
|
+
begin
|
|
585
|
+
# Status of delete old offline messages operation.
|
|
586
|
+
result = api_instance.delete_old_messages_status(delete_old_mam_messages_status_request)
|
|
587
|
+
p result
|
|
588
|
+
rescue EjabberdHttpClient::ApiError => e
|
|
589
|
+
puts "Error when calling PurgeApi->delete_old_messages_status: #{e}"
|
|
590
|
+
end
|
|
591
|
+
```
|
|
592
|
+
|
|
593
|
+
#### Using the delete_old_messages_status_with_http_info variant
|
|
594
|
+
|
|
595
|
+
This returns an Array which contains the response data, status code and headers.
|
|
596
|
+
|
|
597
|
+
> <Array(<AbortDeleteOldMamMessages200Response>, Integer, Hash)> delete_old_messages_status_with_http_info(delete_old_mam_messages_status_request)
|
|
598
|
+
|
|
599
|
+
```ruby
|
|
600
|
+
begin
|
|
601
|
+
# Status of delete old offline messages operation.
|
|
602
|
+
data, status_code, headers = api_instance.delete_old_messages_status_with_http_info(delete_old_mam_messages_status_request)
|
|
603
|
+
p status_code # => 2xx
|
|
604
|
+
p headers # => { ... }
|
|
605
|
+
p data # => <AbortDeleteOldMamMessages200Response>
|
|
606
|
+
rescue EjabberdHttpClient::ApiError => e
|
|
607
|
+
puts "Error when calling PurgeApi->delete_old_messages_status_with_http_info: #{e}"
|
|
608
|
+
end
|
|
609
|
+
```
|
|
610
|
+
|
|
611
|
+
### Parameters
|
|
612
|
+
|
|
613
|
+
| Name | Type | Description | Notes |
|
|
614
|
+
| ---- | ---- | ----------- | ----- |
|
|
615
|
+
| **delete_old_mam_messages_status_request** | [**DeleteOldMAMMessagesStatusRequest**](DeleteOldMAMMessagesStatusRequest.md) | | |
|
|
616
|
+
|
|
617
|
+
### Return type
|
|
618
|
+
|
|
619
|
+
[**AbortDeleteOldMamMessages200Response**](AbortDeleteOldMamMessages200Response.md)
|
|
620
|
+
|
|
621
|
+
### Authorization
|
|
622
|
+
|
|
623
|
+
No authorization required
|
|
624
|
+
|
|
625
|
+
### HTTP request headers
|
|
626
|
+
|
|
627
|
+
- **Content-Type**: application/json
|
|
628
|
+
- **Accept**: application/json
|
|
629
|
+
|
|
630
|
+
|
|
631
|
+
## delete_old_pubsub_items
|
|
632
|
+
|
|
633
|
+
> Integer delete_old_pubsub_items(delete_old_pubsub_items_request)
|
|
634
|
+
|
|
635
|
+
Keep only NUMBER of PubSub items per node.
|
|
636
|
+
|
|
637
|
+
### Examples
|
|
638
|
+
|
|
639
|
+
```ruby
|
|
640
|
+
require 'time'
|
|
641
|
+
require 'ejabberd_http_client'
|
|
642
|
+
|
|
643
|
+
api_instance = EjabberdHttpClient::PurgeApi.new
|
|
644
|
+
delete_old_pubsub_items_request = EjabberdHttpClient::DeleteOldPubsubItemsRequest.new # DeleteOldPubsubItemsRequest |
|
|
645
|
+
|
|
646
|
+
begin
|
|
647
|
+
# Keep only NUMBER of PubSub items per node.
|
|
648
|
+
result = api_instance.delete_old_pubsub_items(delete_old_pubsub_items_request)
|
|
649
|
+
p result
|
|
650
|
+
rescue EjabberdHttpClient::ApiError => e
|
|
651
|
+
puts "Error when calling PurgeApi->delete_old_pubsub_items: #{e}"
|
|
652
|
+
end
|
|
653
|
+
```
|
|
654
|
+
|
|
655
|
+
#### Using the delete_old_pubsub_items_with_http_info variant
|
|
656
|
+
|
|
657
|
+
This returns an Array which contains the response data, status code and headers.
|
|
658
|
+
|
|
659
|
+
> <Array(Integer, Integer, Hash)> delete_old_pubsub_items_with_http_info(delete_old_pubsub_items_request)
|
|
660
|
+
|
|
661
|
+
```ruby
|
|
662
|
+
begin
|
|
663
|
+
# Keep only NUMBER of PubSub items per node.
|
|
664
|
+
data, status_code, headers = api_instance.delete_old_pubsub_items_with_http_info(delete_old_pubsub_items_request)
|
|
665
|
+
p status_code # => 2xx
|
|
666
|
+
p headers # => { ... }
|
|
667
|
+
p data # => Integer
|
|
668
|
+
rescue EjabberdHttpClient::ApiError => e
|
|
669
|
+
puts "Error when calling PurgeApi->delete_old_pubsub_items_with_http_info: #{e}"
|
|
670
|
+
end
|
|
671
|
+
```
|
|
672
|
+
|
|
673
|
+
### Parameters
|
|
674
|
+
|
|
675
|
+
| Name | Type | Description | Notes |
|
|
676
|
+
| ---- | ---- | ----------- | ----- |
|
|
677
|
+
| **delete_old_pubsub_items_request** | [**DeleteOldPubsubItemsRequest**](DeleteOldPubsubItemsRequest.md) | | |
|
|
678
|
+
|
|
679
|
+
### Return type
|
|
680
|
+
|
|
681
|
+
**Integer**
|
|
682
|
+
|
|
683
|
+
### Authorization
|
|
684
|
+
|
|
685
|
+
No authorization required
|
|
686
|
+
|
|
687
|
+
### HTTP request headers
|
|
688
|
+
|
|
689
|
+
- **Content-Type**: application/json
|
|
690
|
+
- **Accept**: application/json
|
|
691
|
+
|
|
692
|
+
|
|
693
|
+
## delete_old_push_sessions
|
|
694
|
+
|
|
695
|
+
> Integer delete_old_push_sessions(delete_old_messages_request)
|
|
696
|
+
|
|
697
|
+
Remove push sessions older than DAYS.
|
|
698
|
+
|
|
699
|
+
### Examples
|
|
700
|
+
|
|
701
|
+
```ruby
|
|
702
|
+
require 'time'
|
|
703
|
+
require 'ejabberd_http_client'
|
|
704
|
+
|
|
705
|
+
api_instance = EjabberdHttpClient::PurgeApi.new
|
|
706
|
+
delete_old_messages_request = EjabberdHttpClient::DeleteOldMessagesRequest.new # DeleteOldMessagesRequest |
|
|
707
|
+
|
|
708
|
+
begin
|
|
709
|
+
# Remove push sessions older than DAYS.
|
|
710
|
+
result = api_instance.delete_old_push_sessions(delete_old_messages_request)
|
|
711
|
+
p result
|
|
712
|
+
rescue EjabberdHttpClient::ApiError => e
|
|
713
|
+
puts "Error when calling PurgeApi->delete_old_push_sessions: #{e}"
|
|
714
|
+
end
|
|
715
|
+
```
|
|
716
|
+
|
|
717
|
+
#### Using the delete_old_push_sessions_with_http_info variant
|
|
718
|
+
|
|
719
|
+
This returns an Array which contains the response data, status code and headers.
|
|
720
|
+
|
|
721
|
+
> <Array(Integer, Integer, Hash)> delete_old_push_sessions_with_http_info(delete_old_messages_request)
|
|
722
|
+
|
|
723
|
+
```ruby
|
|
724
|
+
begin
|
|
725
|
+
# Remove push sessions older than DAYS.
|
|
726
|
+
data, status_code, headers = api_instance.delete_old_push_sessions_with_http_info(delete_old_messages_request)
|
|
727
|
+
p status_code # => 2xx
|
|
728
|
+
p headers # => { ... }
|
|
729
|
+
p data # => Integer
|
|
730
|
+
rescue EjabberdHttpClient::ApiError => e
|
|
731
|
+
puts "Error when calling PurgeApi->delete_old_push_sessions_with_http_info: #{e}"
|
|
732
|
+
end
|
|
733
|
+
```
|
|
734
|
+
|
|
735
|
+
### Parameters
|
|
736
|
+
|
|
737
|
+
| Name | Type | Description | Notes |
|
|
738
|
+
| ---- | ---- | ----------- | ----- |
|
|
739
|
+
| **delete_old_messages_request** | [**DeleteOldMessagesRequest**](DeleteOldMessagesRequest.md) | | |
|
|
740
|
+
|
|
741
|
+
### Return type
|
|
742
|
+
|
|
743
|
+
**Integer**
|
|
744
|
+
|
|
745
|
+
### Authorization
|
|
746
|
+
|
|
747
|
+
No authorization required
|
|
748
|
+
|
|
749
|
+
### HTTP request headers
|
|
750
|
+
|
|
751
|
+
- **Content-Type**: application/json
|
|
752
|
+
- **Accept**: application/json
|
|
753
|
+
|
|
754
|
+
|
|
755
|
+
## delete_old_users
|
|
756
|
+
|
|
757
|
+
> String delete_old_users(delete_old_users_request)
|
|
758
|
+
|
|
759
|
+
Delete users that didn't log in last days, or that never logged.
|
|
760
|
+
|
|
761
|
+
### Examples
|
|
762
|
+
|
|
763
|
+
```ruby
|
|
764
|
+
require 'time'
|
|
765
|
+
require 'ejabberd_http_client'
|
|
766
|
+
|
|
767
|
+
api_instance = EjabberdHttpClient::PurgeApi.new
|
|
768
|
+
delete_old_users_request = EjabberdHttpClient::DeleteOldUsersRequest.new # DeleteOldUsersRequest |
|
|
769
|
+
|
|
770
|
+
begin
|
|
771
|
+
# Delete users that didn't log in last days, or that never logged.
|
|
772
|
+
result = api_instance.delete_old_users(delete_old_users_request)
|
|
773
|
+
p result
|
|
774
|
+
rescue EjabberdHttpClient::ApiError => e
|
|
775
|
+
puts "Error when calling PurgeApi->delete_old_users: #{e}"
|
|
776
|
+
end
|
|
777
|
+
```
|
|
778
|
+
|
|
779
|
+
#### Using the delete_old_users_with_http_info variant
|
|
780
|
+
|
|
781
|
+
This returns an Array which contains the response data, status code and headers.
|
|
782
|
+
|
|
783
|
+
> <Array(String, Integer, Hash)> delete_old_users_with_http_info(delete_old_users_request)
|
|
784
|
+
|
|
785
|
+
```ruby
|
|
786
|
+
begin
|
|
787
|
+
# Delete users that didn't log in last days, or that never logged.
|
|
788
|
+
data, status_code, headers = api_instance.delete_old_users_with_http_info(delete_old_users_request)
|
|
789
|
+
p status_code # => 2xx
|
|
790
|
+
p headers # => { ... }
|
|
791
|
+
p data # => String
|
|
792
|
+
rescue EjabberdHttpClient::ApiError => e
|
|
793
|
+
puts "Error when calling PurgeApi->delete_old_users_with_http_info: #{e}"
|
|
794
|
+
end
|
|
795
|
+
```
|
|
796
|
+
|
|
797
|
+
### Parameters
|
|
798
|
+
|
|
799
|
+
| Name | Type | Description | Notes |
|
|
800
|
+
| ---- | ---- | ----------- | ----- |
|
|
801
|
+
| **delete_old_users_request** | [**DeleteOldUsersRequest**](DeleteOldUsersRequest.md) | | |
|
|
802
|
+
|
|
803
|
+
### Return type
|
|
804
|
+
|
|
805
|
+
**String**
|
|
806
|
+
|
|
807
|
+
### Authorization
|
|
808
|
+
|
|
809
|
+
No authorization required
|
|
810
|
+
|
|
811
|
+
### HTTP request headers
|
|
812
|
+
|
|
813
|
+
- **Content-Type**: application/json
|
|
814
|
+
- **Accept**: application/json
|
|
815
|
+
|