Swiftpack.co - traPtitech/swift-traq as Swift Package

Swiftpack.co is a collection of thousands of indexed Swift packages. Search packages.
See all packages published by traPtitech.
traPtitech/swift-traq v0.3.0
⚠️Community Driven⚠️ Swift client library for the traQ API.
⭐️ 0
🕓 1 year ago
iOS macOS watchOS tvOS
.package(url: "https://github.com/traPtitech/swift-traq.git", from: "v0.3.0")

Swift5 API client for Traq

traQ v3 API

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: 3.0
  • Package version:
  • Build package: org.openapitools.codegen.languages.Swift5ClientCodegen For more information, please visit https://github.com/traPtitech/traQ

Installation

Carthage

Run carthage update

CocoaPods

Run pod install

Documentation for API Endpoints

All URIs are relative to https://q.trap.jp/api/v3

Class Method HTTP request Description
ActivityAPI getActivityTimeline GET /activity/timeline アクテビティタイムラインを取得
ActivityAPI getOnlineUsers GET /activity/onlines オンラインユーザーリストを取得
AuthenticationAPI getMyExternalAccounts GET /users/me/ex-accounts 外部ログインアカウント一覧を取得
AuthenticationAPI getMySessions GET /users/me/sessions 自分のログインセッションリストを取得
AuthenticationAPI linkExternalAccount POST /users/me/ex-accounts/link 外部ログインアカウントを紐付ける
AuthenticationAPI login POST /login ログイン
AuthenticationAPI logout POST /logout ログアウト
AuthenticationAPI revokeMySession DELETE /users/me/sessions/{sessionId} セッションを無効化
AuthenticationAPI unlinkExternalAccount POST /users/me/ex-accounts/unlink 外部ログインアカウントの紐付けを解除
BotAPI activateBot POST /bots/{botId}/actions/activate BOTをアクティベート
BotAPI changeBotIcon PUT /bots/{botId}/icon BOTのアイコン画像を変更
BotAPI connectBotWS GET /bots/ws WebSocket Mode BOT用通知ストリームに接続します
BotAPI createBot POST /bots BOTを作成
BotAPI deleteBot DELETE /bots/{botId} BOTを削除
BotAPI editBot PATCH /bots/{botId} BOT情報を変更
BotAPI getBot GET /bots/{botId} BOT情報を取得
BotAPI getBotIcon GET /bots/{botId}/icon BOTのアイコン画像を取得
BotAPI getBotLogs GET /bots/{botId}/logs BOTのイベントログを取得
BotAPI getBots GET /bots BOTリストを取得
BotAPI getChannelBots GET /channels/{channelId}/bots チャンネル参加中のBOTのリストを取得
BotAPI inactivateBot POST /bots/{botId}/actions/inactivate BOTをインアクティベート
BotAPI letBotJoinChannel POST /bots/{botId}/actions/join BOTをチャンネルに参加させる
BotAPI letBotLeaveChannel POST /bots/{botId}/actions/leave BOTをチャンネルから退出させる
BotAPI reissueBot POST /bots/{botId}/actions/reissue BOTのトークンを再発行
ChannelAPI createChannel POST /channels チャンネルを作成
ChannelAPI editChannel PATCH /channels/{channelId} チャンネル情報を変更
ChannelAPI editChannelSubscribers PATCH /channels/{channelId}/subscribers チャンネルの通知購読者を編集
ChannelAPI editChannelTopic PUT /channels/{channelId}/topic チャンネルトピックを編集
ChannelAPI getChannel GET /channels/{channelId} チャンネル情報を取得
ChannelAPI getChannelBots GET /channels/{channelId}/bots チャンネル参加中のBOTのリストを取得
ChannelAPI getChannelEvents GET /channels/{channelId}/events チャンネルイベントのリストを取得
ChannelAPI getChannelPins GET /channels/{channelId}/pins チャンネルピンのリストを取得
ChannelAPI getChannelStats GET /channels/{channelId}/stats チャンネル統計情報を取得
ChannelAPI getChannelSubscribers GET /channels/{channelId}/subscribers チャンネルの通知購読者のリストを取得
ChannelAPI getChannelTopic GET /channels/{channelId}/topic チャンネルトピックを取得
ChannelAPI getChannelViewers GET /channels/{channelId}/viewers チャンネル閲覧者リストを取得
ChannelAPI getChannels GET /channels チャンネルリストを取得
ChannelAPI getMessages GET /channels/{channelId}/messages チャンネルメッセージのリストを取得
ChannelAPI getUserDMChannel GET /users/{userId}/dm-channel DMチャンネル情報を取得
ChannelAPI postMessage POST /channels/{channelId}/messages チャンネルにメッセージを投稿
ChannelAPI setChannelSubscribers PUT /channels/{channelId}/subscribers チャンネルの通知購読者を設定
ClipAPI clipMessage POST /clip-folders/{folderId}/messages メッセージをクリップフォルダに追加
ClipAPI createClipFolder POST /clip-folders クリップフォルダを作成
ClipAPI deleteClipFolder DELETE /clip-folders/{folderId} クリップフォルダを削除
ClipAPI editClipFolder PATCH /clip-folders/{folderId} クリップフォルダ情報を編集
ClipAPI getClipFolder GET /clip-folders/{folderId} クリップフォルダ情報を取得
ClipAPI getClipFolders GET /clip-folders クリップフォルダのリストを取得
ClipAPI getClips GET /clip-folders/{folderId}/messages フォルダ内のクリップのリストを取得
ClipAPI getMessageClips GET /messages/{messageId}/clips 自分のクリップを取得
ClipAPI unclipMessage DELETE /clip-folders/{folderId}/messages/{messageId} メッセージをクリップフォルダから除外
FileAPI deleteFile DELETE /files/{fileId} ファイルを削除
FileAPI getFile GET /files/{fileId} ファイルをダウンロード
FileAPI getFileMeta GET /files/{fileId}/meta ファイルメタを取得
FileAPI getFiles GET /files ファイルメタのリストを取得
FileAPI getThumbnailImage GET /files/{fileId}/thumbnail サムネイル画像を取得
FileAPI postFile POST /files ファイルをアップロード
GroupAPI addUserGroupAdmin POST /groups/{groupId}/admins グループ管理者を追加
GroupAPI addUserGroupMember POST /groups/{groupId}/members グループメンバーを追加
GroupAPI changeUserGroupIcon PUT /groups/{groupId}/icon ユーザーグループのアイコンを変更
GroupAPI createUserGroup POST /groups ユーザーグループを作成
GroupAPI deleteUserGroup DELETE /groups/{groupId} ユーザーグループを削除
GroupAPI editUserGroup PATCH /groups/{groupId} ユーザーグループを編集
GroupAPI editUserGroupMember PATCH /groups/{groupId}/members/{userId} グループメンバーを編集
GroupAPI getUserGroup GET /groups/{groupId} ユーザーグループを取得
GroupAPI getUserGroupAdmins GET /groups/{groupId}/admins グループ管理者を取得
GroupAPI getUserGroupMembers GET /groups/{groupId}/members グループメンバーを取得
GroupAPI getUserGroups GET /groups ユーザーグループのリストを取得
GroupAPI removeUserGroupAdmin DELETE /groups/{groupId}/admins/{userId} グループ管理者を削除
GroupAPI removeUserGroupMember DELETE /groups/{groupId}/members/{userId} グループメンバーを削除
MeAPI addMyStar POST /users/me/stars チャンネルをスターに追加
MeAPI addMyUserTag POST /users/me/tags 自分にタグを追加
MeAPI changeMyIcon PUT /users/me/icon 自分のアイコン画像を変更
MeAPI changeMyNotifyCitation PUT /users/me/settings/notify-citation メッセージ引用通知の設定情報を変更
MeAPI changeMyPassword PUT /users/me/password 自分のパスワードを変更
MeAPI editMe PATCH /users/me 自分のユーザー情報を変更
MeAPI editMyUserTag PATCH /users/me/tags/{tagId} 自分のタグを編集
MeAPI getMe GET /users/me 自分のユーザー詳細を取得
MeAPI getMyChannelSubscriptions GET /users/me/subscriptions 自分のチャンネル購読状態を取得
MeAPI getMyExternalAccounts GET /users/me/ex-accounts 外部ログインアカウント一覧を取得
MeAPI getMyIcon GET /users/me/icon 自分のアイコン画像を取得
MeAPI getMyNotifyCitation GET /users/me/settings/notify-citation メッセージ引用通知の設定情報を取得
MeAPI getMyQRCode GET /users/me/qr-code QRコードを取得
MeAPI getMySessions GET /users/me/sessions 自分のログインセッションリストを取得
MeAPI getMyStampHistory GET /users/me/stamp-history スタンプ履歴を取得
MeAPI getMyStars GET /users/me/stars スターチャンネルリストを取得
MeAPI getMyTokens GET /users/me/tokens 有効トークンのリストを取得
MeAPI getMyUnreadChannels GET /users/me/unread 未読チャンネルを取得
MeAPI getMyUserTags GET /users/me/tags 自分のタグリストを取得
MeAPI getMyViewStates GET /users/me/view-states 自身のチャンネル閲覧状態一覧を取得
MeAPI getUserSettings GET /users/me/settings ユーザー設定を取得
MeAPI linkExternalAccount POST /users/me/ex-accounts/link 外部ログインアカウントを紐付ける
MeAPI readChannel DELETE /users/me/unread/{channelId} チャンネルを既読にする
MeAPI registerFCMDevice POST /users/me/fcm-device FCMデバイスを登録
MeAPI removeMyStar DELETE /users/me/stars/{channelId} チャンネルをスターから削除します
MeAPI removeMyUserTag DELETE /users/me/tags/{tagId} 自分からタグを削除します
MeAPI revokeMySession DELETE /users/me/sessions/{sessionId} セッションを無効化
MeAPI revokeMyToken DELETE /users/me/tokens/{tokenId} トークンの認可を取り消す
MeAPI setChannelSubscribeLevel PUT /users/me/subscriptions/{channelId} チャンネル購読レベルを設定
MeAPI unlinkExternalAccount POST /users/me/ex-accounts/unlink 外部ログインアカウントの紐付けを解除
MessageAPI addMessageStamp POST /messages/{messageId}/stamps/{stampId} スタンプを押す
MessageAPI createPin POST /messages/{messageId}/pin ピン留めする
MessageAPI deleteMessage DELETE /messages/{messageId} メッセージを削除
MessageAPI editMessage PUT /messages/{messageId} メッセージを編集
MessageAPI getDirectMessages GET /users/{userId}/messages ダイレクトメッセージのリストを取得
MessageAPI getMessage GET /messages/{messageId} メッセージを取得
MessageAPI getMessageClips GET /messages/{messageId}/clips 自分のクリップを取得
MessageAPI getMessageStamps GET /messages/{messageId}/stamps メッセージのスタンプリストを取得
MessageAPI getMessages GET /channels/{channelId}/messages チャンネルメッセージのリストを取得
MessageAPI getPin GET /messages/{messageId}/pin ピン留めを取得
MessageAPI postDirectMessage POST /users/{userId}/messages ダイレクトメッセージを送信
MessageAPI postMessage POST /channels/{channelId}/messages チャンネルにメッセージを投稿
MessageAPI removeMessageStamp DELETE /messages/{messageId}/stamps/{stampId} スタンプを消す
MessageAPI removePin DELETE /messages/{messageId}/pin ピン留めを外す
MessageAPI searchMessages GET /messages メッセージを検索
NotificationAPI editChannelSubscribers PATCH /channels/{channelId}/subscribers チャンネルの通知購読者を編集
NotificationAPI getChannelSubscribers GET /channels/{channelId}/subscribers チャンネルの通知購読者のリストを取得
NotificationAPI getMyChannelSubscriptions GET /users/me/subscriptions 自分のチャンネル購読状態を取得
NotificationAPI getMyUnreadChannels GET /users/me/unread 未読チャンネルを取得
NotificationAPI getMyViewStates GET /users/me/view-states 自身のチャンネル閲覧状態一覧を取得
NotificationAPI readChannel DELETE /users/me/unread/{channelId} チャンネルを既読にする
NotificationAPI registerFCMDevice POST /users/me/fcm-device FCMデバイスを登録
NotificationAPI setChannelSubscribeLevel PUT /users/me/subscriptions/{channelId} チャンネル購読レベルを設定
NotificationAPI setChannelSubscribers PUT /channels/{channelId}/subscribers チャンネルの通知購読者を設定
NotificationAPI ws GET /ws WebSocket通知ストリームに接続します
Oauth2API createClient POST /clients OAuth2クライアントを作成
Oauth2API deleteClient DELETE /clients/{clientId} OAuth2クライアントを削除
Oauth2API editClient PATCH /clients/{clientId} OAuth2クライアント情報を変更
Oauth2API getClient GET /clients/{clientId} OAuth2クライアント情報を取得
Oauth2API getClients GET /clients OAuth2クライアントのリストを取得
Oauth2API getMyTokens GET /users/me/tokens 有効トークンのリストを取得
Oauth2API getOAuth2Authorize GET /oauth2/authorize OAuth2 認可エンドポイント
Oauth2API postOAuth2Authorize POST /oauth2/authorize OAuth2 認可エンドポイント
Oauth2API postOAuth2AuthorizeDecide POST /oauth2/authorize/decide OAuth2 認可承諾API
Oauth2API postOAuth2Token POST /oauth2/token OAuth2 トークンエンドポイント
Oauth2API revokeMyToken DELETE /users/me/tokens/{tokenId} トークンの認可を取り消す
Oauth2API revokeOAuth2Token POST /oauth2/revoke OAuth2 トークン無効化エンドポイント
OgpAPI deleteOgpCache DELETE /ogp/cache OGP情報のキャッシュを削除
OgpAPI getOgp GET /ogp OGP情報を取得
PinAPI createPin POST /messages/{messageId}/pin ピン留めする
PinAPI getChannelPins GET /channels/{channelId}/pins チャンネルピンのリストを取得
PinAPI getPin GET /messages/{messageId}/pin ピン留めを取得
PinAPI removePin DELETE /messages/{messageId}/pin ピン留めを外す
PublicAPI getPublicUserIcon GET /public/icon/{username} ユーザーのアイコン画像を取得
PublicAPI getServerVersion GET /version バージョンを取得
StampAPI addMessageStamp POST /messages/{messageId}/stamps/{stampId} スタンプを押す
StampAPI changeStampImage PUT /stamps/{stampId}/image スタンプ画像を変更
StampAPI createStamp POST /stamps スタンプを作成
StampAPI createStampPalette POST /stamp-palettes スタンプパレットを作成
StampAPI deleteStamp DELETE /stamps/{stampId} スタンプを削除
StampAPI deleteStampPalette DELETE /stamp-palettes/{paletteId} スタンプパレットを削除
StampAPI editStamp PATCH /stamps/{stampId} スタンプ情報を変更
StampAPI editStampPalette PATCH /stamp-palettes/{paletteId} スタンプパレットを編集
StampAPI getMessageStamps GET /messages/{messageId}/stamps メッセージのスタンプリストを取得
StampAPI getMyStampHistory GET /users/me/stamp-history スタンプ履歴を取得
StampAPI getStamp GET /stamps/{stampId} スタンプ情報を取得
StampAPI getStampImage GET /stamps/{stampId}/image スタンプ画像を取得
StampAPI getStampPalette GET /stamp-palettes/{paletteId} スタンプパレットを取得
StampAPI getStampPalettes GET /stamp-palettes スタンプパレットのリストを取得
StampAPI getStampStats GET /stamps/{stampId}/stats スタンプ統計情報を取得
StampAPI getStamps GET /stamps スタンプリストを取得
StampAPI removeMessageStamp DELETE /messages/{messageId}/stamps/{stampId} スタンプを消す
StarAPI addMyStar POST /users/me/stars チャンネルをスターに追加
StarAPI getMyStars GET /users/me/stars スターチャンネルリストを取得
StarAPI removeMyStar DELETE /users/me/stars/{channelId} チャンネルをスターから削除します
UserAPI addUserTag POST /users/{userId}/tags ユーザーにタグを追加
UserAPI changeUserIcon PUT /users/{userId}/icon ユーザーのアイコン画像を変更します
UserAPI changeUserPassword PUT /users/{userId}/password ユーザーのパスワードを変更
UserAPI createUser POST /users ユーザーを登録
UserAPI editUser PATCH /users/{userId} ユーザー情報を変更
UserAPI editUserTag PATCH /users/{userId}/tags/{tagId} ユーザーのタグを編集
UserAPI getDirectMessages GET /users/{userId}/messages ダイレクトメッセージのリストを取得
UserAPI getUser GET /users/{userId} ユーザー詳細情報を取得
UserAPI getUserDMChannel GET /users/{userId}/dm-channel DMチャンネル情報を取得
UserAPI getUserIcon GET /users/{userId}/icon ユーザーのアイコン画像を取得
UserAPI getUserStats GET /users/{userId}/stats ユーザー統計情報を取得
UserAPI getUserTags GET /users/{userId}/tags ユーザーのタグリストを取得
UserAPI getUsers GET /users ユーザーのリストを取得
UserAPI postDirectMessage POST /users/{userId}/messages ダイレクトメッセージを送信
UserAPI removeUserTag DELETE /users/{userId}/tags/{tagId} ユーザーからタグを削除します
UserTagAPI addMyUserTag POST /users/me/tags 自分にタグを追加
UserTagAPI addUserTag POST /users/{userId}/tags ユーザーにタグを追加
UserTagAPI editMyUserTag PATCH /users/me/tags/{tagId} 自分のタグを編集
UserTagAPI editUserTag PATCH /users/{userId}/tags/{tagId} ユーザーのタグを編集
UserTagAPI getMyUserTags GET /users/me/tags 自分のタグリストを取得
UserTagAPI getTag GET /tags/{tagId} タグ情報を取得
UserTagAPI getUserTags GET /users/{userId}/tags ユーザーのタグリストを取得
UserTagAPI removeMyUserTag DELETE /users/me/tags/{tagId} 自分からタグを削除します
UserTagAPI removeUserTag DELETE /users/{userId}/tags/{tagId} ユーザーからタグを削除します
WebhookAPI changeWebhookIcon PUT /webhooks/{webhookId}/icon Webhookのアイコンを変更
WebhookAPI createWebhook POST /webhooks Webhookを新規作成
WebhookAPI deleteWebhook DELETE /webhooks/{webhookId} Webhookを削除
WebhookAPI editWebhook PATCH /webhooks/{webhookId} Webhook情報を変更
WebhookAPI getWebhook GET /webhooks/{webhookId} Webhook情報を取得
WebhookAPI getWebhookIcon GET /webhooks/{webhookId}/icon Webhookのアイコンを取得
WebhookAPI getWebhookMessages GET /webhooks/{webhookId}/messages Webhookの投稿メッセージのリストを取得
WebhookAPI getWebhooks GET /webhooks Webhook情報のリストを取得します
WebhookAPI postWebhook POST /webhooks/{webhookId} Webhookを送信
WebrtcAPI getWebRTCState GET /webrtc/state WebRTC状態を取得
WebrtcAPI postWebRTCAuthenticate POST /webrtc/authenticate Skyway用認証API

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

cookieAuth

  • Type: API key
  • API key parameter name: r_session
  • Location:

OAuth2

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: /api/v3/oauth2/authorize
  • Scopes:
  • read: 読み取りスコープ
  • write: 書き込みスコープ
  • manage_bot: bot関連読み書きスコープ

bearerAuth

  • Type: HTTP Bearer Token authentication

Author

GitHub

link
Stars: 0
Last commit: Yesterday
Advertisement: IndiePitcher.com - Cold Email Software for Startups

Release Notes

v0.3.0
1 year ago

Full Changelog: https://github.com/Ras96/swift-traq/compare/v0.2.1...v0.3.0

  • add actions workflows
  • use SPM structure
  • remove concurrency methods
See all

Swiftpack is being maintained by Petr Pavlik | @ptrpavlik | @swiftpackco | API | Analytics