import * as axios from 'axios'; import { AxiosRequestConfig, AxiosInstance, AxiosPromise } from 'axios'; /** * traQ v3 * traQ v3 API * * The version of the OpenAPI document: 3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ interface ConfigurationParameters { apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); username?: string; password?: string; accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); basePath?: string; baseOptions?: any; formDataCtor?: new () => any; } declare class Configuration { /** * parameter for apiKey security * @param name security name * @memberof Configuration */ apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); /** * parameter for basic security * * @type {string} * @memberof Configuration */ username?: string; /** * parameter for basic security * * @type {string} * @memberof Configuration */ password?: string; /** * parameter for oauth2 security * @param name security name * @param scopes oauth2 scope * @memberof Configuration */ accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); /** * override base path * * @type {string} * @memberof Configuration */ basePath?: string; /** * base options for axios calls * * @type {any} * @memberof Configuration */ baseOptions?: any; /** * The FormData constructor that will be used to create multipart form data * requests. You can inject this here so that execution environments that * do not support the FormData class can still run the generated client. * * @type {new () => FormData} */ formDataCtor?: new () => any; constructor(param?: ConfigurationParameters); /** * Check if the given MIME is a JSON MIME. * JSON MIME examples: * application/json * application/json; charset=UTF8 * APPLICATION/JSON * application/vnd.company+json * @param mime - MIME (Multipurpose Internet Mail Extensions) * @return True if the given MIME is JSON, false otherwise. */ isJsonMime(mime: string): boolean; } /** * traQ v3 * traQ v3 API * * The version of the OpenAPI document: 3.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface RequestArgs */ interface RequestArgs { url: string; options: AxiosRequestConfig; } /** * * @export * @class BaseAPI */ declare class BaseAPI { protected basePath: string; protected axios: AxiosInstance; protected configuration: Configuration | undefined; constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance); } /** * 有効なOAuth2トークン情報 * @export * @interface ActiveOAuth2Token */ interface ActiveOAuth2Token { /** * トークンUUID * @type {string} * @memberof ActiveOAuth2Token */ 'id': string; /** * OAuth2クライアントUUID * @type {string} * @memberof ActiveOAuth2Token */ 'clientId': string; /** * スコープ * @type {Array} * @memberof ActiveOAuth2Token */ 'scopes': Array; /** * 発行日時 * @type {string} * @memberof ActiveOAuth2Token */ 'issuedAt': string; } /** * Timelineアクテビティ用メッセージ * @export * @interface ActivityTimelineMessage */ interface ActivityTimelineMessage { /** * メッセージUUID * @type {string} * @memberof ActivityTimelineMessage */ 'id': string; /** * 投稿者UUID * @type {string} * @memberof ActivityTimelineMessage */ 'userId': string; /** * チャンネルUUID * @type {string} * @memberof ActivityTimelineMessage */ 'channelId': string; /** * メッセージ本文 * @type {string} * @memberof ActivityTimelineMessage */ 'content': string; /** * 投稿日時 * @type {string} * @memberof ActivityTimelineMessage */ 'createdAt': string; /** * 編集日時 * @type {string} * @memberof ActivityTimelineMessage */ 'updatedAt': string; } /** * @type AddUserGroupMemberRequest * @export */ type AddUserGroupMemberRequest = UserGroupMember | UserGroupMembers; /** * BOT情報 * @export * @interface Bot */ interface Bot { /** * BOT UUID * @type {string} * @memberof Bot */ 'id': string; /** * BOTユーザーUUID * @type {string} * @memberof Bot */ 'botUserId': string; /** * 説明 * @type {string} * @memberof Bot */ 'description': string; /** * BOT開発者UUID * @type {string} * @memberof Bot */ 'developerId': string; /** * BOTが購読しているイベントの配列 * @type {Array} * @memberof Bot */ 'subscribeEvents': Array; /** * * @type {BotMode} * @memberof Bot */ 'mode': BotMode; /** * * @type {BotState} * @memberof Bot */ 'state': BotState; /** * 作成日時 * @type {string} * @memberof Bot */ 'createdAt': string; /** * 更新日時 * @type {string} * @memberof Bot */ 'updatedAt': string; } /** * BOT詳細情報 * @export * @interface BotDetail */ interface BotDetail { /** * BOT UUID * @type {string} * @memberof BotDetail */ 'id': string; /** * 更新日時 * @type {string} * @memberof BotDetail */ 'updatedAt': string; /** * 作成日時 * @type {string} * @memberof BotDetail */ 'createdAt': string; /** * * @type {BotMode} * @memberof BotDetail */ 'mode': BotMode; /** * * @type {BotState} * @memberof BotDetail */ 'state': BotState; /** * BOTが購読しているイベントの配列 * @type {Array} * @memberof BotDetail */ 'subscribeEvents': Array; /** * BOT開発者UUID * @type {string} * @memberof BotDetail */ 'developerId': string; /** * 説明 * @type {string} * @memberof BotDetail */ 'description': string; /** * BOTユーザーUUID * @type {string} * @memberof BotDetail */ 'botUserId': string; /** * * @type {BotTokens} * @memberof BotDetail */ 'tokens': BotTokens; /** * BOTサーバーエンドポイント * @type {string} * @memberof BotDetail */ 'endpoint': string; /** * 特権BOTかどうか * @type {boolean} * @memberof BotDetail */ 'privileged': boolean; /** * BOTが参加しているチャンネルのUUID配列 * @type {Array} * @memberof BotDetail */ 'channels': Array; } /** * BOTイベントログ * @export * @interface BotEventLog */ interface BotEventLog { /** * BOT UUID * @type {string} * @memberof BotEventLog */ 'botId': string; /** * リクエストUUID * @type {string} * @memberof BotEventLog */ 'requestId': string; /** * イベントタイプ * @type {string} * @memberof BotEventLog */ 'event': string; /** * * @type {BotEventResult} * @memberof BotEventLog */ 'result'?: BotEventResult; /** * ステータスコード * @type {number} * @memberof BotEventLog */ 'code': number; /** * イベント日時 * @type {string} * @memberof BotEventLog */ 'datetime': string; } /** * イベント配送結果 * @export * @enum {string} */ declare const BotEventResult: { /** * 成功 */ readonly OK: "ok"; /** * 失敗(不正なレスポンス) */ readonly NG: "ng"; /** * ネットワークエラー */ readonly NetworkError: "ne"; /** * (WebSocket Modeのみ)接続しているセッションが存在しなかった */ readonly Dropped: "dp"; }; type BotEventResult = typeof BotEventResult[keyof typeof BotEventResult]; /** * BOT動作モード HTTP: HTTP Mode WebSocket: WebSocket Mode * @export * @enum {string} */ declare const BotMode: { /** * HTTP Mode */ readonly HTTP: "HTTP"; /** * WebSocket Mode */ readonly WebSocket: "WebSocket"; }; type BotMode = typeof BotMode[keyof typeof BotMode]; /** * BOT状態 0: 停止 1: 有効 2: 一時停止 * @export * @enum {string} */ declare const BotState: { /** * 停止 */ readonly deactivated: 0; /** * 有効 */ readonly active: 1; /** * 一時停止 */ readonly suspended: 2; }; type BotState = typeof BotState[keyof typeof BotState]; /** * BOTのトークン情報 * @export * @interface BotTokens */ interface BotTokens { /** * Verification Token * @type {string} * @memberof BotTokens */ 'verificationToken': string; /** * BOTアクセストークン * @type {string} * @memberof BotTokens */ 'accessToken': string; } /** * BOTユーザー対 * @export * @interface BotUser */ interface BotUser { /** * BOT UUID * @type {string} * @memberof BotUser */ 'id': string; /** * BOTユーザーUUID * @type {string} * @memberof BotUser */ 'botUserId': string; } /** * チャンネル * @export * @interface Channel */ interface Channel { /** * チャンネルUUID * @type {string} * @memberof Channel */ 'id': string; /** * 親チャンネルUUID * @type {string} * @memberof Channel */ 'parentId': string | null; /** * チャンネルがアーカイブされているかどうか * @type {boolean} * @memberof Channel */ 'archived': boolean; /** * 強制通知チャンネルかどうか * @type {boolean} * @memberof Channel */ 'force': boolean; /** * チャンネルトピック * @type {string} * @memberof Channel */ 'topic': string; /** * チャンネル名 * @type {string} * @memberof Channel */ 'name': string; /** * 子チャンネルのUUID配列 * @type {Array} * @memberof Channel */ 'children': Array; } /** * チャンネルイベント * @export * @interface ChannelEvent */ interface ChannelEvent { /** * イベントタイプ * @type {string} * @memberof ChannelEvent */ 'type': ChannelEventTypeEnum; /** * イベント日時 * @type {string} * @memberof ChannelEvent */ 'datetime': string; /** * * @type {ChannelEventDetail} * @memberof ChannelEvent */ 'detail': ChannelEventDetail; } declare const ChannelEventTypeEnum: { readonly TopicChanged: "TopicChanged"; readonly SubscribersChanged: "SubscribersChanged"; readonly PinAdded: "PinAdded"; readonly PinRemoved: "PinRemoved"; readonly NameChanged: "NameChanged"; readonly ParentChanged: "ParentChanged"; readonly VisibilityChanged: "VisibilityChanged"; readonly ForcedNotificationChanged: "ForcedNotificationChanged"; readonly ChildCreated: "ChildCreated"; }; type ChannelEventTypeEnum = typeof ChannelEventTypeEnum[keyof typeof ChannelEventTypeEnum]; /** * @type ChannelEventDetail * イベント内容 * @export */ type ChannelEventDetail = ChildCreatedEvent | ForcedNotificationChangedEvent | NameChangedEvent | ParentChangedEvent | PinAddedEvent | PinRemovedEvent | SubscribersChangedEvent | TopicChangedEvent | VisibilityChangedEvent; /** * GET /channelsレスポンス * @export * @interface ChannelList */ interface ChannelList { /** * パブリックチャンネルの配列 * @type {Array} * @memberof ChannelList */ 'public': Array; /** * ダイレクトメッセージチャンネルの配列 * @type {Array} * @memberof ChannelList */ 'dm'?: Array; } /** * チャンネルパス * @export * @interface ChannelPath */ interface ChannelPath { /** * チャンネルパス * @type {string} * @memberof ChannelPath */ 'path': string; } /** * チャンネル統計情報 * @export * @interface ChannelStats */ interface ChannelStats { /** * チャンネルの総投稿メッセージ数(削除されたものも含む) * @type {number} * @memberof ChannelStats */ 'totalMessageCount': number; /** * チャンネル上のスタンプ統計情報 * @type {Array} * @memberof ChannelStats */ 'stamps': Array; /** * チャンネル上のユーザー統計情報 * @type {Array} * @memberof ChannelStats */ 'users': Array; /** * 統計情報日時 * @type {string} * @memberof ChannelStats */ 'datetime': string; } /** * チャンネル上の特定スタンプ統計情報 * @export * @interface ChannelStatsStamp */ interface ChannelStatsStamp { /** * スタンプID * @type {string} * @memberof ChannelStatsStamp */ 'id': string; /** * スタンプ数(同一メッセージ上のものは複数カウントしない) * @type {number} * @memberof ChannelStatsStamp */ 'count': number; /** * スタンプ数(同一メッセージ上のものも複数カウントする) * @type {number} * @memberof ChannelStatsStamp */ 'total': number; } /** * チャンネル上の特定ユーザー統計情報 * @export * @interface ChannelStatsUser */ interface ChannelStatsUser { /** * ユーザーID * @type {string} * @memberof ChannelStatsUser */ 'id': string; /** * メッセージ数 * @type {number} * @memberof ChannelStatsUser */ 'messageCount': number; } /** * チャンネル購読レベル 0：無し 1：未読管理 2：未読管理+通知 * @export * @enum {string} */ declare const ChannelSubscribeLevel: { /** * 無し */ readonly none: 0; /** * 未読管理 */ readonly subscribed: 1; /** * 未読管理+通知 */ readonly notified: 2; }; type ChannelSubscribeLevel = typeof ChannelSubscribeLevel[keyof typeof ChannelSubscribeLevel]; /** * チャンネルトピック * @export * @interface ChannelTopic */ interface ChannelTopic { /** * トピック * @type {string} * @memberof ChannelTopic */ 'topic': string; } /** * 閲覧状態 * @export * @enum {string} */ declare const ChannelViewState: { /** * バックグラウンド表示中 */ readonly None: "none"; /** * 古いメッセージを表示中 */ readonly StaleViewing: "stale_viewing"; /** * メッセージ表示中 */ readonly Monitoring: "monitoring"; /** * メッセージ入力中 */ readonly Editing: "editing"; }; type ChannelViewState = typeof ChannelViewState[keyof typeof ChannelViewState]; /** * チャンネル閲覧者情報 * @export * @interface ChannelViewer */ interface ChannelViewer { /** * ユーザーUUID * @type {string} * @memberof ChannelViewer */ 'userId': string; /** * * @type {ChannelViewState} * @memberof ChannelViewer */ 'state': ChannelViewState; /** * 更新日時 * @type {string} * @memberof ChannelViewer */ 'updatedAt': string; } /** * 子チャンネル作成イベント * @export * @interface ChildCreatedEvent */ interface ChildCreatedEvent { /** * 作成者UUID * @type {string} * @memberof ChildCreatedEvent */ 'userId': string; /** * チャンネルUUID * @type {string} * @memberof ChildCreatedEvent */ 'channelId': string; } /** * クリップフォルダ情報 * @export * @interface ClipFolder */ interface ClipFolder { /** * フォルダUUID * @type {string} * @memberof ClipFolder */ 'id': string; /** * フォルダ名 * @type {string} * @memberof ClipFolder */ 'name': string; /** * 作成日時 * @type {string} * @memberof ClipFolder */ 'createdAt': string; /** * フォルダ所有者UUID * @type {string} * @memberof ClipFolder */ 'ownerId': string; /** * 説明 * @type {string} * @memberof ClipFolder */ 'description': string; } /** * クリップされたメッセージ * @export * @interface ClippedMessage */ interface ClippedMessage { /** * * @type {Message} * @memberof ClippedMessage */ 'message': Message; /** * クリップした日時 * @type {string} * @memberof ClippedMessage */ 'clippedAt': string; } /** * ダイレクトメッセージチャンネル * @export * @interface DMChannel */ interface DMChannel { /** * チャンネルUUID * @type {string} * @memberof DMChannel */ 'id': string; /** * 送信先相手のUUID * @type {string} * @memberof DMChannel */ 'userId': string; } /** * 外部認証アカウントユーザー * @export * @interface ExternalProviderUser */ interface ExternalProviderUser { /** * 外部サービス名 * @type {string} * @memberof ExternalProviderUser */ 'providerName': string; /** * 紐付けた日時 * @type {string} * @memberof ExternalProviderUser */ 'linkedAt': string; /** * 外部アカウント名 * @type {string} * @memberof ExternalProviderUser */ 'externalName': string; } /** * ファイル情報 * @export * @interface FileInfo */ interface FileInfo { /** * ファイルUUID * @type {string} * @memberof FileInfo */ 'id': string; /** * ファイル名 * @type {string} * @memberof FileInfo */ 'name': string; /** * MIMEタイプ * @type {string} * @memberof FileInfo */ 'mime': string; /** * ファイルサイズ * @type {number} * @memberof FileInfo */ 'size': number; /** * MD5ハッシュ * @type {string} * @memberof FileInfo */ 'md5': string; /** * アニメーション画像かどうか * @type {boolean} * @memberof FileInfo */ 'isAnimatedImage': boolean; /** * アップロード日時 * @type {string} * @memberof FileInfo */ 'createdAt': string; /** * * @type {Array} * @memberof FileInfo */ 'thumbnails': Array; /** * * @type {FileInfoThumbnail} * @memberof FileInfo * @deprecated */ 'thumbnail': FileInfoThumbnail | null; /** * 属しているチャンネルUUID * @type {string} * @memberof FileInfo */ 'channelId': string | null; /** * アップロード者UUID * @type {string} * @memberof FileInfo */ 'uploaderId': string | null; } /** * サムネイル情報 サムネイルが存在しない場合はnullになります Deprecated: thumbnailsを参照してください * @export * @interface FileInfoThumbnail */ interface FileInfoThumbnail { /** * MIMEタイプ * @type {string} * @memberof FileInfoThumbnail * @deprecated */ 'mime': string; /** * サムネイル幅 * @type {number} * @memberof FileInfoThumbnail * @deprecated */ 'width'?: number; /** * サムネイル高さ * @type {number} * @memberof FileInfoThumbnail * @deprecated */ 'height'?: number; } /** * チャンネル強制通知状態変更イベント * @export * @interface ForcedNotificationChangedEvent */ interface ForcedNotificationChangedEvent { /** * 変更者UUID * @type {string} * @memberof ForcedNotificationChangedEvent */ 'userId': string; /** * 変更後強制通知状態 * @type {boolean} * @memberof ForcedNotificationChangedEvent */ 'force': boolean; } /** * @type GetBot200Response * @export */ type GetBot200Response = Bot | BotDetail; /** * @type GetClient200Response * @export */ type GetClient200Response = OAuth2Client | OAuth2ClientDetail; /** * * @export * @interface GetMyStampRecommendations200ResponseInner */ interface GetMyStampRecommendations200ResponseInner { /** * スタンプUUID * @type {string} * @memberof GetMyStampRecommendations200ResponseInner */ 'stampId': string; /** * レコメンドスコア * @type {number} * @memberof GetMyStampRecommendations200ResponseInner */ 'score': number; } /** * メッセージ引用通知の設定情報 * @export * @interface GetNotifyCitation */ interface GetNotifyCitation { /** * * @type {boolean} * @memberof GetNotifyCitation */ 'notifyCitation': boolean; } /** * ログインセッション情報 * @export * @interface LoginSession */ interface LoginSession { /** * セッションUUID * @type {string} * @memberof LoginSession */ 'id': string; /** * 発行日時 * @type {string} * @memberof LoginSession */ 'issuedAt': string; } /** * メッセージ * @export * @interface Message */ interface Message { /** * メッセージUUID * @type {string} * @memberof Message */ 'id': string; /** * 投稿者UUID * @type {string} * @memberof Message */ 'userId': string; /** * チャンネルUUID * @type {string} * @memberof Message */ 'channelId': string; /** * メッセージ本文 * @type {string} * @memberof Message */ 'content': string; /** * 投稿日時 * @type {string} * @memberof Message */ 'createdAt': string; /** * 編集日時 * @type {string} * @memberof Message */ 'updatedAt': string; /** * ピン留めされているかどうか * @type {boolean} * @memberof Message */ 'pinned': boolean; /** * 押されているスタンプの配列 * @type {Array} * @memberof Message */ 'stamps': Array; /** * スレッドUUID * @type {string} * @memberof Message */ 'threadId': string | null; /** * メッセージ送信の確認に使うことができる任意の識別子(投稿でのみ使用可) * @type {string} * @memberof Message */ 'nonce'?: string; } /** * メッセージクリップ * @export * @interface MessageClip */ interface MessageClip { /** * クリップされているフォルダのID * @type {string} * @memberof MessageClip */ 'folderId': string; /** * クリップされた日時 * @type {string} * @memberof MessageClip */ 'clippedAt': string; } /** * ピン情報 * @export * @interface MessagePin */ interface MessagePin { /** * ピン留めしたユーザーUUID * @type {string} * @memberof MessagePin */ 'userId': string; /** * ピン留めされた日時 * @type {string} * @memberof MessagePin */ 'pinnedAt': string; } /** * メッセージ検索結果 * @export * @interface MessageSearchResult */ interface MessageSearchResult { /** * 検索にヒットしたメッセージ件数 * @type {number} * @memberof MessageSearchResult */ 'totalHits': number; /** * 検索にヒットしたメッセージの配列 * @type {Array} * @memberof MessageSearchResult */ 'hits': Array; } /** * メッセージに押されたスタンプ * @export * @interface MessageStamp */ interface MessageStamp { /** * ユーザーUUID * @type {string} * @memberof MessageStamp */ 'userId': string; /** * スタンプUUID * @type {string} * @memberof MessageStamp */ 'stampId': string; /** * スタンプ数 * @type {number} * @memberof MessageStamp */ 'count': number; /** * スタンプが最初に押された日時 * @type {string} * @memberof MessageStamp */ 'createdAt': string; /** * スタンプが最後に押された日時 * @type {string} * @memberof MessageStamp */ 'updatedAt': string; } /** * 自身のチャンネル閲覧状態 * @export * @interface MyChannelViewState */ interface MyChannelViewState { /** * WSセッションの識別子 * @type {string} * @memberof MyChannelViewState */ 'key': string; /** * チャンネルUUID * @type {string} * @memberof MyChannelViewState */ 'channelId': string; /** * * @type {ChannelViewState} * @memberof MyChannelViewState */ 'state': ChannelViewState; } /** * 自分のユーザー詳細情報 * @export * @interface MyUserDetail */ interface MyUserDetail { /** * ユーザーUUID * @type {string} * @memberof MyUserDetail */ 'id': string; /** * 自己紹介(biography) * @type {string} * @memberof MyUserDetail */ 'bio': string; /** * 所属グループのUUIDの配列 * @type {Array} * @memberof MyUserDetail */ 'groups': Array; /** * タグリスト * @type {Array} * @memberof MyUserDetail */ 'tags': Array; /** * 更新日時 * @type {string} * @memberof MyUserDetail */ 'updatedAt': string; /** * 最終オンライン日時 * @type {string} * @memberof MyUserDetail */ 'lastOnline': string | null; /** * Twitter ID * @type {string} * @memberof MyUserDetail */ 'twitterId': string; /** * ユーザー名 * @type {string} * @memberof MyUserDetail */ 'name': string; /** * ユーザー表示名 * @type {string} * @memberof MyUserDetail */ 'displayName': string; /** * アイコンファイルUUID * @type {string} * @memberof MyUserDetail */ 'iconFileId': string; /** * BOTかどうか * @type {boolean} * @memberof MyUserDetail */ 'bot': boolean; /** * * @type {UserAccountState} * @memberof MyUserDetail */ 'state': UserAccountState; /** * 所有している権限の配列 * @type {Array} * @memberof MyUserDetail */ 'permissions': Array; /** * ホームチャンネル * @type {string} * @memberof MyUserDetail */ 'homeChannel': string | null; } /** * チャンネル名変更イベント * @export * @interface NameChangedEvent */ interface NameChangedEvent { /** * 変更者UUID * @type {string} * @memberof NameChangedEvent */ 'userId': string; /** * 変更前チャンネル名 * @type {string} * @memberof NameChangedEvent */ 'before': string; /** * 変更後チャンネル名 * @type {string} * @memberof NameChangedEvent */ 'after': string; } /** * OAuth2クライアント情報 * @export * @interface OAuth2Client */ interface OAuth2Client { /** * クライアントUUID * @type {string} * @memberof OAuth2Client */ 'id': string; /** * クライアント名 * @type {string} * @memberof OAuth2Client */ 'name': string; /** * 説明 * @type {string} * @memberof OAuth2Client */ 'description': string; /** * クライアント開発者UUID * @type {string} * @memberof OAuth2Client */ 'developerId': string; /** * 要求スコープの配列 * @type {Array} * @memberof OAuth2Client */ 'scopes': Array; /** * confidential client なら true, public client なら false * @type {boolean} * @memberof OAuth2Client */ 'confidential': boolean; } /** * OAuth2クライアント詳細情報 * @export * @interface OAuth2ClientDetail */ interface OAuth2ClientDetail { /** * クライアントUUID * @type {string} * @memberof OAuth2ClientDetail */ 'id': string; /** * クライアント開発者UUID * @type {string} * @memberof OAuth2ClientDetail */ 'developerId': string; /** * 説明 * @type {string} * @memberof OAuth2ClientDetail */ 'description': string; /** * クライアント名 * @type {string} * @memberof OAuth2ClientDetail */ 'name': string; /** * 要求スコープの配列 * @type {Array} * @memberof OAuth2ClientDetail */ 'scopes': Array; /** * コールバックURL * @type {string} * @memberof OAuth2ClientDetail */ 'callbackUrl': string; /** * クライアントシークレット * @type {string} * @memberof OAuth2ClientDetail */ 'secret': string; /** * confidential client なら true, public client なら false * @type {boolean} * @memberof OAuth2ClientDetail */ 'confidential': boolean; } /** * * @export * @enum {string} */ declare const OAuth2Prompt: { readonly None: "none"; }; type OAuth2Prompt = typeof OAuth2Prompt[keyof typeof OAuth2Prompt]; /** * * @export * @enum {string} */ declare const OAuth2ResponseType: { readonly Code: "code"; readonly Token: "token"; readonly None: "none"; }; type OAuth2ResponseType = typeof OAuth2ResponseType[keyof typeof OAuth2ResponseType]; /** * OAuth2スコープ * @export * @enum {string} */ declare const OAuth2Scope: { readonly Openid: "openid"; readonly Profile: "profile"; readonly Read: "read"; readonly Write: "write"; readonly ManageBot: "manage_bot"; }; type OAuth2Scope = typeof OAuth2Scope[keyof typeof OAuth2Scope]; /** * * @export * @interface OAuth2Token */ interface OAuth2Token { /** * * @type {string} * @memberof OAuth2Token */ 'access_token': string; /** * * @type {string} * @memberof OAuth2Token */ 'token_type': string; /** * * @type {number} * @memberof OAuth2Token */ 'expires_in'?: number; /** * * @type {string} * @memberof OAuth2Token */ 'refresh_token'?: string; /** * * @type {string} * @memberof OAuth2Token */ 'scope'?: string; /** * * @type {string} * @memberof OAuth2Token */ 'id_token'?: string; } /** * traQ特有のユーザー詳細情報 * @export * @interface OIDCTraqUserInfo */ interface OIDCTraqUserInfo { /** * 自己紹介(biography) * @type {string} * @memberof OIDCTraqUserInfo */ 'bio': string; /** * 所属グループのUUIDの配列 * @type {Array} * @memberof OIDCTraqUserInfo */ 'groups': Array; /** * タグリスト * @type {Array} * @memberof OIDCTraqUserInfo */ 'tags': Array; /** * 最終オンライン日時 * @type {string} * @memberof OIDCTraqUserInfo */ 'last_online': string | null; /** * Twitter ID * @type {string} * @memberof OIDCTraqUserInfo */ 'twitter_id': string; /** * ユーザー表示名 * @type {string} * @memberof OIDCTraqUserInfo */ 'display_name': string; /** * アイコンファイルUUID * @type {string} * @memberof OIDCTraqUserInfo */ 'icon_file_id': string; /** * BOTかどうか * @type {boolean} * @memberof OIDCTraqUserInfo */ 'bot': boolean; /** * * @type {UserAccountState} * @memberof OIDCTraqUserInfo */ 'state': UserAccountState; /** * 所有している権限の配列 * @type {Array} * @memberof OIDCTraqUserInfo */ 'permissions': Array; /** * ホームチャンネル * @type {string} * @memberof OIDCTraqUserInfo */ 'home_channel': string | null; } /** * 自分のユーザー詳細情報 * @export * @interface OIDCUserInfo */ interface OIDCUserInfo { /** * ユーザーUUID * @type {string} * @memberof OIDCUserInfo */ 'sub': string; /** * ユーザー名 * @type {string} * @memberof OIDCUserInfo */ 'name': string; /** * ユーザー名 * @type {string} * @memberof OIDCUserInfo */ 'preferred_username': string; /** * アイコン画像URL * @type {string} * @memberof OIDCUserInfo */ 'picture': string; /** * 更新日時 * @type {number} * @memberof OIDCUserInfo */ 'updated_at'?: number; /** * * @type {OIDCTraqUserInfo} * @memberof OIDCUserInfo */ 'traq'?: OIDCTraqUserInfo; } /** * OGPの情報 * @export * @interface Ogp */ interface Ogp { /** * * @type {string} * @memberof Ogp */ 'type': string; /** * * @type {string} * @memberof Ogp */ 'title': string; /** * * @type {string} * @memberof Ogp */ 'url': string; /** * * @type {Array} * @memberof Ogp */ 'images': Array; /** * * @type {string} * @memberof Ogp */ 'description': string; /** * * @type {Array} * @memberof Ogp */ 'videos': Array; } /** * OGPに含まれる画像の情報 * @export * @interface OgpMedia */ interface OgpMedia { /** * * @type {string} * @memberof OgpMedia */ 'url': string; /** * * @type {string} * @memberof OgpMedia */ 'secureUrl': string | null; /** * * @type {string} * @memberof OgpMedia */ 'type': string | null; /** * * @type {number} * @memberof OgpMedia */ 'width': number | null; /** * * @type {number} * @memberof OgpMedia */ 'height': number | null; } /** * 親チャンネル変更イベント * @export * @interface ParentChangedEvent */ interface ParentChangedEvent { /** * 変更者UUID * @type {string} * @memberof ParentChangedEvent */ 'userId': string; /** * 変更前親チャンネルUUID * @type {string} * @memberof ParentChangedEvent */ 'before': string; /** * 変更後親チャンネルUUID * @type {string} * @memberof ParentChangedEvent */ 'after': string; } /** * BOT情報変更リクエスト * @export * @interface PatchBotRequest */ interface PatchBotRequest { /** * BOTユーザー表示名 * @type {string} * @memberof PatchBotRequest */ 'displayName'?: string; /** * BOTの説明 * @type {string} * @memberof PatchBotRequest */ 'description'?: string; /** * 特権 * @type {boolean} * @memberof PatchBotRequest */ 'privileged'?: boolean; /** * * @type {BotMode} * @memberof PatchBotRequest */ 'mode'?: BotMode; /** * BOTサーバーエンドポイント * @type {string} * @memberof PatchBotRequest */ 'endpoint'?: string; /** * 移譲先の開発者UUID * @type {string} * @memberof PatchBotRequest */ 'developerId'?: string; /** * 購読するイベント * @type {Array} * @memberof PatchBotRequest */ 'subscribeEvents'?: Array; /** * 自己紹介(biography) * @type {string} * @memberof PatchBotRequest */ 'bio'?: string; } /** * チャンネル情報変更リクエスト * @export * @interface PatchChannelRequest */ interface PatchChannelRequest { /** * チャンネル名 * @type {string} * @memberof PatchChannelRequest */ 'name'?: string; /** * アーカイブされているかどうか * @type {boolean} * @memberof PatchChannelRequest */ 'archived'?: boolean; /** * 強制通知チャンネルかどうか * @type {boolean} * @memberof PatchChannelRequest */ 'force'?: boolean; /** * 親チャンネルUUID * @type {string} * @memberof PatchChannelRequest */ 'parent'?: string; } /** * チャンネル購読者編集リクエスト * @export * @interface PatchChannelSubscribersRequest */ interface PatchChannelSubscribersRequest { /** * 通知をオンにするユーザーのUUID配列 * @type {Array} * @memberof PatchChannelSubscribersRequest */ 'on'?: Array; /** * 通知をオフにするユーザーのUUID配列 * @type {Array} * @memberof PatchChannelSubscribersRequest */ 'off'?: Array; } /** * OAuth2クライアント情報変更リクエスト * @export * @interface PatchClientRequest */ interface PatchClientRequest { /** * クライアント名 * @type {string} * @memberof PatchClientRequest */ 'name'?: string; /** * 説明 * @type {string} * @memberof PatchClientRequest */ 'description'?: string; /** * コールバックURL * @type {string} * @memberof PatchClientRequest */ 'callbackUrl'?: string; /** * クライアント開発者UUID * @type {string} * @memberof PatchClientRequest */ 'developerId'?: string; /** * confidential client なら true, public client なら false * @type {boolean} * @memberof PatchClientRequest */ 'confidential'?: boolean; } /** * クリップフォルダ情報編集リクエスト * @export * @interface PatchClipFolderRequest */ interface PatchClipFolderRequest { /** * フォルダ名 * @type {string} * @memberof PatchClipFolderRequest */ 'name'?: string; /** * 説明 * @type {string} * @memberof PatchClipFolderRequest */ 'description'?: string; } /** * ユーザーグループメンバー編集リクエスト * @export * @interface PatchGroupMemberRequest */ interface PatchGroupMemberRequest { /** * ユーザーの役割 * @type {string} * @memberof PatchGroupMemberRequest */ 'role': string; } /** * 自分のユーザー情報変更リクエスト * @export * @interface PatchMeRequest */ interface PatchMeRequest { /** * 新しい表示名 * @type {string} * @memberof PatchMeRequest */ 'displayName'?: string; /** * TwitterID * @type {string} * @memberof PatchMeRequest */ 'twitterId'?: string; /** * 自己紹介(biography) * @type {string} * @memberof PatchMeRequest */ 'bio'?: string; /** * ホームチャンネルのUUID `00000000-0000-0000-0000-000000000000`を指定すると、ホームチャンネルが`null`に設定されます * @type {string} * @memberof PatchMeRequest */ 'homeChannel'?: string; } /** * スタンプパレット情報変更リクエスト * @export * @interface PatchStampPaletteRequest */ interface PatchStampPaletteRequest { /** * パレット名 * @type {string} * @memberof PatchStampPaletteRequest */ 'name'?: string; /** * 説明 * @type {string} * @memberof PatchStampPaletteRequest */ 'description'?: string; /** * パレット内のスタンプUUIDの配列 * @type {Set} * @memberof PatchStampPaletteRequest */ 'stamps'?: Set; } /** * スタンプ情報変更リクエスト * @export * @interface PatchStampRequest */ interface PatchStampRequest { /** * スタンプ名 * @type {string} * @memberof PatchStampRequest */ 'name'?: string; /** * 作成者UUID * @type {string} * @memberof PatchStampRequest */ 'creatorId'?: string; } /** * ユーザーグループ編集リクエスト * @export * @interface PatchUserGroupRequest */ interface PatchUserGroupRequest { /** * グループ名 * @type {string} * @memberof PatchUserGroupRequest */ 'name'?: string; /** * グループ説明 * @type {string} * @memberof PatchUserGroupRequest */ 'description'?: string; /** * グループタイプ * @type {string} * @memberof PatchUserGroupRequest */ 'type'?: string; } /** * ユーザー情報編集リクエスト * @export * @interface PatchUserRequest */ interface PatchUserRequest { /** * 新しい表示名 * @type {string} * @memberof PatchUserRequest */ 'displayName'?: string; /** * TwitterID * @type {string} * @memberof PatchUserRequest */ 'twitterId'?: string; /** * * @type {UserAccountState} * @memberof PatchUserRequest */ 'state'?: UserAccountState; /** * ユーザーロール * @type {string} * @memberof PatchUserRequest */ 'role'?: string; } /** * ユーザーのタグの編集リクエスト * @export * @interface PatchUserTagRequest */ interface PatchUserTagRequest { /** * タグのロック状態 * @type {boolean} * @memberof PatchUserTagRequest */ 'isLocked': boolean; } /** * Webhook情報変更リクエスト * @export * @interface PatchWebhookRequest */ interface PatchWebhookRequest { /** * Webhookユーザー表示名 * @type {string} * @memberof PatchWebhookRequest */ 'name'?: string; /** * 説明 * @type {string} * @memberof PatchWebhookRequest */ 'description'?: string; /** * デフォルトの投稿先チャンネルUUID * @type {string} * @memberof PatchWebhookRequest */ 'channelId'?: string; /** * Webhookシークレット * @type {string} * @memberof PatchWebhookRequest */ 'secret'?: string; /** * 移譲先のユーザーUUID * @type {string} * @memberof PatchWebhookRequest */ 'ownerId'?: string; } /** * ピン情報(メッセージ本体付き) * @export * @interface Pin */ interface Pin { /** * ピン留めしたユーザーUUID * @type {string} * @memberof Pin */ 'userId': string; /** * ピン留めされた日時 * @type {string} * @memberof Pin */ 'pinnedAt': string; /** * * @type {Message} * @memberof Pin */ 'message': Message; } /** * ピン追加イベント * @export * @interface PinAddedEvent */ interface PinAddedEvent { /** * 変更者UUID * @type {string} * @memberof PinAddedEvent */ 'userId': string; /** * メッセージUUID * @type {string} * @memberof PinAddedEvent */ 'messageId': string; } /** * ピン削除イベント * @export * @interface PinRemovedEvent */ interface PinRemovedEvent { /** * 変更者UUID * @type {string} * @memberof PinRemovedEvent */ 'userId': string; /** * メッセージUUID * @type {string} * @memberof PinRemovedEvent */ 'messageId': string; } /** * BOTチャンネル参加リクエスト * @export * @interface PostBotActionJoinRequest */ interface PostBotActionJoinRequest { /** * チャンネルUUID * @type {string} * @memberof PostBotActionJoinRequest */ 'channelId': string; } /** * BOTチャンネル退出リクエスト * @export * @interface PostBotActionLeaveRequest */ interface PostBotActionLeaveRequest { /** * チャンネルUUID * @type {string} * @memberof PostBotActionLeaveRequest */ 'channelId': string; } /** * BOT作成リクエスト * @export * @interface PostBotRequest */ interface PostBotRequest { /** * BOTユーザーID 自動的に接頭辞\"BOT_\"が付与されます * @type {string} * @memberof PostBotRequest */ 'name': string; /** * BOTユーザー表示名 * @type {string} * @memberof PostBotRequest */ 'displayName': string; /** * BOTの説明 * @type {string} * @memberof PostBotRequest */ 'description': string; /** * * @type {BotMode} * @memberof PostBotRequest */ 'mode': BotMode; /** * BOTサーバーエンドポイント BOT動作モードがHTTPの場合必須です * @type {string} * @memberof PostBotRequest */ 'endpoint'?: string; } /** * チャンネル作成リクエスト * @export * @interface PostChannelRequest */ interface PostChannelRequest { /** * チャンネル名 * @type {string} * @memberof PostChannelRequest */ 'name': string; /** * 親チャンネルのUUID ルートに作成する場合はnullを指定 * @type {string} * @memberof PostChannelRequest */ 'parent': string | null; } /** * OAuth2クライアント作成リクエスト * @export * @interface PostClientRequest */ interface PostClientRequest { /** * クライアント名 * @type {string} * @memberof PostClientRequest */ 'name': string; /** * コールバックURL * @type {string} * @memberof PostClientRequest */ 'callbackUrl': string; /** * 要求スコープの配列 * @type {Array} * @memberof PostClientRequest */ 'scopes': Array; /** * 説明 * @type {string} * @memberof PostClientRequest */ 'description': string; /** * confidential client なら true, public cleint なら false * @type {boolean} * @memberof PostClientRequest */ 'confidential'?: boolean; } /** * クリップ追加リクエスト * @export * @interface PostClipFolderMessageRequest */ interface PostClipFolderMessageRequest { /** * メッセージUUID * @type {string} * @memberof PostClipFolderMessageRequest */ 'messageId': string; } /** * クリップフォルダ作成リクエスト * @export * @interface PostClipFolderRequest */ interface PostClipFolderRequest { /** * フォルダ名 * @type {string} * @memberof PostClipFolderRequest */ 'name': string; /** * 説明 * @type {string} * @memberof PostClipFolderRequest */ 'description': string; } /** * POST /users/me/ex-accounts/link 用リクエストボディ * @export * @interface PostLinkExternalAccount */ interface PostLinkExternalAccount { /** * 外部サービス名 * @type {string} * @memberof PostLinkExternalAccount */ 'providerName': string; } /** * ログインリクエスト * @export * @interface PostLoginRequest */ interface PostLoginRequest { /** * ユーザー名 * @type {string} * @memberof PostLoginRequest */ 'name': string; /** * パスワード * @type {string} * @memberof PostLoginRequest */ 'password': string; } /** * メッセージ投稿リクエスト * @export * @interface PostMessageRequest */ interface PostMessageRequest { /** * メッセージ本文 * @type {string} * @memberof PostMessageRequest */ 'content': string; /** * メンション・チャンネルリンクを自動埋め込みするか * @type {boolean} * @memberof PostMessageRequest */ 'embed'?: boolean; /** * メッセージ送信の確認に使うことができる任意の識別子(投稿でのみ使用可) * @type {string} * @memberof PostMessageRequest */ 'nonce'?: string; } /** * スタンプを押すリクエスト * @export * @interface PostMessageStampRequest */ interface PostMessageStampRequest { /** * 押す数 * @type {number} * @memberof PostMessageStampRequest */ 'count': number; } /** * FCMデバイス登録リクエスト * @export * @interface PostMyFCMDeviceRequest */ interface PostMyFCMDeviceRequest { /** * FCMのデバイストークン * @type {string} * @memberof PostMyFCMDeviceRequest */ 'token': string; } /** * スタンプパレット作成リクエスト * @export * @interface PostStampPaletteRequest */ interface PostStampPaletteRequest { /** * パレット内のスタンプのUUID配列 * @type {Set} * @memberof PostStampPaletteRequest */ 'stamps': Set; /** * パレット名 * @type {string} * @memberof PostStampPaletteRequest */ 'name': string; /** * 説明 * @type {string} * @memberof PostStampPaletteRequest */ 'description': string; } /** * スター追加リクエスト * @export * @interface PostStarRequest */ interface PostStarRequest { /** * チャンネルUUID * @type {string} * @memberof PostStarRequest */ 'channelId': string; } /** * POST /users/me/ex-accounts/unlink 用リクエストボディ * @export * @interface PostUnlinkExternalAccount */ interface PostUnlinkExternalAccount { /** * 外部サービス名 * @type {string} * @memberof PostUnlinkExternalAccount */ 'providerName': string; } /** * グループ管理者追加リクエスト * @export * @interface PostUserGroupAdminRequest */ interface PostUserGroupAdminRequest { /** * 追加するユーザーのUUID * @type {string} * @memberof PostUserGroupAdminRequest */ 'id': string; } /** * ユーザーグループ作成リクエスト * @export * @interface PostUserGroupRequest */ interface PostUserGroupRequest { /** * グループ名 * @type {string} * @memberof PostUserGroupRequest */ 'name': string; /** * 説明 * @type {string} * @memberof PostUserGroupRequest */ 'description': string; /** * グループタイプ * @type {string} * @memberof PostUserGroupRequest */ 'type': string; } /** * ユーザー登録リクエスト * @export * @interface PostUserRequest */ interface PostUserRequest { /** * ユーザー名 * @type {string} * @memberof PostUserRequest */ 'name': string; /** * パスワード * @type {string} * @memberof PostUserRequest */ 'password'?: string; } /** * ユーザータグ追加リクエスト * @export * @interface PostUserTagRequest */ interface PostUserTagRequest { /** * タグ文字列 * @type {string} * @memberof PostUserTagRequest */ 'tag': string; } /** * skyway用認証リクエスト * @export * @interface PostWebRTCAuthenticateRequest */ interface PostWebRTCAuthenticateRequest { /** * ピアID * @type {string} * @memberof PostWebRTCAuthenticateRequest */ 'peerId': string; } /** * Webhook作成リクエスト * @export * @interface PostWebhookRequest */ interface PostWebhookRequest { /** * Webhookユーザーの表示名 * @type {string} * @memberof PostWebhookRequest */ 'name': string; /** * 説明 * @type {string} * @memberof PostWebhookRequest */ 'description': string; /** * デフォルトの投稿先チャンネルUUID * @type {string} * @memberof PostWebhookRequest */ 'channelId': string; /** * Webhookシークレット * @type {string} * @memberof PostWebhookRequest */ 'secret': string; } /** * チャンネル購読レベル変更リクエスト * @export * @interface PutChannelSubscribeLevelRequest */ interface PutChannelSubscribeLevelRequest { /** * * @type {ChannelSubscribeLevel} * @memberof PutChannelSubscribeLevelRequest */ 'level': ChannelSubscribeLevel; } /** * 通知をオンにするユーザーのUUID配列 * @export * @interface PutChannelSubscribersRequest */ interface PutChannelSubscribersRequest { /** * 通知をオンにするユーザーのUUID配列 * @type {Array} * @memberof PutChannelSubscribersRequest */ 'on': Array; } /** * チャンネルトピック編集リクエスト * @export * @interface PutChannelTopicRequest */ interface PutChannelTopicRequest { /** * トピック * @type {string} * @memberof PutChannelTopicRequest */ 'topic': string; } /** * パスワード変更リクエスト * @export * @interface PutMyPasswordRequest */ interface PutMyPasswordRequest { /** * 現在のパスワード * @type {string} * @memberof PutMyPasswordRequest */ 'password': string; /** * 新しいパスワード * @type {string} * @memberof PutMyPasswordRequest */ 'newPassword': string; } /** * メッセージ引用通知設定リクエスト * @export * @interface PutNotifyCitationRequest */ interface PutNotifyCitationRequest { /** * メッセージ引用通知の設定情報 * @type {boolean} * @memberof PutNotifyCitationRequest */ 'notifyCitation': boolean; } /** * ユーザーパスワード変更リクエスト * @export * @interface PutUserPasswordRequest */ interface PutUserPasswordRequest { /** * 新しいパスワード * @type {string} * @memberof PutUserPasswordRequest */ 'newPassword': string; } /** * * @export * @interface QallEndpointResponse */ interface QallEndpointResponse { /** * LiveKitのエンドポイント * @type {string} * @memberof QallEndpointResponse */ 'endpoint': string; } /** * * @export * @interface QallMetadataRequest */ interface QallMetadataRequest { /** * ルームに関連付けられたカスタム属性 * @type {string} * @memberof QallMetadataRequest */ 'metadata'?: string; } /** * * @export * @interface QallMetadataResponse */ interface QallMetadataResponse { /** * ルームに関連付けられたカスタム属性 * @type {string} * @memberof QallMetadataResponse */ 'metadata'?: string; } /** * ルーム内の参加者一覧 * @export * @interface QallParticipant */ interface QallParticipant { /** * ユーザーID_RandomUUID * @type {string} * @memberof QallParticipant */ 'identity'?: string; /** * 表示名 * @type {string} * @memberof QallParticipant */ 'name'?: string; /** * 参加した時刻 * @type {string} * @memberof QallParticipant */ 'joinedAt'?: string; /** * ユーザーに関連付けられたカスタム属性 * @type {{ [key: string]: string; }} * @memberof QallParticipant */ 'attributes'?: { [key: string]: string; }; /** * 発言権限 * @type {boolean} * @memberof QallParticipant */ 'canPublish'?: boolean; } /** * * @export * @interface QallParticipantRequest */ interface QallParticipantRequest { /** * * @type {Array} * @memberof QallParticipantRequest */ 'users': Array; } /** * * @export * @interface QallParticipantRequestUsersInner */ interface QallParticipantRequestUsersInner { /** * ユーザーID * @type {string} * @memberof QallParticipantRequestUsersInner */ 'userId'?: string; /** * 発言権限 * @type {boolean} * @memberof QallParticipantRequestUsersInner */ 'canPublish'?: boolean; } /** * * @export * @interface QallParticipantResponse */ interface QallParticipantResponse { /** * * @type {Array} * @memberof QallParticipantResponse */ 'results'?: Array; } /** * * @export * @interface QallParticipantResponseResultsInner */ interface QallParticipantResponseResultsInner { /** * 対象参加者ID * @type {string} * @memberof QallParticipantResponseResultsInner */ 'participantId'?: string; /** * success もしくは error * @type {string} * @memberof QallParticipantResponseResultsInner */ 'status'?: string; /** * エラーがある場合の詳細 * @type {string} * @memberof QallParticipantResponseResultsInner */ 'errorMessage'?: string; } /** * Qallのルーム状態が変更された * @export * @interface QallRoomStateChangedEvent */ interface QallRoomStateChangedEvent { /** * * @type {Array} * @memberof QallRoomStateChangedEvent */ 'roomStates': Array; } /** * * @export * @interface QallRoomStateChangedEventRoomStatesInner */ interface QallRoomStateChangedEventRoomStatesInner { /** * ルームのID * @type {string} * @memberof QallRoomStateChangedEventRoomStatesInner */ 'roomId': string; /** * * @type {Array} * @memberof QallRoomStateChangedEventRoomStatesInner */ 'participants': Array; /** * ウェビナールームかどうか * @type {boolean} * @memberof QallRoomStateChangedEventRoomStatesInner */ 'isWebinar': boolean; /** * ルームに関連付けられたカスタム属性 * @type {string} * @memberof QallRoomStateChangedEventRoomStatesInner */ 'metadata'?: string; } /** * * @export * @interface QallRoomStateChangedEventRoomStatesInnerParticipantsInner */ interface QallRoomStateChangedEventRoomStatesInnerParticipantsInner { /** * ユーザーID_RandomUUID * @type {string} * @memberof QallRoomStateChangedEventRoomStatesInnerParticipantsInner */ 'identity': string; /** * 表示名 * @type {string} * @memberof QallRoomStateChangedEventRoomStatesInnerParticipantsInner */ 'name': string; /** * 参加した時刻 * @type {string} * @memberof QallRoomStateChangedEventRoomStatesInnerParticipantsInner */ 'joinedAt': string; /** * * @type {{ [key: string]: string; }} * @memberof QallRoomStateChangedEventRoomStatesInnerParticipantsInner */ 'attributes'?: { [key: string]: string; }; /** * 発言権限 * @type {boolean} * @memberof QallRoomStateChangedEventRoomStatesInnerParticipantsInner */ 'canPublish': boolean; } /** * * @export * @interface QallRoomWithParticipants */ interface QallRoomWithParticipants { /** * ルームのID * @type {string} * @memberof QallRoomWithParticipants */ 'roomId': string; /** * * @type {Array} * @memberof QallRoomWithParticipants */ 'participants': Array; /** * ウェビナールームかどうか * @type {boolean} * @memberof QallRoomWithParticipants */ 'isWebinar'?: boolean; /** * ルームに関連付けられたカスタム属性 * @type {string} * @memberof QallRoomWithParticipants */ 'metadata'?: string; } /** * * @export * @interface QallRoomsListResponse */ interface QallRoomsListResponse extends Array { } /** * Qallのサウンドボードアイテムが作成された * @export * @interface QallSoundboardItemCreatedEvent */ interface QallSoundboardItemCreatedEvent { /** * 作成されたサウンドボードアイテムのId * @type {string} * @memberof QallSoundboardItemCreatedEvent */ 'soundId': string; /** * 作成されたサウンドボードアイテムの名前 * @type {string} * @memberof QallSoundboardItemCreatedEvent */ 'name': string; /** * 作成者のId * @type {string} * @memberof QallSoundboardItemCreatedEvent */ 'creatorId': string; } /** * Qallのサウンドボードアイテムが削除された * @export * @interface QallSoundboardItemDeletedEvent */ interface QallSoundboardItemDeletedEvent { /** * 削除されたサウンドボードアイテムのId * @type {string} * @memberof QallSoundboardItemDeletedEvent */ 'soundId': string; } /** * * @export * @interface QallTokenResponse */ interface QallTokenResponse { /** * LiveKit用のJWTトークン * @type {string} * @memberof QallTokenResponse */ 'token': string; } /** * * @export * @interface Session */ interface Session { /** * 状態 * @type {string} * @memberof Session */ 'state': string; /** * セッションID * @type {string} * @memberof Session */ 'sessionId': string; } /** * * @export * @interface SoundboardItem */ interface SoundboardItem { /** * サーバが発行したサウンドID * @type {string} * @memberof SoundboardItem */ 'soundId': string; /** * ユーザが指定した表示用のサウンド名 * @type {string} * @memberof SoundboardItem */ 'soundName': string; /** * 任意のスタンプID等、サウンドに紐づく拡張情報 * @type {string} * @memberof SoundboardItem */ 'stampId': string; /** * 作成者のユーザID * @type {string} * @memberof SoundboardItem */ 'creatorId': string; } /** * * @export * @interface SoundboardListResponse */ interface SoundboardListResponse extends Array { } /** * * @export * @interface SoundboardPlayRequest */ interface SoundboardPlayRequest { /** * サウンドID (DB登録済み) * @type {string} * @memberof SoundboardPlayRequest */ 'soundId': string; /** * 再生させたいルームのUUID * @type {string} * @memberof SoundboardPlayRequest */ 'roomName': string; } /** * * @export * @interface SoundboardPlayResponse */ interface SoundboardPlayResponse { /** * 作成された Ingress のID * @type {string} * @memberof SoundboardPlayResponse */ 'ingressId': string; /** * 作成された Ingress のストリームURL等 * @type {string} * @memberof SoundboardPlayResponse */ 'url'?: string; /** * RTMP配信の場合のstream key * @type {string} * @memberof SoundboardPlayResponse */ 'streamKey'?: string; } /** * * @export * @interface SoundboardUploadResponse */ interface SoundboardUploadResponse { /** * 登録されたサウンドID (ファイル名) * @type {string} * @memberof SoundboardUploadResponse */ 'soundId': string; } /** * スタンプ情報 * @export * @interface Stamp */ interface Stamp { /** * スタンプUUID * @type {string} * @memberof Stamp */ 'id': string; /** * スタンプ名 * @type {string} * @memberof Stamp */ 'name': string; /** * 作成者UUID * @type {string} * @memberof Stamp */ 'creatorId': string; /** * 作成日時 * @type {string} * @memberof Stamp */ 'createdAt': string; /** * 更新日時 * @type {string} * @memberof Stamp */ 'updatedAt': string; /** * ファイルUUID * @type {string} * @memberof Stamp */ 'fileId': string; /** * Unicode絵文字か * @type {boolean} * @memberof Stamp */ 'isUnicode': boolean; } /** * スタンプ履歴の1項目 * @export * @interface StampHistoryEntry */ interface StampHistoryEntry { /** * スタンプUUID * @type {string} * @memberof StampHistoryEntry */ 'stampId': string; /** * 使用日時 * @type {string} * @memberof StampHistoryEntry */ 'datetime': string; } /** * スタンプパレット情報 * @export * @interface StampPalette */ interface StampPalette { /** * スタンプパレットUUID * @type {string} * @memberof StampPalette */ 'id': string; /** * パレット名 * @type {string} * @memberof StampPalette */ 'name': string; /** * パレット内のスタンプのUUID配列 * @type {Set} * @memberof StampPalette */ 'stamps': Set; /** * 作成者UUID * @type {string} * @memberof StampPalette */ 'creatorId': string; /** * パレット作成日時 * @type {string} * @memberof StampPalette */ 'createdAt': string; /** * パレット更新日時 * @type {string} * @memberof StampPalette */ 'updatedAt': string; /** * パレット説明 * @type {string} * @memberof StampPalette */ 'description': string; } /** * スタンプ統計情報 * @export * @interface StampStats */ interface StampStats { /** * スタンプ使用総数(同じユーザによって同じメッセージに貼られたものは複数カウントしない) * @type {number} * @memberof StampStats */ 'count': number; /** * スタンプ使用総数(全てカウント) * @type {number} * @memberof StampStats */ 'totalCount': number; } /** * スタンプ情報とサムネイルの有無 * @export * @interface StampWithThumbnail */ interface StampWithThumbnail { /** * スタンプUUID * @type {string} * @memberof StampWithThumbnail */ 'id': string; /** * スタンプ名 * @type {string} * @memberof StampWithThumbnail */ 'name': string; /** * 作成者UUID * @type {string} * @memberof StampWithThumbnail */ 'creatorId': string; /** * 作成日時 * @type {string} * @memberof StampWithThumbnail */ 'createdAt': string; /** * 更新日時 * @type {string} * @memberof StampWithThumbnail */ 'updatedAt': string; /** * ファイルUUID * @type {string} * @memberof StampWithThumbnail */ 'fileId': string; /** * Unicode絵文字か * @type {boolean} * @memberof StampWithThumbnail */ 'isUnicode': boolean; /** * サムネイルの有無 * @type {boolean} * @memberof StampWithThumbnail */ 'hasThumbnail': boolean; } /** * 購読者変更イベント * @export * @interface SubscribersChangedEvent */ interface SubscribersChangedEvent { /** * 変更者UUID * @type {string} * @memberof SubscribersChangedEvent */ 'userId': string; /** * オンにされたユーザーのUUID配列 * @type {Array} * @memberof SubscribersChangedEvent */ 'on': Array; /** * オフにされたユーザーのUUID配列 * @type {Array} * @memberof SubscribersChangedEvent */ 'off': Array; } /** * タグ情報 * @export * @interface Tag */ interface Tag { /** * タグUUID * @type {string} * @memberof Tag */ 'id': string; /** * タグ文字列 * @type {string} * @memberof Tag */ 'tag': string; /** * タグがつけられているユーザーのUUID配列 * @type {Array} * @memberof Tag */ 'users': Array; } /** * * @export * @interface ThumbnailInfo */ interface ThumbnailInfo { /** * * @type {ThumbnailType} * @memberof ThumbnailInfo */ 'type': ThumbnailType; /** * MIMEタイプ * @type {string} * @memberof ThumbnailInfo */ 'mime': string; /** * サムネイル幅 * @type {number} * @memberof ThumbnailInfo */ 'width'?: number; /** * サムネイル高さ * @type {number} * @memberof ThumbnailInfo */ 'height'?: number; } /** * サムネイル画像のタイプ * @export * @enum {string} */ declare const ThumbnailType: { /** * アップロード画像に対して生成される通常のサムネイル */ readonly Image: "image"; /** * アップロード音声ファイルに対して生成される波形画像 */ readonly Waveform: "waveform"; }; type ThumbnailType = typeof ThumbnailType[keyof typeof ThumbnailType]; /** * トピック変更イベント * @export * @interface TopicChangedEvent */ interface TopicChangedEvent { /** * 変更者UUID * @type {string} * @memberof TopicChangedEvent */ 'userId': string; /** * 変更前トピック * @type {string} * @memberof TopicChangedEvent */ 'before': string; /** * 変更後トピック * @type {string} * @memberof TopicChangedEvent */ 'after': string; } /** * 未読チャンネル情報 * @export * @interface UnreadChannel */ interface UnreadChannel { /** * チャンネルUUID * @type {string} * @memberof UnreadChannel */ 'channelId': string; /** * 未読メッセージ数 * @type {number} * @memberof UnreadChannel */ 'count': number; /** * 自分宛てメッセージが含まれているかどうか * @type {boolean} * @memberof UnreadChannel */ 'noticeable': boolean; /** * チャンネルの最古の未読メッセージの日時 * @type {string} * @memberof UnreadChannel */ 'since': string; /** * チャンネルの最新の未読メッセージの日時 * @type {string} * @memberof UnreadChannel */ 'updatedAt': string; /** * そのチャンネルの未読の中で最も古いメッセージのid * @type {string} * @memberof UnreadChannel */ 'oldestMessageId': string; } /** * ユーザー情報 * @export * @interface User */ interface User { /** * ユーザーUUID * @type {string} * @memberof User */ 'id': string; /** * ユーザー名 * @type {string} * @memberof User */ 'name': string; /** * ユーザー表示名 * @type {string} * @memberof User */ 'displayName': string; /** * アイコンファイルUUID * @type {string} * @memberof User */ 'iconFileId': string; /** * BOTかどうか * @type {boolean} * @memberof User */ 'bot': boolean; /** * * @type {UserAccountState} * @memberof User */ 'state': UserAccountState; /** * 更新日時 * @type {string} * @memberof User */ 'updatedAt': string; } /** * ユーザーアカウント状態 0: 停止 1: 有効 2: 一時停止 * @export * @enum {string} */ declare const UserAccountState: { /** * 停止 */ readonly deactivated: 0; /** * 有効 */ readonly active: 1; /** * 一時停止 */ readonly suspended: 2; }; type UserAccountState = typeof UserAccountState[keyof typeof UserAccountState]; /** * ユーザー詳細情報 * @export * @interface UserDetail */ interface UserDetail { /** * ユーザーUUID * @type {string} * @memberof UserDetail */ 'id': string; /** * * @type {UserAccountState} * @memberof UserDetail */ 'state': UserAccountState; /** * BOTかどうか * @type {boolean} * @memberof UserDetail */ 'bot': boolean; /** * アイコンファイルUUID * @type {string} * @memberof UserDetail */ 'iconFileId': string; /** * ユーザー表示名 * @type {string} * @memberof UserDetail */ 'displayName': string; /** * ユーザー名 * @type {string} * @memberof UserDetail */ 'name': string; /** * Twitter ID * @type {string} * @memberof UserDetail */ 'twitterId': string; /** * 最終オンライン日時 * @type {string} * @memberof UserDetail */ 'lastOnline': string | null; /** * 更新日時 * @type {string} * @memberof UserDetail */ 'updatedAt': string; /** * タグリスト * @type {Array} * @memberof UserDetail */ 'tags': Array; /** * 所属グループのUUIDの配列 * @type {Array} * @memberof UserDetail */ 'groups': Array; /** * 自己紹介(biography) * @type {string} * @memberof UserDetail */ 'bio': string; /** * ホームチャンネル * @type {string} * @memberof UserDetail */ 'homeChannel': string | null; } /** * ユーザーグループ * @export * @interface UserGroup */ interface UserGroup { /** * グループUUID * @type {string} * @memberof UserGroup */ 'id': string; /** * グループ名 * @type {string} * @memberof UserGroup */ 'name': string; /** * グループ説明 * @type {string} * @memberof UserGroup */ 'description': string; /** * グループタイプ * @type {string} * @memberof UserGroup */ 'type': string; /** * グループアイコンUUID * @type {string} * @memberof UserGroup */ 'icon': string; /** * グループメンバーの配列 * @type {Array} * @memberof UserGroup */ 'members': Array; /** * 作成日時 * @type {string} * @memberof UserGroup */ 'createdAt': string; /** * 更新日時 * @type {string} * @memberof UserGroup */ 'updatedAt': string; /** * グループ管理者のUUIDの配列 * @type {Array} * @memberof UserGroup */ 'admins': Array; } /** * ユーザーグループメンバー * @export * @interface UserGroupMember */ interface UserGroupMember { /** * ユーザーUUID * @type {string} * @memberof UserGroupMember */ 'id': string; /** * ユーザーの役割 * @type {string} * @memberof UserGroupMember */ 'role': string; } /** * ユーザーグループメンバーの配列 * @export * @interface UserGroupMembers */ interface UserGroupMembers extends Array { } /** * ユーザー権限 * @export * @enum {string} */ declare const UserPermission: { readonly GetWebhook: "get_webhook"; readonly CreateWebhook: "create_webhook"; readonly EditWebhook: "edit_webhook"; readonly DeleteWebhook: "delete_webhook"; readonly AccessOthersWebhook: "access_others_webhook"; readonly GetBot: "get_bot"; readonly CreateBot: "create_bot"; readonly EditBot: "edit_bot"; readonly DeleteBot: "delete_bot"; readonly AccessOthersBot: "access_others_bot"; readonly BotActionJoinChannel: "bot_action_join_channel"; readonly BotActionLeaveChannel: "bot_action_leave_channel"; readonly CreateChannel: "create_channel"; readonly GetChannel: "get_channel"; readonly EditChannel: "edit_channel"; readonly DeleteChannel: "delete_channel"; readonly ChangeParentChannel: "change_parent_channel"; readonly EditChannelTopic: "edit_channel_topic"; readonly GetChannelStar: "get_channel_star"; readonly EditChannelStar: "edit_channel_star"; readonly GetMyTokens: "get_my_tokens"; readonly RevokeMyToken: "revoke_my_token"; readonly GetClients: "get_clients"; readonly CreateClient: "create_client"; readonly EditMyClient: "edit_my_client"; readonly DeleteMyClient: "delete_my_client"; readonly ManageOthersClient: "manage_others_client"; readonly UploadFile: "upload_file"; readonly DownloadFile: "download_file"; readonly DeleteFile: "delete_file"; readonly GetMessage: "get_message"; readonly PostMessage: "post_message"; readonly EditMessage: "edit_message"; readonly DeleteMessage: "delete_message"; readonly ReportMessage: "report_message"; readonly GetMessageReports: "get_message_reports"; readonly CreateMessagePin: "create_message_pin"; readonly DeleteMessagePin: "delete_message_pin"; readonly GetChannelSubscription: "get_channel_subscription"; readonly EditChannelSubscription: "edit_channel_subscription"; readonly ConnectNotificationStream: "connect_notification_stream"; readonly RegisterFCMDevice: "register_fcm_device"; readonly GetStamp: "get_stamp"; readonly CreateStamp: "create_stamp"; readonly EditStamp: "edit_stamp"; readonly EditStampCreatedByOthers: "edit_stamp_created_by_others"; readonly DeleteStamp: "delete_stamp"; readonly DeleteMyStamp: "delete_my_stamp"; readonly AddMessageStamp: "add_message_stamp"; readonly RemoveMessageStamp: "remove_message_stamp"; readonly GetMyStampHistory: "get_my_stamp_history"; readonly GetMyStampRecommendations: "get_my_stamp_recommendations"; readonly GetStampPalette: "get_stamp_palette"; readonly CreateStampPalette: "create_stamp_palette"; readonly EditStampPalette: "edit_stamp_palette"; readonly DeleteStampPalette: "delete_stamp_palette"; readonly GetUser: "get_user"; readonly RegisterUser: "register_user"; readonly GetMe: "get_me"; readonly GetOIDCUserInfo: "get_oidc_userinfo"; readonly EditMe: "edit_me"; readonly ChangeMyIcon: "change_my_icon"; readonly ChangeMyPassword: "change_my_password"; readonly EditOtherUsers: "edit_other_users"; readonly GetUserQRCode: "get_user_qr_code"; readonly GetUserTag: "get_user_tag"; readonly EditUserTag: "edit_user_tag"; readonly GetUserGroup: "get_user_group"; readonly CreateUserGroup: "create_user_group"; readonly CreateSpecialUserGroup: "create_special_user_group"; readonly EditUserGroup: "edit_user_group"; readonly DeleteUserGroup: "delete_user_group"; readonly AllUserGroupsAdmin: "edit_others_user_group"; readonly WebRTC: "web_rtc"; readonly GetMySessions: "get_my_sessions"; readonly DeleteMySessions: "delete_my_sessions"; readonly GetMyExternalAccount: "get_my_external_account"; readonly EditMyExternalAccount: "edit_my_external_account"; readonly GetUnread: "get_unread"; readonly DeleteUnread: "delete_unread"; readonly GetClipFolder: "get_clip_folder"; readonly CreateClipFolder: "create_clip_folder"; readonly EditClipFolder: "edit_clip_folder"; readonly DeleteClipFolder: "delete_clip_folder"; }; type UserPermission = typeof UserPermission[keyof typeof UserPermission]; /** * ユーザー設定の情報 * @export * @interface UserSettings */ interface UserSettings { /** * ユーザーUUID * @type {string} * @memberof UserSettings */ 'id': string; /** * メッセージ引用通知の設定情報 * @type {boolean} * @memberof UserSettings */ 'notifyCitation': boolean; } /** * ユーザー統計情報 * @export * @interface UserStats */ interface UserStats { /** * ユーザーの総投稿メッセージ数(削除されたものも含む) * @type {number} * @memberof UserStats */ 'totalMessageCount': number; /** * ユーザーのスタンプ統計情報 * @type {Array} * @memberof UserStats */ 'stamps': Array; /** * 統計情報日時 * @type {string} * @memberof UserStats */ 'datetime': string; } /** * ユーザーの特定スタンプ統計情報 * @export * @interface UserStatsStamp */ interface UserStatsStamp { /** * スタンプID * @type {string} * @memberof UserStatsStamp */ 'id': string; /** * スタンプ数(同一メッセージ上のものは複数カウントしない) * @type {number} * @memberof UserStatsStamp */ 'count': number; /** * スタンプ数(同一メッセージ上のものも複数カウントする) * @type {number} * @memberof UserStatsStamp */ 'total': number; } /** * ユーザーのチャンネル購読状態 * @export * @interface UserSubscribeState */ interface UserSubscribeState { /** * チャンネルUUID * @type {string} * @memberof UserSubscribeState */ 'channelId': string; /** * * @type {ChannelSubscribeLevel} * @memberof UserSubscribeState */ 'level': ChannelSubscribeLevel; } /** * ユーザータグ * @export * @interface UserTag */ interface UserTag { /** * タグUUID * @type {string} * @memberof UserTag */ 'tagId': string; /** * タグ文字列 * @type {string} * @memberof UserTag */ 'tag': string; /** * タグがロックされているか * @type {boolean} * @memberof UserTag */ 'isLocked': boolean; /** * タグ付与日時 * @type {string} * @memberof UserTag */ 'createdAt': string; /** * タグ更新日時 * @type {string} * @memberof UserTag */ 'updatedAt': string; } /** * バージョン・サーバーフラグ情報 * @export * @interface Version */ interface Version { /** * traQ(サーバー)リビジョン * @type {string} * @memberof Version */ 'revision': string; /** * traQ(サーバー)バージョン * @type {string} * @memberof Version */ 'version': string; /** * * @type {VersionFlags} * @memberof Version */ 'flags': VersionFlags; } /** * * @export * @interface VersionFlags */ interface VersionFlags { /** * 有効な外部ログインプロバイダ * @type {Array} * @memberof VersionFlags */ 'externalLogin': Array; /** * ユーザーが自身で新規登録(POST /api/v3/users)可能か * @type {boolean} * @memberof VersionFlags */ 'signUpAllowed': boolean; } /** * チャンネル可視状態変更イベント * @export * @interface VisibilityChangedEvent */ interface VisibilityChangedEvent { /** * 変更者UUID * @type {string} * @memberof VisibilityChangedEvent */ 'userId': string; /** * 変更後可視状態 * @type {boolean} * @memberof VisibilityChangedEvent */ 'visibility': boolean; } /** * skyway用認証リクエストリザルト * @export * @interface WebRTCAuthenticateResult */ interface WebRTCAuthenticateResult { /** * ピアID * @type {string} * @memberof WebRTCAuthenticateResult */ 'peerId': string; /** * TTL * @type {number} * @memberof WebRTCAuthenticateResult */ 'ttl': number; /** * タイムスタンプ * @type {number} * @memberof WebRTCAuthenticateResult */ 'timestamp': number; /** * 認証トークン * @type {string} * @memberof WebRTCAuthenticateResult */ 'authToken': string; } /** * WebRTC状態 * @export * @interface WebRTCUserState */ interface WebRTCUserState { /** * ユーザーUUID * @type {string} * @memberof WebRTCUserState */ 'userId': string; /** * チャンネルUUID * @type {string} * @memberof WebRTCUserState */ 'channelId': string; /** * セッションの配列 * @type {Array} * @memberof WebRTCUserState */ 'sessions': Array; } /** * WebRTC状態の配列 * @export * @interface WebRTCUserStates */ interface WebRTCUserStates extends Array { } /** * Webhook情報 * @export * @interface Webhook */ interface Webhook { /** * WebhookUUID * @type {string} * @memberof Webhook */ 'id': string; /** * WebhookユーザーUUID * @type {string} * @memberof Webhook */ 'botUserId': string; /** * Webhookユーザー表示名 * @type {string} * @memberof Webhook */ 'displayName': string; /** * 説明 * @type {string} * @memberof Webhook */ 'description': string; /** * セキュアWebhookかどうか * @type {boolean} * @memberof Webhook */ 'secure': boolean; /** * デフォルトの投稿先チャンネルUUID * @type {string} * @memberof Webhook */ 'channelId': string; /** * オーナーUUID * @type {string} * @memberof Webhook */ 'ownerId': string; /** * 作成日時 * @type {string} * @memberof Webhook */ 'createdAt': string; /** * 更新日時 * @type {string} * @memberof Webhook */ 'updatedAt': string; } /** * ActivityApi - axios parameter creator * @export */ declare const ActivityApiAxiosParamCreator: (configuration?: Configuration) => { /** * パブリックチャンネルの直近の投稿メッセージを作成日時の降順で取得します。 `all`が`true`でない場合、購読チャンネルのみのタイムラインを取得します * @summary アクテビティタイムラインを取得 * @param {number} [limit] 取得する件数 * @param {boolean} [all] 全てのチャンネルのタイムラインを取得する * @param {boolean} [perChannel] 同じチャンネルのメッセージは最新のもののみ取得するか * @param {*} [options] Override http request option. * @throws {RequiredError} */ getActivityTimeline: (limit?: number, all?: boolean, perChannel?: boolean, options?: AxiosRequestConfig) => Promise; /** * 現在オンラインな(SSEまたはWSが接続中)ユーザーのUUIDのリストを返します。 * @summary オンラインユーザーリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOnlineUsers: (options?: AxiosRequestConfig) => Promise; }; /** * ActivityApi - functional programming interface * @export */ declare const ActivityApiFp: (configuration?: Configuration) => { /** * パブリックチャンネルの直近の投稿メッセージを作成日時の降順で取得します。 `all`が`true`でない場合、購読チャンネルのみのタイムラインを取得します * @summary アクテビティタイムラインを取得 * @param {number} [limit] 取得する件数 * @param {boolean} [all] 全てのチャンネルのタイムラインを取得する * @param {boolean} [perChannel] 同じチャンネルのメッセージは最新のもののみ取得するか * @param {*} [options] Override http request option. * @throws {RequiredError} */ getActivityTimeline(limit?: number, all?: boolean, perChannel?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 現在オンラインな(SSEまたはWSが接続中)ユーザーのUUIDのリストを返します。 * @summary オンラインユーザーリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOnlineUsers(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; }; /** * ActivityApi - factory interface * @export */ declare const ActivityApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * パブリックチャンネルの直近の投稿メッセージを作成日時の降順で取得します。 `all`が`true`でない場合、購読チャンネルのみのタイムラインを取得します * @summary アクテビティタイムラインを取得 * @param {number} [limit] 取得する件数 * @param {boolean} [all] 全てのチャンネルのタイムラインを取得する * @param {boolean} [perChannel] 同じチャンネルのメッセージは最新のもののみ取得するか * @param {*} [options] Override http request option. * @throws {RequiredError} */ getActivityTimeline(limit?: number, all?: boolean, perChannel?: boolean, options?: any): AxiosPromise>; /** * 現在オンラインな(SSEまたはWSが接続中)ユーザーのUUIDのリストを返します。 * @summary オンラインユーザーリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOnlineUsers(options?: any): AxiosPromise>; }; /** * ActivityApi - object-oriented interface * @export * @class ActivityApi * @extends {BaseAPI} */ declare class ActivityApi extends BaseAPI { /** * パブリックチャンネルの直近の投稿メッセージを作成日時の降順で取得します。 `all`が`true`でない場合、購読チャンネルのみのタイムラインを取得します * @summary アクテビティタイムラインを取得 * @param {number} [limit] 取得する件数 * @param {boolean} [all] 全てのチャンネルのタイムラインを取得する * @param {boolean} [perChannel] 同じチャンネルのメッセージは最新のもののみ取得するか * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ActivityApi */ getActivityTimeline(limit?: number, all?: boolean, perChannel?: boolean, options?: AxiosRequestConfig): Promise>; /** * 現在オンラインな(SSEまたはWSが接続中)ユーザーのUUIDのリストを返します。 * @summary オンラインユーザーリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ActivityApi */ getOnlineUsers(options?: AxiosRequestConfig): Promise>; } /** * AuthenticationApi - axios parameter creator * @export */ declare const AuthenticationApiAxiosParamCreator: (configuration?: Configuration) => { /** * 自分に紐付けられている外部ログインアカウント一覧を取得します。 * @summary 外部ログインアカウント一覧を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyExternalAccounts: (options?: AxiosRequestConfig) => Promise; /** * 自分のログインセッションのリストを取得します。 * @summary 自分のログインセッションリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMySessions: (options?: AxiosRequestConfig) => Promise; /** * 自分に外部ログインアカウントを紐付けます。 指定した`providerName`がサーバー側で有効である必要があります。 リクエストが受理された場合、外部サービスの認証画面にリダイレクトされ、認証される必要があります。 * @summary 外部ログインアカウントを紐付ける * @param {PostLinkExternalAccount} [postLinkExternalAccount] * @param {*} [options] Override http request option. * @throws {RequiredError} */ linkExternalAccount: (postLinkExternalAccount?: PostLinkExternalAccount, options?: AxiosRequestConfig) => Promise; /** * ログインします。 * @summary ログイン * @param {string} [redirect] リダイレクト先 * @param {PostLoginRequest} [postLoginRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ login: (redirect?: string, postLoginRequest?: PostLoginRequest, options?: AxiosRequestConfig) => Promise; /** * ログアウトします。 * @summary ログアウト * @param {string} [redirect] リダイレクト先 * @param {boolean} [all] 全てのセッションでログアウトするかどうか * @param {*} [options] Override http request option. * @throws {RequiredError} */ logout: (redirect?: string, all?: boolean, options?: AxiosRequestConfig) => Promise; /** * 指定した自分のセッションを無効化(ログアウト)します。 既に存在しない・無効化されているセッションを指定した場合も`204`を返します。 * @summary セッションを無効化 * @param {string} sessionId セッションUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ revokeMySession: (sessionId: string, options?: AxiosRequestConfig) => Promise; /** * 自分に紐付けられている外部ログインアカウントの紐付けを解除します。 * @summary 外部ログインアカウントの紐付けを解除 * @param {PostUnlinkExternalAccount} [postUnlinkExternalAccount] * @param {*} [options] Override http request option. * @throws {RequiredError} */ unlinkExternalAccount: (postUnlinkExternalAccount?: PostUnlinkExternalAccount, options?: AxiosRequestConfig) => Promise; }; /** * AuthenticationApi - functional programming interface * @export */ declare const AuthenticationApiFp: (configuration?: Configuration) => { /** * 自分に紐付けられている外部ログインアカウント一覧を取得します。 * @summary 外部ログインアカウント一覧を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyExternalAccounts(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 自分のログインセッションのリストを取得します。 * @summary 自分のログインセッションリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMySessions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 自分に外部ログインアカウントを紐付けます。 指定した`providerName`がサーバー側で有効である必要があります。 リクエストが受理された場合、外部サービスの認証画面にリダイレクトされ、認証される必要があります。 * @summary 外部ログインアカウントを紐付ける * @param {PostLinkExternalAccount} [postLinkExternalAccount] * @param {*} [options] Override http request option. * @throws {RequiredError} */ linkExternalAccount(postLinkExternalAccount?: PostLinkExternalAccount, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * ログインします。 * @summary ログイン * @param {string} [redirect] リダイレクト先 * @param {PostLoginRequest} [postLoginRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ login(redirect?: string, postLoginRequest?: PostLoginRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * ログアウトします。 * @summary ログアウト * @param {string} [redirect] リダイレクト先 * @param {boolean} [all] 全てのセッションでログアウトするかどうか * @param {*} [options] Override http request option. * @throws {RequiredError} */ logout(redirect?: string, all?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定した自分のセッションを無効化(ログアウト)します。 既に存在しない・無効化されているセッションを指定した場合も`204`を返します。 * @summary セッションを無効化 * @param {string} sessionId セッションUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ revokeMySession(sessionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 自分に紐付けられている外部ログインアカウントの紐付けを解除します。 * @summary 外部ログインアカウントの紐付けを解除 * @param {PostUnlinkExternalAccount} [postUnlinkExternalAccount] * @param {*} [options] Override http request option. * @throws {RequiredError} */ unlinkExternalAccount(postUnlinkExternalAccount?: PostUnlinkExternalAccount, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * AuthenticationApi - factory interface * @export */ declare const AuthenticationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * 自分に紐付けられている外部ログインアカウント一覧を取得します。 * @summary 外部ログインアカウント一覧を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyExternalAccounts(options?: any): AxiosPromise>; /** * 自分のログインセッションのリストを取得します。 * @summary 自分のログインセッションリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMySessions(options?: any): AxiosPromise>; /** * 自分に外部ログインアカウントを紐付けます。 指定した`providerName`がサーバー側で有効である必要があります。 リクエストが受理された場合、外部サービスの認証画面にリダイレクトされ、認証される必要があります。 * @summary 外部ログインアカウントを紐付ける * @param {PostLinkExternalAccount} [postLinkExternalAccount] * @param {*} [options] Override http request option. * @throws {RequiredError} */ linkExternalAccount(postLinkExternalAccount?: PostLinkExternalAccount, options?: any): AxiosPromise; /** * ログインします。 * @summary ログイン * @param {string} [redirect] リダイレクト先 * @param {PostLoginRequest} [postLoginRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ login(redirect?: string, postLoginRequest?: PostLoginRequest, options?: any): AxiosPromise; /** * ログアウトします。 * @summary ログアウト * @param {string} [redirect] リダイレクト先 * @param {boolean} [all] 全てのセッションでログアウトするかどうか * @param {*} [options] Override http request option. * @throws {RequiredError} */ logout(redirect?: string, all?: boolean, options?: any): AxiosPromise; /** * 指定した自分のセッションを無効化(ログアウト)します。 既に存在しない・無効化されているセッションを指定した場合も`204`を返します。 * @summary セッションを無効化 * @param {string} sessionId セッションUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ revokeMySession(sessionId: string, options?: any): AxiosPromise; /** * 自分に紐付けられている外部ログインアカウントの紐付けを解除します。 * @summary 外部ログインアカウントの紐付けを解除 * @param {PostUnlinkExternalAccount} [postUnlinkExternalAccount] * @param {*} [options] Override http request option. * @throws {RequiredError} */ unlinkExternalAccount(postUnlinkExternalAccount?: PostUnlinkExternalAccount, options?: any): AxiosPromise; }; /** * AuthenticationApi - object-oriented interface * @export * @class AuthenticationApi * @extends {BaseAPI} */ declare class AuthenticationApi extends BaseAPI { /** * 自分に紐付けられている外部ログインアカウント一覧を取得します。 * @summary 外部ログインアカウント一覧を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthenticationApi */ getMyExternalAccounts(options?: AxiosRequestConfig): Promise>; /** * 自分のログインセッションのリストを取得します。 * @summary 自分のログインセッションリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthenticationApi */ getMySessions(options?: AxiosRequestConfig): Promise>; /** * 自分に外部ログインアカウントを紐付けます。 指定した`providerName`がサーバー側で有効である必要があります。 リクエストが受理された場合、外部サービスの認証画面にリダイレクトされ、認証される必要があります。 * @summary 外部ログインアカウントを紐付ける * @param {PostLinkExternalAccount} [postLinkExternalAccount] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthenticationApi */ linkExternalAccount(postLinkExternalAccount?: PostLinkExternalAccount, options?: AxiosRequestConfig): Promise>; /** * ログインします。 * @summary ログイン * @param {string} [redirect] リダイレクト先 * @param {PostLoginRequest} [postLoginRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthenticationApi */ login(redirect?: string, postLoginRequest?: PostLoginRequest, options?: AxiosRequestConfig): Promise>; /** * ログアウトします。 * @summary ログアウト * @param {string} [redirect] リダイレクト先 * @param {boolean} [all] 全てのセッションでログアウトするかどうか * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthenticationApi */ logout(redirect?: string, all?: boolean, options?: AxiosRequestConfig): Promise>; /** * 指定した自分のセッションを無効化(ログアウト)します。 既に存在しない・無効化されているセッションを指定した場合も`204`を返します。 * @summary セッションを無効化 * @param {string} sessionId セッションUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthenticationApi */ revokeMySession(sessionId: string, options?: AxiosRequestConfig): Promise>; /** * 自分に紐付けられている外部ログインアカウントの紐付けを解除します。 * @summary 外部ログインアカウントの紐付けを解除 * @param {PostUnlinkExternalAccount} [postUnlinkExternalAccount] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthenticationApi */ unlinkExternalAccount(postUnlinkExternalAccount?: PostUnlinkExternalAccount, options?: AxiosRequestConfig): Promise>; } /** * BotApi - axios parameter creator * @export */ declare const BotApiAxiosParamCreator: (configuration?: Configuration) => { /** * 指定したBOTを有効化します。 対象のBOTの管理権限が必要です。 * @summary BOTをアクティベート * @param {string} botId BOTUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ activateBot: (botId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したBOTのアイコン画像を変更を変更します。 対象のBOTの管理権限が必要です。 * @summary BOTのアイコン画像を変更 * @param {string} botId BOTUUID * @param {File} file アイコン画像(2MB,`Config.Imaging.MaxPixels`(default: 2560*1600)までのpng, jpeg, gif) * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeBotIcon: (botId: string, file: File, options?: AxiosRequestConfig) => Promise; /** * # BOT WebSocketプロトコル ## 送信 `コマンド:引数1:引数2:...` のような形式のTextMessageをサーバーに送信することで、このWebSocketセッションに対する設定が実行できます。 ### `rtcstate`コマンド 自分のWebRTC状態を変更します。 他のコネクションが既に状態を保持している場合、変更することができません。 `rtcstate:{チャンネルID}:({状態}:{セッションID})*` チャンネルIDにnullもしくは空文字を指定するか、状態にnullもしくは空文字を指定した場合、WebRTC状態はリセットされます。 `rtcstate:null`, `rtcstate:`, `rtcstate:channelId:null`, `rtcstate:channelId:` コネクションが切断された場合、自分のWebRTC状態はリセットされます。 ## 受信 TextMessageとして各種イベントが`type`、`reqId`、`body`を持つJSONとして非同期に送られます。 `body`の内容はHTTP Modeの場合のRequest Bodyと同様です。 例外として`ERROR`イベントは`reqId`を持ちません。 例: PINGイベント `{\"type\":\"PING\",\"reqId\":\"requestId\",\"body\":{\"eventTime\":\"2019-05-07T04:50:48.582586882Z\"}}` ### `ERROR` コマンドの引数が不正などの理由でコマンドが受理されなかった場合に送られます。 非同期に送られるため、必ずしもコマンドとの対応関係を確定できないことに注意してください。 本番環境ではERRORが送られないようにすることが望ましいです。 `{\"type\":\"ERROR\",\"body\":\"message\"}` * @summary WebSocket Mode BOT用通知ストリームに接続します * @param {*} [options] Override http request option. * @throws {RequiredError} */ connectBotWS: (options?: AxiosRequestConfig) => Promise; /** * BOTを作成します。 作成後に購読イベントの設定を行う必要があります。 さらにHTTP Modeの場合はアクティベーションを行う必要があります。 * @summary BOTを作成 * @param {PostBotRequest} [postBotRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createBot: (postBotRequest?: PostBotRequest, options?: AxiosRequestConfig) => Promise; /** * 指定したBOTを削除します。 対象のBOTの管理権限が必要です。 * @summary BOTを削除 * @param {string} botId BOTUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteBot: (botId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したBOTの情報を変更します。 対象のBOTの管理権限が必要です。 BOT開発者UUIDを変更した場合は、変更先ユーザーにBOT管理権限が移譲され、自分自身は権限を失います。 * @summary BOT情報を変更 * @param {string} botId BOTUUID * @param {PatchBotRequest} [patchBotRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editBot: (botId: string, patchBotRequest?: PatchBotRequest, options?: AxiosRequestConfig) => Promise; /** * 指定したBOTのBOT情報を取得します。 BOT詳細情報を取得する場合は、対象のBOTの管理権限が必要です。 * @summary BOT情報を取得 * @param {string} botId BOTUUID * @param {boolean} [detail] 詳細情報を含めるかどうか * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBot: (botId: string, detail?: boolean, options?: AxiosRequestConfig) => Promise; /** * 指定したBOTのアイコン画像を取得を取得します。 * @summary BOTのアイコン画像を取得 * @param {string} botId BOTUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBotIcon: (botId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したBOTのイベントログを取得します。 対象のBOTの管理権限が必要です。 * @summary BOTのイベントログを取得 * @param {string} botId BOTUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBotLogs: (botId: string, limit?: number, offset?: number, options?: AxiosRequestConfig) => Promise; /** * BOT情報のリストを取得します。 allを指定しない場合、自分が開発者のBOTのみを返します。 * @summary BOTリストを取得 * @param {boolean} [all] 全てのBOTを取得するかどうか * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBots: (all?: boolean, options?: AxiosRequestConfig) => Promise; /** * 指定したチャンネルに参加しているBOTのリストを取得します。 * @summary チャンネル参加中のBOTのリストを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannelBots: (channelId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したBOTを無効化します。対象のBOTの管理権限が必要です。 * @summary BOTをインアクティベート * @param {string} botId BOTUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ inactivateBot: (botId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したBOTを指定したチャンネルに参加させます。 チャンネルに参加したBOTは、そのチャンネルの各種イベントを受け取るようになります。 対象のBOTの管理権限が必要です。 * @summary BOTをチャンネルに参加させる * @param {string} botId BOTUUID * @param {PostBotActionJoinRequest} [postBotActionJoinRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ letBotJoinChannel: (botId: string, postBotActionJoinRequest?: PostBotActionJoinRequest, options?: AxiosRequestConfig) => Promise; /** * 指定したBOTを指定したチャンネルから退出させます。 対象のBOTの管理権限が必要です。 * @summary BOTをチャンネルから退出させる * @param {string} botId BOTUUID * @param {PostBotActionLeaveRequest} [postBotActionLeaveRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ letBotLeaveChannel: (botId: string, postBotActionLeaveRequest?: PostBotActionLeaveRequest, options?: AxiosRequestConfig) => Promise; /** * 指定したBOTの現在の各種トークンを無効化し、再発行を行います。 対象のBOTの管理権限が必要です。 * @summary BOTのトークンを再発行 * @param {string} botId BOTUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ reissueBot: (botId: string, options?: AxiosRequestConfig) => Promise; }; /** * BotApi - functional programming interface * @export */ declare const BotApiFp: (configuration?: Configuration) => { /** * 指定したBOTを有効化します。 対象のBOTの管理権限が必要です。 * @summary BOTをアクティベート * @param {string} botId BOTUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ activateBot(botId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したBOTのアイコン画像を変更を変更します。 対象のBOTの管理権限が必要です。 * @summary BOTのアイコン画像を変更 * @param {string} botId BOTUUID * @param {File} file アイコン画像(2MB,`Config.Imaging.MaxPixels`(default: 2560*1600)までのpng, jpeg, gif) * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeBotIcon(botId: string, file: File, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * # BOT WebSocketプロトコル ## 送信 `コマンド:引数1:引数2:...` のような形式のTextMessageをサーバーに送信することで、このWebSocketセッションに対する設定が実行できます。 ### `rtcstate`コマンド 自分のWebRTC状態を変更します。 他のコネクションが既に状態を保持している場合、変更することができません。 `rtcstate:{チャンネルID}:({状態}:{セッションID})*` チャンネルIDにnullもしくは空文字を指定するか、状態にnullもしくは空文字を指定した場合、WebRTC状態はリセットされます。 `rtcstate:null`, `rtcstate:`, `rtcstate:channelId:null`, `rtcstate:channelId:` コネクションが切断された場合、自分のWebRTC状態はリセットされます。 ## 受信 TextMessageとして各種イベントが`type`、`reqId`、`body`を持つJSONとして非同期に送られます。 `body`の内容はHTTP Modeの場合のRequest Bodyと同様です。 例外として`ERROR`イベントは`reqId`を持ちません。 例: PINGイベント `{\"type\":\"PING\",\"reqId\":\"requestId\",\"body\":{\"eventTime\":\"2019-05-07T04:50:48.582586882Z\"}}` ### `ERROR` コマンドの引数が不正などの理由でコマンドが受理されなかった場合に送られます。 非同期に送られるため、必ずしもコマンドとの対応関係を確定できないことに注意してください。 本番環境ではERRORが送られないようにすることが望ましいです。 `{\"type\":\"ERROR\",\"body\":\"message\"}` * @summary WebSocket Mode BOT用通知ストリームに接続します * @param {*} [options] Override http request option. * @throws {RequiredError} */ connectBotWS(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * BOTを作成します。 作成後に購読イベントの設定を行う必要があります。 さらにHTTP Modeの場合はアクティベーションを行う必要があります。 * @summary BOTを作成 * @param {PostBotRequest} [postBotRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createBot(postBotRequest?: PostBotRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したBOTを削除します。 対象のBOTの管理権限が必要です。 * @summary BOTを削除 * @param {string} botId BOTUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteBot(botId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したBOTの情報を変更します。 対象のBOTの管理権限が必要です。 BOT開発者UUIDを変更した場合は、変更先ユーザーにBOT管理権限が移譲され、自分自身は権限を失います。 * @summary BOT情報を変更 * @param {string} botId BOTUUID * @param {PatchBotRequest} [patchBotRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editBot(botId: string, patchBotRequest?: PatchBotRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したBOTのBOT情報を取得します。 BOT詳細情報を取得する場合は、対象のBOTの管理権限が必要です。 * @summary BOT情報を取得 * @param {string} botId BOTUUID * @param {boolean} [detail] 詳細情報を含めるかどうか * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBot(botId: string, detail?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したBOTのアイコン画像を取得を取得します。 * @summary BOTのアイコン画像を取得 * @param {string} botId BOTUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBotIcon(botId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したBOTのイベントログを取得します。 対象のBOTの管理権限が必要です。 * @summary BOTのイベントログを取得 * @param {string} botId BOTUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBotLogs(botId: string, limit?: number, offset?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * BOT情報のリストを取得します。 allを指定しない場合、自分が開発者のBOTのみを返します。 * @summary BOTリストを取得 * @param {boolean} [all] 全てのBOTを取得するかどうか * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBots(all?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 指定したチャンネルに参加しているBOTのリストを取得します。 * @summary チャンネル参加中のBOTのリストを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannelBots(channelId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 指定したBOTを無効化します。対象のBOTの管理権限が必要です。 * @summary BOTをインアクティベート * @param {string} botId BOTUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ inactivateBot(botId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したBOTを指定したチャンネルに参加させます。 チャンネルに参加したBOTは、そのチャンネルの各種イベントを受け取るようになります。 対象のBOTの管理権限が必要です。 * @summary BOTをチャンネルに参加させる * @param {string} botId BOTUUID * @param {PostBotActionJoinRequest} [postBotActionJoinRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ letBotJoinChannel(botId: string, postBotActionJoinRequest?: PostBotActionJoinRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したBOTを指定したチャンネルから退出させます。 対象のBOTの管理権限が必要です。 * @summary BOTをチャンネルから退出させる * @param {string} botId BOTUUID * @param {PostBotActionLeaveRequest} [postBotActionLeaveRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ letBotLeaveChannel(botId: string, postBotActionLeaveRequest?: PostBotActionLeaveRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したBOTの現在の各種トークンを無効化し、再発行を行います。 対象のBOTの管理権限が必要です。 * @summary BOTのトークンを再発行 * @param {string} botId BOTUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ reissueBot(botId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * BotApi - factory interface * @export */ declare const BotApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * 指定したBOTを有効化します。 対象のBOTの管理権限が必要です。 * @summary BOTをアクティベート * @param {string} botId BOTUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ activateBot(botId: string, options?: any): AxiosPromise; /** * 指定したBOTのアイコン画像を変更を変更します。 対象のBOTの管理権限が必要です。 * @summary BOTのアイコン画像を変更 * @param {string} botId BOTUUID * @param {File} file アイコン画像(2MB,`Config.Imaging.MaxPixels`(default: 2560*1600)までのpng, jpeg, gif) * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeBotIcon(botId: string, file: File, options?: any): AxiosPromise; /** * # BOT WebSocketプロトコル ## 送信 `コマンド:引数1:引数2:...` のような形式のTextMessageをサーバーに送信することで、このWebSocketセッションに対する設定が実行できます。 ### `rtcstate`コマンド 自分のWebRTC状態を変更します。 他のコネクションが既に状態を保持している場合、変更することができません。 `rtcstate:{チャンネルID}:({状態}:{セッションID})*` チャンネルIDにnullもしくは空文字を指定するか、状態にnullもしくは空文字を指定した場合、WebRTC状態はリセットされます。 `rtcstate:null`, `rtcstate:`, `rtcstate:channelId:null`, `rtcstate:channelId:` コネクションが切断された場合、自分のWebRTC状態はリセットされます。 ## 受信 TextMessageとして各種イベントが`type`、`reqId`、`body`を持つJSONとして非同期に送られます。 `body`の内容はHTTP Modeの場合のRequest Bodyと同様です。 例外として`ERROR`イベントは`reqId`を持ちません。 例: PINGイベント `{\"type\":\"PING\",\"reqId\":\"requestId\",\"body\":{\"eventTime\":\"2019-05-07T04:50:48.582586882Z\"}}` ### `ERROR` コマンドの引数が不正などの理由でコマンドが受理されなかった場合に送られます。 非同期に送られるため、必ずしもコマンドとの対応関係を確定できないことに注意してください。 本番環境ではERRORが送られないようにすることが望ましいです。 `{\"type\":\"ERROR\",\"body\":\"message\"}` * @summary WebSocket Mode BOT用通知ストリームに接続します * @param {*} [options] Override http request option. * @throws {RequiredError} */ connectBotWS(options?: any): AxiosPromise; /** * BOTを作成します。 作成後に購読イベントの設定を行う必要があります。 さらにHTTP Modeの場合はアクティベーションを行う必要があります。 * @summary BOTを作成 * @param {PostBotRequest} [postBotRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createBot(postBotRequest?: PostBotRequest, options?: any): AxiosPromise; /** * 指定したBOTを削除します。 対象のBOTの管理権限が必要です。 * @summary BOTを削除 * @param {string} botId BOTUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteBot(botId: string, options?: any): AxiosPromise; /** * 指定したBOTの情報を変更します。 対象のBOTの管理権限が必要です。 BOT開発者UUIDを変更した場合は、変更先ユーザーにBOT管理権限が移譲され、自分自身は権限を失います。 * @summary BOT情報を変更 * @param {string} botId BOTUUID * @param {PatchBotRequest} [patchBotRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editBot(botId: string, patchBotRequest?: PatchBotRequest, options?: any): AxiosPromise; /** * 指定したBOTのBOT情報を取得します。 BOT詳細情報を取得する場合は、対象のBOTの管理権限が必要です。 * @summary BOT情報を取得 * @param {string} botId BOTUUID * @param {boolean} [detail] 詳細情報を含めるかどうか * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBot(botId: string, detail?: boolean, options?: any): AxiosPromise; /** * 指定したBOTのアイコン画像を取得を取得します。 * @summary BOTのアイコン画像を取得 * @param {string} botId BOTUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBotIcon(botId: string, options?: any): AxiosPromise; /** * 指定したBOTのイベントログを取得します。 対象のBOTの管理権限が必要です。 * @summary BOTのイベントログを取得 * @param {string} botId BOTUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBotLogs(botId: string, limit?: number, offset?: number, options?: any): AxiosPromise>; /** * BOT情報のリストを取得します。 allを指定しない場合、自分が開発者のBOTのみを返します。 * @summary BOTリストを取得 * @param {boolean} [all] 全てのBOTを取得するかどうか * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBots(all?: boolean, options?: any): AxiosPromise>; /** * 指定したチャンネルに参加しているBOTのリストを取得します。 * @summary チャンネル参加中のBOTのリストを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannelBots(channelId: string, options?: any): AxiosPromise>; /** * 指定したBOTを無効化します。対象のBOTの管理権限が必要です。 * @summary BOTをインアクティベート * @param {string} botId BOTUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ inactivateBot(botId: string, options?: any): AxiosPromise; /** * 指定したBOTを指定したチャンネルに参加させます。 チャンネルに参加したBOTは、そのチャンネルの各種イベントを受け取るようになります。 対象のBOTの管理権限が必要です。 * @summary BOTをチャンネルに参加させる * @param {string} botId BOTUUID * @param {PostBotActionJoinRequest} [postBotActionJoinRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ letBotJoinChannel(botId: string, postBotActionJoinRequest?: PostBotActionJoinRequest, options?: any): AxiosPromise; /** * 指定したBOTを指定したチャンネルから退出させます。 対象のBOTの管理権限が必要です。 * @summary BOTをチャンネルから退出させる * @param {string} botId BOTUUID * @param {PostBotActionLeaveRequest} [postBotActionLeaveRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ letBotLeaveChannel(botId: string, postBotActionLeaveRequest?: PostBotActionLeaveRequest, options?: any): AxiosPromise; /** * 指定したBOTの現在の各種トークンを無効化し、再発行を行います。 対象のBOTの管理権限が必要です。 * @summary BOTのトークンを再発行 * @param {string} botId BOTUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ reissueBot(botId: string, options?: any): AxiosPromise; }; /** * BotApi - object-oriented interface * @export * @class BotApi * @extends {BaseAPI} */ declare class BotApi extends BaseAPI { /** * 指定したBOTを有効化します。 対象のBOTの管理権限が必要です。 * @summary BOTをアクティベート * @param {string} botId BOTUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BotApi */ activateBot(botId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したBOTのアイコン画像を変更を変更します。 対象のBOTの管理権限が必要です。 * @summary BOTのアイコン画像を変更 * @param {string} botId BOTUUID * @param {File} file アイコン画像(2MB,`Config.Imaging.MaxPixels`(default: 2560*1600)までのpng, jpeg, gif) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BotApi */ changeBotIcon(botId: string, file: File, options?: AxiosRequestConfig): Promise>; /** * # BOT WebSocketプロトコル ## 送信 `コマンド:引数1:引数2:...` のような形式のTextMessageをサーバーに送信することで、このWebSocketセッションに対する設定が実行できます。 ### `rtcstate`コマンド 自分のWebRTC状態を変更します。 他のコネクションが既に状態を保持している場合、変更することができません。 `rtcstate:{チャンネルID}:({状態}:{セッションID})*` チャンネルIDにnullもしくは空文字を指定するか、状態にnullもしくは空文字を指定した場合、WebRTC状態はリセットされます。 `rtcstate:null`, `rtcstate:`, `rtcstate:channelId:null`, `rtcstate:channelId:` コネクションが切断された場合、自分のWebRTC状態はリセットされます。 ## 受信 TextMessageとして各種イベントが`type`、`reqId`、`body`を持つJSONとして非同期に送られます。 `body`の内容はHTTP Modeの場合のRequest Bodyと同様です。 例外として`ERROR`イベントは`reqId`を持ちません。 例: PINGイベント `{\"type\":\"PING\",\"reqId\":\"requestId\",\"body\":{\"eventTime\":\"2019-05-07T04:50:48.582586882Z\"}}` ### `ERROR` コマンドの引数が不正などの理由でコマンドが受理されなかった場合に送られます。 非同期に送られるため、必ずしもコマンドとの対応関係を確定できないことに注意してください。 本番環境ではERRORが送られないようにすることが望ましいです。 `{\"type\":\"ERROR\",\"body\":\"message\"}` * @summary WebSocket Mode BOT用通知ストリームに接続します * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BotApi */ connectBotWS(options?: AxiosRequestConfig): Promise>; /** * BOTを作成します。 作成後に購読イベントの設定を行う必要があります。 さらにHTTP Modeの場合はアクティベーションを行う必要があります。 * @summary BOTを作成 * @param {PostBotRequest} [postBotRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BotApi */ createBot(postBotRequest?: PostBotRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したBOTを削除します。 対象のBOTの管理権限が必要です。 * @summary BOTを削除 * @param {string} botId BOTUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BotApi */ deleteBot(botId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したBOTの情報を変更します。 対象のBOTの管理権限が必要です。 BOT開発者UUIDを変更した場合は、変更先ユーザーにBOT管理権限が移譲され、自分自身は権限を失います。 * @summary BOT情報を変更 * @param {string} botId BOTUUID * @param {PatchBotRequest} [patchBotRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BotApi */ editBot(botId: string, patchBotRequest?: PatchBotRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したBOTのBOT情報を取得します。 BOT詳細情報を取得する場合は、対象のBOTの管理権限が必要です。 * @summary BOT情報を取得 * @param {string} botId BOTUUID * @param {boolean} [detail] 詳細情報を含めるかどうか * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BotApi */ getBot(botId: string, detail?: boolean, options?: AxiosRequestConfig): Promise>; /** * 指定したBOTのアイコン画像を取得を取得します。 * @summary BOTのアイコン画像を取得 * @param {string} botId BOTUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BotApi */ getBotIcon(botId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したBOTのイベントログを取得します。 対象のBOTの管理権限が必要です。 * @summary BOTのイベントログを取得 * @param {string} botId BOTUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BotApi */ getBotLogs(botId: string, limit?: number, offset?: number, options?: AxiosRequestConfig): Promise>; /** * BOT情報のリストを取得します。 allを指定しない場合、自分が開発者のBOTのみを返します。 * @summary BOTリストを取得 * @param {boolean} [all] 全てのBOTを取得するかどうか * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BotApi */ getBots(all?: boolean, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルに参加しているBOTのリストを取得します。 * @summary チャンネル参加中のBOTのリストを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BotApi */ getChannelBots(channelId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したBOTを無効化します。対象のBOTの管理権限が必要です。 * @summary BOTをインアクティベート * @param {string} botId BOTUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BotApi */ inactivateBot(botId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したBOTを指定したチャンネルに参加させます。 チャンネルに参加したBOTは、そのチャンネルの各種イベントを受け取るようになります。 対象のBOTの管理権限が必要です。 * @summary BOTをチャンネルに参加させる * @param {string} botId BOTUUID * @param {PostBotActionJoinRequest} [postBotActionJoinRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BotApi */ letBotJoinChannel(botId: string, postBotActionJoinRequest?: PostBotActionJoinRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したBOTを指定したチャンネルから退出させます。 対象のBOTの管理権限が必要です。 * @summary BOTをチャンネルから退出させる * @param {string} botId BOTUUID * @param {PostBotActionLeaveRequest} [postBotActionLeaveRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BotApi */ letBotLeaveChannel(botId: string, postBotActionLeaveRequest?: PostBotActionLeaveRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したBOTの現在の各種トークンを無効化し、再発行を行います。 対象のBOTの管理権限が必要です。 * @summary BOTのトークンを再発行 * @param {string} botId BOTUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BotApi */ reissueBot(botId: string, options?: AxiosRequestConfig): Promise>; } /** * ChannelApi - axios parameter creator * @export */ declare const ChannelApiAxiosParamCreator: (configuration?: Configuration) => { /** * チャンネルを作成します。 階層が6以上になるチャンネルは作成できません。 * @summary チャンネルを作成 * @param {PostChannelRequest} [postChannelRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createChannel: (postChannelRequest?: PostChannelRequest, options?: AxiosRequestConfig) => Promise; /** * 指定したチャンネルの情報を変更します。 変更には権限が必要です。 ルートチャンネルに移動させる場合は、`parent`に`00000000-0000-0000-0000-000000000000`を指定してください。 * @summary チャンネル情報を変更 * @param {string} channelId チャンネルUUID * @param {PatchChannelRequest} [patchChannelRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editChannel: (channelId: string, patchChannelRequest?: PatchChannelRequest, options?: AxiosRequestConfig) => Promise; /** * 指定したチャンネルの通知購読者を編集します。 リクエストに含めなかったユーザーの通知購読状態は変更しません。 また、存在しないユーザーを指定した場合は無視されます。 * @summary チャンネルの通知購読者を編集 * @param {string} channelId チャンネルUUID * @param {PatchChannelSubscribersRequest} [patchChannelSubscribersRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editChannelSubscribers: (channelId: string, patchChannelSubscribersRequest?: PatchChannelSubscribersRequest, options?: AxiosRequestConfig) => Promise; /** * 指定したチャンネルのトピックを編集します。 アーカイブされているチャンネルのトピックは編集できません。 * @summary チャンネルトピックを編集 * @param {string} channelId チャンネルUUID * @param {PutChannelTopicRequest} [putChannelTopicRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editChannelTopic: (channelId: string, putChannelTopicRequest?: PutChannelTopicRequest, options?: AxiosRequestConfig) => Promise; /** * 指定したチャンネルの情報を取得します。 * @summary チャンネル情報を取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannel: (channelId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したチャンネルに参加しているBOTのリストを取得します。 * @summary チャンネル参加中のBOTのリストを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannelBots: (channelId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したチャンネルのイベントリストを取得します。 * @summary チャンネルイベントのリストを取得 * @param {string} channelId チャンネルUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {string} [since] 取得する時間範囲の開始日時 * @param {string} [until] 取得する時間範囲の終了日時 * @param {boolean} [inclusive] 範囲の端を含めるかどうか * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannelEvents: (channelId: string, limit?: number, offset?: number, since?: string, until?: string, inclusive?: boolean, order?: "asc" | "desc", options?: AxiosRequestConfig) => Promise; /** * 指定されたチャンネルのパスを取得します。 * @summary 指定したチャンネルパスを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannelPath: (channelId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したチャンネルにピン留めされているピンメッセージのリストを取得します。 * @summary チャンネルピンのリストを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannelPins: (channelId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したチャンネルの統計情報を取得します。 * @summary チャンネル統計情報を取得 * @param {string} channelId チャンネルUUID * @param {boolean} [excludeDeletedMessages] 削除されたメッセージを除外するかどうか(デフォルト false) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannelStats: (channelId: string, excludeDeletedMessages?: boolean, options?: AxiosRequestConfig) => Promise; /** * 指定したチャンネルを通知購読しているユーザーのUUIDのリストを取得します。 * @summary チャンネルの通知購読者のリストを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannelSubscribers: (channelId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したチャンネルのトピックを取得します。 * @summary チャンネルトピックを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannelTopic: (channelId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したチャンネルの閲覧者のリストを取得します。 * @summary チャンネル閲覧者リストを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannelViewers: (channelId: string, options?: AxiosRequestConfig) => Promise; /** * チャンネルのリストを取得します。 * @summary チャンネルリストを取得 * @param {boolean} [includeDm] ダイレクトメッセージチャンネルをレスポンスに含めるかどうか * @param {string} [path] パスが一致するチャンネルのみを取得する * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannels: (includeDm?: boolean, path?: string, options?: AxiosRequestConfig) => Promise; /** * 指定したチャンネルのメッセージのリストを取得します。 * @summary チャンネルメッセージのリストを取得 * @param {string} channelId チャンネルUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {string} [since] 取得する時間範囲の開始日時 * @param {string} [until] 取得する時間範囲の終了日時 * @param {boolean} [inclusive] 範囲の端を含めるかどうか * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessages: (channelId: string, limit?: number, offset?: number, since?: string, until?: string, inclusive?: boolean, order?: "asc" | "desc", options?: AxiosRequestConfig) => Promise; /** * 指定したユーザーとのダイレクトメッセージチャンネルの情報を返します。 ダイレクトメッセージチャンネルが存在しなかった場合、自動的に作成されます。 * @summary DMチャンネル情報を取得 * @param {string} userId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserDMChannel: (userId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したチャンネルにメッセージを投稿します。 embedをtrueに指定すると、メッセージ埋め込みが自動で行われます。 アーカイブされているチャンネルに投稿することはできません。 * @summary チャンネルにメッセージを投稿 * @param {string} channelId チャンネルUUID * @param {PostMessageRequest} [postMessageRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ postMessage: (channelId: string, postMessageRequest?: PostMessageRequest, options?: AxiosRequestConfig) => Promise; /** * 指定したチャンネルの通知購読者を設定します。 リクエストに含めなかったユーザーの通知購読状態はオフになります。 また、存在しないユーザーを指定した場合は無視されます。 * @summary チャンネルの通知購読者を設定 * @param {string} channelId チャンネルUUID * @param {PutChannelSubscribersRequest} [putChannelSubscribersRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ setChannelSubscribers: (channelId: string, putChannelSubscribersRequest?: PutChannelSubscribersRequest, options?: AxiosRequestConfig) => Promise; }; /** * ChannelApi - functional programming interface * @export */ declare const ChannelApiFp: (configuration?: Configuration) => { /** * チャンネルを作成します。 階層が6以上になるチャンネルは作成できません。 * @summary チャンネルを作成 * @param {PostChannelRequest} [postChannelRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createChannel(postChannelRequest?: PostChannelRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したチャンネルの情報を変更します。 変更には権限が必要です。 ルートチャンネルに移動させる場合は、`parent`に`00000000-0000-0000-0000-000000000000`を指定してください。 * @summary チャンネル情報を変更 * @param {string} channelId チャンネルUUID * @param {PatchChannelRequest} [patchChannelRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editChannel(channelId: string, patchChannelRequest?: PatchChannelRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したチャンネルの通知購読者を編集します。 リクエストに含めなかったユーザーの通知購読状態は変更しません。 また、存在しないユーザーを指定した場合は無視されます。 * @summary チャンネルの通知購読者を編集 * @param {string} channelId チャンネルUUID * @param {PatchChannelSubscribersRequest} [patchChannelSubscribersRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editChannelSubscribers(channelId: string, patchChannelSubscribersRequest?: PatchChannelSubscribersRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したチャンネルのトピックを編集します。 アーカイブされているチャンネルのトピックは編集できません。 * @summary チャンネルトピックを編集 * @param {string} channelId チャンネルUUID * @param {PutChannelTopicRequest} [putChannelTopicRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editChannelTopic(channelId: string, putChannelTopicRequest?: PutChannelTopicRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したチャンネルの情報を取得します。 * @summary チャンネル情報を取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannel(channelId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したチャンネルに参加しているBOTのリストを取得します。 * @summary チャンネル参加中のBOTのリストを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannelBots(channelId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 指定したチャンネルのイベントリストを取得します。 * @summary チャンネルイベントのリストを取得 * @param {string} channelId チャンネルUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {string} [since] 取得する時間範囲の開始日時 * @param {string} [until] 取得する時間範囲の終了日時 * @param {boolean} [inclusive] 範囲の端を含めるかどうか * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannelEvents(channelId: string, limit?: number, offset?: number, since?: string, until?: string, inclusive?: boolean, order?: "asc" | "desc", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 指定されたチャンネルのパスを取得します。 * @summary 指定したチャンネルパスを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannelPath(channelId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したチャンネルにピン留めされているピンメッセージのリストを取得します。 * @summary チャンネルピンのリストを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannelPins(channelId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 指定したチャンネルの統計情報を取得します。 * @summary チャンネル統計情報を取得 * @param {string} channelId チャンネルUUID * @param {boolean} [excludeDeletedMessages] 削除されたメッセージを除外するかどうか(デフォルト false) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannelStats(channelId: string, excludeDeletedMessages?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したチャンネルを通知購読しているユーザーのUUIDのリストを取得します。 * @summary チャンネルの通知購読者のリストを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannelSubscribers(channelId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 指定したチャンネルのトピックを取得します。 * @summary チャンネルトピックを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannelTopic(channelId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したチャンネルの閲覧者のリストを取得します。 * @summary チャンネル閲覧者リストを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannelViewers(channelId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * チャンネルのリストを取得します。 * @summary チャンネルリストを取得 * @param {boolean} [includeDm] ダイレクトメッセージチャンネルをレスポンスに含めるかどうか * @param {string} [path] パスが一致するチャンネルのみを取得する * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannels(includeDm?: boolean, path?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したチャンネルのメッセージのリストを取得します。 * @summary チャンネルメッセージのリストを取得 * @param {string} channelId チャンネルUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {string} [since] 取得する時間範囲の開始日時 * @param {string} [until] 取得する時間範囲の終了日時 * @param {boolean} [inclusive] 範囲の端を含めるかどうか * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessages(channelId: string, limit?: number, offset?: number, since?: string, until?: string, inclusive?: boolean, order?: "asc" | "desc", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 指定したユーザーとのダイレクトメッセージチャンネルの情報を返します。 ダイレクトメッセージチャンネルが存在しなかった場合、自動的に作成されます。 * @summary DMチャンネル情報を取得 * @param {string} userId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserDMChannel(userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したチャンネルにメッセージを投稿します。 embedをtrueに指定すると、メッセージ埋め込みが自動で行われます。 アーカイブされているチャンネルに投稿することはできません。 * @summary チャンネルにメッセージを投稿 * @param {string} channelId チャンネルUUID * @param {PostMessageRequest} [postMessageRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ postMessage(channelId: string, postMessageRequest?: PostMessageRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したチャンネルの通知購読者を設定します。 リクエストに含めなかったユーザーの通知購読状態はオフになります。 また、存在しないユーザーを指定した場合は無視されます。 * @summary チャンネルの通知購読者を設定 * @param {string} channelId チャンネルUUID * @param {PutChannelSubscribersRequest} [putChannelSubscribersRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ setChannelSubscribers(channelId: string, putChannelSubscribersRequest?: PutChannelSubscribersRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ChannelApi - factory interface * @export */ declare const ChannelApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * チャンネルを作成します。 階層が6以上になるチャンネルは作成できません。 * @summary チャンネルを作成 * @param {PostChannelRequest} [postChannelRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createChannel(postChannelRequest?: PostChannelRequest, options?: any): AxiosPromise; /** * 指定したチャンネルの情報を変更します。 変更には権限が必要です。 ルートチャンネルに移動させる場合は、`parent`に`00000000-0000-0000-0000-000000000000`を指定してください。 * @summary チャンネル情報を変更 * @param {string} channelId チャンネルUUID * @param {PatchChannelRequest} [patchChannelRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editChannel(channelId: string, patchChannelRequest?: PatchChannelRequest, options?: any): AxiosPromise; /** * 指定したチャンネルの通知購読者を編集します。 リクエストに含めなかったユーザーの通知購読状態は変更しません。 また、存在しないユーザーを指定した場合は無視されます。 * @summary チャンネルの通知購読者を編集 * @param {string} channelId チャンネルUUID * @param {PatchChannelSubscribersRequest} [patchChannelSubscribersRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editChannelSubscribers(channelId: string, patchChannelSubscribersRequest?: PatchChannelSubscribersRequest, options?: any): AxiosPromise; /** * 指定したチャンネルのトピックを編集します。 アーカイブされているチャンネルのトピックは編集できません。 * @summary チャンネルトピックを編集 * @param {string} channelId チャンネルUUID * @param {PutChannelTopicRequest} [putChannelTopicRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editChannelTopic(channelId: string, putChannelTopicRequest?: PutChannelTopicRequest, options?: any): AxiosPromise; /** * 指定したチャンネルの情報を取得します。 * @summary チャンネル情報を取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannel(channelId: string, options?: any): AxiosPromise; /** * 指定したチャンネルに参加しているBOTのリストを取得します。 * @summary チャンネル参加中のBOTのリストを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannelBots(channelId: string, options?: any): AxiosPromise>; /** * 指定したチャンネルのイベントリストを取得します。 * @summary チャンネルイベントのリストを取得 * @param {string} channelId チャンネルUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {string} [since] 取得する時間範囲の開始日時 * @param {string} [until] 取得する時間範囲の終了日時 * @param {boolean} [inclusive] 範囲の端を含めるかどうか * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannelEvents(channelId: string, limit?: number, offset?: number, since?: string, until?: string, inclusive?: boolean, order?: "asc" | "desc", options?: any): AxiosPromise>; /** * 指定されたチャンネルのパスを取得します。 * @summary 指定したチャンネルパスを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannelPath(channelId: string, options?: any): AxiosPromise; /** * 指定したチャンネルにピン留めされているピンメッセージのリストを取得します。 * @summary チャンネルピンのリストを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannelPins(channelId: string, options?: any): AxiosPromise>; /** * 指定したチャンネルの統計情報を取得します。 * @summary チャンネル統計情報を取得 * @param {string} channelId チャンネルUUID * @param {boolean} [excludeDeletedMessages] 削除されたメッセージを除外するかどうか(デフォルト false) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannelStats(channelId: string, excludeDeletedMessages?: boolean, options?: any): AxiosPromise; /** * 指定したチャンネルを通知購読しているユーザーのUUIDのリストを取得します。 * @summary チャンネルの通知購読者のリストを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannelSubscribers(channelId: string, options?: any): AxiosPromise>; /** * 指定したチャンネルのトピックを取得します。 * @summary チャンネルトピックを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannelTopic(channelId: string, options?: any): AxiosPromise; /** * 指定したチャンネルの閲覧者のリストを取得します。 * @summary チャンネル閲覧者リストを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannelViewers(channelId: string, options?: any): AxiosPromise>; /** * チャンネルのリストを取得します。 * @summary チャンネルリストを取得 * @param {boolean} [includeDm] ダイレクトメッセージチャンネルをレスポンスに含めるかどうか * @param {string} [path] パスが一致するチャンネルのみを取得する * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannels(includeDm?: boolean, path?: string, options?: any): AxiosPromise; /** * 指定したチャンネルのメッセージのリストを取得します。 * @summary チャンネルメッセージのリストを取得 * @param {string} channelId チャンネルUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {string} [since] 取得する時間範囲の開始日時 * @param {string} [until] 取得する時間範囲の終了日時 * @param {boolean} [inclusive] 範囲の端を含めるかどうか * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessages(channelId: string, limit?: number, offset?: number, since?: string, until?: string, inclusive?: boolean, order?: "asc" | "desc", options?: any): AxiosPromise>; /** * 指定したユーザーとのダイレクトメッセージチャンネルの情報を返します。 ダイレクトメッセージチャンネルが存在しなかった場合、自動的に作成されます。 * @summary DMチャンネル情報を取得 * @param {string} userId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserDMChannel(userId: string, options?: any): AxiosPromise; /** * 指定したチャンネルにメッセージを投稿します。 embedをtrueに指定すると、メッセージ埋め込みが自動で行われます。 アーカイブされているチャンネルに投稿することはできません。 * @summary チャンネルにメッセージを投稿 * @param {string} channelId チャンネルUUID * @param {PostMessageRequest} [postMessageRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ postMessage(channelId: string, postMessageRequest?: PostMessageRequest, options?: any): AxiosPromise; /** * 指定したチャンネルの通知購読者を設定します。 リクエストに含めなかったユーザーの通知購読状態はオフになります。 また、存在しないユーザーを指定した場合は無視されます。 * @summary チャンネルの通知購読者を設定 * @param {string} channelId チャンネルUUID * @param {PutChannelSubscribersRequest} [putChannelSubscribersRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ setChannelSubscribers(channelId: string, putChannelSubscribersRequest?: PutChannelSubscribersRequest, options?: any): AxiosPromise; }; /** * ChannelApi - object-oriented interface * @export * @class ChannelApi * @extends {BaseAPI} */ declare class ChannelApi extends BaseAPI { /** * チャンネルを作成します。 階層が6以上になるチャンネルは作成できません。 * @summary チャンネルを作成 * @param {PostChannelRequest} [postChannelRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ createChannel(postChannelRequest?: PostChannelRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルの情報を変更します。 変更には権限が必要です。 ルートチャンネルに移動させる場合は、`parent`に`00000000-0000-0000-0000-000000000000`を指定してください。 * @summary チャンネル情報を変更 * @param {string} channelId チャンネルUUID * @param {PatchChannelRequest} [patchChannelRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ editChannel(channelId: string, patchChannelRequest?: PatchChannelRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルの通知購読者を編集します。 リクエストに含めなかったユーザーの通知購読状態は変更しません。 また、存在しないユーザーを指定した場合は無視されます。 * @summary チャンネルの通知購読者を編集 * @param {string} channelId チャンネルUUID * @param {PatchChannelSubscribersRequest} [patchChannelSubscribersRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ editChannelSubscribers(channelId: string, patchChannelSubscribersRequest?: PatchChannelSubscribersRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルのトピックを編集します。 アーカイブされているチャンネルのトピックは編集できません。 * @summary チャンネルトピックを編集 * @param {string} channelId チャンネルUUID * @param {PutChannelTopicRequest} [putChannelTopicRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ editChannelTopic(channelId: string, putChannelTopicRequest?: PutChannelTopicRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルの情報を取得します。 * @summary チャンネル情報を取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ getChannel(channelId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルに参加しているBOTのリストを取得します。 * @summary チャンネル参加中のBOTのリストを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ getChannelBots(channelId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルのイベントリストを取得します。 * @summary チャンネルイベントのリストを取得 * @param {string} channelId チャンネルUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {string} [since] 取得する時間範囲の開始日時 * @param {string} [until] 取得する時間範囲の終了日時 * @param {boolean} [inclusive] 範囲の端を含めるかどうか * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ getChannelEvents(channelId: string, limit?: number, offset?: number, since?: string, until?: string, inclusive?: boolean, order?: 'asc' | 'desc', options?: AxiosRequestConfig): Promise>; /** * 指定されたチャンネルのパスを取得します。 * @summary 指定したチャンネルパスを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ getChannelPath(channelId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルにピン留めされているピンメッセージのリストを取得します。 * @summary チャンネルピンのリストを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ getChannelPins(channelId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルの統計情報を取得します。 * @summary チャンネル統計情報を取得 * @param {string} channelId チャンネルUUID * @param {boolean} [excludeDeletedMessages] 削除されたメッセージを除外するかどうか(デフォルト false) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ getChannelStats(channelId: string, excludeDeletedMessages?: boolean, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルを通知購読しているユーザーのUUIDのリストを取得します。 * @summary チャンネルの通知購読者のリストを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ getChannelSubscribers(channelId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルのトピックを取得します。 * @summary チャンネルトピックを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ getChannelTopic(channelId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルの閲覧者のリストを取得します。 * @summary チャンネル閲覧者リストを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ getChannelViewers(channelId: string, options?: AxiosRequestConfig): Promise>; /** * チャンネルのリストを取得します。 * @summary チャンネルリストを取得 * @param {boolean} [includeDm] ダイレクトメッセージチャンネルをレスポンスに含めるかどうか * @param {string} [path] パスが一致するチャンネルのみを取得する * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ getChannels(includeDm?: boolean, path?: string, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルのメッセージのリストを取得します。 * @summary チャンネルメッセージのリストを取得 * @param {string} channelId チャンネルUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {string} [since] 取得する時間範囲の開始日時 * @param {string} [until] 取得する時間範囲の終了日時 * @param {boolean} [inclusive] 範囲の端を含めるかどうか * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ getMessages(channelId: string, limit?: number, offset?: number, since?: string, until?: string, inclusive?: boolean, order?: 'asc' | 'desc', options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーとのダイレクトメッセージチャンネルの情報を返します。 ダイレクトメッセージチャンネルが存在しなかった場合、自動的に作成されます。 * @summary DMチャンネル情報を取得 * @param {string} userId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ getUserDMChannel(userId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルにメッセージを投稿します。 embedをtrueに指定すると、メッセージ埋め込みが自動で行われます。 アーカイブされているチャンネルに投稿することはできません。 * @summary チャンネルにメッセージを投稿 * @param {string} channelId チャンネルUUID * @param {PostMessageRequest} [postMessageRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ postMessage(channelId: string, postMessageRequest?: PostMessageRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルの通知購読者を設定します。 リクエストに含めなかったユーザーの通知購読状態はオフになります。 また、存在しないユーザーを指定した場合は無視されます。 * @summary チャンネルの通知購読者を設定 * @param {string} channelId チャンネルUUID * @param {PutChannelSubscribersRequest} [putChannelSubscribersRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ setChannelSubscribers(channelId: string, putChannelSubscribersRequest?: PutChannelSubscribersRequest, options?: AxiosRequestConfig): Promise>; } /** * ClipApi - axios parameter creator * @export */ declare const ClipApiAxiosParamCreator: (configuration?: Configuration) => { /** * 指定したメッセージを指定したクリップフォルダに追加します。 * @summary メッセージをクリップフォルダに追加 * @param {string} folderId クリップフォルダUUID * @param {PostClipFolderMessageRequest} [postClipFolderMessageRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ clipMessage: (folderId: string, postClipFolderMessageRequest?: PostClipFolderMessageRequest, options?: AxiosRequestConfig) => Promise; /** * クリップフォルダを作成します。 既にあるフォルダと同名のフォルダを作成することは可能です。 * @summary クリップフォルダを作成 * @param {PostClipFolderRequest} [postClipFolderRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createClipFolder: (postClipFolderRequest?: PostClipFolderRequest, options?: AxiosRequestConfig) => Promise; /** * 指定したクリップフォルダを削除します。 * @summary クリップフォルダを削除 * @param {string} folderId クリップフォルダUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteClipFolder: (folderId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したクリップフォルダの情報を編集します。 * @summary クリップフォルダ情報を編集 * @param {string} folderId クリップフォルダUUID * @param {PatchClipFolderRequest} [patchClipFolderRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editClipFolder: (folderId: string, patchClipFolderRequest?: PatchClipFolderRequest, options?: AxiosRequestConfig) => Promise; /** * 指定したクリップフォルダの情報を取得します。 * @summary クリップフォルダ情報を取得 * @param {string} folderId クリップフォルダUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getClipFolder: (folderId: string, options?: AxiosRequestConfig) => Promise; /** * 自身が所有するクリップフォルダのリストを取得します。 * @summary クリップフォルダのリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getClipFolders: (options?: AxiosRequestConfig) => Promise; /** * 指定したフォルダ内のクリップのリストを取得します。 `order`を指定しない場合、クリップした日時の新しい順で返されます。 * @summary フォルダ内のクリップのリストを取得 * @param {string} folderId クリップフォルダUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {*} [options] Override http request option. * @throws {RequiredError} */ getClips: (folderId: string, limit?: number, offset?: number, order?: "asc" | "desc", options?: AxiosRequestConfig) => Promise; /** * 対象のメッセージの自分のクリップの一覧を返します。 * @summary 自分のクリップを取得 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessageClips: (messageId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したフォルダから指定したメッセージのクリップを除外します。 既に外されているメッセージを指定した場合は204を返します。 * @summary メッセージをクリップフォルダから除外 * @param {string} folderId クリップフォルダUUID * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ unclipMessage: (folderId: string, messageId: string, options?: AxiosRequestConfig) => Promise; }; /** * ClipApi - functional programming interface * @export */ declare const ClipApiFp: (configuration?: Configuration) => { /** * 指定したメッセージを指定したクリップフォルダに追加します。 * @summary メッセージをクリップフォルダに追加 * @param {string} folderId クリップフォルダUUID * @param {PostClipFolderMessageRequest} [postClipFolderMessageRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ clipMessage(folderId: string, postClipFolderMessageRequest?: PostClipFolderMessageRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * クリップフォルダを作成します。 既にあるフォルダと同名のフォルダを作成することは可能です。 * @summary クリップフォルダを作成 * @param {PostClipFolderRequest} [postClipFolderRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createClipFolder(postClipFolderRequest?: PostClipFolderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したクリップフォルダを削除します。 * @summary クリップフォルダを削除 * @param {string} folderId クリップフォルダUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteClipFolder(folderId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したクリップフォルダの情報を編集します。 * @summary クリップフォルダ情報を編集 * @param {string} folderId クリップフォルダUUID * @param {PatchClipFolderRequest} [patchClipFolderRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editClipFolder(folderId: string, patchClipFolderRequest?: PatchClipFolderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したクリップフォルダの情報を取得します。 * @summary クリップフォルダ情報を取得 * @param {string} folderId クリップフォルダUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getClipFolder(folderId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 自身が所有するクリップフォルダのリストを取得します。 * @summary クリップフォルダのリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getClipFolders(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 指定したフォルダ内のクリップのリストを取得します。 `order`を指定しない場合、クリップした日時の新しい順で返されます。 * @summary フォルダ内のクリップのリストを取得 * @param {string} folderId クリップフォルダUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {*} [options] Override http request option. * @throws {RequiredError} */ getClips(folderId: string, limit?: number, offset?: number, order?: "asc" | "desc", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 対象のメッセージの自分のクリップの一覧を返します。 * @summary 自分のクリップを取得 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessageClips(messageId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 指定したフォルダから指定したメッセージのクリップを除外します。 既に外されているメッセージを指定した場合は204を返します。 * @summary メッセージをクリップフォルダから除外 * @param {string} folderId クリップフォルダUUID * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ unclipMessage(folderId: string, messageId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ClipApi - factory interface * @export */ declare const ClipApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * 指定したメッセージを指定したクリップフォルダに追加します。 * @summary メッセージをクリップフォルダに追加 * @param {string} folderId クリップフォルダUUID * @param {PostClipFolderMessageRequest} [postClipFolderMessageRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ clipMessage(folderId: string, postClipFolderMessageRequest?: PostClipFolderMessageRequest, options?: any): AxiosPromise; /** * クリップフォルダを作成します。 既にあるフォルダと同名のフォルダを作成することは可能です。 * @summary クリップフォルダを作成 * @param {PostClipFolderRequest} [postClipFolderRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createClipFolder(postClipFolderRequest?: PostClipFolderRequest, options?: any): AxiosPromise; /** * 指定したクリップフォルダを削除します。 * @summary クリップフォルダを削除 * @param {string} folderId クリップフォルダUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteClipFolder(folderId: string, options?: any): AxiosPromise; /** * 指定したクリップフォルダの情報を編集します。 * @summary クリップフォルダ情報を編集 * @param {string} folderId クリップフォルダUUID * @param {PatchClipFolderRequest} [patchClipFolderRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editClipFolder(folderId: string, patchClipFolderRequest?: PatchClipFolderRequest, options?: any): AxiosPromise; /** * 指定したクリップフォルダの情報を取得します。 * @summary クリップフォルダ情報を取得 * @param {string} folderId クリップフォルダUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getClipFolder(folderId: string, options?: any): AxiosPromise; /** * 自身が所有するクリップフォルダのリストを取得します。 * @summary クリップフォルダのリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getClipFolders(options?: any): AxiosPromise>; /** * 指定したフォルダ内のクリップのリストを取得します。 `order`を指定しない場合、クリップした日時の新しい順で返されます。 * @summary フォルダ内のクリップのリストを取得 * @param {string} folderId クリップフォルダUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {*} [options] Override http request option. * @throws {RequiredError} */ getClips(folderId: string, limit?: number, offset?: number, order?: "asc" | "desc", options?: any): AxiosPromise>; /** * 対象のメッセージの自分のクリップの一覧を返します。 * @summary 自分のクリップを取得 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessageClips(messageId: string, options?: any): AxiosPromise>; /** * 指定したフォルダから指定したメッセージのクリップを除外します。 既に外されているメッセージを指定した場合は204を返します。 * @summary メッセージをクリップフォルダから除外 * @param {string} folderId クリップフォルダUUID * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ unclipMessage(folderId: string, messageId: string, options?: any): AxiosPromise; }; /** * ClipApi - object-oriented interface * @export * @class ClipApi * @extends {BaseAPI} */ declare class ClipApi extends BaseAPI { /** * 指定したメッセージを指定したクリップフォルダに追加します。 * @summary メッセージをクリップフォルダに追加 * @param {string} folderId クリップフォルダUUID * @param {PostClipFolderMessageRequest} [postClipFolderMessageRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ClipApi */ clipMessage(folderId: string, postClipFolderMessageRequest?: PostClipFolderMessageRequest, options?: AxiosRequestConfig): Promise>; /** * クリップフォルダを作成します。 既にあるフォルダと同名のフォルダを作成することは可能です。 * @summary クリップフォルダを作成 * @param {PostClipFolderRequest} [postClipFolderRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ClipApi */ createClipFolder(postClipFolderRequest?: PostClipFolderRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したクリップフォルダを削除します。 * @summary クリップフォルダを削除 * @param {string} folderId クリップフォルダUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ClipApi */ deleteClipFolder(folderId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したクリップフォルダの情報を編集します。 * @summary クリップフォルダ情報を編集 * @param {string} folderId クリップフォルダUUID * @param {PatchClipFolderRequest} [patchClipFolderRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ClipApi */ editClipFolder(folderId: string, patchClipFolderRequest?: PatchClipFolderRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したクリップフォルダの情報を取得します。 * @summary クリップフォルダ情報を取得 * @param {string} folderId クリップフォルダUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ClipApi */ getClipFolder(folderId: string, options?: AxiosRequestConfig): Promise>; /** * 自身が所有するクリップフォルダのリストを取得します。 * @summary クリップフォルダのリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ClipApi */ getClipFolders(options?: AxiosRequestConfig): Promise>; /** * 指定したフォルダ内のクリップのリストを取得します。 `order`を指定しない場合、クリップした日時の新しい順で返されます。 * @summary フォルダ内のクリップのリストを取得 * @param {string} folderId クリップフォルダUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ClipApi */ getClips(folderId: string, limit?: number, offset?: number, order?: 'asc' | 'desc', options?: AxiosRequestConfig): Promise>; /** * 対象のメッセージの自分のクリップの一覧を返します。 * @summary 自分のクリップを取得 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ClipApi */ getMessageClips(messageId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したフォルダから指定したメッセージのクリップを除外します。 既に外されているメッセージを指定した場合は204を返します。 * @summary メッセージをクリップフォルダから除外 * @param {string} folderId クリップフォルダUUID * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ClipApi */ unclipMessage(folderId: string, messageId: string, options?: AxiosRequestConfig): Promise>; } /** * FileApi - axios parameter creator * @export */ declare const FileApiAxiosParamCreator: (configuration?: Configuration) => { /** * 指定したファイルを削除します。 指定したファイルの削除権限が必要です。 * @summary ファイルを削除 * @param {string} fileId ファイルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFile: (fileId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したファイル本体を取得します。 指定したファイルへのアクセス権限が必要です。 * @summary ファイルをダウンロード * @param {string} fileId ファイルUUID * @param {number} [dl] このクエリパラメータは廃止されており、意味を持ちません（現在、このパラメータが0の場合も1の場合もレスポンスにはContent-Dispositionヘッダーが付与されます） * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFile: (fileId: string, dl?: number, options?: AxiosRequestConfig) => Promise; /** * 指定したファイルのメタ情報を取得します。 指定したファイルへのアクセス権限が必要です。 * @summary ファイルメタを取得 * @param {string} fileId ファイルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFileMeta: (fileId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したクエリでファイルメタのリストを取得します。 クエリパラメータ`channelId`, `mine`の少なくともいずれかが必須です。 * @summary ファイルメタのリストを取得 * @param {string} [channelId] アップロード先チャンネルUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {string} [since] 取得する時間範囲の開始日時 * @param {string} [until] 取得する時間範囲の終了日時 * @param {boolean} [inclusive] 範囲の端を含めるかどうか * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {boolean} [mine] アップロード者が自分のファイルのみを取得するか * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFiles: (channelId?: string, limit?: number, offset?: number, since?: string, until?: string, inclusive?: boolean, order?: "asc" | "desc", mine?: boolean, options?: AxiosRequestConfig) => Promise; /** * 指定したファイルのサムネイル画像を取得します。 指定したファイルへのアクセス権限が必要です。 * @summary サムネイル画像を取得 * @param {string} fileId ファイルUUID * @param {ThumbnailType} [type] 取得するサムネイルのタイプ * @param {*} [options] Override http request option. * @throws {RequiredError} */ getThumbnailImage: (fileId: string, type?: ThumbnailType, options?: AxiosRequestConfig) => Promise; /** * 指定したチャンネルにファイルをアップロードします。 アーカイブされているチャンネルにはアップロード出来ません。 * @summary ファイルをアップロード * @param {File} file ファイル本体 * @param {string} channelId アップロード先チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ postFile: (file: File, channelId: string, options?: AxiosRequestConfig) => Promise; }; /** * FileApi - functional programming interface * @export */ declare const FileApiFp: (configuration?: Configuration) => { /** * 指定したファイルを削除します。 指定したファイルの削除権限が必要です。 * @summary ファイルを削除 * @param {string} fileId ファイルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFile(fileId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したファイル本体を取得します。 指定したファイルへのアクセス権限が必要です。 * @summary ファイルをダウンロード * @param {string} fileId ファイルUUID * @param {number} [dl] このクエリパラメータは廃止されており、意味を持ちません（現在、このパラメータが0の場合も1の場合もレスポンスにはContent-Dispositionヘッダーが付与されます） * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFile(fileId: string, dl?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したファイルのメタ情報を取得します。 指定したファイルへのアクセス権限が必要です。 * @summary ファイルメタを取得 * @param {string} fileId ファイルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFileMeta(fileId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したクエリでファイルメタのリストを取得します。 クエリパラメータ`channelId`, `mine`の少なくともいずれかが必須です。 * @summary ファイルメタのリストを取得 * @param {string} [channelId] アップロード先チャンネルUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {string} [since] 取得する時間範囲の開始日時 * @param {string} [until] 取得する時間範囲の終了日時 * @param {boolean} [inclusive] 範囲の端を含めるかどうか * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {boolean} [mine] アップロード者が自分のファイルのみを取得するか * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFiles(channelId?: string, limit?: number, offset?: number, since?: string, until?: string, inclusive?: boolean, order?: "asc" | "desc", mine?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 指定したファイルのサムネイル画像を取得します。 指定したファイルへのアクセス権限が必要です。 * @summary サムネイル画像を取得 * @param {string} fileId ファイルUUID * @param {ThumbnailType} [type] 取得するサムネイルのタイプ * @param {*} [options] Override http request option. * @throws {RequiredError} */ getThumbnailImage(fileId: string, type?: ThumbnailType, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したチャンネルにファイルをアップロードします。 アーカイブされているチャンネルにはアップロード出来ません。 * @summary ファイルをアップロード * @param {File} file ファイル本体 * @param {string} channelId アップロード先チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ postFile(file: File, channelId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * FileApi - factory interface * @export */ declare const FileApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * 指定したファイルを削除します。 指定したファイルの削除権限が必要です。 * @summary ファイルを削除 * @param {string} fileId ファイルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFile(fileId: string, options?: any): AxiosPromise; /** * 指定したファイル本体を取得します。 指定したファイルへのアクセス権限が必要です。 * @summary ファイルをダウンロード * @param {string} fileId ファイルUUID * @param {number} [dl] このクエリパラメータは廃止されており、意味を持ちません（現在、このパラメータが0の場合も1の場合もレスポンスにはContent-Dispositionヘッダーが付与されます） * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFile(fileId: string, dl?: number, options?: any): AxiosPromise; /** * 指定したファイルのメタ情報を取得します。 指定したファイルへのアクセス権限が必要です。 * @summary ファイルメタを取得 * @param {string} fileId ファイルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFileMeta(fileId: string, options?: any): AxiosPromise; /** * 指定したクエリでファイルメタのリストを取得します。 クエリパラメータ`channelId`, `mine`の少なくともいずれかが必須です。 * @summary ファイルメタのリストを取得 * @param {string} [channelId] アップロード先チャンネルUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {string} [since] 取得する時間範囲の開始日時 * @param {string} [until] 取得する時間範囲の終了日時 * @param {boolean} [inclusive] 範囲の端を含めるかどうか * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {boolean} [mine] アップロード者が自分のファイルのみを取得するか * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFiles(channelId?: string, limit?: number, offset?: number, since?: string, until?: string, inclusive?: boolean, order?: "asc" | "desc", mine?: boolean, options?: any): AxiosPromise>; /** * 指定したファイルのサムネイル画像を取得します。 指定したファイルへのアクセス権限が必要です。 * @summary サムネイル画像を取得 * @param {string} fileId ファイルUUID * @param {ThumbnailType} [type] 取得するサムネイルのタイプ * @param {*} [options] Override http request option. * @throws {RequiredError} */ getThumbnailImage(fileId: string, type?: ThumbnailType, options?: any): AxiosPromise; /** * 指定したチャンネルにファイルをアップロードします。 アーカイブされているチャンネルにはアップロード出来ません。 * @summary ファイルをアップロード * @param {File} file ファイル本体 * @param {string} channelId アップロード先チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ postFile(file: File, channelId: string, options?: any): AxiosPromise; }; /** * FileApi - object-oriented interface * @export * @class FileApi * @extends {BaseAPI} */ declare class FileApi extends BaseAPI { /** * 指定したファイルを削除します。 指定したファイルの削除権限が必要です。 * @summary ファイルを削除 * @param {string} fileId ファイルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FileApi */ deleteFile(fileId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したファイル本体を取得します。 指定したファイルへのアクセス権限が必要です。 * @summary ファイルをダウンロード * @param {string} fileId ファイルUUID * @param {number} [dl] このクエリパラメータは廃止されており、意味を持ちません（現在、このパラメータが0の場合も1の場合もレスポンスにはContent-Dispositionヘッダーが付与されます） * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FileApi */ getFile(fileId: string, dl?: number, options?: AxiosRequestConfig): Promise>; /** * 指定したファイルのメタ情報を取得します。 指定したファイルへのアクセス権限が必要です。 * @summary ファイルメタを取得 * @param {string} fileId ファイルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FileApi */ getFileMeta(fileId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したクエリでファイルメタのリストを取得します。 クエリパラメータ`channelId`, `mine`の少なくともいずれかが必須です。 * @summary ファイルメタのリストを取得 * @param {string} [channelId] アップロード先チャンネルUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {string} [since] 取得する時間範囲の開始日時 * @param {string} [until] 取得する時間範囲の終了日時 * @param {boolean} [inclusive] 範囲の端を含めるかどうか * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {boolean} [mine] アップロード者が自分のファイルのみを取得するか * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FileApi */ getFiles(channelId?: string, limit?: number, offset?: number, since?: string, until?: string, inclusive?: boolean, order?: 'asc' | 'desc', mine?: boolean, options?: AxiosRequestConfig): Promise>; /** * 指定したファイルのサムネイル画像を取得します。 指定したファイルへのアクセス権限が必要です。 * @summary サムネイル画像を取得 * @param {string} fileId ファイルUUID * @param {ThumbnailType} [type] 取得するサムネイルのタイプ * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FileApi */ getThumbnailImage(fileId: string, type?: ThumbnailType, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルにファイルをアップロードします。 アーカイブされているチャンネルにはアップロード出来ません。 * @summary ファイルをアップロード * @param {File} file ファイル本体 * @param {string} channelId アップロード先チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FileApi */ postFile(file: File, channelId: string, options?: AxiosRequestConfig): Promise>; } /** * GroupApi - axios parameter creator * @export */ declare const GroupApiAxiosParamCreator: (configuration?: Configuration) => { /** * 指定したグループに管理者を追加します。 対象のユーザーグループの管理者権限が必要です。 * @summary グループ管理者を追加 * @param {string} groupId ユーザーグループUUID * @param {PostUserGroupAdminRequest} [postUserGroupAdminRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addUserGroupAdmin: (groupId: string, postUserGroupAdminRequest?: PostUserGroupAdminRequest, options?: AxiosRequestConfig) => Promise; /** * 指定したグループにメンバーを追加します。 対象のユーザーグループの管理者権限が必要です。 * @summary グループメンバーを追加 * @param {string} groupId ユーザーグループUUID * @param {AddUserGroupMemberRequest} [addUserGroupMemberRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addUserGroupMember: (groupId: string, addUserGroupMemberRequest?: AddUserGroupMemberRequest, options?: AxiosRequestConfig) => Promise; /** * ユーザーグループのアイコンを変更します。 対象のユーザーグループの管理者権限が必要です。 * @summary ユーザーグループのアイコンを変更 * @param {string} groupId ユーザーグループUUID * @param {File} file アイコン画像(2MB,`Config.Imaging.MaxPixels`(default: 2560*1600)までのpng, jpeg, gif) * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeUserGroupIcon: (groupId: string, file: File, options?: AxiosRequestConfig) => Promise; /** * ユーザーグループを作成します。 作成者は自動的にグループ管理者になります。 * @summary ユーザーグループを作成 * @param {PostUserGroupRequest} [postUserGroupRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createUserGroup: (postUserGroupRequest?: PostUserGroupRequest, options?: AxiosRequestConfig) => Promise; /** * 指定したユーザーグループを削除します。 対象のユーザーグループの管理者権限が必要です。 * @summary ユーザーグループを削除 * @param {string} groupId ユーザーグループUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUserGroup: (groupId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したユーザーグループの情報を編集します。 対象のユーザーグループの管理者権限が必要です。 * @summary ユーザーグループを編集 * @param {string} groupId ユーザーグループUUID * @param {PatchUserGroupRequest} [patchUserGroupRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editUserGroup: (groupId: string, patchUserGroupRequest?: PatchUserGroupRequest, options?: AxiosRequestConfig) => Promise; /** * 指定したユーザーグループ内の指定したユーザーの属性を編集します。 対象のユーザーグループの管理者権限が必要です。 * @summary グループメンバーを編集 * @param {string} groupId ユーザーグループUUID * @param {string} userId ユーザーUUID * @param {PatchGroupMemberRequest} [patchGroupMemberRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editUserGroupMember: (groupId: string, userId: string, patchGroupMemberRequest?: PatchGroupMemberRequest, options?: AxiosRequestConfig) => Promise; /** * 指定したユーザーグループの情報を取得します。 * @summary ユーザーグループを取得 * @param {string} groupId ユーザーグループUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserGroup: (groupId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したグループの管理者のリストを取得します。 * @summary グループ管理者を取得 * @param {string} groupId ユーザーグループUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserGroupAdmins: (groupId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したグループのメンバーのリストを取得します。 * @summary グループメンバーを取得 * @param {string} groupId ユーザーグループUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserGroupMembers: (groupId: string, options?: AxiosRequestConfig) => Promise; /** * ユーザーグループのリストを取得します。 * @summary ユーザーグループのリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserGroups: (options?: AxiosRequestConfig) => Promise; /** * 指定したユーザーグループから指定した管理者を削除します。 対象のユーザーグループの管理者権限が必要です。 グループから管理者が存在しなくなる場合は400エラーを返します。 * @summary グループ管理者を削除 * @param {string} groupId ユーザーグループUUID * @param {string} userId ユーザーUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeUserGroupAdmin: (groupId: string, userId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したユーザーグループから指定したユーザーを削除します。 既にグループから削除されているメンバーを指定した場合は204を返します。 対象のユーザーグループの管理者権限が必要です。 * @summary グループメンバーを削除 * @param {string} groupId ユーザーグループUUID * @param {string} userId ユーザーUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeUserGroupMember: (groupId: string, userId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したグループから全てのメンバーを削除します。 対象のユーザーグループの管理者権限が必要です。 * @summary グループメンバーを一括削除 * @param {string} groupId ユーザーグループUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeUserGroupMembers: (groupId: string, options?: AxiosRequestConfig) => Promise; }; /** * GroupApi - functional programming interface * @export */ declare const GroupApiFp: (configuration?: Configuration) => { /** * 指定したグループに管理者を追加します。 対象のユーザーグループの管理者権限が必要です。 * @summary グループ管理者を追加 * @param {string} groupId ユーザーグループUUID * @param {PostUserGroupAdminRequest} [postUserGroupAdminRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addUserGroupAdmin(groupId: string, postUserGroupAdminRequest?: PostUserGroupAdminRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したグループにメンバーを追加します。 対象のユーザーグループの管理者権限が必要です。 * @summary グループメンバーを追加 * @param {string} groupId ユーザーグループUUID * @param {AddUserGroupMemberRequest} [addUserGroupMemberRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addUserGroupMember(groupId: string, addUserGroupMemberRequest?: AddUserGroupMemberRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * ユーザーグループのアイコンを変更します。 対象のユーザーグループの管理者権限が必要です。 * @summary ユーザーグループのアイコンを変更 * @param {string} groupId ユーザーグループUUID * @param {File} file アイコン画像(2MB,`Config.Imaging.MaxPixels`(default: 2560*1600)までのpng, jpeg, gif) * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeUserGroupIcon(groupId: string, file: File, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * ユーザーグループを作成します。 作成者は自動的にグループ管理者になります。 * @summary ユーザーグループを作成 * @param {PostUserGroupRequest} [postUserGroupRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createUserGroup(postUserGroupRequest?: PostUserGroupRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したユーザーグループを削除します。 対象のユーザーグループの管理者権限が必要です。 * @summary ユーザーグループを削除 * @param {string} groupId ユーザーグループUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUserGroup(groupId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したユーザーグループの情報を編集します。 対象のユーザーグループの管理者権限が必要です。 * @summary ユーザーグループを編集 * @param {string} groupId ユーザーグループUUID * @param {PatchUserGroupRequest} [patchUserGroupRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editUserGroup(groupId: string, patchUserGroupRequest?: PatchUserGroupRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したユーザーグループ内の指定したユーザーの属性を編集します。 対象のユーザーグループの管理者権限が必要です。 * @summary グループメンバーを編集 * @param {string} groupId ユーザーグループUUID * @param {string} userId ユーザーUUID * @param {PatchGroupMemberRequest} [patchGroupMemberRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editUserGroupMember(groupId: string, userId: string, patchGroupMemberRequest?: PatchGroupMemberRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したユーザーグループの情報を取得します。 * @summary ユーザーグループを取得 * @param {string} groupId ユーザーグループUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserGroup(groupId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したグループの管理者のリストを取得します。 * @summary グループ管理者を取得 * @param {string} groupId ユーザーグループUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserGroupAdmins(groupId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 指定したグループのメンバーのリストを取得します。 * @summary グループメンバーを取得 * @param {string} groupId ユーザーグループUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserGroupMembers(groupId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * ユーザーグループのリストを取得します。 * @summary ユーザーグループのリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserGroups(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 指定したユーザーグループから指定した管理者を削除します。 対象のユーザーグループの管理者権限が必要です。 グループから管理者が存在しなくなる場合は400エラーを返します。 * @summary グループ管理者を削除 * @param {string} groupId ユーザーグループUUID * @param {string} userId ユーザーUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeUserGroupAdmin(groupId: string, userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したユーザーグループから指定したユーザーを削除します。 既にグループから削除されているメンバーを指定した場合は204を返します。 対象のユーザーグループの管理者権限が必要です。 * @summary グループメンバーを削除 * @param {string} groupId ユーザーグループUUID * @param {string} userId ユーザーUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeUserGroupMember(groupId: string, userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したグループから全てのメンバーを削除します。 対象のユーザーグループの管理者権限が必要です。 * @summary グループメンバーを一括削除 * @param {string} groupId ユーザーグループUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeUserGroupMembers(groupId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * GroupApi - factory interface * @export */ declare const GroupApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * 指定したグループに管理者を追加します。 対象のユーザーグループの管理者権限が必要です。 * @summary グループ管理者を追加 * @param {string} groupId ユーザーグループUUID * @param {PostUserGroupAdminRequest} [postUserGroupAdminRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addUserGroupAdmin(groupId: string, postUserGroupAdminRequest?: PostUserGroupAdminRequest, options?: any): AxiosPromise; /** * 指定したグループにメンバーを追加します。 対象のユーザーグループの管理者権限が必要です。 * @summary グループメンバーを追加 * @param {string} groupId ユーザーグループUUID * @param {AddUserGroupMemberRequest} [addUserGroupMemberRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addUserGroupMember(groupId: string, addUserGroupMemberRequest?: AddUserGroupMemberRequest, options?: any): AxiosPromise; /** * ユーザーグループのアイコンを変更します。 対象のユーザーグループの管理者権限が必要です。 * @summary ユーザーグループのアイコンを変更 * @param {string} groupId ユーザーグループUUID * @param {File} file アイコン画像(2MB,`Config.Imaging.MaxPixels`(default: 2560*1600)までのpng, jpeg, gif) * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeUserGroupIcon(groupId: string, file: File, options?: any): AxiosPromise; /** * ユーザーグループを作成します。 作成者は自動的にグループ管理者になります。 * @summary ユーザーグループを作成 * @param {PostUserGroupRequest} [postUserGroupRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createUserGroup(postUserGroupRequest?: PostUserGroupRequest, options?: any): AxiosPromise; /** * 指定したユーザーグループを削除します。 対象のユーザーグループの管理者権限が必要です。 * @summary ユーザーグループを削除 * @param {string} groupId ユーザーグループUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUserGroup(groupId: string, options?: any): AxiosPromise; /** * 指定したユーザーグループの情報を編集します。 対象のユーザーグループの管理者権限が必要です。 * @summary ユーザーグループを編集 * @param {string} groupId ユーザーグループUUID * @param {PatchUserGroupRequest} [patchUserGroupRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editUserGroup(groupId: string, patchUserGroupRequest?: PatchUserGroupRequest, options?: any): AxiosPromise; /** * 指定したユーザーグループ内の指定したユーザーの属性を編集します。 対象のユーザーグループの管理者権限が必要です。 * @summary グループメンバーを編集 * @param {string} groupId ユーザーグループUUID * @param {string} userId ユーザーUUID * @param {PatchGroupMemberRequest} [patchGroupMemberRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editUserGroupMember(groupId: string, userId: string, patchGroupMemberRequest?: PatchGroupMemberRequest, options?: any): AxiosPromise; /** * 指定したユーザーグループの情報を取得します。 * @summary ユーザーグループを取得 * @param {string} groupId ユーザーグループUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserGroup(groupId: string, options?: any): AxiosPromise; /** * 指定したグループの管理者のリストを取得します。 * @summary グループ管理者を取得 * @param {string} groupId ユーザーグループUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserGroupAdmins(groupId: string, options?: any): AxiosPromise>; /** * 指定したグループのメンバーのリストを取得します。 * @summary グループメンバーを取得 * @param {string} groupId ユーザーグループUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserGroupMembers(groupId: string, options?: any): AxiosPromise>; /** * ユーザーグループのリストを取得します。 * @summary ユーザーグループのリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserGroups(options?: any): AxiosPromise>; /** * 指定したユーザーグループから指定した管理者を削除します。 対象のユーザーグループの管理者権限が必要です。 グループから管理者が存在しなくなる場合は400エラーを返します。 * @summary グループ管理者を削除 * @param {string} groupId ユーザーグループUUID * @param {string} userId ユーザーUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeUserGroupAdmin(groupId: string, userId: string, options?: any): AxiosPromise; /** * 指定したユーザーグループから指定したユーザーを削除します。 既にグループから削除されているメンバーを指定した場合は204を返します。 対象のユーザーグループの管理者権限が必要です。 * @summary グループメンバーを削除 * @param {string} groupId ユーザーグループUUID * @param {string} userId ユーザーUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeUserGroupMember(groupId: string, userId: string, options?: any): AxiosPromise; /** * 指定したグループから全てのメンバーを削除します。 対象のユーザーグループの管理者権限が必要です。 * @summary グループメンバーを一括削除 * @param {string} groupId ユーザーグループUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeUserGroupMembers(groupId: string, options?: any): AxiosPromise; }; /** * GroupApi - object-oriented interface * @export * @class GroupApi * @extends {BaseAPI} */ declare class GroupApi extends BaseAPI { /** * 指定したグループに管理者を追加します。 対象のユーザーグループの管理者権限が必要です。 * @summary グループ管理者を追加 * @param {string} groupId ユーザーグループUUID * @param {PostUserGroupAdminRequest} [postUserGroupAdminRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupApi */ addUserGroupAdmin(groupId: string, postUserGroupAdminRequest?: PostUserGroupAdminRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したグループにメンバーを追加します。 対象のユーザーグループの管理者権限が必要です。 * @summary グループメンバーを追加 * @param {string} groupId ユーザーグループUUID * @param {AddUserGroupMemberRequest} [addUserGroupMemberRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupApi */ addUserGroupMember(groupId: string, addUserGroupMemberRequest?: AddUserGroupMemberRequest, options?: AxiosRequestConfig): Promise>; /** * ユーザーグループのアイコンを変更します。 対象のユーザーグループの管理者権限が必要です。 * @summary ユーザーグループのアイコンを変更 * @param {string} groupId ユーザーグループUUID * @param {File} file アイコン画像(2MB,`Config.Imaging.MaxPixels`(default: 2560*1600)までのpng, jpeg, gif) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupApi */ changeUserGroupIcon(groupId: string, file: File, options?: AxiosRequestConfig): Promise>; /** * ユーザーグループを作成します。 作成者は自動的にグループ管理者になります。 * @summary ユーザーグループを作成 * @param {PostUserGroupRequest} [postUserGroupRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupApi */ createUserGroup(postUserGroupRequest?: PostUserGroupRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーグループを削除します。 対象のユーザーグループの管理者権限が必要です。 * @summary ユーザーグループを削除 * @param {string} groupId ユーザーグループUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupApi */ deleteUserGroup(groupId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーグループの情報を編集します。 対象のユーザーグループの管理者権限が必要です。 * @summary ユーザーグループを編集 * @param {string} groupId ユーザーグループUUID * @param {PatchUserGroupRequest} [patchUserGroupRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupApi */ editUserGroup(groupId: string, patchUserGroupRequest?: PatchUserGroupRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーグループ内の指定したユーザーの属性を編集します。 対象のユーザーグループの管理者権限が必要です。 * @summary グループメンバーを編集 * @param {string} groupId ユーザーグループUUID * @param {string} userId ユーザーUUID * @param {PatchGroupMemberRequest} [patchGroupMemberRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupApi */ editUserGroupMember(groupId: string, userId: string, patchGroupMemberRequest?: PatchGroupMemberRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーグループの情報を取得します。 * @summary ユーザーグループを取得 * @param {string} groupId ユーザーグループUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupApi */ getUserGroup(groupId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したグループの管理者のリストを取得します。 * @summary グループ管理者を取得 * @param {string} groupId ユーザーグループUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupApi */ getUserGroupAdmins(groupId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したグループのメンバーのリストを取得します。 * @summary グループメンバーを取得 * @param {string} groupId ユーザーグループUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupApi */ getUserGroupMembers(groupId: string, options?: AxiosRequestConfig): Promise>; /** * ユーザーグループのリストを取得します。 * @summary ユーザーグループのリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupApi */ getUserGroups(options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーグループから指定した管理者を削除します。 対象のユーザーグループの管理者権限が必要です。 グループから管理者が存在しなくなる場合は400エラーを返します。 * @summary グループ管理者を削除 * @param {string} groupId ユーザーグループUUID * @param {string} userId ユーザーUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupApi */ removeUserGroupAdmin(groupId: string, userId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーグループから指定したユーザーを削除します。 既にグループから削除されているメンバーを指定した場合は204を返します。 対象のユーザーグループの管理者権限が必要です。 * @summary グループメンバーを削除 * @param {string} groupId ユーザーグループUUID * @param {string} userId ユーザーUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupApi */ removeUserGroupMember(groupId: string, userId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したグループから全てのメンバーを削除します。 対象のユーザーグループの管理者権限が必要です。 * @summary グループメンバーを一括削除 * @param {string} groupId ユーザーグループUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupApi */ removeUserGroupMembers(groupId: string, options?: AxiosRequestConfig): Promise>; } /** * MeApi - axios parameter creator * @export */ declare const MeApiAxiosParamCreator: (configuration?: Configuration) => { /** * 指定したチャンネルをスターチャンネルに追加します。 スター済みのチャンネルIDを指定した場合、204を返します。 不正なチャンネルIDを指定した場合、400を返します。 * @summary チャンネルをスターに追加 * @param {PostStarRequest} [postStarRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addMyStar: (postStarRequest?: PostStarRequest, options?: AxiosRequestConfig) => Promise; /** * 自分に新しくタグを追加します。 * @summary 自分にタグを追加 * @param {PostUserTagRequest} [postUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addMyUserTag: (postUserTagRequest?: PostUserTagRequest, options?: AxiosRequestConfig) => Promise; /** * 自分のアイコン画像を変更します。 * @summary 自分のアイコン画像を変更 * @param {File} file アイコン画像(2MB,`Config.Imaging.MaxPixels`(default: 2560*1600)までのpng, jpeg, gif) * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeMyIcon: (file: File, options?: AxiosRequestConfig) => Promise; /** * メッセージ引用通知の設定情報を変更します * @summary メッセージ引用通知の設定情報を変更 * @param {PutNotifyCitationRequest} [putNotifyCitationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeMyNotifyCitation: (putNotifyCitationRequest?: PutNotifyCitationRequest, options?: AxiosRequestConfig) => Promise; /** * 自身のパスワードを変更します。 * @summary 自分のパスワードを変更 * @param {PutMyPasswordRequest} [putMyPasswordRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeMyPassword: (putMyPasswordRequest?: PutMyPasswordRequest, options?: AxiosRequestConfig) => Promise; /** * 自身のユーザー情報を変更します。 * @summary 自分のユーザー情報を変更 * @param {PatchMeRequest} [patchMeRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editMe: (patchMeRequest?: PatchMeRequest, options?: AxiosRequestConfig) => Promise; /** * 自分の指定したタグの状態を変更します。 * @summary 自分のタグを編集 * @param {string} tagId タグUUID * @param {PatchUserTagRequest} [patchUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editMyUserTag: (tagId: string, patchUserTagRequest?: PatchUserTagRequest, options?: AxiosRequestConfig) => Promise; /** * 自身のユーザー詳細情報を取得します。 * @summary 自分のユーザー詳細を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMe: (options?: AxiosRequestConfig) => Promise; /** * 自身のチャンネル購読状態を取得します。 * @summary 自分のチャンネル購読状態を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyChannelSubscriptions: (options?: AxiosRequestConfig) => Promise; /** * 自分に紐付けられている外部ログインアカウント一覧を取得します。 * @summary 外部ログインアカウント一覧を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyExternalAccounts: (options?: AxiosRequestConfig) => Promise; /** * 自分のアイコン画像を取得します。 * @summary 自分のアイコン画像を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyIcon: (options?: AxiosRequestConfig) => Promise; /** * メッセージ引用通知の設定情報を変更します。 * @summary メッセージ引用通知の設定情報を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyNotifyCitation: (options?: AxiosRequestConfig) => Promise; /** * 自身のQRコードを取得します。 返されたQRコードまたはトークンは、発行後の5分間のみ有効です * @summary QRコードを取得 * @param {boolean} [token] 画像でなくトークン文字列で返すかどうか * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyQRCode: (token?: boolean, options?: AxiosRequestConfig) => Promise; /** * 自分のログインセッションのリストを取得します。 * @summary 自分のログインセッションリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMySessions: (options?: AxiosRequestConfig) => Promise; /** * 自分のスタンプ履歴を最大100件まで取得します。 結果は降順で返されます。 このAPIが返すスタンプ履歴は厳密な履歴ではありません。 * @summary スタンプ履歴を取得 * @param {number} [limit] 件数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyStampHistory: (limit?: number, options?: AxiosRequestConfig) => Promise; /** * 自分のスタンプレコメンドを最大200件まで取得します。 結果は推薦度の高い順で返されます。 スタンプを使用したことがないユーザーの場合は空配列が返されます。 * @summary スタンプレコメンドを取得 * @param {number} [limit] 件数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyStampRecommendations: (limit?: number, options?: AxiosRequestConfig) => Promise; /** * 自分がスターしているチャンネルのUUIDの配列を取得します。 * @summary スターチャンネルリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyStars: (options?: AxiosRequestConfig) => Promise; /** * 有効な自分に発行されたOAuth2トークンのリストを取得します。 * @summary 有効トークンのリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyTokens: (options?: AxiosRequestConfig) => Promise; /** * 自分が現在未読のチャンネルの未読情報を取得します。 * @summary 未読チャンネルを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyUnreadChannels: (options?: AxiosRequestConfig) => Promise; /** * 自分に付けられているタグの配列を取得します。 * @summary 自分のタグリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyUserTags: (options?: AxiosRequestConfig) => Promise; /** * 自身のチャンネル閲覧状態一覧を取得します。 * @summary 自身のチャンネル閲覧状態一覧を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyViewStates: (options?: AxiosRequestConfig) => Promise; /** * OIDCトークンを用いてユーザー詳細を取得します。 OIDC UserInfo Endpointです。 * @summary 自分のユーザー詳細を取得 (OIDC UserInfo) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOIDCUserInfo: (options?: AxiosRequestConfig) => Promise; /** * ユーザー設定を取得します。 * @summary ユーザー設定を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserSettings: (options?: AxiosRequestConfig) => Promise; /** * 自分に外部ログインアカウントを紐付けます。 指定した`providerName`がサーバー側で有効である必要があります。 リクエストが受理された場合、外部サービスの認証画面にリダイレクトされ、認証される必要があります。 * @summary 外部ログインアカウントを紐付ける * @param {PostLinkExternalAccount} [postLinkExternalAccount] * @param {*} [options] Override http request option. * @throws {RequiredError} */ linkExternalAccount: (postLinkExternalAccount?: PostLinkExternalAccount, options?: AxiosRequestConfig) => Promise; /** * 自分が未読のチャンネルを既読にします。 * @summary チャンネルを既読にする * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ readChannel: (channelId: string, options?: AxiosRequestConfig) => Promise; /** * 自身のFCMデバイスを登録します。 * @summary FCMデバイスを登録 * @param {PostMyFCMDeviceRequest} [postMyFCMDeviceRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ registerFCMDevice: (postMyFCMDeviceRequest?: PostMyFCMDeviceRequest, options?: AxiosRequestConfig) => Promise; /** * 既にスターから削除されているチャンネルを指定した場合は204を返します。 * @summary チャンネルをスターから削除します * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeMyStar: (channelId: string, options?: AxiosRequestConfig) => Promise; /** * 既に存在しないタグを削除しようとした場合は204を返します。 * @summary 自分からタグを削除します * @param {string} tagId タグUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeMyUserTag: (tagId: string, options?: AxiosRequestConfig) => Promise; /** * 指定した自分のセッションを無効化(ログアウト)します。 既に存在しない・無効化されているセッションを指定した場合も`204`を返します。 * @summary セッションを無効化 * @param {string} sessionId セッションUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ revokeMySession: (sessionId: string, options?: AxiosRequestConfig) => Promise; /** * 自分の指定したトークンの認可を取り消します。 * @summary トークンの認可を取り消す * @param {string} tokenId OAuth2トークンUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ revokeMyToken: (tokenId: string, options?: AxiosRequestConfig) => Promise; /** * 自身の指定したチャンネルの購読レベルを設定します。 * @summary チャンネル購読レベルを設定 * @param {string} channelId チャンネルUUID * @param {PutChannelSubscribeLevelRequest} [putChannelSubscribeLevelRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ setChannelSubscribeLevel: (channelId: string, putChannelSubscribeLevelRequest?: PutChannelSubscribeLevelRequest, options?: AxiosRequestConfig) => Promise; /** * 自分に紐付けられている外部ログインアカウントの紐付けを解除します。 * @summary 外部ログインアカウントの紐付けを解除 * @param {PostUnlinkExternalAccount} [postUnlinkExternalAccount] * @param {*} [options] Override http request option. * @throws {RequiredError} */ unlinkExternalAccount: (postUnlinkExternalAccount?: PostUnlinkExternalAccount, options?: AxiosRequestConfig) => Promise; }; /** * MeApi - functional programming interface * @export */ declare const MeApiFp: (configuration?: Configuration) => { /** * 指定したチャンネルをスターチャンネルに追加します。 スター済みのチャンネルIDを指定した場合、204を返します。 不正なチャンネルIDを指定した場合、400を返します。 * @summary チャンネルをスターに追加 * @param {PostStarRequest} [postStarRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addMyStar(postStarRequest?: PostStarRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 自分に新しくタグを追加します。 * @summary 自分にタグを追加 * @param {PostUserTagRequest} [postUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addMyUserTag(postUserTagRequest?: PostUserTagRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 自分のアイコン画像を変更します。 * @summary 自分のアイコン画像を変更 * @param {File} file アイコン画像(2MB,`Config.Imaging.MaxPixels`(default: 2560*1600)までのpng, jpeg, gif) * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeMyIcon(file: File, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * メッセージ引用通知の設定情報を変更します * @summary メッセージ引用通知の設定情報を変更 * @param {PutNotifyCitationRequest} [putNotifyCitationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeMyNotifyCitation(putNotifyCitationRequest?: PutNotifyCitationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 自身のパスワードを変更します。 * @summary 自分のパスワードを変更 * @param {PutMyPasswordRequest} [putMyPasswordRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeMyPassword(putMyPasswordRequest?: PutMyPasswordRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 自身のユーザー情報を変更します。 * @summary 自分のユーザー情報を変更 * @param {PatchMeRequest} [patchMeRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editMe(patchMeRequest?: PatchMeRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 自分の指定したタグの状態を変更します。 * @summary 自分のタグを編集 * @param {string} tagId タグUUID * @param {PatchUserTagRequest} [patchUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editMyUserTag(tagId: string, patchUserTagRequest?: PatchUserTagRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 自身のユーザー詳細情報を取得します。 * @summary 自分のユーザー詳細を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMe(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 自身のチャンネル購読状態を取得します。 * @summary 自分のチャンネル購読状態を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyChannelSubscriptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 自分に紐付けられている外部ログインアカウント一覧を取得します。 * @summary 外部ログインアカウント一覧を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyExternalAccounts(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 自分のアイコン画像を取得します。 * @summary 自分のアイコン画像を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyIcon(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * メッセージ引用通知の設定情報を変更します。 * @summary メッセージ引用通知の設定情報を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyNotifyCitation(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 自身のQRコードを取得します。 返されたQRコードまたはトークンは、発行後の5分間のみ有効です * @summary QRコードを取得 * @param {boolean} [token] 画像でなくトークン文字列で返すかどうか * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyQRCode(token?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 自分のログインセッションのリストを取得します。 * @summary 自分のログインセッションリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMySessions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 自分のスタンプ履歴を最大100件まで取得します。 結果は降順で返されます。 このAPIが返すスタンプ履歴は厳密な履歴ではありません。 * @summary スタンプ履歴を取得 * @param {number} [limit] 件数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyStampHistory(limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 自分のスタンプレコメンドを最大200件まで取得します。 結果は推薦度の高い順で返されます。 スタンプを使用したことがないユーザーの場合は空配列が返されます。 * @summary スタンプレコメンドを取得 * @param {number} [limit] 件数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyStampRecommendations(limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 自分がスターしているチャンネルのUUIDの配列を取得します。 * @summary スターチャンネルリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyStars(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 有効な自分に発行されたOAuth2トークンのリストを取得します。 * @summary 有効トークンのリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyTokens(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 自分が現在未読のチャンネルの未読情報を取得します。 * @summary 未読チャンネルを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyUnreadChannels(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 自分に付けられているタグの配列を取得します。 * @summary 自分のタグリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyUserTags(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 自身のチャンネル閲覧状態一覧を取得します。 * @summary 自身のチャンネル閲覧状態一覧を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyViewStates(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * OIDCトークンを用いてユーザー詳細を取得します。 OIDC UserInfo Endpointです。 * @summary 自分のユーザー詳細を取得 (OIDC UserInfo) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOIDCUserInfo(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * ユーザー設定を取得します。 * @summary ユーザー設定を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserSettings(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 自分に外部ログインアカウントを紐付けます。 指定した`providerName`がサーバー側で有効である必要があります。 リクエストが受理された場合、外部サービスの認証画面にリダイレクトされ、認証される必要があります。 * @summary 外部ログインアカウントを紐付ける * @param {PostLinkExternalAccount} [postLinkExternalAccount] * @param {*} [options] Override http request option. * @throws {RequiredError} */ linkExternalAccount(postLinkExternalAccount?: PostLinkExternalAccount, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 自分が未読のチャンネルを既読にします。 * @summary チャンネルを既読にする * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ readChannel(channelId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 自身のFCMデバイスを登録します。 * @summary FCMデバイスを登録 * @param {PostMyFCMDeviceRequest} [postMyFCMDeviceRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ registerFCMDevice(postMyFCMDeviceRequest?: PostMyFCMDeviceRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 既にスターから削除されているチャンネルを指定した場合は204を返します。 * @summary チャンネルをスターから削除します * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeMyStar(channelId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 既に存在しないタグを削除しようとした場合は204を返します。 * @summary 自分からタグを削除します * @param {string} tagId タグUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeMyUserTag(tagId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定した自分のセッションを無効化(ログアウト)します。 既に存在しない・無効化されているセッションを指定した場合も`204`を返します。 * @summary セッションを無効化 * @param {string} sessionId セッションUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ revokeMySession(sessionId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 自分の指定したトークンの認可を取り消します。 * @summary トークンの認可を取り消す * @param {string} tokenId OAuth2トークンUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ revokeMyToken(tokenId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 自身の指定したチャンネルの購読レベルを設定します。 * @summary チャンネル購読レベルを設定 * @param {string} channelId チャンネルUUID * @param {PutChannelSubscribeLevelRequest} [putChannelSubscribeLevelRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ setChannelSubscribeLevel(channelId: string, putChannelSubscribeLevelRequest?: PutChannelSubscribeLevelRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 自分に紐付けられている外部ログインアカウントの紐付けを解除します。 * @summary 外部ログインアカウントの紐付けを解除 * @param {PostUnlinkExternalAccount} [postUnlinkExternalAccount] * @param {*} [options] Override http request option. * @throws {RequiredError} */ unlinkExternalAccount(postUnlinkExternalAccount?: PostUnlinkExternalAccount, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * MeApi - factory interface * @export */ declare const MeApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * 指定したチャンネルをスターチャンネルに追加します。 スター済みのチャンネルIDを指定した場合、204を返します。 不正なチャンネルIDを指定した場合、400を返します。 * @summary チャンネルをスターに追加 * @param {PostStarRequest} [postStarRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addMyStar(postStarRequest?: PostStarRequest, options?: any): AxiosPromise; /** * 自分に新しくタグを追加します。 * @summary 自分にタグを追加 * @param {PostUserTagRequest} [postUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addMyUserTag(postUserTagRequest?: PostUserTagRequest, options?: any): AxiosPromise; /** * 自分のアイコン画像を変更します。 * @summary 自分のアイコン画像を変更 * @param {File} file アイコン画像(2MB,`Config.Imaging.MaxPixels`(default: 2560*1600)までのpng, jpeg, gif) * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeMyIcon(file: File, options?: any): AxiosPromise; /** * メッセージ引用通知の設定情報を変更します * @summary メッセージ引用通知の設定情報を変更 * @param {PutNotifyCitationRequest} [putNotifyCitationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeMyNotifyCitation(putNotifyCitationRequest?: PutNotifyCitationRequest, options?: any): AxiosPromise; /** * 自身のパスワードを変更します。 * @summary 自分のパスワードを変更 * @param {PutMyPasswordRequest} [putMyPasswordRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeMyPassword(putMyPasswordRequest?: PutMyPasswordRequest, options?: any): AxiosPromise; /** * 自身のユーザー情報を変更します。 * @summary 自分のユーザー情報を変更 * @param {PatchMeRequest} [patchMeRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editMe(patchMeRequest?: PatchMeRequest, options?: any): AxiosPromise; /** * 自分の指定したタグの状態を変更します。 * @summary 自分のタグを編集 * @param {string} tagId タグUUID * @param {PatchUserTagRequest} [patchUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editMyUserTag(tagId: string, patchUserTagRequest?: PatchUserTagRequest, options?: any): AxiosPromise; /** * 自身のユーザー詳細情報を取得します。 * @summary 自分のユーザー詳細を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMe(options?: any): AxiosPromise; /** * 自身のチャンネル購読状態を取得します。 * @summary 自分のチャンネル購読状態を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyChannelSubscriptions(options?: any): AxiosPromise>; /** * 自分に紐付けられている外部ログインアカウント一覧を取得します。 * @summary 外部ログインアカウント一覧を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyExternalAccounts(options?: any): AxiosPromise>; /** * 自分のアイコン画像を取得します。 * @summary 自分のアイコン画像を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyIcon(options?: any): AxiosPromise; /** * メッセージ引用通知の設定情報を変更します。 * @summary メッセージ引用通知の設定情報を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyNotifyCitation(options?: any): AxiosPromise; /** * 自身のQRコードを取得します。 返されたQRコードまたはトークンは、発行後の5分間のみ有効です * @summary QRコードを取得 * @param {boolean} [token] 画像でなくトークン文字列で返すかどうか * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyQRCode(token?: boolean, options?: any): AxiosPromise; /** * 自分のログインセッションのリストを取得します。 * @summary 自分のログインセッションリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMySessions(options?: any): AxiosPromise>; /** * 自分のスタンプ履歴を最大100件まで取得します。 結果は降順で返されます。 このAPIが返すスタンプ履歴は厳密な履歴ではありません。 * @summary スタンプ履歴を取得 * @param {number} [limit] 件数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyStampHistory(limit?: number, options?: any): AxiosPromise>; /** * 自分のスタンプレコメンドを最大200件まで取得します。 結果は推薦度の高い順で返されます。 スタンプを使用したことがないユーザーの場合は空配列が返されます。 * @summary スタンプレコメンドを取得 * @param {number} [limit] 件数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyStampRecommendations(limit?: number, options?: any): AxiosPromise>; /** * 自分がスターしているチャンネルのUUIDの配列を取得します。 * @summary スターチャンネルリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyStars(options?: any): AxiosPromise>; /** * 有効な自分に発行されたOAuth2トークンのリストを取得します。 * @summary 有効トークンのリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyTokens(options?: any): AxiosPromise>; /** * 自分が現在未読のチャンネルの未読情報を取得します。 * @summary 未読チャンネルを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyUnreadChannels(options?: any): AxiosPromise>; /** * 自分に付けられているタグの配列を取得します。 * @summary 自分のタグリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyUserTags(options?: any): AxiosPromise>; /** * 自身のチャンネル閲覧状態一覧を取得します。 * @summary 自身のチャンネル閲覧状態一覧を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyViewStates(options?: any): AxiosPromise>; /** * OIDCトークンを用いてユーザー詳細を取得します。 OIDC UserInfo Endpointです。 * @summary 自分のユーザー詳細を取得 (OIDC UserInfo) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOIDCUserInfo(options?: any): AxiosPromise; /** * ユーザー設定を取得します。 * @summary ユーザー設定を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserSettings(options?: any): AxiosPromise; /** * 自分に外部ログインアカウントを紐付けます。 指定した`providerName`がサーバー側で有効である必要があります。 リクエストが受理された場合、外部サービスの認証画面にリダイレクトされ、認証される必要があります。 * @summary 外部ログインアカウントを紐付ける * @param {PostLinkExternalAccount} [postLinkExternalAccount] * @param {*} [options] Override http request option. * @throws {RequiredError} */ linkExternalAccount(postLinkExternalAccount?: PostLinkExternalAccount, options?: any): AxiosPromise; /** * 自分が未読のチャンネルを既読にします。 * @summary チャンネルを既読にする * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ readChannel(channelId: string, options?: any): AxiosPromise; /** * 自身のFCMデバイスを登録します。 * @summary FCMデバイスを登録 * @param {PostMyFCMDeviceRequest} [postMyFCMDeviceRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ registerFCMDevice(postMyFCMDeviceRequest?: PostMyFCMDeviceRequest, options?: any): AxiosPromise; /** * 既にスターから削除されているチャンネルを指定した場合は204を返します。 * @summary チャンネルをスターから削除します * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeMyStar(channelId: string, options?: any): AxiosPromise; /** * 既に存在しないタグを削除しようとした場合は204を返します。 * @summary 自分からタグを削除します * @param {string} tagId タグUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeMyUserTag(tagId: string, options?: any): AxiosPromise; /** * 指定した自分のセッションを無効化(ログアウト)します。 既に存在しない・無効化されているセッションを指定した場合も`204`を返します。 * @summary セッションを無効化 * @param {string} sessionId セッションUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ revokeMySession(sessionId: string, options?: any): AxiosPromise; /** * 自分の指定したトークンの認可を取り消します。 * @summary トークンの認可を取り消す * @param {string} tokenId OAuth2トークンUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ revokeMyToken(tokenId: string, options?: any): AxiosPromise; /** * 自身の指定したチャンネルの購読レベルを設定します。 * @summary チャンネル購読レベルを設定 * @param {string} channelId チャンネルUUID * @param {PutChannelSubscribeLevelRequest} [putChannelSubscribeLevelRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ setChannelSubscribeLevel(channelId: string, putChannelSubscribeLevelRequest?: PutChannelSubscribeLevelRequest, options?: any): AxiosPromise; /** * 自分に紐付けられている外部ログインアカウントの紐付けを解除します。 * @summary 外部ログインアカウントの紐付けを解除 * @param {PostUnlinkExternalAccount} [postUnlinkExternalAccount] * @param {*} [options] Override http request option. * @throws {RequiredError} */ unlinkExternalAccount(postUnlinkExternalAccount?: PostUnlinkExternalAccount, options?: any): AxiosPromise; }; /** * MeApi - object-oriented interface * @export * @class MeApi * @extends {BaseAPI} */ declare class MeApi extends BaseAPI { /** * 指定したチャンネルをスターチャンネルに追加します。 スター済みのチャンネルIDを指定した場合、204を返します。 不正なチャンネルIDを指定した場合、400を返します。 * @summary チャンネルをスターに追加 * @param {PostStarRequest} [postStarRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ addMyStar(postStarRequest?: PostStarRequest, options?: AxiosRequestConfig): Promise>; /** * 自分に新しくタグを追加します。 * @summary 自分にタグを追加 * @param {PostUserTagRequest} [postUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ addMyUserTag(postUserTagRequest?: PostUserTagRequest, options?: AxiosRequestConfig): Promise>; /** * 自分のアイコン画像を変更します。 * @summary 自分のアイコン画像を変更 * @param {File} file アイコン画像(2MB,`Config.Imaging.MaxPixels`(default: 2560*1600)までのpng, jpeg, gif) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ changeMyIcon(file: File, options?: AxiosRequestConfig): Promise>; /** * メッセージ引用通知の設定情報を変更します * @summary メッセージ引用通知の設定情報を変更 * @param {PutNotifyCitationRequest} [putNotifyCitationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ changeMyNotifyCitation(putNotifyCitationRequest?: PutNotifyCitationRequest, options?: AxiosRequestConfig): Promise>; /** * 自身のパスワードを変更します。 * @summary 自分のパスワードを変更 * @param {PutMyPasswordRequest} [putMyPasswordRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ changeMyPassword(putMyPasswordRequest?: PutMyPasswordRequest, options?: AxiosRequestConfig): Promise>; /** * 自身のユーザー情報を変更します。 * @summary 自分のユーザー情報を変更 * @param {PatchMeRequest} [patchMeRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ editMe(patchMeRequest?: PatchMeRequest, options?: AxiosRequestConfig): Promise>; /** * 自分の指定したタグの状態を変更します。 * @summary 自分のタグを編集 * @param {string} tagId タグUUID * @param {PatchUserTagRequest} [patchUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ editMyUserTag(tagId: string, patchUserTagRequest?: PatchUserTagRequest, options?: AxiosRequestConfig): Promise>; /** * 自身のユーザー詳細情報を取得します。 * @summary 自分のユーザー詳細を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ getMe(options?: AxiosRequestConfig): Promise>; /** * 自身のチャンネル購読状態を取得します。 * @summary 自分のチャンネル購読状態を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ getMyChannelSubscriptions(options?: AxiosRequestConfig): Promise>; /** * 自分に紐付けられている外部ログインアカウント一覧を取得します。 * @summary 外部ログインアカウント一覧を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ getMyExternalAccounts(options?: AxiosRequestConfig): Promise>; /** * 自分のアイコン画像を取得します。 * @summary 自分のアイコン画像を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ getMyIcon(options?: AxiosRequestConfig): Promise>; /** * メッセージ引用通知の設定情報を変更します。 * @summary メッセージ引用通知の設定情報を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ getMyNotifyCitation(options?: AxiosRequestConfig): Promise>; /** * 自身のQRコードを取得します。 返されたQRコードまたはトークンは、発行後の5分間のみ有効です * @summary QRコードを取得 * @param {boolean} [token] 画像でなくトークン文字列で返すかどうか * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ getMyQRCode(token?: boolean, options?: AxiosRequestConfig): Promise>; /** * 自分のログインセッションのリストを取得します。 * @summary 自分のログインセッションリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ getMySessions(options?: AxiosRequestConfig): Promise>; /** * 自分のスタンプ履歴を最大100件まで取得します。 結果は降順で返されます。 このAPIが返すスタンプ履歴は厳密な履歴ではありません。 * @summary スタンプ履歴を取得 * @param {number} [limit] 件数 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ getMyStampHistory(limit?: number, options?: AxiosRequestConfig): Promise>; /** * 自分のスタンプレコメンドを最大200件まで取得します。 結果は推薦度の高い順で返されます。 スタンプを使用したことがないユーザーの場合は空配列が返されます。 * @summary スタンプレコメンドを取得 * @param {number} [limit] 件数 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ getMyStampRecommendations(limit?: number, options?: AxiosRequestConfig): Promise>; /** * 自分がスターしているチャンネルのUUIDの配列を取得します。 * @summary スターチャンネルリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ getMyStars(options?: AxiosRequestConfig): Promise>; /** * 有効な自分に発行されたOAuth2トークンのリストを取得します。 * @summary 有効トークンのリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ getMyTokens(options?: AxiosRequestConfig): Promise>; /** * 自分が現在未読のチャンネルの未読情報を取得します。 * @summary 未読チャンネルを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ getMyUnreadChannels(options?: AxiosRequestConfig): Promise>; /** * 自分に付けられているタグの配列を取得します。 * @summary 自分のタグリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ getMyUserTags(options?: AxiosRequestConfig): Promise>; /** * 自身のチャンネル閲覧状態一覧を取得します。 * @summary 自身のチャンネル閲覧状態一覧を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ getMyViewStates(options?: AxiosRequestConfig): Promise>; /** * OIDCトークンを用いてユーザー詳細を取得します。 OIDC UserInfo Endpointです。 * @summary 自分のユーザー詳細を取得 (OIDC UserInfo) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ getOIDCUserInfo(options?: AxiosRequestConfig): Promise>; /** * ユーザー設定を取得します。 * @summary ユーザー設定を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ getUserSettings(options?: AxiosRequestConfig): Promise>; /** * 自分に外部ログインアカウントを紐付けます。 指定した`providerName`がサーバー側で有効である必要があります。 リクエストが受理された場合、外部サービスの認証画面にリダイレクトされ、認証される必要があります。 * @summary 外部ログインアカウントを紐付ける * @param {PostLinkExternalAccount} [postLinkExternalAccount] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ linkExternalAccount(postLinkExternalAccount?: PostLinkExternalAccount, options?: AxiosRequestConfig): Promise>; /** * 自分が未読のチャンネルを既読にします。 * @summary チャンネルを既読にする * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ readChannel(channelId: string, options?: AxiosRequestConfig): Promise>; /** * 自身のFCMデバイスを登録します。 * @summary FCMデバイスを登録 * @param {PostMyFCMDeviceRequest} [postMyFCMDeviceRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ registerFCMDevice(postMyFCMDeviceRequest?: PostMyFCMDeviceRequest, options?: AxiosRequestConfig): Promise>; /** * 既にスターから削除されているチャンネルを指定した場合は204を返します。 * @summary チャンネルをスターから削除します * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ removeMyStar(channelId: string, options?: AxiosRequestConfig): Promise>; /** * 既に存在しないタグを削除しようとした場合は204を返します。 * @summary 自分からタグを削除します * @param {string} tagId タグUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ removeMyUserTag(tagId: string, options?: AxiosRequestConfig): Promise>; /** * 指定した自分のセッションを無効化(ログアウト)します。 既に存在しない・無効化されているセッションを指定した場合も`204`を返します。 * @summary セッションを無効化 * @param {string} sessionId セッションUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ revokeMySession(sessionId: string, options?: AxiosRequestConfig): Promise>; /** * 自分の指定したトークンの認可を取り消します。 * @summary トークンの認可を取り消す * @param {string} tokenId OAuth2トークンUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ revokeMyToken(tokenId: string, options?: AxiosRequestConfig): Promise>; /** * 自身の指定したチャンネルの購読レベルを設定します。 * @summary チャンネル購読レベルを設定 * @param {string} channelId チャンネルUUID * @param {PutChannelSubscribeLevelRequest} [putChannelSubscribeLevelRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ setChannelSubscribeLevel(channelId: string, putChannelSubscribeLevelRequest?: PutChannelSubscribeLevelRequest, options?: AxiosRequestConfig): Promise>; /** * 自分に紐付けられている外部ログインアカウントの紐付けを解除します。 * @summary 外部ログインアカウントの紐付けを解除 * @param {PostUnlinkExternalAccount} [postUnlinkExternalAccount] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ unlinkExternalAccount(postUnlinkExternalAccount?: PostUnlinkExternalAccount, options?: AxiosRequestConfig): Promise>; } /** * MessageApi - axios parameter creator * @export */ declare const MessageApiAxiosParamCreator: (configuration?: Configuration) => { /** * 指定したメッセージに指定したスタンプを押します。 * @summary スタンプを押す * @param {string} messageId メッセージUUID * @param {string} stampId スタンプUUID * @param {PostMessageStampRequest} [postMessageStampRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addMessageStamp: (messageId: string, stampId: string, postMessageStampRequest?: PostMessageStampRequest, options?: AxiosRequestConfig) => Promise; /** * 指定したメッセージをピン留めします。 アーカイブされているチャンネルのメッセージ・存在しないメッセージ・チャンネル当たりの上限数を超えたメッセージのピン留めはできません。 * @summary ピン留めする * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ createPin: (messageId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したメッセージを削除します。 自身が投稿したメッセージと自身が管理権限を持つWebhookとBOTが投稿したメッセージのみ削除することができます。 アーカイブされているチャンネルのメッセージを編集することは出来ません。 * @summary メッセージを削除 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteMessage: (messageId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したメッセージを編集します。 自身が投稿したメッセージのみ編集することができます。 アーカイブされているチャンネルのメッセージを編集することは出来ません。 * @summary メッセージを編集 * @param {string} messageId メッセージUUID * @param {PostMessageRequest} [postMessageRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editMessage: (messageId: string, postMessageRequest?: PostMessageRequest, options?: AxiosRequestConfig) => Promise; /** * 指定したユーザーとのダイレクトメッセージのリストを取得します。 * @summary ダイレクトメッセージのリストを取得 * @param {string} userId ユーザーUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {string} [since] 取得する時間範囲の開始日時 * @param {string} [until] 取得する時間範囲の終了日時 * @param {boolean} [inclusive] 範囲の端を含めるかどうか * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDirectMessages: (userId: string, limit?: number, offset?: number, since?: string, until?: string, inclusive?: boolean, order?: "asc" | "desc", options?: AxiosRequestConfig) => Promise; /** * 指定したメッセージを取得します。 * @summary メッセージを取得 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessage: (messageId: string, options?: AxiosRequestConfig) => Promise; /** * 対象のメッセージの自分のクリップの一覧を返します。 * @summary 自分のクリップを取得 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessageClips: (messageId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したメッセージに押されているスタンプのリストを取得します。 * @summary メッセージのスタンプリストを取得 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessageStamps: (messageId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したチャンネルのメッセージのリストを取得します。 * @summary チャンネルメッセージのリストを取得 * @param {string} channelId チャンネルUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {string} [since] 取得する時間範囲の開始日時 * @param {string} [until] 取得する時間範囲の終了日時 * @param {boolean} [inclusive] 範囲の端を含めるかどうか * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessages: (channelId: string, limit?: number, offset?: number, since?: string, until?: string, inclusive?: boolean, order?: "asc" | "desc", options?: AxiosRequestConfig) => Promise; /** * 指定したメッセージのピン留め情報を取得します。 * @summary ピン留めを取得 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPin: (messageId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したユーザーにダイレクトメッセージを送信します。 * @summary ダイレクトメッセージを送信 * @param {string} userId ユーザーUUID * @param {PostMessageRequest} [postMessageRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ postDirectMessage: (userId: string, postMessageRequest?: PostMessageRequest, options?: AxiosRequestConfig) => Promise; /** * 指定したチャンネルにメッセージを投稿します。 embedをtrueに指定すると、メッセージ埋め込みが自動で行われます。 アーカイブされているチャンネルに投稿することはできません。 * @summary チャンネルにメッセージを投稿 * @param {string} channelId チャンネルUUID * @param {PostMessageRequest} [postMessageRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ postMessage: (channelId: string, postMessageRequest?: PostMessageRequest, options?: AxiosRequestConfig) => Promise; /** * 指定したメッセージから指定した自身が押したスタンプを削除します。 * @summary スタンプを消す * @param {string} messageId メッセージUUID * @param {string} stampId スタンプUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeMessageStamp: (messageId: string, stampId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したメッセージのピン留めを外します。 * @summary ピン留めを外す * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removePin: (messageId: string, options?: AxiosRequestConfig) => Promise; /** * メッセージを検索します。 * @summary メッセージを検索 * @param {string} [word] 検索ワード Simple-Query-String-Syntaxをパースして検索します * @param {string} [after] 投稿日時が指定日時より後 * @param {string} [before] 投稿日時が指定日時より前 * @param {string} [_in] メッセージが投稿されたチャンネル * @param {Array} [to] メンションされたユーザー * @param {Array} [from] メッセージを投稿したユーザー * @param {string} [citation] 引用しているメッセージ * @param {boolean} [bot] メッセージを投稿したユーザーがBotかどうか * @param {boolean} [hasURL] メッセージがURLを含むか * @param {boolean} [hasAttachments] メッセージが添付ファイルを含むか * @param {boolean} [hasImage] メッセージが画像を含むか * @param {boolean} [hasVideo] メッセージが動画を含むか * @param {boolean} [hasAudio] メッセージが音声ファイルを含むか * @param {number} [limit] 検索結果から取得するメッセージの最大件数 * @param {number} [offset] 検索結果から取得するメッセージのオフセット * @param {'createdAt' | '-createdAt' | 'updatedAt' | '-updatedAt'} [sort] ソート順 (作成日時が新しい `createdAt`, 作成日時が古い `-createdAt`, 更新日時が新しい `updatedAt`, 更新日時が古い `-updatedAt`) * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchMessages: (word?: string, after?: string, before?: string, _in?: string, to?: Array, from?: Array, citation?: string, bot?: boolean, hasURL?: boolean, hasAttachments?: boolean, hasImage?: boolean, hasVideo?: boolean, hasAudio?: boolean, limit?: number, offset?: number, sort?: "createdAt" | "-createdAt" | "updatedAt" | "-updatedAt", options?: AxiosRequestConfig) => Promise; }; /** * MessageApi - functional programming interface * @export */ declare const MessageApiFp: (configuration?: Configuration) => { /** * 指定したメッセージに指定したスタンプを押します。 * @summary スタンプを押す * @param {string} messageId メッセージUUID * @param {string} stampId スタンプUUID * @param {PostMessageStampRequest} [postMessageStampRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addMessageStamp(messageId: string, stampId: string, postMessageStampRequest?: PostMessageStampRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したメッセージをピン留めします。 アーカイブされているチャンネルのメッセージ・存在しないメッセージ・チャンネル当たりの上限数を超えたメッセージのピン留めはできません。 * @summary ピン留めする * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ createPin(messageId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したメッセージを削除します。 自身が投稿したメッセージと自身が管理権限を持つWebhookとBOTが投稿したメッセージのみ削除することができます。 アーカイブされているチャンネルのメッセージを編集することは出来ません。 * @summary メッセージを削除 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteMessage(messageId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したメッセージを編集します。 自身が投稿したメッセージのみ編集することができます。 アーカイブされているチャンネルのメッセージを編集することは出来ません。 * @summary メッセージを編集 * @param {string} messageId メッセージUUID * @param {PostMessageRequest} [postMessageRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editMessage(messageId: string, postMessageRequest?: PostMessageRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したユーザーとのダイレクトメッセージのリストを取得します。 * @summary ダイレクトメッセージのリストを取得 * @param {string} userId ユーザーUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {string} [since] 取得する時間範囲の開始日時 * @param {string} [until] 取得する時間範囲の終了日時 * @param {boolean} [inclusive] 範囲の端を含めるかどうか * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDirectMessages(userId: string, limit?: number, offset?: number, since?: string, until?: string, inclusive?: boolean, order?: "asc" | "desc", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 指定したメッセージを取得します。 * @summary メッセージを取得 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessage(messageId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 対象のメッセージの自分のクリップの一覧を返します。 * @summary 自分のクリップを取得 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessageClips(messageId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 指定したメッセージに押されているスタンプのリストを取得します。 * @summary メッセージのスタンプリストを取得 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessageStamps(messageId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 指定したチャンネルのメッセージのリストを取得します。 * @summary チャンネルメッセージのリストを取得 * @param {string} channelId チャンネルUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {string} [since] 取得する時間範囲の開始日時 * @param {string} [until] 取得する時間範囲の終了日時 * @param {boolean} [inclusive] 範囲の端を含めるかどうか * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessages(channelId: string, limit?: number, offset?: number, since?: string, until?: string, inclusive?: boolean, order?: "asc" | "desc", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 指定したメッセージのピン留め情報を取得します。 * @summary ピン留めを取得 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPin(messageId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したユーザーにダイレクトメッセージを送信します。 * @summary ダイレクトメッセージを送信 * @param {string} userId ユーザーUUID * @param {PostMessageRequest} [postMessageRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ postDirectMessage(userId: string, postMessageRequest?: PostMessageRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したチャンネルにメッセージを投稿します。 embedをtrueに指定すると、メッセージ埋め込みが自動で行われます。 アーカイブされているチャンネルに投稿することはできません。 * @summary チャンネルにメッセージを投稿 * @param {string} channelId チャンネルUUID * @param {PostMessageRequest} [postMessageRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ postMessage(channelId: string, postMessageRequest?: PostMessageRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したメッセージから指定した自身が押したスタンプを削除します。 * @summary スタンプを消す * @param {string} messageId メッセージUUID * @param {string} stampId スタンプUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeMessageStamp(messageId: string, stampId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したメッセージのピン留めを外します。 * @summary ピン留めを外す * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removePin(messageId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * メッセージを検索します。 * @summary メッセージを検索 * @param {string} [word] 検索ワード Simple-Query-String-Syntaxをパースして検索します * @param {string} [after] 投稿日時が指定日時より後 * @param {string} [before] 投稿日時が指定日時より前 * @param {string} [_in] メッセージが投稿されたチャンネル * @param {Array} [to] メンションされたユーザー * @param {Array} [from] メッセージを投稿したユーザー * @param {string} [citation] 引用しているメッセージ * @param {boolean} [bot] メッセージを投稿したユーザーがBotかどうか * @param {boolean} [hasURL] メッセージがURLを含むか * @param {boolean} [hasAttachments] メッセージが添付ファイルを含むか * @param {boolean} [hasImage] メッセージが画像を含むか * @param {boolean} [hasVideo] メッセージが動画を含むか * @param {boolean} [hasAudio] メッセージが音声ファイルを含むか * @param {number} [limit] 検索結果から取得するメッセージの最大件数 * @param {number} [offset] 検索結果から取得するメッセージのオフセット * @param {'createdAt' | '-createdAt' | 'updatedAt' | '-updatedAt'} [sort] ソート順 (作成日時が新しい `createdAt`, 作成日時が古い `-createdAt`, 更新日時が新しい `updatedAt`, 更新日時が古い `-updatedAt`) * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchMessages(word?: string, after?: string, before?: string, _in?: string, to?: Array, from?: Array, citation?: string, bot?: boolean, hasURL?: boolean, hasAttachments?: boolean, hasImage?: boolean, hasVideo?: boolean, hasAudio?: boolean, limit?: number, offset?: number, sort?: "createdAt" | "-createdAt" | "updatedAt" | "-updatedAt", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * MessageApi - factory interface * @export */ declare const MessageApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * 指定したメッセージに指定したスタンプを押します。 * @summary スタンプを押す * @param {string} messageId メッセージUUID * @param {string} stampId スタンプUUID * @param {PostMessageStampRequest} [postMessageStampRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addMessageStamp(messageId: string, stampId: string, postMessageStampRequest?: PostMessageStampRequest, options?: any): AxiosPromise; /** * 指定したメッセージをピン留めします。 アーカイブされているチャンネルのメッセージ・存在しないメッセージ・チャンネル当たりの上限数を超えたメッセージのピン留めはできません。 * @summary ピン留めする * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ createPin(messageId: string, options?: any): AxiosPromise; /** * 指定したメッセージを削除します。 自身が投稿したメッセージと自身が管理権限を持つWebhookとBOTが投稿したメッセージのみ削除することができます。 アーカイブされているチャンネルのメッセージを編集することは出来ません。 * @summary メッセージを削除 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteMessage(messageId: string, options?: any): AxiosPromise; /** * 指定したメッセージを編集します。 自身が投稿したメッセージのみ編集することができます。 アーカイブされているチャンネルのメッセージを編集することは出来ません。 * @summary メッセージを編集 * @param {string} messageId メッセージUUID * @param {PostMessageRequest} [postMessageRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editMessage(messageId: string, postMessageRequest?: PostMessageRequest, options?: any): AxiosPromise; /** * 指定したユーザーとのダイレクトメッセージのリストを取得します。 * @summary ダイレクトメッセージのリストを取得 * @param {string} userId ユーザーUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {string} [since] 取得する時間範囲の開始日時 * @param {string} [until] 取得する時間範囲の終了日時 * @param {boolean} [inclusive] 範囲の端を含めるかどうか * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDirectMessages(userId: string, limit?: number, offset?: number, since?: string, until?: string, inclusive?: boolean, order?: "asc" | "desc", options?: any): AxiosPromise>; /** * 指定したメッセージを取得します。 * @summary メッセージを取得 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessage(messageId: string, options?: any): AxiosPromise; /** * 対象のメッセージの自分のクリップの一覧を返します。 * @summary 自分のクリップを取得 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessageClips(messageId: string, options?: any): AxiosPromise>; /** * 指定したメッセージに押されているスタンプのリストを取得します。 * @summary メッセージのスタンプリストを取得 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessageStamps(messageId: string, options?: any): AxiosPromise>; /** * 指定したチャンネルのメッセージのリストを取得します。 * @summary チャンネルメッセージのリストを取得 * @param {string} channelId チャンネルUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {string} [since] 取得する時間範囲の開始日時 * @param {string} [until] 取得する時間範囲の終了日時 * @param {boolean} [inclusive] 範囲の端を含めるかどうか * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessages(channelId: string, limit?: number, offset?: number, since?: string, until?: string, inclusive?: boolean, order?: "asc" | "desc", options?: any): AxiosPromise>; /** * 指定したメッセージのピン留め情報を取得します。 * @summary ピン留めを取得 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPin(messageId: string, options?: any): AxiosPromise; /** * 指定したユーザーにダイレクトメッセージを送信します。 * @summary ダイレクトメッセージを送信 * @param {string} userId ユーザーUUID * @param {PostMessageRequest} [postMessageRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ postDirectMessage(userId: string, postMessageRequest?: PostMessageRequest, options?: any): AxiosPromise; /** * 指定したチャンネルにメッセージを投稿します。 embedをtrueに指定すると、メッセージ埋め込みが自動で行われます。 アーカイブされているチャンネルに投稿することはできません。 * @summary チャンネルにメッセージを投稿 * @param {string} channelId チャンネルUUID * @param {PostMessageRequest} [postMessageRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ postMessage(channelId: string, postMessageRequest?: PostMessageRequest, options?: any): AxiosPromise; /** * 指定したメッセージから指定した自身が押したスタンプを削除します。 * @summary スタンプを消す * @param {string} messageId メッセージUUID * @param {string} stampId スタンプUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeMessageStamp(messageId: string, stampId: string, options?: any): AxiosPromise; /** * 指定したメッセージのピン留めを外します。 * @summary ピン留めを外す * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removePin(messageId: string, options?: any): AxiosPromise; /** * メッセージを検索します。 * @summary メッセージを検索 * @param {string} [word] 検索ワード Simple-Query-String-Syntaxをパースして検索します * @param {string} [after] 投稿日時が指定日時より後 * @param {string} [before] 投稿日時が指定日時より前 * @param {string} [_in] メッセージが投稿されたチャンネル * @param {Array} [to] メンションされたユーザー * @param {Array} [from] メッセージを投稿したユーザー * @param {string} [citation] 引用しているメッセージ * @param {boolean} [bot] メッセージを投稿したユーザーがBotかどうか * @param {boolean} [hasURL] メッセージがURLを含むか * @param {boolean} [hasAttachments] メッセージが添付ファイルを含むか * @param {boolean} [hasImage] メッセージが画像を含むか * @param {boolean} [hasVideo] メッセージが動画を含むか * @param {boolean} [hasAudio] メッセージが音声ファイルを含むか * @param {number} [limit] 検索結果から取得するメッセージの最大件数 * @param {number} [offset] 検索結果から取得するメッセージのオフセット * @param {'createdAt' | '-createdAt' | 'updatedAt' | '-updatedAt'} [sort] ソート順 (作成日時が新しい `createdAt`, 作成日時が古い `-createdAt`, 更新日時が新しい `updatedAt`, 更新日時が古い `-updatedAt`) * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchMessages(word?: string, after?: string, before?: string, _in?: string, to?: Array, from?: Array, citation?: string, bot?: boolean, hasURL?: boolean, hasAttachments?: boolean, hasImage?: boolean, hasVideo?: boolean, hasAudio?: boolean, limit?: number, offset?: number, sort?: "createdAt" | "-createdAt" | "updatedAt" | "-updatedAt", options?: any): AxiosPromise; }; /** * MessageApi - object-oriented interface * @export * @class MessageApi * @extends {BaseAPI} */ declare class MessageApi extends BaseAPI { /** * 指定したメッセージに指定したスタンプを押します。 * @summary スタンプを押す * @param {string} messageId メッセージUUID * @param {string} stampId スタンプUUID * @param {PostMessageStampRequest} [postMessageStampRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessageApi */ addMessageStamp(messageId: string, stampId: string, postMessageStampRequest?: PostMessageStampRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したメッセージをピン留めします。 アーカイブされているチャンネルのメッセージ・存在しないメッセージ・チャンネル当たりの上限数を超えたメッセージのピン留めはできません。 * @summary ピン留めする * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessageApi */ createPin(messageId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したメッセージを削除します。 自身が投稿したメッセージと自身が管理権限を持つWebhookとBOTが投稿したメッセージのみ削除することができます。 アーカイブされているチャンネルのメッセージを編集することは出来ません。 * @summary メッセージを削除 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessageApi */ deleteMessage(messageId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したメッセージを編集します。 自身が投稿したメッセージのみ編集することができます。 アーカイブされているチャンネルのメッセージを編集することは出来ません。 * @summary メッセージを編集 * @param {string} messageId メッセージUUID * @param {PostMessageRequest} [postMessageRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessageApi */ editMessage(messageId: string, postMessageRequest?: PostMessageRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーとのダイレクトメッセージのリストを取得します。 * @summary ダイレクトメッセージのリストを取得 * @param {string} userId ユーザーUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {string} [since] 取得する時間範囲の開始日時 * @param {string} [until] 取得する時間範囲の終了日時 * @param {boolean} [inclusive] 範囲の端を含めるかどうか * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessageApi */ getDirectMessages(userId: string, limit?: number, offset?: number, since?: string, until?: string, inclusive?: boolean, order?: 'asc' | 'desc', options?: AxiosRequestConfig): Promise>; /** * 指定したメッセージを取得します。 * @summary メッセージを取得 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessageApi */ getMessage(messageId: string, options?: AxiosRequestConfig): Promise>; /** * 対象のメッセージの自分のクリップの一覧を返します。 * @summary 自分のクリップを取得 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessageApi */ getMessageClips(messageId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したメッセージに押されているスタンプのリストを取得します。 * @summary メッセージのスタンプリストを取得 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessageApi */ getMessageStamps(messageId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルのメッセージのリストを取得します。 * @summary チャンネルメッセージのリストを取得 * @param {string} channelId チャンネルUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {string} [since] 取得する時間範囲の開始日時 * @param {string} [until] 取得する時間範囲の終了日時 * @param {boolean} [inclusive] 範囲の端を含めるかどうか * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessageApi */ getMessages(channelId: string, limit?: number, offset?: number, since?: string, until?: string, inclusive?: boolean, order?: 'asc' | 'desc', options?: AxiosRequestConfig): Promise>; /** * 指定したメッセージのピン留め情報を取得します。 * @summary ピン留めを取得 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessageApi */ getPin(messageId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーにダイレクトメッセージを送信します。 * @summary ダイレクトメッセージを送信 * @param {string} userId ユーザーUUID * @param {PostMessageRequest} [postMessageRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessageApi */ postDirectMessage(userId: string, postMessageRequest?: PostMessageRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルにメッセージを投稿します。 embedをtrueに指定すると、メッセージ埋め込みが自動で行われます。 アーカイブされているチャンネルに投稿することはできません。 * @summary チャンネルにメッセージを投稿 * @param {string} channelId チャンネルUUID * @param {PostMessageRequest} [postMessageRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessageApi */ postMessage(channelId: string, postMessageRequest?: PostMessageRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したメッセージから指定した自身が押したスタンプを削除します。 * @summary スタンプを消す * @param {string} messageId メッセージUUID * @param {string} stampId スタンプUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessageApi */ removeMessageStamp(messageId: string, stampId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したメッセージのピン留めを外します。 * @summary ピン留めを外す * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessageApi */ removePin(messageId: string, options?: AxiosRequestConfig): Promise>; /** * メッセージを検索します。 * @summary メッセージを検索 * @param {string} [word] 検索ワード Simple-Query-String-Syntaxをパースして検索します * @param {string} [after] 投稿日時が指定日時より後 * @param {string} [before] 投稿日時が指定日時より前 * @param {string} [_in] メッセージが投稿されたチャンネル * @param {Array} [to] メンションされたユーザー * @param {Array} [from] メッセージを投稿したユーザー * @param {string} [citation] 引用しているメッセージ * @param {boolean} [bot] メッセージを投稿したユーザーがBotかどうか * @param {boolean} [hasURL] メッセージがURLを含むか * @param {boolean} [hasAttachments] メッセージが添付ファイルを含むか * @param {boolean} [hasImage] メッセージが画像を含むか * @param {boolean} [hasVideo] メッセージが動画を含むか * @param {boolean} [hasAudio] メッセージが音声ファイルを含むか * @param {number} [limit] 検索結果から取得するメッセージの最大件数 * @param {number} [offset] 検索結果から取得するメッセージのオフセット * @param {'createdAt' | '-createdAt' | 'updatedAt' | '-updatedAt'} [sort] ソート順 (作成日時が新しい `createdAt`, 作成日時が古い `-createdAt`, 更新日時が新しい `updatedAt`, 更新日時が古い `-updatedAt`) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessageApi */ searchMessages(word?: string, after?: string, before?: string, _in?: string, to?: Array, from?: Array, citation?: string, bot?: boolean, hasURL?: boolean, hasAttachments?: boolean, hasImage?: boolean, hasVideo?: boolean, hasAudio?: boolean, limit?: number, offset?: number, sort?: 'createdAt' | '-createdAt' | 'updatedAt' | '-updatedAt', options?: AxiosRequestConfig): Promise>; } /** * NotificationApi - axios parameter creator * @export */ declare const NotificationApiAxiosParamCreator: (configuration?: Configuration) => { /** * 指定したチャンネルの通知購読者を編集します。 リクエストに含めなかったユーザーの通知購読状態は変更しません。 また、存在しないユーザーを指定した場合は無視されます。 * @summary チャンネルの通知購読者を編集 * @param {string} channelId チャンネルUUID * @param {PatchChannelSubscribersRequest} [patchChannelSubscribersRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editChannelSubscribers: (channelId: string, patchChannelSubscribersRequest?: PatchChannelSubscribersRequest, options?: AxiosRequestConfig) => Promise; /** * 指定したチャンネルを通知購読しているユーザーのUUIDのリストを取得します。 * @summary チャンネルの通知購読者のリストを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannelSubscribers: (channelId: string, options?: AxiosRequestConfig) => Promise; /** * 自身のチャンネル購読状態を取得します。 * @summary 自分のチャンネル購読状態を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyChannelSubscriptions: (options?: AxiosRequestConfig) => Promise; /** * 自分が現在未読のチャンネルの未読情報を取得します。 * @summary 未読チャンネルを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyUnreadChannels: (options?: AxiosRequestConfig) => Promise; /** * 自身のチャンネル閲覧状態一覧を取得します。 * @summary 自身のチャンネル閲覧状態一覧を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyViewStates: (options?: AxiosRequestConfig) => Promise; /** * 自分が未読のチャンネルを既読にします。 * @summary チャンネルを既読にする * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ readChannel: (channelId: string, options?: AxiosRequestConfig) => Promise; /** * 自身のFCMデバイスを登録します。 * @summary FCMデバイスを登録 * @param {PostMyFCMDeviceRequest} [postMyFCMDeviceRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ registerFCMDevice: (postMyFCMDeviceRequest?: PostMyFCMDeviceRequest, options?: AxiosRequestConfig) => Promise; /** * 自身の指定したチャンネルの購読レベルを設定します。 * @summary チャンネル購読レベルを設定 * @param {string} channelId チャンネルUUID * @param {PutChannelSubscribeLevelRequest} [putChannelSubscribeLevelRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ setChannelSubscribeLevel: (channelId: string, putChannelSubscribeLevelRequest?: PutChannelSubscribeLevelRequest, options?: AxiosRequestConfig) => Promise; /** * 指定したチャンネルの通知購読者を設定します。 リクエストに含めなかったユーザーの通知購読状態はオフになります。 また、存在しないユーザーを指定した場合は無視されます。 * @summary チャンネルの通知購読者を設定 * @param {string} channelId チャンネルUUID * @param {PutChannelSubscribersRequest} [putChannelSubscribersRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ setChannelSubscribers: (channelId: string, putChannelSubscribersRequest?: PutChannelSubscribersRequest, options?: AxiosRequestConfig) => Promise; /** * # WebSocketプロトコル ## 送信 `コマンド:引数1:引数2:...`のような形式のTextMessageをサーバーに送信することで、このWebSocketセッションに対する設定が実行できる。 ### `viewstate`コマンド このWebSocketセッションが見ているチャンネル(イベントを受け取るチャンネル)を設定する。 現時点では1つのセッションに対して1つのチャンネルしか設定できない。 `viewstate:{チャンネルID}:{閲覧状態}` + チャンネルID: 対象のチャンネルID + 閲覧状態: `none`, `monitoring`, `editing` 最初の`viewstate`コマンドを送る前、または`viewstate:null`, `viewstate:`を送信した後は、このセッションはどこのチャンネルも見ていないことになる。 ### `rtcstate`コマンド 自分のWebRTC状態を変更する。 他のコネクションが既に状態を保持している場合、変更することができません。 `rtcstate:{チャンネルID}:({状態}:{セッションID})*` コネクションが切断された場合、自分のWebRTC状態はリセットされます。 ### `timeline_streaming`コマンド 全てのパブリックチャンネルの`MESSAGE_CREATED`イベントを受け取るかどうかを設定する。 初期状態は`off`です。 `timeline_streaming:(on|off|true|false)` ## 受信 TextMessageとして各種イベントが`type`と`body`を持つJSONとして非同期に送られます。 例: ```json {\"type\":\"USER_ONLINE\",\"body\":{\"id\":\"7dd8e07f-7f5d-4331-9176-b56a4299768b\"}} ``` ## イベント一覧 ### `USER_JOINED` ユーザーが新規登録された。 対象: 全員 + `id`: 登録されたユーザーのId ### `USER_UPDATED` ユーザーの情報が更新された。 対象: 全員 + `id`: 情報が更新されたユーザーのId ### `USER_TAGS_UPDATED` ユーザーのタグが更新された。 対象: 全員 + `id`: タグが更新されたユーザーのId + `tag_id`: 更新されたタグのId ### `USER_ICON_UPDATED` ユーザーのアイコンが更新された。 対象: 全員 + `id`: アイコンが更新されたユーザーのId ### `USER_WEBRTC_STATE_CHANGED` ユーザーのWebRTCの状態が変化した 対象: 全員 + `user_id`: 変更があったユーザーのId + `channel_id`: ユーザーの変更後の接続チャンネルのId + `sessions`: ユーザーの変更後の状態(配列) + `state`: 状態 + `sessionId`: セッションID ### `USER_VIEWSTATE_CHANGED` ユーザーのチャンネルの閲覧状態が変化した 対象: 変化したWSセッションを含めた、該当ユーザーのWSセッション全て + `view_states`: 変化したWSセッションを含めた、該当ユーザーの変更後の状態(配列) + `key`: WSセッションの識別子 + `channel_id`: 閲覧しているチャンネルId + `state`: 閲覧状態 ### `USER_ONLINE` ユーザーがオンラインになった。 対象: 全員 + `id`: オンラインになったユーザーのId ### `USER_OFFLINE` ユーザーがオフラインになった。 対象: 全員 + `id`: オフラインになったユーザーのId ### `USER_GROUP_CREATED` ユーザーグループが作成された 対象: 全員 + `id`: 作成されたユーザーグループのId ### `USER_GROUP_UPDATED` ユーザーグループが更新された 対象: 全員 + `id`: 作成されたユーザーグループのId ### `USER_GROUP_DELETED` ユーザーグループが削除された 対象: 全員 + `id`: 削除されたユーザーグループのId ### `CHANNEL_CREATED` チャンネルが新規作成された。 対象: 該当チャンネルを閲覧可能な全員 + `id`: 作成されたチャンネルのId + `dm_user_id`: (DMの場合のみ) DM相手のユーザーId ### `CHANNEL_UPDATED` チャンネルの情報が変更された。 対象: 該当チャンネルを閲覧可能な全員 + `id`: 変更があったチャンネルのId + `dm_user_id`: (DMの場合のみ) DM相手のユーザーId ### `CHANNEL_DELETED` チャンネルが削除された。 対象: 該当チャンネルを閲覧可能な全員 + `id`: 削除されたチャンネルのId + `dm_user_id`: (DMの場合のみ) DM相手のユーザーId ### `CHANNEL_STARED` 自分がチャンネルをスターした。 対象: 自分 + `id`: スターしたチャンネルのId ### `CHANNEL_UNSTARED` 自分がチャンネルのスターを解除した。 対象: 自分 + `id`: スターしたチャンネルのId ### `CHANNEL_VIEWERS_CHANGED` チャンネルの閲覧者が変化した。 対象: 該当チャンネルを閲覧しているユーザー + `id`: 変化したチャンネルのId + `viewers`: 変化後の閲覧者(配列) + `userId`: ユーザーId + `state`: 閲覧状態 + `updatedAt`: 閲覧状態の更新日時 ### `CHANNEL_SUBSCRIBERS_CHANGED` チャンネルの購読者が変化した。 対象: 該当チャンネルを閲覧しているユーザー + `id`: 変化したチャンネルのId ### `MESSAGE_CREATED` メッセージが投稿された。 対象: 投稿チャンネルを閲覧しているユーザー・投稿チャンネルに通知をつけているユーザー・メンションを受けたユーザー + `id`: 投稿されたメッセージのId + `is_citing`: 投稿されたメッセージがWebSocketを接続しているユーザーの投稿を引用しているかどうか ### `MESSAGE_UPDATED` メッセージが更新された。 対象: 投稿チャンネルを閲覧しているユーザー + `id`: 更新されたメッセージのId ### `MESSAGE_DELETED` メッセージが削除された。 対象: 投稿チャンネルを閲覧しているユーザー + `id`: 削除されたメッセージのId ### `MESSAGE_STAMPED` メッセージにスタンプが押された。 対象: 投稿チャンネルを閲覧しているユーザー + `message_id`: メッセージId + `user_id`: スタンプを押したユーザーのId + `stamp_id`: スタンプのId + `count`: そのユーザーが押した数 + `created_at`: そのユーザーがそのスタンプをそのメッセージに最初に押した日時 ### `MESSAGE_UNSTAMPED` メッセージからスタンプが外された。 対象: 投稿チャンネルを閲覧しているユーザー + `message_id`: メッセージId + `user_id`: スタンプを押したユーザーのId + `stamp_id`: スタンプのId ### `MESSAGE_PINNED` メッセージがピン留めされた。 対象: 投稿チャンネルを閲覧しているユーザー + `message_id`: ピンされたメッセージのID + `channel_id`: ピンされたメッセージのチャンネルID ### `MESSAGE_UNPINNED` ピン留めされたメッセージのピンが外された。 対象: 投稿チャンネルを閲覧しているユーザー + `message_id`: ピンが外されたメッセージのID + `channel_id`: ピンが外されたメッセージのチャンネルID ### `MESSAGE_READ` 自分があるチャンネルのメッセージを読んだ。 対象: 自分 + `id`: 読んだチャンネルId ### `STAMP_CREATED` スタンプが新しく追加された。 対象: 全員 + `id`: 作成されたスタンプのId ### `STAMP_UPDATED` スタンプが修正された。 対象: 全員 + `id`: 修正されたスタンプのId ### `STAMP_DELETED` スタンプが削除された。 対象: 全員 + `id`: 削除されたスタンプのId ### `STAMP_PALETTE_CREATED` スタンプパレットが新しく追加された。 対象: 自分 + `id`: 作成されたスタンプパレットのId ### `STAMP_PALETTE_UPDATED` スタンプパレットが修正された。 対象: 自分 + `id`: 修正されたスタンプパレットのId ### `STAMP_PALETTE_DELETED` スタンプパレットが削除された。 対象: 自分 + `id`: 削除されたスタンプパレットのId ### `CLIP_FOLDER_CREATED` クリップフォルダーが作成された。 対象：自分 + `id`: 作成されたクリップフォルダーのId ### `CLIP_FOLDER_UPDATED` クリップフォルダーが修正された。 対象: 自分 + `id`: 更新されたクリップフォルダーのId ### `CLIP_FOLDER_DELETED` クリップフォルダーが削除された。 対象: 自分 + `id`: 削除されたクリップフォルダーのId ### `CLIP_FOLDER_MESSAGE_DELETED` クリップフォルダーからメッセージが除外された。 対象: 自分 + `folder_id`: メッセージが除外されたクリップフォルダーのId + `message_id`: クリップフォルダーから除外されたメッセージのId ### `CLIP_FOLDER_MESSAGE_ADDED` クリップフォルダーにメッセージが追加された。 対象: 自分 + `folder_id`: メッセージが追加されたクリップフォルダーのId + `message_id`: クリップフォルダーに追加されたメッセージのId ### `QALL_ROOM_STATE_CHANGED` ルーム状態が変更された。 対象: 全員 + `room_id`: 変更されたルームのId + `state`: 変更後のルーム状態 + `roomId`: ルームのID + `participants`: ルーム内の参加者(配列) + `identity`: ユーザーID_RandomUUID + `name`: 表示名 + `joinedAt`: 参加した時刻 + `attributes`: ユーザーに関連付けられたカスタム属性 + `canPublish`: 発言権限 + `isWebinar`: ウェビナールームかどうか + `metadata`: ルームに関連付けられたカスタム属性 ### `QALL_SOUNDBOARD_ITEM_CREATED` サウンドボードアイテムが作成された。 対象: 全員 + `sound_id`: 作成されたサウンドのId + `name`: サウンド名 + `creator_id`: 作成者のId ### `QALL_SOUNDBOARD_ITEM_DELETED` サウンドボードアイテムが削除された。 対象: 全員 + `sound_id`: 削除されたサウンドのId * @summary WebSocket通知ストリームに接続します * @param {*} [options] Override http request option. * @throws {RequiredError} */ ws: (options?: AxiosRequestConfig) => Promise; }; /** * NotificationApi - functional programming interface * @export */ declare const NotificationApiFp: (configuration?: Configuration) => { /** * 指定したチャンネルの通知購読者を編集します。 リクエストに含めなかったユーザーの通知購読状態は変更しません。 また、存在しないユーザーを指定した場合は無視されます。 * @summary チャンネルの通知購読者を編集 * @param {string} channelId チャンネルUUID * @param {PatchChannelSubscribersRequest} [patchChannelSubscribersRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editChannelSubscribers(channelId: string, patchChannelSubscribersRequest?: PatchChannelSubscribersRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したチャンネルを通知購読しているユーザーのUUIDのリストを取得します。 * @summary チャンネルの通知購読者のリストを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannelSubscribers(channelId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 自身のチャンネル購読状態を取得します。 * @summary 自分のチャンネル購読状態を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyChannelSubscriptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 自分が現在未読のチャンネルの未読情報を取得します。 * @summary 未読チャンネルを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyUnreadChannels(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 自身のチャンネル閲覧状態一覧を取得します。 * @summary 自身のチャンネル閲覧状態一覧を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyViewStates(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 自分が未読のチャンネルを既読にします。 * @summary チャンネルを既読にする * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ readChannel(channelId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 自身のFCMデバイスを登録します。 * @summary FCMデバイスを登録 * @param {PostMyFCMDeviceRequest} [postMyFCMDeviceRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ registerFCMDevice(postMyFCMDeviceRequest?: PostMyFCMDeviceRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 自身の指定したチャンネルの購読レベルを設定します。 * @summary チャンネル購読レベルを設定 * @param {string} channelId チャンネルUUID * @param {PutChannelSubscribeLevelRequest} [putChannelSubscribeLevelRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ setChannelSubscribeLevel(channelId: string, putChannelSubscribeLevelRequest?: PutChannelSubscribeLevelRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したチャンネルの通知購読者を設定します。 リクエストに含めなかったユーザーの通知購読状態はオフになります。 また、存在しないユーザーを指定した場合は無視されます。 * @summary チャンネルの通知購読者を設定 * @param {string} channelId チャンネルUUID * @param {PutChannelSubscribersRequest} [putChannelSubscribersRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ setChannelSubscribers(channelId: string, putChannelSubscribersRequest?: PutChannelSubscribersRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * # WebSocketプロトコル ## 送信 `コマンド:引数1:引数2:...`のような形式のTextMessageをサーバーに送信することで、このWebSocketセッションに対する設定が実行できる。 ### `viewstate`コマンド このWebSocketセッションが見ているチャンネル(イベントを受け取るチャンネル)を設定する。 現時点では1つのセッションに対して1つのチャンネルしか設定できない。 `viewstate:{チャンネルID}:{閲覧状態}` + チャンネルID: 対象のチャンネルID + 閲覧状態: `none`, `monitoring`, `editing` 最初の`viewstate`コマンドを送る前、または`viewstate:null`, `viewstate:`を送信した後は、このセッションはどこのチャンネルも見ていないことになる。 ### `rtcstate`コマンド 自分のWebRTC状態を変更する。 他のコネクションが既に状態を保持している場合、変更することができません。 `rtcstate:{チャンネルID}:({状態}:{セッションID})*` コネクションが切断された場合、自分のWebRTC状態はリセットされます。 ### `timeline_streaming`コマンド 全てのパブリックチャンネルの`MESSAGE_CREATED`イベントを受け取るかどうかを設定する。 初期状態は`off`です。 `timeline_streaming:(on|off|true|false)` ## 受信 TextMessageとして各種イベントが`type`と`body`を持つJSONとして非同期に送られます。 例: ```json {\"type\":\"USER_ONLINE\",\"body\":{\"id\":\"7dd8e07f-7f5d-4331-9176-b56a4299768b\"}} ``` ## イベント一覧 ### `USER_JOINED` ユーザーが新規登録された。 対象: 全員 + `id`: 登録されたユーザーのId ### `USER_UPDATED` ユーザーの情報が更新された。 対象: 全員 + `id`: 情報が更新されたユーザーのId ### `USER_TAGS_UPDATED` ユーザーのタグが更新された。 対象: 全員 + `id`: タグが更新されたユーザーのId + `tag_id`: 更新されたタグのId ### `USER_ICON_UPDATED` ユーザーのアイコンが更新された。 対象: 全員 + `id`: アイコンが更新されたユーザーのId ### `USER_WEBRTC_STATE_CHANGED` ユーザーのWebRTCの状態が変化した 対象: 全員 + `user_id`: 変更があったユーザーのId + `channel_id`: ユーザーの変更後の接続チャンネルのId + `sessions`: ユーザーの変更後の状態(配列) + `state`: 状態 + `sessionId`: セッションID ### `USER_VIEWSTATE_CHANGED` ユーザーのチャンネルの閲覧状態が変化した 対象: 変化したWSセッションを含めた、該当ユーザーのWSセッション全て + `view_states`: 変化したWSセッションを含めた、該当ユーザーの変更後の状態(配列) + `key`: WSセッションの識別子 + `channel_id`: 閲覧しているチャンネルId + `state`: 閲覧状態 ### `USER_ONLINE` ユーザーがオンラインになった。 対象: 全員 + `id`: オンラインになったユーザーのId ### `USER_OFFLINE` ユーザーがオフラインになった。 対象: 全員 + `id`: オフラインになったユーザーのId ### `USER_GROUP_CREATED` ユーザーグループが作成された 対象: 全員 + `id`: 作成されたユーザーグループのId ### `USER_GROUP_UPDATED` ユーザーグループが更新された 対象: 全員 + `id`: 作成されたユーザーグループのId ### `USER_GROUP_DELETED` ユーザーグループが削除された 対象: 全員 + `id`: 削除されたユーザーグループのId ### `CHANNEL_CREATED` チャンネルが新規作成された。 対象: 該当チャンネルを閲覧可能な全員 + `id`: 作成されたチャンネルのId + `dm_user_id`: (DMの場合のみ) DM相手のユーザーId ### `CHANNEL_UPDATED` チャンネルの情報が変更された。 対象: 該当チャンネルを閲覧可能な全員 + `id`: 変更があったチャンネルのId + `dm_user_id`: (DMの場合のみ) DM相手のユーザーId ### `CHANNEL_DELETED` チャンネルが削除された。 対象: 該当チャンネルを閲覧可能な全員 + `id`: 削除されたチャンネルのId + `dm_user_id`: (DMの場合のみ) DM相手のユーザーId ### `CHANNEL_STARED` 自分がチャンネルをスターした。 対象: 自分 + `id`: スターしたチャンネルのId ### `CHANNEL_UNSTARED` 自分がチャンネルのスターを解除した。 対象: 自分 + `id`: スターしたチャンネルのId ### `CHANNEL_VIEWERS_CHANGED` チャンネルの閲覧者が変化した。 対象: 該当チャンネルを閲覧しているユーザー + `id`: 変化したチャンネルのId + `viewers`: 変化後の閲覧者(配列) + `userId`: ユーザーId + `state`: 閲覧状態 + `updatedAt`: 閲覧状態の更新日時 ### `CHANNEL_SUBSCRIBERS_CHANGED` チャンネルの購読者が変化した。 対象: 該当チャンネルを閲覧しているユーザー + `id`: 変化したチャンネルのId ### `MESSAGE_CREATED` メッセージが投稿された。 対象: 投稿チャンネルを閲覧しているユーザー・投稿チャンネルに通知をつけているユーザー・メンションを受けたユーザー + `id`: 投稿されたメッセージのId + `is_citing`: 投稿されたメッセージがWebSocketを接続しているユーザーの投稿を引用しているかどうか ### `MESSAGE_UPDATED` メッセージが更新された。 対象: 投稿チャンネルを閲覧しているユーザー + `id`: 更新されたメッセージのId ### `MESSAGE_DELETED` メッセージが削除された。 対象: 投稿チャンネルを閲覧しているユーザー + `id`: 削除されたメッセージのId ### `MESSAGE_STAMPED` メッセージにスタンプが押された。 対象: 投稿チャンネルを閲覧しているユーザー + `message_id`: メッセージId + `user_id`: スタンプを押したユーザーのId + `stamp_id`: スタンプのId + `count`: そのユーザーが押した数 + `created_at`: そのユーザーがそのスタンプをそのメッセージに最初に押した日時 ### `MESSAGE_UNSTAMPED` メッセージからスタンプが外された。 対象: 投稿チャンネルを閲覧しているユーザー + `message_id`: メッセージId + `user_id`: スタンプを押したユーザーのId + `stamp_id`: スタンプのId ### `MESSAGE_PINNED` メッセージがピン留めされた。 対象: 投稿チャンネルを閲覧しているユーザー + `message_id`: ピンされたメッセージのID + `channel_id`: ピンされたメッセージのチャンネルID ### `MESSAGE_UNPINNED` ピン留めされたメッセージのピンが外された。 対象: 投稿チャンネルを閲覧しているユーザー + `message_id`: ピンが外されたメッセージのID + `channel_id`: ピンが外されたメッセージのチャンネルID ### `MESSAGE_READ` 自分があるチャンネルのメッセージを読んだ。 対象: 自分 + `id`: 読んだチャンネルId ### `STAMP_CREATED` スタンプが新しく追加された。 対象: 全員 + `id`: 作成されたスタンプのId ### `STAMP_UPDATED` スタンプが修正された。 対象: 全員 + `id`: 修正されたスタンプのId ### `STAMP_DELETED` スタンプが削除された。 対象: 全員 + `id`: 削除されたスタンプのId ### `STAMP_PALETTE_CREATED` スタンプパレットが新しく追加された。 対象: 自分 + `id`: 作成されたスタンプパレットのId ### `STAMP_PALETTE_UPDATED` スタンプパレットが修正された。 対象: 自分 + `id`: 修正されたスタンプパレットのId ### `STAMP_PALETTE_DELETED` スタンプパレットが削除された。 対象: 自分 + `id`: 削除されたスタンプパレットのId ### `CLIP_FOLDER_CREATED` クリップフォルダーが作成された。 対象：自分 + `id`: 作成されたクリップフォルダーのId ### `CLIP_FOLDER_UPDATED` クリップフォルダーが修正された。 対象: 自分 + `id`: 更新されたクリップフォルダーのId ### `CLIP_FOLDER_DELETED` クリップフォルダーが削除された。 対象: 自分 + `id`: 削除されたクリップフォルダーのId ### `CLIP_FOLDER_MESSAGE_DELETED` クリップフォルダーからメッセージが除外された。 対象: 自分 + `folder_id`: メッセージが除外されたクリップフォルダーのId + `message_id`: クリップフォルダーから除外されたメッセージのId ### `CLIP_FOLDER_MESSAGE_ADDED` クリップフォルダーにメッセージが追加された。 対象: 自分 + `folder_id`: メッセージが追加されたクリップフォルダーのId + `message_id`: クリップフォルダーに追加されたメッセージのId ### `QALL_ROOM_STATE_CHANGED` ルーム状態が変更された。 対象: 全員 + `room_id`: 変更されたルームのId + `state`: 変更後のルーム状態 + `roomId`: ルームのID + `participants`: ルーム内の参加者(配列) + `identity`: ユーザーID_RandomUUID + `name`: 表示名 + `joinedAt`: 参加した時刻 + `attributes`: ユーザーに関連付けられたカスタム属性 + `canPublish`: 発言権限 + `isWebinar`: ウェビナールームかどうか + `metadata`: ルームに関連付けられたカスタム属性 ### `QALL_SOUNDBOARD_ITEM_CREATED` サウンドボードアイテムが作成された。 対象: 全員 + `sound_id`: 作成されたサウンドのId + `name`: サウンド名 + `creator_id`: 作成者のId ### `QALL_SOUNDBOARD_ITEM_DELETED` サウンドボードアイテムが削除された。 対象: 全員 + `sound_id`: 削除されたサウンドのId * @summary WebSocket通知ストリームに接続します * @param {*} [options] Override http request option. * @throws {RequiredError} */ ws(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * NotificationApi - factory interface * @export */ declare const NotificationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * 指定したチャンネルの通知購読者を編集します。 リクエストに含めなかったユーザーの通知購読状態は変更しません。 また、存在しないユーザーを指定した場合は無視されます。 * @summary チャンネルの通知購読者を編集 * @param {string} channelId チャンネルUUID * @param {PatchChannelSubscribersRequest} [patchChannelSubscribersRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editChannelSubscribers(channelId: string, patchChannelSubscribersRequest?: PatchChannelSubscribersRequest, options?: any): AxiosPromise; /** * 指定したチャンネルを通知購読しているユーザーのUUIDのリストを取得します。 * @summary チャンネルの通知購読者のリストを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannelSubscribers(channelId: string, options?: any): AxiosPromise>; /** * 自身のチャンネル購読状態を取得します。 * @summary 自分のチャンネル購読状態を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyChannelSubscriptions(options?: any): AxiosPromise>; /** * 自分が現在未読のチャンネルの未読情報を取得します。 * @summary 未読チャンネルを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyUnreadChannels(options?: any): AxiosPromise>; /** * 自身のチャンネル閲覧状態一覧を取得します。 * @summary 自身のチャンネル閲覧状態一覧を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyViewStates(options?: any): AxiosPromise>; /** * 自分が未読のチャンネルを既読にします。 * @summary チャンネルを既読にする * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ readChannel(channelId: string, options?: any): AxiosPromise; /** * 自身のFCMデバイスを登録します。 * @summary FCMデバイスを登録 * @param {PostMyFCMDeviceRequest} [postMyFCMDeviceRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ registerFCMDevice(postMyFCMDeviceRequest?: PostMyFCMDeviceRequest, options?: any): AxiosPromise; /** * 自身の指定したチャンネルの購読レベルを設定します。 * @summary チャンネル購読レベルを設定 * @param {string} channelId チャンネルUUID * @param {PutChannelSubscribeLevelRequest} [putChannelSubscribeLevelRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ setChannelSubscribeLevel(channelId: string, putChannelSubscribeLevelRequest?: PutChannelSubscribeLevelRequest, options?: any): AxiosPromise; /** * 指定したチャンネルの通知購読者を設定します。 リクエストに含めなかったユーザーの通知購読状態はオフになります。 また、存在しないユーザーを指定した場合は無視されます。 * @summary チャンネルの通知購読者を設定 * @param {string} channelId チャンネルUUID * @param {PutChannelSubscribersRequest} [putChannelSubscribersRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ setChannelSubscribers(channelId: string, putChannelSubscribersRequest?: PutChannelSubscribersRequest, options?: any): AxiosPromise; /** * # WebSocketプロトコル ## 送信 `コマンド:引数1:引数2:...`のような形式のTextMessageをサーバーに送信することで、このWebSocketセッションに対する設定が実行できる。 ### `viewstate`コマンド このWebSocketセッションが見ているチャンネル(イベントを受け取るチャンネル)を設定する。 現時点では1つのセッションに対して1つのチャンネルしか設定できない。 `viewstate:{チャンネルID}:{閲覧状態}` + チャンネルID: 対象のチャンネルID + 閲覧状態: `none`, `monitoring`, `editing` 最初の`viewstate`コマンドを送る前、または`viewstate:null`, `viewstate:`を送信した後は、このセッションはどこのチャンネルも見ていないことになる。 ### `rtcstate`コマンド 自分のWebRTC状態を変更する。 他のコネクションが既に状態を保持している場合、変更することができません。 `rtcstate:{チャンネルID}:({状態}:{セッションID})*` コネクションが切断された場合、自分のWebRTC状態はリセットされます。 ### `timeline_streaming`コマンド 全てのパブリックチャンネルの`MESSAGE_CREATED`イベントを受け取るかどうかを設定する。 初期状態は`off`です。 `timeline_streaming:(on|off|true|false)` ## 受信 TextMessageとして各種イベントが`type`と`body`を持つJSONとして非同期に送られます。 例: ```json {\"type\":\"USER_ONLINE\",\"body\":{\"id\":\"7dd8e07f-7f5d-4331-9176-b56a4299768b\"}} ``` ## イベント一覧 ### `USER_JOINED` ユーザーが新規登録された。 対象: 全員 + `id`: 登録されたユーザーのId ### `USER_UPDATED` ユーザーの情報が更新された。 対象: 全員 + `id`: 情報が更新されたユーザーのId ### `USER_TAGS_UPDATED` ユーザーのタグが更新された。 対象: 全員 + `id`: タグが更新されたユーザーのId + `tag_id`: 更新されたタグのId ### `USER_ICON_UPDATED` ユーザーのアイコンが更新された。 対象: 全員 + `id`: アイコンが更新されたユーザーのId ### `USER_WEBRTC_STATE_CHANGED` ユーザーのWebRTCの状態が変化した 対象: 全員 + `user_id`: 変更があったユーザーのId + `channel_id`: ユーザーの変更後の接続チャンネルのId + `sessions`: ユーザーの変更後の状態(配列) + `state`: 状態 + `sessionId`: セッションID ### `USER_VIEWSTATE_CHANGED` ユーザーのチャンネルの閲覧状態が変化した 対象: 変化したWSセッションを含めた、該当ユーザーのWSセッション全て + `view_states`: 変化したWSセッションを含めた、該当ユーザーの変更後の状態(配列) + `key`: WSセッションの識別子 + `channel_id`: 閲覧しているチャンネルId + `state`: 閲覧状態 ### `USER_ONLINE` ユーザーがオンラインになった。 対象: 全員 + `id`: オンラインになったユーザーのId ### `USER_OFFLINE` ユーザーがオフラインになった。 対象: 全員 + `id`: オフラインになったユーザーのId ### `USER_GROUP_CREATED` ユーザーグループが作成された 対象: 全員 + `id`: 作成されたユーザーグループのId ### `USER_GROUP_UPDATED` ユーザーグループが更新された 対象: 全員 + `id`: 作成されたユーザーグループのId ### `USER_GROUP_DELETED` ユーザーグループが削除された 対象: 全員 + `id`: 削除されたユーザーグループのId ### `CHANNEL_CREATED` チャンネルが新規作成された。 対象: 該当チャンネルを閲覧可能な全員 + `id`: 作成されたチャンネルのId + `dm_user_id`: (DMの場合のみ) DM相手のユーザーId ### `CHANNEL_UPDATED` チャンネルの情報が変更された。 対象: 該当チャンネルを閲覧可能な全員 + `id`: 変更があったチャンネルのId + `dm_user_id`: (DMの場合のみ) DM相手のユーザーId ### `CHANNEL_DELETED` チャンネルが削除された。 対象: 該当チャンネルを閲覧可能な全員 + `id`: 削除されたチャンネルのId + `dm_user_id`: (DMの場合のみ) DM相手のユーザーId ### `CHANNEL_STARED` 自分がチャンネルをスターした。 対象: 自分 + `id`: スターしたチャンネルのId ### `CHANNEL_UNSTARED` 自分がチャンネルのスターを解除した。 対象: 自分 + `id`: スターしたチャンネルのId ### `CHANNEL_VIEWERS_CHANGED` チャンネルの閲覧者が変化した。 対象: 該当チャンネルを閲覧しているユーザー + `id`: 変化したチャンネルのId + `viewers`: 変化後の閲覧者(配列) + `userId`: ユーザーId + `state`: 閲覧状態 + `updatedAt`: 閲覧状態の更新日時 ### `CHANNEL_SUBSCRIBERS_CHANGED` チャンネルの購読者が変化した。 対象: 該当チャンネルを閲覧しているユーザー + `id`: 変化したチャンネルのId ### `MESSAGE_CREATED` メッセージが投稿された。 対象: 投稿チャンネルを閲覧しているユーザー・投稿チャンネルに通知をつけているユーザー・メンションを受けたユーザー + `id`: 投稿されたメッセージのId + `is_citing`: 投稿されたメッセージがWebSocketを接続しているユーザーの投稿を引用しているかどうか ### `MESSAGE_UPDATED` メッセージが更新された。 対象: 投稿チャンネルを閲覧しているユーザー + `id`: 更新されたメッセージのId ### `MESSAGE_DELETED` メッセージが削除された。 対象: 投稿チャンネルを閲覧しているユーザー + `id`: 削除されたメッセージのId ### `MESSAGE_STAMPED` メッセージにスタンプが押された。 対象: 投稿チャンネルを閲覧しているユーザー + `message_id`: メッセージId + `user_id`: スタンプを押したユーザーのId + `stamp_id`: スタンプのId + `count`: そのユーザーが押した数 + `created_at`: そのユーザーがそのスタンプをそのメッセージに最初に押した日時 ### `MESSAGE_UNSTAMPED` メッセージからスタンプが外された。 対象: 投稿チャンネルを閲覧しているユーザー + `message_id`: メッセージId + `user_id`: スタンプを押したユーザーのId + `stamp_id`: スタンプのId ### `MESSAGE_PINNED` メッセージがピン留めされた。 対象: 投稿チャンネルを閲覧しているユーザー + `message_id`: ピンされたメッセージのID + `channel_id`: ピンされたメッセージのチャンネルID ### `MESSAGE_UNPINNED` ピン留めされたメッセージのピンが外された。 対象: 投稿チャンネルを閲覧しているユーザー + `message_id`: ピンが外されたメッセージのID + `channel_id`: ピンが外されたメッセージのチャンネルID ### `MESSAGE_READ` 自分があるチャンネルのメッセージを読んだ。 対象: 自分 + `id`: 読んだチャンネルId ### `STAMP_CREATED` スタンプが新しく追加された。 対象: 全員 + `id`: 作成されたスタンプのId ### `STAMP_UPDATED` スタンプが修正された。 対象: 全員 + `id`: 修正されたスタンプのId ### `STAMP_DELETED` スタンプが削除された。 対象: 全員 + `id`: 削除されたスタンプのId ### `STAMP_PALETTE_CREATED` スタンプパレットが新しく追加された。 対象: 自分 + `id`: 作成されたスタンプパレットのId ### `STAMP_PALETTE_UPDATED` スタンプパレットが修正された。 対象: 自分 + `id`: 修正されたスタンプパレットのId ### `STAMP_PALETTE_DELETED` スタンプパレットが削除された。 対象: 自分 + `id`: 削除されたスタンプパレットのId ### `CLIP_FOLDER_CREATED` クリップフォルダーが作成された。 対象：自分 + `id`: 作成されたクリップフォルダーのId ### `CLIP_FOLDER_UPDATED` クリップフォルダーが修正された。 対象: 自分 + `id`: 更新されたクリップフォルダーのId ### `CLIP_FOLDER_DELETED` クリップフォルダーが削除された。 対象: 自分 + `id`: 削除されたクリップフォルダーのId ### `CLIP_FOLDER_MESSAGE_DELETED` クリップフォルダーからメッセージが除外された。 対象: 自分 + `folder_id`: メッセージが除外されたクリップフォルダーのId + `message_id`: クリップフォルダーから除外されたメッセージのId ### `CLIP_FOLDER_MESSAGE_ADDED` クリップフォルダーにメッセージが追加された。 対象: 自分 + `folder_id`: メッセージが追加されたクリップフォルダーのId + `message_id`: クリップフォルダーに追加されたメッセージのId ### `QALL_ROOM_STATE_CHANGED` ルーム状態が変更された。 対象: 全員 + `room_id`: 変更されたルームのId + `state`: 変更後のルーム状態 + `roomId`: ルームのID + `participants`: ルーム内の参加者(配列) + `identity`: ユーザーID_RandomUUID + `name`: 表示名 + `joinedAt`: 参加した時刻 + `attributes`: ユーザーに関連付けられたカスタム属性 + `canPublish`: 発言権限 + `isWebinar`: ウェビナールームかどうか + `metadata`: ルームに関連付けられたカスタム属性 ### `QALL_SOUNDBOARD_ITEM_CREATED` サウンドボードアイテムが作成された。 対象: 全員 + `sound_id`: 作成されたサウンドのId + `name`: サウンド名 + `creator_id`: 作成者のId ### `QALL_SOUNDBOARD_ITEM_DELETED` サウンドボードアイテムが削除された。 対象: 全員 + `sound_id`: 削除されたサウンドのId * @summary WebSocket通知ストリームに接続します * @param {*} [options] Override http request option. * @throws {RequiredError} */ ws(options?: any): AxiosPromise; }; /** * NotificationApi - object-oriented interface * @export * @class NotificationApi * @extends {BaseAPI} */ declare class NotificationApi extends BaseAPI { /** * 指定したチャンネルの通知購読者を編集します。 リクエストに含めなかったユーザーの通知購読状態は変更しません。 また、存在しないユーザーを指定した場合は無視されます。 * @summary チャンネルの通知購読者を編集 * @param {string} channelId チャンネルUUID * @param {PatchChannelSubscribersRequest} [patchChannelSubscribersRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationApi */ editChannelSubscribers(channelId: string, patchChannelSubscribersRequest?: PatchChannelSubscribersRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルを通知購読しているユーザーのUUIDのリストを取得します。 * @summary チャンネルの通知購読者のリストを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationApi */ getChannelSubscribers(channelId: string, options?: AxiosRequestConfig): Promise>; /** * 自身のチャンネル購読状態を取得します。 * @summary 自分のチャンネル購読状態を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationApi */ getMyChannelSubscriptions(options?: AxiosRequestConfig): Promise>; /** * 自分が現在未読のチャンネルの未読情報を取得します。 * @summary 未読チャンネルを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationApi */ getMyUnreadChannels(options?: AxiosRequestConfig): Promise>; /** * 自身のチャンネル閲覧状態一覧を取得します。 * @summary 自身のチャンネル閲覧状態一覧を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationApi */ getMyViewStates(options?: AxiosRequestConfig): Promise>; /** * 自分が未読のチャンネルを既読にします。 * @summary チャンネルを既読にする * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationApi */ readChannel(channelId: string, options?: AxiosRequestConfig): Promise>; /** * 自身のFCMデバイスを登録します。 * @summary FCMデバイスを登録 * @param {PostMyFCMDeviceRequest} [postMyFCMDeviceRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationApi */ registerFCMDevice(postMyFCMDeviceRequest?: PostMyFCMDeviceRequest, options?: AxiosRequestConfig): Promise>; /** * 自身の指定したチャンネルの購読レベルを設定します。 * @summary チャンネル購読レベルを設定 * @param {string} channelId チャンネルUUID * @param {PutChannelSubscribeLevelRequest} [putChannelSubscribeLevelRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationApi */ setChannelSubscribeLevel(channelId: string, putChannelSubscribeLevelRequest?: PutChannelSubscribeLevelRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルの通知購読者を設定します。 リクエストに含めなかったユーザーの通知購読状態はオフになります。 また、存在しないユーザーを指定した場合は無視されます。 * @summary チャンネルの通知購読者を設定 * @param {string} channelId チャンネルUUID * @param {PutChannelSubscribersRequest} [putChannelSubscribersRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationApi */ setChannelSubscribers(channelId: string, putChannelSubscribersRequest?: PutChannelSubscribersRequest, options?: AxiosRequestConfig): Promise>; /** * # WebSocketプロトコル ## 送信 `コマンド:引数1:引数2:...`のような形式のTextMessageをサーバーに送信することで、このWebSocketセッションに対する設定が実行できる。 ### `viewstate`コマンド このWebSocketセッションが見ているチャンネル(イベントを受け取るチャンネル)を設定する。 現時点では1つのセッションに対して1つのチャンネルしか設定できない。 `viewstate:{チャンネルID}:{閲覧状態}` + チャンネルID: 対象のチャンネルID + 閲覧状態: `none`, `monitoring`, `editing` 最初の`viewstate`コマンドを送る前、または`viewstate:null`, `viewstate:`を送信した後は、このセッションはどこのチャンネルも見ていないことになる。 ### `rtcstate`コマンド 自分のWebRTC状態を変更する。 他のコネクションが既に状態を保持している場合、変更することができません。 `rtcstate:{チャンネルID}:({状態}:{セッションID})*` コネクションが切断された場合、自分のWebRTC状態はリセットされます。 ### `timeline_streaming`コマンド 全てのパブリックチャンネルの`MESSAGE_CREATED`イベントを受け取るかどうかを設定する。 初期状態は`off`です。 `timeline_streaming:(on|off|true|false)` ## 受信 TextMessageとして各種イベントが`type`と`body`を持つJSONとして非同期に送られます。 例: ```json {\"type\":\"USER_ONLINE\",\"body\":{\"id\":\"7dd8e07f-7f5d-4331-9176-b56a4299768b\"}} ``` ## イベント一覧 ### `USER_JOINED` ユーザーが新規登録された。 対象: 全員 + `id`: 登録されたユーザーのId ### `USER_UPDATED` ユーザーの情報が更新された。 対象: 全員 + `id`: 情報が更新されたユーザーのId ### `USER_TAGS_UPDATED` ユーザーのタグが更新された。 対象: 全員 + `id`: タグが更新されたユーザーのId + `tag_id`: 更新されたタグのId ### `USER_ICON_UPDATED` ユーザーのアイコンが更新された。 対象: 全員 + `id`: アイコンが更新されたユーザーのId ### `USER_WEBRTC_STATE_CHANGED` ユーザーのWebRTCの状態が変化した 対象: 全員 + `user_id`: 変更があったユーザーのId + `channel_id`: ユーザーの変更後の接続チャンネルのId + `sessions`: ユーザーの変更後の状態(配列) + `state`: 状態 + `sessionId`: セッションID ### `USER_VIEWSTATE_CHANGED` ユーザーのチャンネルの閲覧状態が変化した 対象: 変化したWSセッションを含めた、該当ユーザーのWSセッション全て + `view_states`: 変化したWSセッションを含めた、該当ユーザーの変更後の状態(配列) + `key`: WSセッションの識別子 + `channel_id`: 閲覧しているチャンネルId + `state`: 閲覧状態 ### `USER_ONLINE` ユーザーがオンラインになった。 対象: 全員 + `id`: オンラインになったユーザーのId ### `USER_OFFLINE` ユーザーがオフラインになった。 対象: 全員 + `id`: オフラインになったユーザーのId ### `USER_GROUP_CREATED` ユーザーグループが作成された 対象: 全員 + `id`: 作成されたユーザーグループのId ### `USER_GROUP_UPDATED` ユーザーグループが更新された 対象: 全員 + `id`: 作成されたユーザーグループのId ### `USER_GROUP_DELETED` ユーザーグループが削除された 対象: 全員 + `id`: 削除されたユーザーグループのId ### `CHANNEL_CREATED` チャンネルが新規作成された。 対象: 該当チャンネルを閲覧可能な全員 + `id`: 作成されたチャンネルのId + `dm_user_id`: (DMの場合のみ) DM相手のユーザーId ### `CHANNEL_UPDATED` チャンネルの情報が変更された。 対象: 該当チャンネルを閲覧可能な全員 + `id`: 変更があったチャンネルのId + `dm_user_id`: (DMの場合のみ) DM相手のユーザーId ### `CHANNEL_DELETED` チャンネルが削除された。 対象: 該当チャンネルを閲覧可能な全員 + `id`: 削除されたチャンネルのId + `dm_user_id`: (DMの場合のみ) DM相手のユーザーId ### `CHANNEL_STARED` 自分がチャンネルをスターした。 対象: 自分 + `id`: スターしたチャンネルのId ### `CHANNEL_UNSTARED` 自分がチャンネルのスターを解除した。 対象: 自分 + `id`: スターしたチャンネルのId ### `CHANNEL_VIEWERS_CHANGED` チャンネルの閲覧者が変化した。 対象: 該当チャンネルを閲覧しているユーザー + `id`: 変化したチャンネルのId + `viewers`: 変化後の閲覧者(配列) + `userId`: ユーザーId + `state`: 閲覧状態 + `updatedAt`: 閲覧状態の更新日時 ### `CHANNEL_SUBSCRIBERS_CHANGED` チャンネルの購読者が変化した。 対象: 該当チャンネルを閲覧しているユーザー + `id`: 変化したチャンネルのId ### `MESSAGE_CREATED` メッセージが投稿された。 対象: 投稿チャンネルを閲覧しているユーザー・投稿チャンネルに通知をつけているユーザー・メンションを受けたユーザー + `id`: 投稿されたメッセージのId + `is_citing`: 投稿されたメッセージがWebSocketを接続しているユーザーの投稿を引用しているかどうか ### `MESSAGE_UPDATED` メッセージが更新された。 対象: 投稿チャンネルを閲覧しているユーザー + `id`: 更新されたメッセージのId ### `MESSAGE_DELETED` メッセージが削除された。 対象: 投稿チャンネルを閲覧しているユーザー + `id`: 削除されたメッセージのId ### `MESSAGE_STAMPED` メッセージにスタンプが押された。 対象: 投稿チャンネルを閲覧しているユーザー + `message_id`: メッセージId + `user_id`: スタンプを押したユーザーのId + `stamp_id`: スタンプのId + `count`: そのユーザーが押した数 + `created_at`: そのユーザーがそのスタンプをそのメッセージに最初に押した日時 ### `MESSAGE_UNSTAMPED` メッセージからスタンプが外された。 対象: 投稿チャンネルを閲覧しているユーザー + `message_id`: メッセージId + `user_id`: スタンプを押したユーザーのId + `stamp_id`: スタンプのId ### `MESSAGE_PINNED` メッセージがピン留めされた。 対象: 投稿チャンネルを閲覧しているユーザー + `message_id`: ピンされたメッセージのID + `channel_id`: ピンされたメッセージのチャンネルID ### `MESSAGE_UNPINNED` ピン留めされたメッセージのピンが外された。 対象: 投稿チャンネルを閲覧しているユーザー + `message_id`: ピンが外されたメッセージのID + `channel_id`: ピンが外されたメッセージのチャンネルID ### `MESSAGE_READ` 自分があるチャンネルのメッセージを読んだ。 対象: 自分 + `id`: 読んだチャンネルId ### `STAMP_CREATED` スタンプが新しく追加された。 対象: 全員 + `id`: 作成されたスタンプのId ### `STAMP_UPDATED` スタンプが修正された。 対象: 全員 + `id`: 修正されたスタンプのId ### `STAMP_DELETED` スタンプが削除された。 対象: 全員 + `id`: 削除されたスタンプのId ### `STAMP_PALETTE_CREATED` スタンプパレットが新しく追加された。 対象: 自分 + `id`: 作成されたスタンプパレットのId ### `STAMP_PALETTE_UPDATED` スタンプパレットが修正された。 対象: 自分 + `id`: 修正されたスタンプパレットのId ### `STAMP_PALETTE_DELETED` スタンプパレットが削除された。 対象: 自分 + `id`: 削除されたスタンプパレットのId ### `CLIP_FOLDER_CREATED` クリップフォルダーが作成された。 対象：自分 + `id`: 作成されたクリップフォルダーのId ### `CLIP_FOLDER_UPDATED` クリップフォルダーが修正された。 対象: 自分 + `id`: 更新されたクリップフォルダーのId ### `CLIP_FOLDER_DELETED` クリップフォルダーが削除された。 対象: 自分 + `id`: 削除されたクリップフォルダーのId ### `CLIP_FOLDER_MESSAGE_DELETED` クリップフォルダーからメッセージが除外された。 対象: 自分 + `folder_id`: メッセージが除外されたクリップフォルダーのId + `message_id`: クリップフォルダーから除外されたメッセージのId ### `CLIP_FOLDER_MESSAGE_ADDED` クリップフォルダーにメッセージが追加された。 対象: 自分 + `folder_id`: メッセージが追加されたクリップフォルダーのId + `message_id`: クリップフォルダーに追加されたメッセージのId ### `QALL_ROOM_STATE_CHANGED` ルーム状態が変更された。 対象: 全員 + `room_id`: 変更されたルームのId + `state`: 変更後のルーム状態 + `roomId`: ルームのID + `participants`: ルーム内の参加者(配列) + `identity`: ユーザーID_RandomUUID + `name`: 表示名 + `joinedAt`: 参加した時刻 + `attributes`: ユーザーに関連付けられたカスタム属性 + `canPublish`: 発言権限 + `isWebinar`: ウェビナールームかどうか + `metadata`: ルームに関連付けられたカスタム属性 ### `QALL_SOUNDBOARD_ITEM_CREATED` サウンドボードアイテムが作成された。 対象: 全員 + `sound_id`: 作成されたサウンドのId + `name`: サウンド名 + `creator_id`: 作成者のId ### `QALL_SOUNDBOARD_ITEM_DELETED` サウンドボードアイテムが削除された。 対象: 全員 + `sound_id`: 削除されたサウンドのId * @summary WebSocket通知ストリームに接続します * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationApi */ ws(options?: AxiosRequestConfig): Promise>; } /** * Oauth2Api - axios parameter creator * @export */ declare const Oauth2ApiAxiosParamCreator: (configuration?: Configuration) => { /** * OAuth2クライアントを作成します。 * @summary OAuth2クライアントを作成 * @param {PostClientRequest} [postClientRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createClient: (postClientRequest?: PostClientRequest, options?: AxiosRequestConfig) => Promise; /** * 指定したOAuth2クライアントを削除します。 対象のクライアントの管理権限が必要です。正常に削除された場合、このクライアントに対する認可は全て取り消されます。 * @summary OAuth2クライアントを削除 * @param {string} clientId OAuth2クライアントUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteClient: (clientId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したOAuth2クライアントの情報を変更します。 対象のクライアントの管理権限が必要です。 クライアント開発者UUIDを変更した場合は、変更先ユーザーにクライアント管理権限が移譲され、自分自身は権限を失います。 * @summary OAuth2クライアント情報を変更 * @param {string} clientId OAuth2クライアントUUID * @param {PatchClientRequest} [patchClientRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editClient: (clientId: string, patchClientRequest?: PatchClientRequest, options?: AxiosRequestConfig) => Promise; /** * 指定したOAuth2クライアントの情報を取得します。 詳細情報の取得には対象のクライアントの管理権限が必要です。 * @summary OAuth2クライアント情報を取得 * @param {string} clientId OAuth2クライアントUUID * @param {boolean} [detail] 詳細情報を含めるかどうか * @param {*} [options] Override http request option. * @throws {RequiredError} */ getClient: (clientId: string, detail?: boolean, options?: AxiosRequestConfig) => Promise; /** * 自身が開発者のOAuth2クライアントのリストを取得します。 `all`が`true`の場合、全開発者の全クライアントのリストを返します。 * @summary OAuth2クライアントのリストを取得 * @param {boolean} [all] 全てのクライアントを取得するかどうか * @param {*} [options] Override http request option. * @throws {RequiredError} */ getClients: (all?: boolean, options?: AxiosRequestConfig) => Promise; /** * 有効な自分に発行されたOAuth2トークンのリストを取得します。 * @summary 有効トークンのリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyTokens: (options?: AxiosRequestConfig) => Promise; /** * OAuth2 認可エンドポイント * @summary OAuth2 認可エンドポイント * @param {string} clientId * @param {OAuth2ResponseType} [responseType] * @param {string} [redirectUri] * @param {string} [scope] * @param {string} [state] * @param {string} [codeChallenge] * @param {string} [codeChallengeMethod] * @param {string} [nonce] * @param {OAuth2Prompt} [prompt] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOAuth2Authorize: (clientId: string, responseType?: OAuth2ResponseType, redirectUri?: string, scope?: string, state?: string, codeChallenge?: string, codeChallengeMethod?: string, nonce?: string, prompt?: OAuth2Prompt, options?: AxiosRequestConfig) => Promise; /** * OAuth2 認可エンドポイント * @summary OAuth2 認可エンドポイント * @param {string} clientId * @param {OAuth2ResponseType} [responseType] * @param {string} [redirectUri] * @param {string} [scope] * @param {string} [state] * @param {string} [codeChallenge] * @param {string} [codeChallengeMethod] * @param {string} [nonce] * @param {OAuth2Prompt} [prompt] * @param {*} [options] Override http request option. * @throws {RequiredError} */ postOAuth2Authorize: (clientId: string, responseType?: OAuth2ResponseType, redirectUri?: string, scope?: string, state?: string, codeChallenge?: string, codeChallengeMethod?: string, nonce?: string, prompt?: OAuth2Prompt, options?: AxiosRequestConfig) => Promise; /** * OAuth2 認可承諾 * @summary OAuth2 認可承諾API * @param {string} submit 承諾する場合は\\\"approve\\\" * @param {*} [options] Override http request option. * @throws {RequiredError} */ postOAuth2AuthorizeDecide: (submit: string, options?: AxiosRequestConfig) => Promise; /** * OAuth2 トークンエンドポイント * @summary OAuth2 トークンエンドポイント * @param {string} grantType * @param {string} [code] * @param {string} [redirectUri] * @param {string} [clientId] * @param {string} [codeVerifier] * @param {string} [username] * @param {string} [password] * @param {string} [scope] * @param {string} [refreshToken] * @param {string} [clientSecret] * @param {*} [options] Override http request option. * @throws {RequiredError} */ postOAuth2Token: (grantType: string, code?: string, redirectUri?: string, clientId?: string, codeVerifier?: string, username?: string, password?: string, scope?: string, refreshToken?: string, clientSecret?: string, options?: AxiosRequestConfig) => Promise; /** * 自分が許可している指定したOAuthクライアントのアクセストークンを全てRevokeします。 * @summary OAuthクライアントのトークンを削除 * @param {string} clientId OAuth2クライアントUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ revokeClientTokens: (clientId: string, options?: AxiosRequestConfig) => Promise; /** * 自分の指定したトークンの認可を取り消します。 * @summary トークンの認可を取り消す * @param {string} tokenId OAuth2トークンUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ revokeMyToken: (tokenId: string, options?: AxiosRequestConfig) => Promise; /** * OAuth2 トークン無効化エンドポイント * @summary OAuth2 トークン無効化エンドポイント * @param {string} token 無効化するOAuth2トークンまたはOAuth2リフレッシュトークン * @param {*} [options] Override http request option. * @throws {RequiredError} */ revokeOAuth2Token: (token: string, options?: AxiosRequestConfig) => Promise; }; /** * Oauth2Api - functional programming interface * @export */ declare const Oauth2ApiFp: (configuration?: Configuration) => { /** * OAuth2クライアントを作成します。 * @summary OAuth2クライアントを作成 * @param {PostClientRequest} [postClientRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createClient(postClientRequest?: PostClientRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したOAuth2クライアントを削除します。 対象のクライアントの管理権限が必要です。正常に削除された場合、このクライアントに対する認可は全て取り消されます。 * @summary OAuth2クライアントを削除 * @param {string} clientId OAuth2クライアントUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteClient(clientId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したOAuth2クライアントの情報を変更します。 対象のクライアントの管理権限が必要です。 クライアント開発者UUIDを変更した場合は、変更先ユーザーにクライアント管理権限が移譲され、自分自身は権限を失います。 * @summary OAuth2クライアント情報を変更 * @param {string} clientId OAuth2クライアントUUID * @param {PatchClientRequest} [patchClientRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editClient(clientId: string, patchClientRequest?: PatchClientRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したOAuth2クライアントの情報を取得します。 詳細情報の取得には対象のクライアントの管理権限が必要です。 * @summary OAuth2クライアント情報を取得 * @param {string} clientId OAuth2クライアントUUID * @param {boolean} [detail] 詳細情報を含めるかどうか * @param {*} [options] Override http request option. * @throws {RequiredError} */ getClient(clientId: string, detail?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 自身が開発者のOAuth2クライアントのリストを取得します。 `all`が`true`の場合、全開発者の全クライアントのリストを返します。 * @summary OAuth2クライアントのリストを取得 * @param {boolean} [all] 全てのクライアントを取得するかどうか * @param {*} [options] Override http request option. * @throws {RequiredError} */ getClients(all?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 有効な自分に発行されたOAuth2トークンのリストを取得します。 * @summary 有効トークンのリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyTokens(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * OAuth2 認可エンドポイント * @summary OAuth2 認可エンドポイント * @param {string} clientId * @param {OAuth2ResponseType} [responseType] * @param {string} [redirectUri] * @param {string} [scope] * @param {string} [state] * @param {string} [codeChallenge] * @param {string} [codeChallengeMethod] * @param {string} [nonce] * @param {OAuth2Prompt} [prompt] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOAuth2Authorize(clientId: string, responseType?: OAuth2ResponseType, redirectUri?: string, scope?: string, state?: string, codeChallenge?: string, codeChallengeMethod?: string, nonce?: string, prompt?: OAuth2Prompt, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * OAuth2 認可エンドポイント * @summary OAuth2 認可エンドポイント * @param {string} clientId * @param {OAuth2ResponseType} [responseType] * @param {string} [redirectUri] * @param {string} [scope] * @param {string} [state] * @param {string} [codeChallenge] * @param {string} [codeChallengeMethod] * @param {string} [nonce] * @param {OAuth2Prompt} [prompt] * @param {*} [options] Override http request option. * @throws {RequiredError} */ postOAuth2Authorize(clientId: string, responseType?: OAuth2ResponseType, redirectUri?: string, scope?: string, state?: string, codeChallenge?: string, codeChallengeMethod?: string, nonce?: string, prompt?: OAuth2Prompt, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * OAuth2 認可承諾 * @summary OAuth2 認可承諾API * @param {string} submit 承諾する場合は\\\"approve\\\" * @param {*} [options] Override http request option. * @throws {RequiredError} */ postOAuth2AuthorizeDecide(submit: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * OAuth2 トークンエンドポイント * @summary OAuth2 トークンエンドポイント * @param {string} grantType * @param {string} [code] * @param {string} [redirectUri] * @param {string} [clientId] * @param {string} [codeVerifier] * @param {string} [username] * @param {string} [password] * @param {string} [scope] * @param {string} [refreshToken] * @param {string} [clientSecret] * @param {*} [options] Override http request option. * @throws {RequiredError} */ postOAuth2Token(grantType: string, code?: string, redirectUri?: string, clientId?: string, codeVerifier?: string, username?: string, password?: string, scope?: string, refreshToken?: string, clientSecret?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 自分が許可している指定したOAuthクライアントのアクセストークンを全てRevokeします。 * @summary OAuthクライアントのトークンを削除 * @param {string} clientId OAuth2クライアントUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ revokeClientTokens(clientId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 自分の指定したトークンの認可を取り消します。 * @summary トークンの認可を取り消す * @param {string} tokenId OAuth2トークンUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ revokeMyToken(tokenId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * OAuth2 トークン無効化エンドポイント * @summary OAuth2 トークン無効化エンドポイント * @param {string} token 無効化するOAuth2トークンまたはOAuth2リフレッシュトークン * @param {*} [options] Override http request option. * @throws {RequiredError} */ revokeOAuth2Token(token: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * Oauth2Api - factory interface * @export */ declare const Oauth2ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * OAuth2クライアントを作成します。 * @summary OAuth2クライアントを作成 * @param {PostClientRequest} [postClientRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createClient(postClientRequest?: PostClientRequest, options?: any): AxiosPromise; /** * 指定したOAuth2クライアントを削除します。 対象のクライアントの管理権限が必要です。正常に削除された場合、このクライアントに対する認可は全て取り消されます。 * @summary OAuth2クライアントを削除 * @param {string} clientId OAuth2クライアントUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteClient(clientId: string, options?: any): AxiosPromise; /** * 指定したOAuth2クライアントの情報を変更します。 対象のクライアントの管理権限が必要です。 クライアント開発者UUIDを変更した場合は、変更先ユーザーにクライアント管理権限が移譲され、自分自身は権限を失います。 * @summary OAuth2クライアント情報を変更 * @param {string} clientId OAuth2クライアントUUID * @param {PatchClientRequest} [patchClientRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editClient(clientId: string, patchClientRequest?: PatchClientRequest, options?: any): AxiosPromise; /** * 指定したOAuth2クライアントの情報を取得します。 詳細情報の取得には対象のクライアントの管理権限が必要です。 * @summary OAuth2クライアント情報を取得 * @param {string} clientId OAuth2クライアントUUID * @param {boolean} [detail] 詳細情報を含めるかどうか * @param {*} [options] Override http request option. * @throws {RequiredError} */ getClient(clientId: string, detail?: boolean, options?: any): AxiosPromise; /** * 自身が開発者のOAuth2クライアントのリストを取得します。 `all`が`true`の場合、全開発者の全クライアントのリストを返します。 * @summary OAuth2クライアントのリストを取得 * @param {boolean} [all] 全てのクライアントを取得するかどうか * @param {*} [options] Override http request option. * @throws {RequiredError} */ getClients(all?: boolean, options?: any): AxiosPromise>; /** * 有効な自分に発行されたOAuth2トークンのリストを取得します。 * @summary 有効トークンのリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyTokens(options?: any): AxiosPromise>; /** * OAuth2 認可エンドポイント * @summary OAuth2 認可エンドポイント * @param {string} clientId * @param {OAuth2ResponseType} [responseType] * @param {string} [redirectUri] * @param {string} [scope] * @param {string} [state] * @param {string} [codeChallenge] * @param {string} [codeChallengeMethod] * @param {string} [nonce] * @param {OAuth2Prompt} [prompt] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOAuth2Authorize(clientId: string, responseType?: OAuth2ResponseType, redirectUri?: string, scope?: string, state?: string, codeChallenge?: string, codeChallengeMethod?: string, nonce?: string, prompt?: OAuth2Prompt, options?: any): AxiosPromise; /** * OAuth2 認可エンドポイント * @summary OAuth2 認可エンドポイント * @param {string} clientId * @param {OAuth2ResponseType} [responseType] * @param {string} [redirectUri] * @param {string} [scope] * @param {string} [state] * @param {string} [codeChallenge] * @param {string} [codeChallengeMethod] * @param {string} [nonce] * @param {OAuth2Prompt} [prompt] * @param {*} [options] Override http request option. * @throws {RequiredError} */ postOAuth2Authorize(clientId: string, responseType?: OAuth2ResponseType, redirectUri?: string, scope?: string, state?: string, codeChallenge?: string, codeChallengeMethod?: string, nonce?: string, prompt?: OAuth2Prompt, options?: any): AxiosPromise; /** * OAuth2 認可承諾 * @summary OAuth2 認可承諾API * @param {string} submit 承諾する場合は\\\"approve\\\" * @param {*} [options] Override http request option. * @throws {RequiredError} */ postOAuth2AuthorizeDecide(submit: string, options?: any): AxiosPromise; /** * OAuth2 トークンエンドポイント * @summary OAuth2 トークンエンドポイント * @param {string} grantType * @param {string} [code] * @param {string} [redirectUri] * @param {string} [clientId] * @param {string} [codeVerifier] * @param {string} [username] * @param {string} [password] * @param {string} [scope] * @param {string} [refreshToken] * @param {string} [clientSecret] * @param {*} [options] Override http request option. * @throws {RequiredError} */ postOAuth2Token(grantType: string, code?: string, redirectUri?: string, clientId?: string, codeVerifier?: string, username?: string, password?: string, scope?: string, refreshToken?: string, clientSecret?: string, options?: any): AxiosPromise; /** * 自分が許可している指定したOAuthクライアントのアクセストークンを全てRevokeします。 * @summary OAuthクライアントのトークンを削除 * @param {string} clientId OAuth2クライアントUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ revokeClientTokens(clientId: string, options?: any): AxiosPromise; /** * 自分の指定したトークンの認可を取り消します。 * @summary トークンの認可を取り消す * @param {string} tokenId OAuth2トークンUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ revokeMyToken(tokenId: string, options?: any): AxiosPromise; /** * OAuth2 トークン無効化エンドポイント * @summary OAuth2 トークン無効化エンドポイント * @param {string} token 無効化するOAuth2トークンまたはOAuth2リフレッシュトークン * @param {*} [options] Override http request option. * @throws {RequiredError} */ revokeOAuth2Token(token: string, options?: any): AxiosPromise; }; /** * Oauth2Api - object-oriented interface * @export * @class Oauth2Api * @extends {BaseAPI} */ declare class Oauth2Api extends BaseAPI { /** * OAuth2クライアントを作成します。 * @summary OAuth2クライアントを作成 * @param {PostClientRequest} [postClientRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof Oauth2Api */ createClient(postClientRequest?: PostClientRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したOAuth2クライアントを削除します。 対象のクライアントの管理権限が必要です。正常に削除された場合、このクライアントに対する認可は全て取り消されます。 * @summary OAuth2クライアントを削除 * @param {string} clientId OAuth2クライアントUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof Oauth2Api */ deleteClient(clientId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したOAuth2クライアントの情報を変更します。 対象のクライアントの管理権限が必要です。 クライアント開発者UUIDを変更した場合は、変更先ユーザーにクライアント管理権限が移譲され、自分自身は権限を失います。 * @summary OAuth2クライアント情報を変更 * @param {string} clientId OAuth2クライアントUUID * @param {PatchClientRequest} [patchClientRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof Oauth2Api */ editClient(clientId: string, patchClientRequest?: PatchClientRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したOAuth2クライアントの情報を取得します。 詳細情報の取得には対象のクライアントの管理権限が必要です。 * @summary OAuth2クライアント情報を取得 * @param {string} clientId OAuth2クライアントUUID * @param {boolean} [detail] 詳細情報を含めるかどうか * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof Oauth2Api */ getClient(clientId: string, detail?: boolean, options?: AxiosRequestConfig): Promise>; /** * 自身が開発者のOAuth2クライアントのリストを取得します。 `all`が`true`の場合、全開発者の全クライアントのリストを返します。 * @summary OAuth2クライアントのリストを取得 * @param {boolean} [all] 全てのクライアントを取得するかどうか * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof Oauth2Api */ getClients(all?: boolean, options?: AxiosRequestConfig): Promise>; /** * 有効な自分に発行されたOAuth2トークンのリストを取得します。 * @summary 有効トークンのリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof Oauth2Api */ getMyTokens(options?: AxiosRequestConfig): Promise>; /** * OAuth2 認可エンドポイント * @summary OAuth2 認可エンドポイント * @param {string} clientId * @param {OAuth2ResponseType} [responseType] * @param {string} [redirectUri] * @param {string} [scope] * @param {string} [state] * @param {string} [codeChallenge] * @param {string} [codeChallengeMethod] * @param {string} [nonce] * @param {OAuth2Prompt} [prompt] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof Oauth2Api */ getOAuth2Authorize(clientId: string, responseType?: OAuth2ResponseType, redirectUri?: string, scope?: string, state?: string, codeChallenge?: string, codeChallengeMethod?: string, nonce?: string, prompt?: OAuth2Prompt, options?: AxiosRequestConfig): Promise>; /** * OAuth2 認可エンドポイント * @summary OAuth2 認可エンドポイント * @param {string} clientId * @param {OAuth2ResponseType} [responseType] * @param {string} [redirectUri] * @param {string} [scope] * @param {string} [state] * @param {string} [codeChallenge] * @param {string} [codeChallengeMethod] * @param {string} [nonce] * @param {OAuth2Prompt} [prompt] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof Oauth2Api */ postOAuth2Authorize(clientId: string, responseType?: OAuth2ResponseType, redirectUri?: string, scope?: string, state?: string, codeChallenge?: string, codeChallengeMethod?: string, nonce?: string, prompt?: OAuth2Prompt, options?: AxiosRequestConfig): Promise>; /** * OAuth2 認可承諾 * @summary OAuth2 認可承諾API * @param {string} submit 承諾する場合は\\\"approve\\\" * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof Oauth2Api */ postOAuth2AuthorizeDecide(submit: string, options?: AxiosRequestConfig): Promise>; /** * OAuth2 トークンエンドポイント * @summary OAuth2 トークンエンドポイント * @param {string} grantType * @param {string} [code] * @param {string} [redirectUri] * @param {string} [clientId] * @param {string} [codeVerifier] * @param {string} [username] * @param {string} [password] * @param {string} [scope] * @param {string} [refreshToken] * @param {string} [clientSecret] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof Oauth2Api */ postOAuth2Token(grantType: string, code?: string, redirectUri?: string, clientId?: string, codeVerifier?: string, username?: string, password?: string, scope?: string, refreshToken?: string, clientSecret?: string, options?: AxiosRequestConfig): Promise>; /** * 自分が許可している指定したOAuthクライアントのアクセストークンを全てRevokeします。 * @summary OAuthクライアントのトークンを削除 * @param {string} clientId OAuth2クライアントUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof Oauth2Api */ revokeClientTokens(clientId: string, options?: AxiosRequestConfig): Promise>; /** * 自分の指定したトークンの認可を取り消します。 * @summary トークンの認可を取り消す * @param {string} tokenId OAuth2トークンUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof Oauth2Api */ revokeMyToken(tokenId: string, options?: AxiosRequestConfig): Promise>; /** * OAuth2 トークン無効化エンドポイント * @summary OAuth2 トークン無効化エンドポイント * @param {string} token 無効化するOAuth2トークンまたはOAuth2リフレッシュトークン * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof Oauth2Api */ revokeOAuth2Token(token: string, options?: AxiosRequestConfig): Promise>; } /** * OgpApi - axios parameter creator * @export */ declare const OgpApiAxiosParamCreator: (configuration?: Configuration) => { /** * 指定されたURLのOGP情報のキャッシュを削除します。 * @summary OGP情報のキャッシュを削除 * @param {string} url OGPのキャッシュを削除したいURL * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteOgpCache: (url: string, options?: AxiosRequestConfig) => Promise; /** * 指定されたURLのOGP情報を取得します。 指定されたURLに対するOGP情報が見つからなかった場合、typeがemptyに設定された空のOGP情報を返します。 * @summary OGP情報を取得 * @param {string} url OGPを取得したいURL * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOgp: (url: string, options?: AxiosRequestConfig) => Promise; }; /** * OgpApi - functional programming interface * @export */ declare const OgpApiFp: (configuration?: Configuration) => { /** * 指定されたURLのOGP情報のキャッシュを削除します。 * @summary OGP情報のキャッシュを削除 * @param {string} url OGPのキャッシュを削除したいURL * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteOgpCache(url: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定されたURLのOGP情報を取得します。 指定されたURLに対するOGP情報が見つからなかった場合、typeがemptyに設定された空のOGP情報を返します。 * @summary OGP情報を取得 * @param {string} url OGPを取得したいURL * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOgp(url: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * OgpApi - factory interface * @export */ declare const OgpApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * 指定されたURLのOGP情報のキャッシュを削除します。 * @summary OGP情報のキャッシュを削除 * @param {string} url OGPのキャッシュを削除したいURL * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteOgpCache(url: string, options?: any): AxiosPromise; /** * 指定されたURLのOGP情報を取得します。 指定されたURLに対するOGP情報が見つからなかった場合、typeがemptyに設定された空のOGP情報を返します。 * @summary OGP情報を取得 * @param {string} url OGPを取得したいURL * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOgp(url: string, options?: any): AxiosPromise; }; /** * OgpApi - object-oriented interface * @export * @class OgpApi * @extends {BaseAPI} */ declare class OgpApi extends BaseAPI { /** * 指定されたURLのOGP情報のキャッシュを削除します。 * @summary OGP情報のキャッシュを削除 * @param {string} url OGPのキャッシュを削除したいURL * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OgpApi */ deleteOgpCache(url: string, options?: AxiosRequestConfig): Promise>; /** * 指定されたURLのOGP情報を取得します。 指定されたURLに対するOGP情報が見つからなかった場合、typeがemptyに設定された空のOGP情報を返します。 * @summary OGP情報を取得 * @param {string} url OGPを取得したいURL * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OgpApi */ getOgp(url: string, options?: AxiosRequestConfig): Promise>; } /** * PinApi - axios parameter creator * @export */ declare const PinApiAxiosParamCreator: (configuration?: Configuration) => { /** * 指定したメッセージをピン留めします。 アーカイブされているチャンネルのメッセージ・存在しないメッセージ・チャンネル当たりの上限数を超えたメッセージのピン留めはできません。 * @summary ピン留めする * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ createPin: (messageId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したチャンネルにピン留めされているピンメッセージのリストを取得します。 * @summary チャンネルピンのリストを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannelPins: (channelId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したメッセージのピン留め情報を取得します。 * @summary ピン留めを取得 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPin: (messageId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したメッセージのピン留めを外します。 * @summary ピン留めを外す * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removePin: (messageId: string, options?: AxiosRequestConfig) => Promise; }; /** * PinApi - functional programming interface * @export */ declare const PinApiFp: (configuration?: Configuration) => { /** * 指定したメッセージをピン留めします。 アーカイブされているチャンネルのメッセージ・存在しないメッセージ・チャンネル当たりの上限数を超えたメッセージのピン留めはできません。 * @summary ピン留めする * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ createPin(messageId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したチャンネルにピン留めされているピンメッセージのリストを取得します。 * @summary チャンネルピンのリストを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannelPins(channelId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 指定したメッセージのピン留め情報を取得します。 * @summary ピン留めを取得 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPin(messageId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したメッセージのピン留めを外します。 * @summary ピン留めを外す * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removePin(messageId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * PinApi - factory interface * @export */ declare const PinApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * 指定したメッセージをピン留めします。 アーカイブされているチャンネルのメッセージ・存在しないメッセージ・チャンネル当たりの上限数を超えたメッセージのピン留めはできません。 * @summary ピン留めする * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ createPin(messageId: string, options?: any): AxiosPromise; /** * 指定したチャンネルにピン留めされているピンメッセージのリストを取得します。 * @summary チャンネルピンのリストを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChannelPins(channelId: string, options?: any): AxiosPromise>; /** * 指定したメッセージのピン留め情報を取得します。 * @summary ピン留めを取得 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPin(messageId: string, options?: any): AxiosPromise; /** * 指定したメッセージのピン留めを外します。 * @summary ピン留めを外す * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removePin(messageId: string, options?: any): AxiosPromise; }; /** * PinApi - object-oriented interface * @export * @class PinApi * @extends {BaseAPI} */ declare class PinApi extends BaseAPI { /** * 指定したメッセージをピン留めします。 アーカイブされているチャンネルのメッセージ・存在しないメッセージ・チャンネル当たりの上限数を超えたメッセージのピン留めはできません。 * @summary ピン留めする * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PinApi */ createPin(messageId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルにピン留めされているピンメッセージのリストを取得します。 * @summary チャンネルピンのリストを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PinApi */ getChannelPins(channelId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したメッセージのピン留め情報を取得します。 * @summary ピン留めを取得 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PinApi */ getPin(messageId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したメッセージのピン留めを外します。 * @summary ピン留めを外す * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PinApi */ removePin(messageId: string, options?: AxiosRequestConfig): Promise>; } /** * PublicApi - axios parameter creator * @export */ declare const PublicApiAxiosParamCreator: (configuration?: Configuration) => { /** * ユーザーのアイコン画像を取得します。 * @summary ユーザーのアイコン画像を取得 * @param {string} username ユーザー名 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicUserIcon: (username: string, options?: AxiosRequestConfig) => Promise; /** * サーバーバージョン及びサーバーフラグ情報を取得します。 * @summary バージョンを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getServerVersion: (options?: AxiosRequestConfig) => Promise; }; /** * PublicApi - functional programming interface * @export */ declare const PublicApiFp: (configuration?: Configuration) => { /** * ユーザーのアイコン画像を取得します。 * @summary ユーザーのアイコン画像を取得 * @param {string} username ユーザー名 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicUserIcon(username: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * サーバーバージョン及びサーバーフラグ情報を取得します。 * @summary バージョンを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getServerVersion(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * PublicApi - factory interface * @export */ declare const PublicApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * ユーザーのアイコン画像を取得します。 * @summary ユーザーのアイコン画像を取得 * @param {string} username ユーザー名 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPublicUserIcon(username: string, options?: any): AxiosPromise; /** * サーバーバージョン及びサーバーフラグ情報を取得します。 * @summary バージョンを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getServerVersion(options?: any): AxiosPromise; }; /** * PublicApi - object-oriented interface * @export * @class PublicApi * @extends {BaseAPI} */ declare class PublicApi extends BaseAPI { /** * ユーザーのアイコン画像を取得します。 * @summary ユーザーのアイコン画像を取得 * @param {string} username ユーザー名 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PublicApi */ getPublicUserIcon(username: string, options?: AxiosRequestConfig): Promise>; /** * サーバーバージョン及びサーバーフラグ情報を取得します。 * @summary バージョンを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PublicApi */ getServerVersion(options?: AxiosRequestConfig): Promise>; } /** * QallApi - axios parameter creator * @export */ declare const QallApiAxiosParamCreator: (configuration?: Configuration) => { /** * ルーム内の参加者の発言権限を変更します。 * @summary ルームでの発言権限を変更 * @param {string} roomId ルームUUID * @param {Array} qallParticipantRequest 発言権限を変更する参加者の情報 * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeParticipantRole: (roomId: string, qallParticipantRequest: Array, options?: AxiosRequestConfig) => Promise; /** * 指定したルームに参加するためのLiveKitトークンを取得します。 * @summary LiveKitトークンを取得 * @param {string} [roomId] ルームUUID * @param {boolean} [isWebinar] ウェビナールームかどうか(デフォルト false) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLiveKitToken: (roomId?: string, isWebinar?: boolean, options?: AxiosRequestConfig) => Promise; /** * 接続可能なLiveKitエンドポイントを取得します。 * @summary LiveKitエンドポイントを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getQallEndpoints: (options?: AxiosRequestConfig) => Promise; /** * ルームのメタデータを取得します。 * @summary ルームのメタデータを取得 * @param {string} roomId ルームUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRoomMetadata: (roomId: string, options?: AxiosRequestConfig) => Promise; /** * 現在存在する(またはアクティブな)ルームと、そのルームに所属している参加者情報を取得します。 * @summary ルームと参加者の一覧を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRooms: (options?: AxiosRequestConfig) => Promise; /** * DBに保存されたサウンドボード情報を取得します。 各アイテムには soundId, soundName, stampId が含まれます。 * @summary サウンドボード用の音声一覧を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSoundboardList: (options?: AxiosRequestConfig) => Promise; /** * LiveKit側で設定したWebhookから呼び出されるエンドポイントです。 参加者の入室・退出などのイベントを受け取り、サーバ内で処理を行います。 * @summary LiveKit Webhook受信 * @param {object} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ liveKitWebhook: (body: object, options?: AxiosRequestConfig) => Promise; /** * 15秒程度の短い音声ファイルを multipart/form-data で送信し、S3(互換ストレージ)にアップロードします。 クライアントは「soundName」というフィールドを送信し、それをDBに保存して関連付けを行います。 また、サーバ側で soundId を自動生成し、S3のファイル名に使用します。 * @summary サウンドボード用の短い音声ファイルをアップロード * @param {File} audio アップロードする音声ファイル(20秒以内) * @param {string} soundName ユーザが自由につけるサウンド名 * @param {string} [stampId] アイコンスタンプID * @param {*} [options] Override http request option. * @throws {RequiredError} */ postSoundboard: (audio: File, soundName: string, stampId?: string, options?: AxiosRequestConfig) => Promise; /** * S3上にある音声ファイルの署名付きURLを生成し、 Ingressを介して指定ルームに音声を流します。 該当ルームに参加しているユーザであれば再生可能とします。 * @summary アップロード済み音声を LiveKit ルームで再生 * @param {SoundboardPlayRequest} soundboardPlayRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postSoundboardPlay: (soundboardPlayRequest: SoundboardPlayRequest, options?: AxiosRequestConfig) => Promise; /** * ルームのメタデータを更新します。 * @summary ルームのメタデータを更新 * @param {string} roomId ルームUUID * @param {QallMetadataRequest} qallMetadataRequest ルームのメタデータ * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateRoomMetadata: (roomId: string, qallMetadataRequest: QallMetadataRequest, options?: AxiosRequestConfig) => Promise; }; /** * QallApi - functional programming interface * @export */ declare const QallApiFp: (configuration?: Configuration) => { /** * ルーム内の参加者の発言権限を変更します。 * @summary ルームでの発言権限を変更 * @param {string} roomId ルームUUID * @param {Array} qallParticipantRequest 発言権限を変更する参加者の情報 * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeParticipantRole(roomId: string, qallParticipantRequest: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したルームに参加するためのLiveKitトークンを取得します。 * @summary LiveKitトークンを取得 * @param {string} [roomId] ルームUUID * @param {boolean} [isWebinar] ウェビナールームかどうか(デフォルト false) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLiveKitToken(roomId?: string, isWebinar?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 接続可能なLiveKitエンドポイントを取得します。 * @summary LiveKitエンドポイントを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getQallEndpoints(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * ルームのメタデータを取得します。 * @summary ルームのメタデータを取得 * @param {string} roomId ルームUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRoomMetadata(roomId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 現在存在する(またはアクティブな)ルームと、そのルームに所属している参加者情報を取得します。 * @summary ルームと参加者の一覧を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRooms(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * DBに保存されたサウンドボード情報を取得します。 各アイテムには soundId, soundName, stampId が含まれます。 * @summary サウンドボード用の音声一覧を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSoundboardList(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * LiveKit側で設定したWebhookから呼び出されるエンドポイントです。 参加者の入室・退出などのイベントを受け取り、サーバ内で処理を行います。 * @summary LiveKit Webhook受信 * @param {object} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ liveKitWebhook(body: object, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 15秒程度の短い音声ファイルを multipart/form-data で送信し、S3(互換ストレージ)にアップロードします。 クライアントは「soundName」というフィールドを送信し、それをDBに保存して関連付けを行います。 また、サーバ側で soundId を自動生成し、S3のファイル名に使用します。 * @summary サウンドボード用の短い音声ファイルをアップロード * @param {File} audio アップロードする音声ファイル(20秒以内) * @param {string} soundName ユーザが自由につけるサウンド名 * @param {string} [stampId] アイコンスタンプID * @param {*} [options] Override http request option. * @throws {RequiredError} */ postSoundboard(audio: File, soundName: string, stampId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * S3上にある音声ファイルの署名付きURLを生成し、 Ingressを介して指定ルームに音声を流します。 該当ルームに参加しているユーザであれば再生可能とします。 * @summary アップロード済み音声を LiveKit ルームで再生 * @param {SoundboardPlayRequest} soundboardPlayRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postSoundboardPlay(soundboardPlayRequest: SoundboardPlayRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * ルームのメタデータを更新します。 * @summary ルームのメタデータを更新 * @param {string} roomId ルームUUID * @param {QallMetadataRequest} qallMetadataRequest ルームのメタデータ * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateRoomMetadata(roomId: string, qallMetadataRequest: QallMetadataRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * QallApi - factory interface * @export */ declare const QallApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * ルーム内の参加者の発言権限を変更します。 * @summary ルームでの発言権限を変更 * @param {string} roomId ルームUUID * @param {Array} qallParticipantRequest 発言権限を変更する参加者の情報 * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeParticipantRole(roomId: string, qallParticipantRequest: Array, options?: any): AxiosPromise; /** * 指定したルームに参加するためのLiveKitトークンを取得します。 * @summary LiveKitトークンを取得 * @param {string} [roomId] ルームUUID * @param {boolean} [isWebinar] ウェビナールームかどうか(デフォルト false) * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLiveKitToken(roomId?: string, isWebinar?: boolean, options?: any): AxiosPromise; /** * 接続可能なLiveKitエンドポイントを取得します。 * @summary LiveKitエンドポイントを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getQallEndpoints(options?: any): AxiosPromise; /** * ルームのメタデータを取得します。 * @summary ルームのメタデータを取得 * @param {string} roomId ルームUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRoomMetadata(roomId: string, options?: any): AxiosPromise; /** * 現在存在する(またはアクティブな)ルームと、そのルームに所属している参加者情報を取得します。 * @summary ルームと参加者の一覧を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRooms(options?: any): AxiosPromise; /** * DBに保存されたサウンドボード情報を取得します。 各アイテムには soundId, soundName, stampId が含まれます。 * @summary サウンドボード用の音声一覧を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSoundboardList(options?: any): AxiosPromise; /** * LiveKit側で設定したWebhookから呼び出されるエンドポイントです。 参加者の入室・退出などのイベントを受け取り、サーバ内で処理を行います。 * @summary LiveKit Webhook受信 * @param {object} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ liveKitWebhook(body: object, options?: any): AxiosPromise; /** * 15秒程度の短い音声ファイルを multipart/form-data で送信し、S3(互換ストレージ)にアップロードします。 クライアントは「soundName」というフィールドを送信し、それをDBに保存して関連付けを行います。 また、サーバ側で soundId を自動生成し、S3のファイル名に使用します。 * @summary サウンドボード用の短い音声ファイルをアップロード * @param {File} audio アップロードする音声ファイル(20秒以内) * @param {string} soundName ユーザが自由につけるサウンド名 * @param {string} [stampId] アイコンスタンプID * @param {*} [options] Override http request option. * @throws {RequiredError} */ postSoundboard(audio: File, soundName: string, stampId?: string, options?: any): AxiosPromise; /** * S3上にある音声ファイルの署名付きURLを生成し、 Ingressを介して指定ルームに音声を流します。 該当ルームに参加しているユーザであれば再生可能とします。 * @summary アップロード済み音声を LiveKit ルームで再生 * @param {SoundboardPlayRequest} soundboardPlayRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ postSoundboardPlay(soundboardPlayRequest: SoundboardPlayRequest, options?: any): AxiosPromise; /** * ルームのメタデータを更新します。 * @summary ルームのメタデータを更新 * @param {string} roomId ルームUUID * @param {QallMetadataRequest} qallMetadataRequest ルームのメタデータ * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateRoomMetadata(roomId: string, qallMetadataRequest: QallMetadataRequest, options?: any): AxiosPromise; }; /** * QallApi - object-oriented interface * @export * @class QallApi * @extends {BaseAPI} */ declare class QallApi extends BaseAPI { /** * ルーム内の参加者の発言権限を変更します。 * @summary ルームでの発言権限を変更 * @param {string} roomId ルームUUID * @param {Array} qallParticipantRequest 発言権限を変更する参加者の情報 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof QallApi */ changeParticipantRole(roomId: string, qallParticipantRequest: Array, options?: AxiosRequestConfig): Promise>; /** * 指定したルームに参加するためのLiveKitトークンを取得します。 * @summary LiveKitトークンを取得 * @param {string} [roomId] ルームUUID * @param {boolean} [isWebinar] ウェビナールームかどうか(デフォルト false) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof QallApi */ getLiveKitToken(roomId?: string, isWebinar?: boolean, options?: AxiosRequestConfig): Promise>; /** * 接続可能なLiveKitエンドポイントを取得します。 * @summary LiveKitエンドポイントを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof QallApi */ getQallEndpoints(options?: AxiosRequestConfig): Promise>; /** * ルームのメタデータを取得します。 * @summary ルームのメタデータを取得 * @param {string} roomId ルームUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof QallApi */ getRoomMetadata(roomId: string, options?: AxiosRequestConfig): Promise>; /** * 現在存在する(またはアクティブな)ルームと、そのルームに所属している参加者情報を取得します。 * @summary ルームと参加者の一覧を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof QallApi */ getRooms(options?: AxiosRequestConfig): Promise>; /** * DBに保存されたサウンドボード情報を取得します。 各アイテムには soundId, soundName, stampId が含まれます。 * @summary サウンドボード用の音声一覧を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof QallApi */ getSoundboardList(options?: AxiosRequestConfig): Promise>; /** * LiveKit側で設定したWebhookから呼び出されるエンドポイントです。 参加者の入室・退出などのイベントを受け取り、サーバ内で処理を行います。 * @summary LiveKit Webhook受信 * @param {object} body * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof QallApi */ liveKitWebhook(body: object, options?: AxiosRequestConfig): Promise>; /** * 15秒程度の短い音声ファイルを multipart/form-data で送信し、S3(互換ストレージ)にアップロードします。 クライアントは「soundName」というフィールドを送信し、それをDBに保存して関連付けを行います。 また、サーバ側で soundId を自動生成し、S3のファイル名に使用します。 * @summary サウンドボード用の短い音声ファイルをアップロード * @param {File} audio アップロードする音声ファイル(20秒以内) * @param {string} soundName ユーザが自由につけるサウンド名 * @param {string} [stampId] アイコンスタンプID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof QallApi */ postSoundboard(audio: File, soundName: string, stampId?: string, options?: AxiosRequestConfig): Promise>; /** * S3上にある音声ファイルの署名付きURLを生成し、 Ingressを介して指定ルームに音声を流します。 該当ルームに参加しているユーザであれば再生可能とします。 * @summary アップロード済み音声を LiveKit ルームで再生 * @param {SoundboardPlayRequest} soundboardPlayRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof QallApi */ postSoundboardPlay(soundboardPlayRequest: SoundboardPlayRequest, options?: AxiosRequestConfig): Promise>; /** * ルームのメタデータを更新します。 * @summary ルームのメタデータを更新 * @param {string} roomId ルームUUID * @param {QallMetadataRequest} qallMetadataRequest ルームのメタデータ * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof QallApi */ updateRoomMetadata(roomId: string, qallMetadataRequest: QallMetadataRequest, options?: AxiosRequestConfig): Promise>; } /** * StampApi - axios parameter creator * @export */ declare const StampApiAxiosParamCreator: (configuration?: Configuration) => { /** * 指定したメッセージに指定したスタンプを押します。 * @summary スタンプを押す * @param {string} messageId メッセージUUID * @param {string} stampId スタンプUUID * @param {PostMessageStampRequest} [postMessageStampRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addMessageStamp: (messageId: string, stampId: string, postMessageStampRequest?: PostMessageStampRequest, options?: AxiosRequestConfig) => Promise; /** * 指定したスタンプの画像を変更します。 * @summary スタンプ画像を変更 * @param {string} stampId スタンプUUID * @param {File} file スタンプ画像(1MBまでのpng, jpeg, gif) * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeStampImage: (stampId: string, file: File, options?: AxiosRequestConfig) => Promise; /** * スタンプを新規作成します。 * @summary スタンプを作成 * @param {string} name スタンプ名 * @param {File} file スタンプ画像(1MBまでのpng, jpeg, gif) * @param {*} [options] Override http request option. * @throws {RequiredError} */ createStamp: (name: string, file: File, options?: AxiosRequestConfig) => Promise; /** * スタンプパレットを作成します。 * @summary スタンプパレットを作成 * @param {PostStampPaletteRequest} [postStampPaletteRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createStampPalette: (postStampPaletteRequest?: PostStampPaletteRequest, options?: AxiosRequestConfig) => Promise; /** * 指定したスタンプを削除します。 対象のスタンプの削除権限が必要です。 * @summary スタンプを削除 * @param {string} stampId スタンプUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteStamp: (stampId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したスタンプパレットを削除します。 対象のスタンプパレットの管理権限が必要です。 * @summary スタンプパレットを削除 * @param {string} paletteId スタンプパレットUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteStampPalette: (paletteId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したスタンプの情報を変更します。 * @summary スタンプ情報を変更 * @param {string} stampId スタンプUUID * @param {PatchStampRequest} [patchStampRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editStamp: (stampId: string, patchStampRequest?: PatchStampRequest, options?: AxiosRequestConfig) => Promise; /** * 指定したスタンプパレットを編集します。 リクエストのスタンプの配列の順番は保存されて変更されます。 対象のスタンプパレットの管理権限が必要です。 * @summary スタンプパレットを編集 * @param {string} paletteId スタンプパレットUUID * @param {PatchStampPaletteRequest} [patchStampPaletteRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editStampPalette: (paletteId: string, patchStampPaletteRequest?: PatchStampPaletteRequest, options?: AxiosRequestConfig) => Promise; /** * 指定したメッセージに押されているスタンプのリストを取得します。 * @summary メッセージのスタンプリストを取得 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessageStamps: (messageId: string, options?: AxiosRequestConfig) => Promise; /** * 自分のスタンプ履歴を最大100件まで取得します。 結果は降順で返されます。 このAPIが返すスタンプ履歴は厳密な履歴ではありません。 * @summary スタンプ履歴を取得 * @param {number} [limit] 件数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyStampHistory: (limit?: number, options?: AxiosRequestConfig) => Promise; /** * 自分のスタンプレコメンドを最大200件まで取得します。 結果は推薦度の高い順で返されます。 スタンプを使用したことがないユーザーの場合は空配列が返されます。 * @summary スタンプレコメンドを取得 * @param {number} [limit] 件数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyStampRecommendations: (limit?: number, options?: AxiosRequestConfig) => Promise; /** * 指定したスタンプの情報を取得します。 * @summary スタンプ情報を取得 * @param {string} stampId スタンプUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStamp: (stampId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したIDのスタンプ画像を返します。 * @summary スタンプ画像を取得 * @param {string} stampId スタンプUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStampImage: (stampId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したスタンプパレットの情報を取得します。 * @summary スタンプパレットを取得 * @param {string} paletteId スタンプパレットUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStampPalette: (paletteId: string, options?: AxiosRequestConfig) => Promise; /** * 自身が所有しているスタンプパレットのリストを取得します。 * @summary スタンプパレットのリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStampPalettes: (options?: AxiosRequestConfig) => Promise; /** * 指定したスタンプの統計情報を取得します。 * @summary スタンプ統計情報を取得 * @param {string} stampId スタンプUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStampStats: (stampId: string, options?: AxiosRequestConfig) => Promise; /** * スタンプのリストを取得します。 * @summary スタンプリストを取得 * @param {boolean} [includeUnicode] Unicode絵文字を含ませるかどうか Deprecated: typeクエリを指定しなければ全てのスタンプを取得できるため、そちらを利用してください * @param {'unicode' | 'original'} [type] 取得するスタンプの種類 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStamps: (includeUnicode?: boolean, type?: "unicode" | "original", options?: AxiosRequestConfig) => Promise; /** * 指定したメッセージから指定した自身が押したスタンプを削除します。 * @summary スタンプを消す * @param {string} messageId メッセージUUID * @param {string} stampId スタンプUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeMessageStamp: (messageId: string, stampId: string, options?: AxiosRequestConfig) => Promise; }; /** * StampApi - functional programming interface * @export */ declare const StampApiFp: (configuration?: Configuration) => { /** * 指定したメッセージに指定したスタンプを押します。 * @summary スタンプを押す * @param {string} messageId メッセージUUID * @param {string} stampId スタンプUUID * @param {PostMessageStampRequest} [postMessageStampRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addMessageStamp(messageId: string, stampId: string, postMessageStampRequest?: PostMessageStampRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したスタンプの画像を変更します。 * @summary スタンプ画像を変更 * @param {string} stampId スタンプUUID * @param {File} file スタンプ画像(1MBまでのpng, jpeg, gif) * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeStampImage(stampId: string, file: File, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * スタンプを新規作成します。 * @summary スタンプを作成 * @param {string} name スタンプ名 * @param {File} file スタンプ画像(1MBまでのpng, jpeg, gif) * @param {*} [options] Override http request option. * @throws {RequiredError} */ createStamp(name: string, file: File, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * スタンプパレットを作成します。 * @summary スタンプパレットを作成 * @param {PostStampPaletteRequest} [postStampPaletteRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createStampPalette(postStampPaletteRequest?: PostStampPaletteRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したスタンプを削除します。 対象のスタンプの削除権限が必要です。 * @summary スタンプを削除 * @param {string} stampId スタンプUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteStamp(stampId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したスタンプパレットを削除します。 対象のスタンプパレットの管理権限が必要です。 * @summary スタンプパレットを削除 * @param {string} paletteId スタンプパレットUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteStampPalette(paletteId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したスタンプの情報を変更します。 * @summary スタンプ情報を変更 * @param {string} stampId スタンプUUID * @param {PatchStampRequest} [patchStampRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editStamp(stampId: string, patchStampRequest?: PatchStampRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したスタンプパレットを編集します。 リクエストのスタンプの配列の順番は保存されて変更されます。 対象のスタンプパレットの管理権限が必要です。 * @summary スタンプパレットを編集 * @param {string} paletteId スタンプパレットUUID * @param {PatchStampPaletteRequest} [patchStampPaletteRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editStampPalette(paletteId: string, patchStampPaletteRequest?: PatchStampPaletteRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したメッセージに押されているスタンプのリストを取得します。 * @summary メッセージのスタンプリストを取得 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessageStamps(messageId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 自分のスタンプ履歴を最大100件まで取得します。 結果は降順で返されます。 このAPIが返すスタンプ履歴は厳密な履歴ではありません。 * @summary スタンプ履歴を取得 * @param {number} [limit] 件数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyStampHistory(limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 自分のスタンプレコメンドを最大200件まで取得します。 結果は推薦度の高い順で返されます。 スタンプを使用したことがないユーザーの場合は空配列が返されます。 * @summary スタンプレコメンドを取得 * @param {number} [limit] 件数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyStampRecommendations(limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 指定したスタンプの情報を取得します。 * @summary スタンプ情報を取得 * @param {string} stampId スタンプUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStamp(stampId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したIDのスタンプ画像を返します。 * @summary スタンプ画像を取得 * @param {string} stampId スタンプUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStampImage(stampId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したスタンプパレットの情報を取得します。 * @summary スタンプパレットを取得 * @param {string} paletteId スタンプパレットUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStampPalette(paletteId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 自身が所有しているスタンプパレットのリストを取得します。 * @summary スタンプパレットのリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStampPalettes(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 指定したスタンプの統計情報を取得します。 * @summary スタンプ統計情報を取得 * @param {string} stampId スタンプUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStampStats(stampId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * スタンプのリストを取得します。 * @summary スタンプリストを取得 * @param {boolean} [includeUnicode] Unicode絵文字を含ませるかどうか Deprecated: typeクエリを指定しなければ全てのスタンプを取得できるため、そちらを利用してください * @param {'unicode' | 'original'} [type] 取得するスタンプの種類 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStamps(includeUnicode?: boolean, type?: "unicode" | "original", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 指定したメッセージから指定した自身が押したスタンプを削除します。 * @summary スタンプを消す * @param {string} messageId メッセージUUID * @param {string} stampId スタンプUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeMessageStamp(messageId: string, stampId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * StampApi - factory interface * @export */ declare const StampApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * 指定したメッセージに指定したスタンプを押します。 * @summary スタンプを押す * @param {string} messageId メッセージUUID * @param {string} stampId スタンプUUID * @param {PostMessageStampRequest} [postMessageStampRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addMessageStamp(messageId: string, stampId: string, postMessageStampRequest?: PostMessageStampRequest, options?: any): AxiosPromise; /** * 指定したスタンプの画像を変更します。 * @summary スタンプ画像を変更 * @param {string} stampId スタンプUUID * @param {File} file スタンプ画像(1MBまでのpng, jpeg, gif) * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeStampImage(stampId: string, file: File, options?: any): AxiosPromise; /** * スタンプを新規作成します。 * @summary スタンプを作成 * @param {string} name スタンプ名 * @param {File} file スタンプ画像(1MBまでのpng, jpeg, gif) * @param {*} [options] Override http request option. * @throws {RequiredError} */ createStamp(name: string, file: File, options?: any): AxiosPromise; /** * スタンプパレットを作成します。 * @summary スタンプパレットを作成 * @param {PostStampPaletteRequest} [postStampPaletteRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createStampPalette(postStampPaletteRequest?: PostStampPaletteRequest, options?: any): AxiosPromise; /** * 指定したスタンプを削除します。 対象のスタンプの削除権限が必要です。 * @summary スタンプを削除 * @param {string} stampId スタンプUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteStamp(stampId: string, options?: any): AxiosPromise; /** * 指定したスタンプパレットを削除します。 対象のスタンプパレットの管理権限が必要です。 * @summary スタンプパレットを削除 * @param {string} paletteId スタンプパレットUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteStampPalette(paletteId: string, options?: any): AxiosPromise; /** * 指定したスタンプの情報を変更します。 * @summary スタンプ情報を変更 * @param {string} stampId スタンプUUID * @param {PatchStampRequest} [patchStampRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editStamp(stampId: string, patchStampRequest?: PatchStampRequest, options?: any): AxiosPromise; /** * 指定したスタンプパレットを編集します。 リクエストのスタンプの配列の順番は保存されて変更されます。 対象のスタンプパレットの管理権限が必要です。 * @summary スタンプパレットを編集 * @param {string} paletteId スタンプパレットUUID * @param {PatchStampPaletteRequest} [patchStampPaletteRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editStampPalette(paletteId: string, patchStampPaletteRequest?: PatchStampPaletteRequest, options?: any): AxiosPromise; /** * 指定したメッセージに押されているスタンプのリストを取得します。 * @summary メッセージのスタンプリストを取得 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessageStamps(messageId: string, options?: any): AxiosPromise>; /** * 自分のスタンプ履歴を最大100件まで取得します。 結果は降順で返されます。 このAPIが返すスタンプ履歴は厳密な履歴ではありません。 * @summary スタンプ履歴を取得 * @param {number} [limit] 件数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyStampHistory(limit?: number, options?: any): AxiosPromise>; /** * 自分のスタンプレコメンドを最大200件まで取得します。 結果は推薦度の高い順で返されます。 スタンプを使用したことがないユーザーの場合は空配列が返されます。 * @summary スタンプレコメンドを取得 * @param {number} [limit] 件数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyStampRecommendations(limit?: number, options?: any): AxiosPromise>; /** * 指定したスタンプの情報を取得します。 * @summary スタンプ情報を取得 * @param {string} stampId スタンプUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStamp(stampId: string, options?: any): AxiosPromise; /** * 指定したIDのスタンプ画像を返します。 * @summary スタンプ画像を取得 * @param {string} stampId スタンプUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStampImage(stampId: string, options?: any): AxiosPromise; /** * 指定したスタンプパレットの情報を取得します。 * @summary スタンプパレットを取得 * @param {string} paletteId スタンプパレットUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStampPalette(paletteId: string, options?: any): AxiosPromise; /** * 自身が所有しているスタンプパレットのリストを取得します。 * @summary スタンプパレットのリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStampPalettes(options?: any): AxiosPromise>; /** * 指定したスタンプの統計情報を取得します。 * @summary スタンプ統計情報を取得 * @param {string} stampId スタンプUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStampStats(stampId: string, options?: any): AxiosPromise; /** * スタンプのリストを取得します。 * @summary スタンプリストを取得 * @param {boolean} [includeUnicode] Unicode絵文字を含ませるかどうか Deprecated: typeクエリを指定しなければ全てのスタンプを取得できるため、そちらを利用してください * @param {'unicode' | 'original'} [type] 取得するスタンプの種類 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStamps(includeUnicode?: boolean, type?: "unicode" | "original", options?: any): AxiosPromise>; /** * 指定したメッセージから指定した自身が押したスタンプを削除します。 * @summary スタンプを消す * @param {string} messageId メッセージUUID * @param {string} stampId スタンプUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeMessageStamp(messageId: string, stampId: string, options?: any): AxiosPromise; }; /** * StampApi - object-oriented interface * @export * @class StampApi * @extends {BaseAPI} */ declare class StampApi extends BaseAPI { /** * 指定したメッセージに指定したスタンプを押します。 * @summary スタンプを押す * @param {string} messageId メッセージUUID * @param {string} stampId スタンプUUID * @param {PostMessageStampRequest} [postMessageStampRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ addMessageStamp(messageId: string, stampId: string, postMessageStampRequest?: PostMessageStampRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したスタンプの画像を変更します。 * @summary スタンプ画像を変更 * @param {string} stampId スタンプUUID * @param {File} file スタンプ画像(1MBまでのpng, jpeg, gif) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ changeStampImage(stampId: string, file: File, options?: AxiosRequestConfig): Promise>; /** * スタンプを新規作成します。 * @summary スタンプを作成 * @param {string} name スタンプ名 * @param {File} file スタンプ画像(1MBまでのpng, jpeg, gif) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ createStamp(name: string, file: File, options?: AxiosRequestConfig): Promise>; /** * スタンプパレットを作成します。 * @summary スタンプパレットを作成 * @param {PostStampPaletteRequest} [postStampPaletteRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ createStampPalette(postStampPaletteRequest?: PostStampPaletteRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したスタンプを削除します。 対象のスタンプの削除権限が必要です。 * @summary スタンプを削除 * @param {string} stampId スタンプUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ deleteStamp(stampId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したスタンプパレットを削除します。 対象のスタンプパレットの管理権限が必要です。 * @summary スタンプパレットを削除 * @param {string} paletteId スタンプパレットUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ deleteStampPalette(paletteId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したスタンプの情報を変更します。 * @summary スタンプ情報を変更 * @param {string} stampId スタンプUUID * @param {PatchStampRequest} [patchStampRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ editStamp(stampId: string, patchStampRequest?: PatchStampRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したスタンプパレットを編集します。 リクエストのスタンプの配列の順番は保存されて変更されます。 対象のスタンプパレットの管理権限が必要です。 * @summary スタンプパレットを編集 * @param {string} paletteId スタンプパレットUUID * @param {PatchStampPaletteRequest} [patchStampPaletteRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ editStampPalette(paletteId: string, patchStampPaletteRequest?: PatchStampPaletteRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したメッセージに押されているスタンプのリストを取得します。 * @summary メッセージのスタンプリストを取得 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ getMessageStamps(messageId: string, options?: AxiosRequestConfig): Promise>; /** * 自分のスタンプ履歴を最大100件まで取得します。 結果は降順で返されます。 このAPIが返すスタンプ履歴は厳密な履歴ではありません。 * @summary スタンプ履歴を取得 * @param {number} [limit] 件数 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ getMyStampHistory(limit?: number, options?: AxiosRequestConfig): Promise>; /** * 自分のスタンプレコメンドを最大200件まで取得します。 結果は推薦度の高い順で返されます。 スタンプを使用したことがないユーザーの場合は空配列が返されます。 * @summary スタンプレコメンドを取得 * @param {number} [limit] 件数 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ getMyStampRecommendations(limit?: number, options?: AxiosRequestConfig): Promise>; /** * 指定したスタンプの情報を取得します。 * @summary スタンプ情報を取得 * @param {string} stampId スタンプUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ getStamp(stampId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したIDのスタンプ画像を返します。 * @summary スタンプ画像を取得 * @param {string} stampId スタンプUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ getStampImage(stampId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したスタンプパレットの情報を取得します。 * @summary スタンプパレットを取得 * @param {string} paletteId スタンプパレットUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ getStampPalette(paletteId: string, options?: AxiosRequestConfig): Promise>; /** * 自身が所有しているスタンプパレットのリストを取得します。 * @summary スタンプパレットのリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ getStampPalettes(options?: AxiosRequestConfig): Promise>; /** * 指定したスタンプの統計情報を取得します。 * @summary スタンプ統計情報を取得 * @param {string} stampId スタンプUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ getStampStats(stampId: string, options?: AxiosRequestConfig): Promise>; /** * スタンプのリストを取得します。 * @summary スタンプリストを取得 * @param {boolean} [includeUnicode] Unicode絵文字を含ませるかどうか Deprecated: typeクエリを指定しなければ全てのスタンプを取得できるため、そちらを利用してください * @param {'unicode' | 'original'} [type] 取得するスタンプの種類 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ getStamps(includeUnicode?: boolean, type?: 'unicode' | 'original', options?: AxiosRequestConfig): Promise>; /** * 指定したメッセージから指定した自身が押したスタンプを削除します。 * @summary スタンプを消す * @param {string} messageId メッセージUUID * @param {string} stampId スタンプUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ removeMessageStamp(messageId: string, stampId: string, options?: AxiosRequestConfig): Promise>; } /** * StarApi - axios parameter creator * @export */ declare const StarApiAxiosParamCreator: (configuration?: Configuration) => { /** * 指定したチャンネルをスターチャンネルに追加します。 スター済みのチャンネルIDを指定した場合、204を返します。 不正なチャンネルIDを指定した場合、400を返します。 * @summary チャンネルをスターに追加 * @param {PostStarRequest} [postStarRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addMyStar: (postStarRequest?: PostStarRequest, options?: AxiosRequestConfig) => Promise; /** * 自分がスターしているチャンネルのUUIDの配列を取得します。 * @summary スターチャンネルリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyStars: (options?: AxiosRequestConfig) => Promise; /** * 既にスターから削除されているチャンネルを指定した場合は204を返します。 * @summary チャンネルをスターから削除します * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeMyStar: (channelId: string, options?: AxiosRequestConfig) => Promise; }; /** * StarApi - functional programming interface * @export */ declare const StarApiFp: (configuration?: Configuration) => { /** * 指定したチャンネルをスターチャンネルに追加します。 スター済みのチャンネルIDを指定した場合、204を返します。 不正なチャンネルIDを指定した場合、400を返します。 * @summary チャンネルをスターに追加 * @param {PostStarRequest} [postStarRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addMyStar(postStarRequest?: PostStarRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 自分がスターしているチャンネルのUUIDの配列を取得します。 * @summary スターチャンネルリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyStars(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 既にスターから削除されているチャンネルを指定した場合は204を返します。 * @summary チャンネルをスターから削除します * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeMyStar(channelId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * StarApi - factory interface * @export */ declare const StarApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * 指定したチャンネルをスターチャンネルに追加します。 スター済みのチャンネルIDを指定した場合、204を返します。 不正なチャンネルIDを指定した場合、400を返します。 * @summary チャンネルをスターに追加 * @param {PostStarRequest} [postStarRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addMyStar(postStarRequest?: PostStarRequest, options?: any): AxiosPromise; /** * 自分がスターしているチャンネルのUUIDの配列を取得します。 * @summary スターチャンネルリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyStars(options?: any): AxiosPromise>; /** * 既にスターから削除されているチャンネルを指定した場合は204を返します。 * @summary チャンネルをスターから削除します * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeMyStar(channelId: string, options?: any): AxiosPromise; }; /** * StarApi - object-oriented interface * @export * @class StarApi * @extends {BaseAPI} */ declare class StarApi extends BaseAPI { /** * 指定したチャンネルをスターチャンネルに追加します。 スター済みのチャンネルIDを指定した場合、204を返します。 不正なチャンネルIDを指定した場合、400を返します。 * @summary チャンネルをスターに追加 * @param {PostStarRequest} [postStarRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StarApi */ addMyStar(postStarRequest?: PostStarRequest, options?: AxiosRequestConfig): Promise>; /** * 自分がスターしているチャンネルのUUIDの配列を取得します。 * @summary スターチャンネルリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StarApi */ getMyStars(options?: AxiosRequestConfig): Promise>; /** * 既にスターから削除されているチャンネルを指定した場合は204を返します。 * @summary チャンネルをスターから削除します * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StarApi */ removeMyStar(channelId: string, options?: AxiosRequestConfig): Promise>; } /** * UserApi - axios parameter creator * @export */ declare const UserApiAxiosParamCreator: (configuration?: Configuration) => { /** * 指定したユーザーに指定したタグを追加します。 Webhookユーザーにタグを追加することは出来ません。 * @summary ユーザーにタグを追加 * @param {string} userId ユーザーUUID * @param {PostUserTagRequest} [postUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addUserTag: (userId: string, postUserTagRequest?: PostUserTagRequest, options?: AxiosRequestConfig) => Promise; /** * 指定したユーザーのアイコン画像を変更します。 管理者権限が必要です。 * @summary ユーザーのアイコン画像を変更します * @param {string} userId ユーザーUUID * @param {File} file アイコン画像(2MB,`Config.Imaging.MaxPixels`(default: 2560*1600)までのpng, jpeg, gif) * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeUserIcon: (userId: string, file: File, options?: AxiosRequestConfig) => Promise; /** * 指定したユーザーのパスワードを変更します。 管理者権限が必要です。 * @summary ユーザーのパスワードを変更 * @param {string} userId ユーザーUUID * @param {PutUserPasswordRequest} [putUserPasswordRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeUserPassword: (userId: string, putUserPasswordRequest?: PutUserPasswordRequest, options?: AxiosRequestConfig) => Promise; /** * ユーザーを登録します。 管理者権限が必要です。 * @summary ユーザーを登録 * @param {PostUserRequest} [postUserRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createUser: (postUserRequest?: PostUserRequest, options?: AxiosRequestConfig) => Promise; /** * 指定したユーザーの情報を変更します。 管理者権限が必要です。 * @summary ユーザー情報を変更 * @param {string} userId ユーザーUUID * @param {PatchUserRequest} [patchUserRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editUser: (userId: string, patchUserRequest?: PatchUserRequest, options?: AxiosRequestConfig) => Promise; /** * 指定したユーザーの指定したタグの状態を変更します。 他人の状態は変更できません。 * @summary ユーザーのタグを編集 * @param {string} userId ユーザーUUID * @param {string} tagId タグUUID * @param {PatchUserTagRequest} [patchUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editUserTag: (userId: string, tagId: string, patchUserTagRequest?: PatchUserTagRequest, options?: AxiosRequestConfig) => Promise; /** * 指定したユーザーとのダイレクトメッセージのリストを取得します。 * @summary ダイレクトメッセージのリストを取得 * @param {string} userId ユーザーUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {string} [since] 取得する時間範囲の開始日時 * @param {string} [until] 取得する時間範囲の終了日時 * @param {boolean} [inclusive] 範囲の端を含めるかどうか * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDirectMessages: (userId: string, limit?: number, offset?: number, since?: string, until?: string, inclusive?: boolean, order?: "asc" | "desc", options?: AxiosRequestConfig) => Promise; /** * 指定したユーザーの詳細情報を取得します。 * @summary ユーザー詳細情報を取得 * @param {string} userId ユーザーUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUser: (userId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したユーザーとのダイレクトメッセージチャンネルの情報を返します。 ダイレクトメッセージチャンネルが存在しなかった場合、自動的に作成されます。 * @summary DMチャンネル情報を取得 * @param {string} userId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserDMChannel: (userId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したユーザーのアイコン画像を取得します。 * @summary ユーザーのアイコン画像を取得 * @param {string} userId ユーザーUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserIcon: (userId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したユーザーの統計情報を取得します。 * @summary ユーザー統計情報を取得 * @param {string} userId ユーザーUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserStats: (userId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したユーザーのタグリストを取得します。 * @summary ユーザーのタグリストを取得 * @param {string} userId ユーザーUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserTags: (userId: string, options?: AxiosRequestConfig) => Promise; /** * ユーザーのリストを取得します。 `include-suspended`を指定しない場合、レスポンスにはユーザーアカウント状態が\"1: 有効\"であるユーザーのみが含まれます。 `include-suspended`と`name`を同時に指定することはできません。 * @summary ユーザーのリストを取得 * @param {boolean} [includeSuspended] アカウントがアクティブでないユーザーを含め、全てのユーザーを取得するかどうか * @param {string} [name] 名前が一致するアカウントのみを取得する * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUsers: (includeSuspended?: boolean, name?: string, options?: AxiosRequestConfig) => Promise; /** * 指定したユーザーにダイレクトメッセージを送信します。 * @summary ダイレクトメッセージを送信 * @param {string} userId ユーザーUUID * @param {PostMessageRequest} [postMessageRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ postDirectMessage: (userId: string, postMessageRequest?: PostMessageRequest, options?: AxiosRequestConfig) => Promise; /** * 既に存在しないタグを削除しようとした場合は204を返します。 * @summary ユーザーからタグを削除します * @param {string} userId ユーザーUUID * @param {string} tagId タグUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeUserTag: (userId: string, tagId: string, options?: AxiosRequestConfig) => Promise; }; /** * UserApi - functional programming interface * @export */ declare const UserApiFp: (configuration?: Configuration) => { /** * 指定したユーザーに指定したタグを追加します。 Webhookユーザーにタグを追加することは出来ません。 * @summary ユーザーにタグを追加 * @param {string} userId ユーザーUUID * @param {PostUserTagRequest} [postUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addUserTag(userId: string, postUserTagRequest?: PostUserTagRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したユーザーのアイコン画像を変更します。 管理者権限が必要です。 * @summary ユーザーのアイコン画像を変更します * @param {string} userId ユーザーUUID * @param {File} file アイコン画像(2MB,`Config.Imaging.MaxPixels`(default: 2560*1600)までのpng, jpeg, gif) * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeUserIcon(userId: string, file: File, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したユーザーのパスワードを変更します。 管理者権限が必要です。 * @summary ユーザーのパスワードを変更 * @param {string} userId ユーザーUUID * @param {PutUserPasswordRequest} [putUserPasswordRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeUserPassword(userId: string, putUserPasswordRequest?: PutUserPasswordRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * ユーザーを登録します。 管理者権限が必要です。 * @summary ユーザーを登録 * @param {PostUserRequest} [postUserRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createUser(postUserRequest?: PostUserRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したユーザーの情報を変更します。 管理者権限が必要です。 * @summary ユーザー情報を変更 * @param {string} userId ユーザーUUID * @param {PatchUserRequest} [patchUserRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editUser(userId: string, patchUserRequest?: PatchUserRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したユーザーの指定したタグの状態を変更します。 他人の状態は変更できません。 * @summary ユーザーのタグを編集 * @param {string} userId ユーザーUUID * @param {string} tagId タグUUID * @param {PatchUserTagRequest} [patchUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editUserTag(userId: string, tagId: string, patchUserTagRequest?: PatchUserTagRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したユーザーとのダイレクトメッセージのリストを取得します。 * @summary ダイレクトメッセージのリストを取得 * @param {string} userId ユーザーUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {string} [since] 取得する時間範囲の開始日時 * @param {string} [until] 取得する時間範囲の終了日時 * @param {boolean} [inclusive] 範囲の端を含めるかどうか * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDirectMessages(userId: string, limit?: number, offset?: number, since?: string, until?: string, inclusive?: boolean, order?: "asc" | "desc", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 指定したユーザーの詳細情報を取得します。 * @summary ユーザー詳細情報を取得 * @param {string} userId ユーザーUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUser(userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したユーザーとのダイレクトメッセージチャンネルの情報を返します。 ダイレクトメッセージチャンネルが存在しなかった場合、自動的に作成されます。 * @summary DMチャンネル情報を取得 * @param {string} userId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserDMChannel(userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したユーザーのアイコン画像を取得します。 * @summary ユーザーのアイコン画像を取得 * @param {string} userId ユーザーUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserIcon(userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したユーザーの統計情報を取得します。 * @summary ユーザー統計情報を取得 * @param {string} userId ユーザーUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserStats(userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したユーザーのタグリストを取得します。 * @summary ユーザーのタグリストを取得 * @param {string} userId ユーザーUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserTags(userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * ユーザーのリストを取得します。 `include-suspended`を指定しない場合、レスポンスにはユーザーアカウント状態が\"1: 有効\"であるユーザーのみが含まれます。 `include-suspended`と`name`を同時に指定することはできません。 * @summary ユーザーのリストを取得 * @param {boolean} [includeSuspended] アカウントがアクティブでないユーザーを含め、全てのユーザーを取得するかどうか * @param {string} [name] 名前が一致するアカウントのみを取得する * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUsers(includeSuspended?: boolean, name?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 指定したユーザーにダイレクトメッセージを送信します。 * @summary ダイレクトメッセージを送信 * @param {string} userId ユーザーUUID * @param {PostMessageRequest} [postMessageRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ postDirectMessage(userId: string, postMessageRequest?: PostMessageRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 既に存在しないタグを削除しようとした場合は204を返します。 * @summary ユーザーからタグを削除します * @param {string} userId ユーザーUUID * @param {string} tagId タグUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeUserTag(userId: string, tagId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * UserApi - factory interface * @export */ declare const UserApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * 指定したユーザーに指定したタグを追加します。 Webhookユーザーにタグを追加することは出来ません。 * @summary ユーザーにタグを追加 * @param {string} userId ユーザーUUID * @param {PostUserTagRequest} [postUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addUserTag(userId: string, postUserTagRequest?: PostUserTagRequest, options?: any): AxiosPromise; /** * 指定したユーザーのアイコン画像を変更します。 管理者権限が必要です。 * @summary ユーザーのアイコン画像を変更します * @param {string} userId ユーザーUUID * @param {File} file アイコン画像(2MB,`Config.Imaging.MaxPixels`(default: 2560*1600)までのpng, jpeg, gif) * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeUserIcon(userId: string, file: File, options?: any): AxiosPromise; /** * 指定したユーザーのパスワードを変更します。 管理者権限が必要です。 * @summary ユーザーのパスワードを変更 * @param {string} userId ユーザーUUID * @param {PutUserPasswordRequest} [putUserPasswordRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeUserPassword(userId: string, putUserPasswordRequest?: PutUserPasswordRequest, options?: any): AxiosPromise; /** * ユーザーを登録します。 管理者権限が必要です。 * @summary ユーザーを登録 * @param {PostUserRequest} [postUserRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createUser(postUserRequest?: PostUserRequest, options?: any): AxiosPromise; /** * 指定したユーザーの情報を変更します。 管理者権限が必要です。 * @summary ユーザー情報を変更 * @param {string} userId ユーザーUUID * @param {PatchUserRequest} [patchUserRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editUser(userId: string, patchUserRequest?: PatchUserRequest, options?: any): AxiosPromise; /** * 指定したユーザーの指定したタグの状態を変更します。 他人の状態は変更できません。 * @summary ユーザーのタグを編集 * @param {string} userId ユーザーUUID * @param {string} tagId タグUUID * @param {PatchUserTagRequest} [patchUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editUserTag(userId: string, tagId: string, patchUserTagRequest?: PatchUserTagRequest, options?: any): AxiosPromise; /** * 指定したユーザーとのダイレクトメッセージのリストを取得します。 * @summary ダイレクトメッセージのリストを取得 * @param {string} userId ユーザーUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {string} [since] 取得する時間範囲の開始日時 * @param {string} [until] 取得する時間範囲の終了日時 * @param {boolean} [inclusive] 範囲の端を含めるかどうか * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDirectMessages(userId: string, limit?: number, offset?: number, since?: string, until?: string, inclusive?: boolean, order?: "asc" | "desc", options?: any): AxiosPromise>; /** * 指定したユーザーの詳細情報を取得します。 * @summary ユーザー詳細情報を取得 * @param {string} userId ユーザーUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUser(userId: string, options?: any): AxiosPromise; /** * 指定したユーザーとのダイレクトメッセージチャンネルの情報を返します。 ダイレクトメッセージチャンネルが存在しなかった場合、自動的に作成されます。 * @summary DMチャンネル情報を取得 * @param {string} userId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserDMChannel(userId: string, options?: any): AxiosPromise; /** * 指定したユーザーのアイコン画像を取得します。 * @summary ユーザーのアイコン画像を取得 * @param {string} userId ユーザーUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserIcon(userId: string, options?: any): AxiosPromise; /** * 指定したユーザーの統計情報を取得します。 * @summary ユーザー統計情報を取得 * @param {string} userId ユーザーUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserStats(userId: string, options?: any): AxiosPromise; /** * 指定したユーザーのタグリストを取得します。 * @summary ユーザーのタグリストを取得 * @param {string} userId ユーザーUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserTags(userId: string, options?: any): AxiosPromise>; /** * ユーザーのリストを取得します。 `include-suspended`を指定しない場合、レスポンスにはユーザーアカウント状態が\"1: 有効\"であるユーザーのみが含まれます。 `include-suspended`と`name`を同時に指定することはできません。 * @summary ユーザーのリストを取得 * @param {boolean} [includeSuspended] アカウントがアクティブでないユーザーを含め、全てのユーザーを取得するかどうか * @param {string} [name] 名前が一致するアカウントのみを取得する * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUsers(includeSuspended?: boolean, name?: string, options?: any): AxiosPromise>; /** * 指定したユーザーにダイレクトメッセージを送信します。 * @summary ダイレクトメッセージを送信 * @param {string} userId ユーザーUUID * @param {PostMessageRequest} [postMessageRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ postDirectMessage(userId: string, postMessageRequest?: PostMessageRequest, options?: any): AxiosPromise; /** * 既に存在しないタグを削除しようとした場合は204を返します。 * @summary ユーザーからタグを削除します * @param {string} userId ユーザーUUID * @param {string} tagId タグUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeUserTag(userId: string, tagId: string, options?: any): AxiosPromise; }; /** * UserApi - object-oriented interface * @export * @class UserApi * @extends {BaseAPI} */ declare class UserApi extends BaseAPI { /** * 指定したユーザーに指定したタグを追加します。 Webhookユーザーにタグを追加することは出来ません。 * @summary ユーザーにタグを追加 * @param {string} userId ユーザーUUID * @param {PostUserTagRequest} [postUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ addUserTag(userId: string, postUserTagRequest?: PostUserTagRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーのアイコン画像を変更します。 管理者権限が必要です。 * @summary ユーザーのアイコン画像を変更します * @param {string} userId ユーザーUUID * @param {File} file アイコン画像(2MB,`Config.Imaging.MaxPixels`(default: 2560*1600)までのpng, jpeg, gif) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ changeUserIcon(userId: string, file: File, options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーのパスワードを変更します。 管理者権限が必要です。 * @summary ユーザーのパスワードを変更 * @param {string} userId ユーザーUUID * @param {PutUserPasswordRequest} [putUserPasswordRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ changeUserPassword(userId: string, putUserPasswordRequest?: PutUserPasswordRequest, options?: AxiosRequestConfig): Promise>; /** * ユーザーを登録します。 管理者権限が必要です。 * @summary ユーザーを登録 * @param {PostUserRequest} [postUserRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ createUser(postUserRequest?: PostUserRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーの情報を変更します。 管理者権限が必要です。 * @summary ユーザー情報を変更 * @param {string} userId ユーザーUUID * @param {PatchUserRequest} [patchUserRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ editUser(userId: string, patchUserRequest?: PatchUserRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーの指定したタグの状態を変更します。 他人の状態は変更できません。 * @summary ユーザーのタグを編集 * @param {string} userId ユーザーUUID * @param {string} tagId タグUUID * @param {PatchUserTagRequest} [patchUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ editUserTag(userId: string, tagId: string, patchUserTagRequest?: PatchUserTagRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーとのダイレクトメッセージのリストを取得します。 * @summary ダイレクトメッセージのリストを取得 * @param {string} userId ユーザーUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {string} [since] 取得する時間範囲の開始日時 * @param {string} [until] 取得する時間範囲の終了日時 * @param {boolean} [inclusive] 範囲の端を含めるかどうか * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ getDirectMessages(userId: string, limit?: number, offset?: number, since?: string, until?: string, inclusive?: boolean, order?: 'asc' | 'desc', options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーの詳細情報を取得します。 * @summary ユーザー詳細情報を取得 * @param {string} userId ユーザーUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ getUser(userId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーとのダイレクトメッセージチャンネルの情報を返します。 ダイレクトメッセージチャンネルが存在しなかった場合、自動的に作成されます。 * @summary DMチャンネル情報を取得 * @param {string} userId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ getUserDMChannel(userId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーのアイコン画像を取得します。 * @summary ユーザーのアイコン画像を取得 * @param {string} userId ユーザーUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ getUserIcon(userId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーの統計情報を取得します。 * @summary ユーザー統計情報を取得 * @param {string} userId ユーザーUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ getUserStats(userId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーのタグリストを取得します。 * @summary ユーザーのタグリストを取得 * @param {string} userId ユーザーUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ getUserTags(userId: string, options?: AxiosRequestConfig): Promise>; /** * ユーザーのリストを取得します。 `include-suspended`を指定しない場合、レスポンスにはユーザーアカウント状態が\"1: 有効\"であるユーザーのみが含まれます。 `include-suspended`と`name`を同時に指定することはできません。 * @summary ユーザーのリストを取得 * @param {boolean} [includeSuspended] アカウントがアクティブでないユーザーを含め、全てのユーザーを取得するかどうか * @param {string} [name] 名前が一致するアカウントのみを取得する * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ getUsers(includeSuspended?: boolean, name?: string, options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーにダイレクトメッセージを送信します。 * @summary ダイレクトメッセージを送信 * @param {string} userId ユーザーUUID * @param {PostMessageRequest} [postMessageRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ postDirectMessage(userId: string, postMessageRequest?: PostMessageRequest, options?: AxiosRequestConfig): Promise>; /** * 既に存在しないタグを削除しようとした場合は204を返します。 * @summary ユーザーからタグを削除します * @param {string} userId ユーザーUUID * @param {string} tagId タグUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ removeUserTag(userId: string, tagId: string, options?: AxiosRequestConfig): Promise>; } /** * UserTagApi - axios parameter creator * @export */ declare const UserTagApiAxiosParamCreator: (configuration?: Configuration) => { /** * 自分に新しくタグを追加します。 * @summary 自分にタグを追加 * @param {PostUserTagRequest} [postUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addMyUserTag: (postUserTagRequest?: PostUserTagRequest, options?: AxiosRequestConfig) => Promise; /** * 指定したユーザーに指定したタグを追加します。 Webhookユーザーにタグを追加することは出来ません。 * @summary ユーザーにタグを追加 * @param {string} userId ユーザーUUID * @param {PostUserTagRequest} [postUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addUserTag: (userId: string, postUserTagRequest?: PostUserTagRequest, options?: AxiosRequestConfig) => Promise; /** * 自分の指定したタグの状態を変更します。 * @summary 自分のタグを編集 * @param {string} tagId タグUUID * @param {PatchUserTagRequest} [patchUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editMyUserTag: (tagId: string, patchUserTagRequest?: PatchUserTagRequest, options?: AxiosRequestConfig) => Promise; /** * 指定したユーザーの指定したタグの状態を変更します。 他人の状態は変更できません。 * @summary ユーザーのタグを編集 * @param {string} userId ユーザーUUID * @param {string} tagId タグUUID * @param {PatchUserTagRequest} [patchUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editUserTag: (userId: string, tagId: string, patchUserTagRequest?: PatchUserTagRequest, options?: AxiosRequestConfig) => Promise; /** * 自分に付けられているタグの配列を取得します。 * @summary 自分のタグリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyUserTags: (options?: AxiosRequestConfig) => Promise; /** * 指定したタグの情報を取得します。 * @summary タグ情報を取得 * @param {string} tagId タグUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTag: (tagId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したユーザーのタグリストを取得します。 * @summary ユーザーのタグリストを取得 * @param {string} userId ユーザーUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserTags: (userId: string, options?: AxiosRequestConfig) => Promise; /** * 既に存在しないタグを削除しようとした場合は204を返します。 * @summary 自分からタグを削除します * @param {string} tagId タグUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeMyUserTag: (tagId: string, options?: AxiosRequestConfig) => Promise; /** * 既に存在しないタグを削除しようとした場合は204を返します。 * @summary ユーザーからタグを削除します * @param {string} userId ユーザーUUID * @param {string} tagId タグUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeUserTag: (userId: string, tagId: string, options?: AxiosRequestConfig) => Promise; }; /** * UserTagApi - functional programming interface * @export */ declare const UserTagApiFp: (configuration?: Configuration) => { /** * 自分に新しくタグを追加します。 * @summary 自分にタグを追加 * @param {PostUserTagRequest} [postUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addMyUserTag(postUserTagRequest?: PostUserTagRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したユーザーに指定したタグを追加します。 Webhookユーザーにタグを追加することは出来ません。 * @summary ユーザーにタグを追加 * @param {string} userId ユーザーUUID * @param {PostUserTagRequest} [postUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addUserTag(userId: string, postUserTagRequest?: PostUserTagRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 自分の指定したタグの状態を変更します。 * @summary 自分のタグを編集 * @param {string} tagId タグUUID * @param {PatchUserTagRequest} [patchUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editMyUserTag(tagId: string, patchUserTagRequest?: PatchUserTagRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したユーザーの指定したタグの状態を変更します。 他人の状態は変更できません。 * @summary ユーザーのタグを編集 * @param {string} userId ユーザーUUID * @param {string} tagId タグUUID * @param {PatchUserTagRequest} [patchUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editUserTag(userId: string, tagId: string, patchUserTagRequest?: PatchUserTagRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 自分に付けられているタグの配列を取得します。 * @summary 自分のタグリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyUserTags(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 指定したタグの情報を取得します。 * @summary タグ情報を取得 * @param {string} tagId タグUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTag(tagId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したユーザーのタグリストを取得します。 * @summary ユーザーのタグリストを取得 * @param {string} userId ユーザーUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserTags(userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * 既に存在しないタグを削除しようとした場合は204を返します。 * @summary 自分からタグを削除します * @param {string} tagId タグUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeMyUserTag(tagId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 既に存在しないタグを削除しようとした場合は204を返します。 * @summary ユーザーからタグを削除します * @param {string} userId ユーザーUUID * @param {string} tagId タグUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeUserTag(userId: string, tagId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * UserTagApi - factory interface * @export */ declare const UserTagApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * 自分に新しくタグを追加します。 * @summary 自分にタグを追加 * @param {PostUserTagRequest} [postUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addMyUserTag(postUserTagRequest?: PostUserTagRequest, options?: any): AxiosPromise; /** * 指定したユーザーに指定したタグを追加します。 Webhookユーザーにタグを追加することは出来ません。 * @summary ユーザーにタグを追加 * @param {string} userId ユーザーUUID * @param {PostUserTagRequest} [postUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addUserTag(userId: string, postUserTagRequest?: PostUserTagRequest, options?: any): AxiosPromise; /** * 自分の指定したタグの状態を変更します。 * @summary 自分のタグを編集 * @param {string} tagId タグUUID * @param {PatchUserTagRequest} [patchUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editMyUserTag(tagId: string, patchUserTagRequest?: PatchUserTagRequest, options?: any): AxiosPromise; /** * 指定したユーザーの指定したタグの状態を変更します。 他人の状態は変更できません。 * @summary ユーザーのタグを編集 * @param {string} userId ユーザーUUID * @param {string} tagId タグUUID * @param {PatchUserTagRequest} [patchUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editUserTag(userId: string, tagId: string, patchUserTagRequest?: PatchUserTagRequest, options?: any): AxiosPromise; /** * 自分に付けられているタグの配列を取得します。 * @summary 自分のタグリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyUserTags(options?: any): AxiosPromise>; /** * 指定したタグの情報を取得します。 * @summary タグ情報を取得 * @param {string} tagId タグUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTag(tagId: string, options?: any): AxiosPromise; /** * 指定したユーザーのタグリストを取得します。 * @summary ユーザーのタグリストを取得 * @param {string} userId ユーザーUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserTags(userId: string, options?: any): AxiosPromise>; /** * 既に存在しないタグを削除しようとした場合は204を返します。 * @summary 自分からタグを削除します * @param {string} tagId タグUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeMyUserTag(tagId: string, options?: any): AxiosPromise; /** * 既に存在しないタグを削除しようとした場合は204を返します。 * @summary ユーザーからタグを削除します * @param {string} userId ユーザーUUID * @param {string} tagId タグUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeUserTag(userId: string, tagId: string, options?: any): AxiosPromise; }; /** * UserTagApi - object-oriented interface * @export * @class UserTagApi * @extends {BaseAPI} */ declare class UserTagApi extends BaseAPI { /** * 自分に新しくタグを追加します。 * @summary 自分にタグを追加 * @param {PostUserTagRequest} [postUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserTagApi */ addMyUserTag(postUserTagRequest?: PostUserTagRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーに指定したタグを追加します。 Webhookユーザーにタグを追加することは出来ません。 * @summary ユーザーにタグを追加 * @param {string} userId ユーザーUUID * @param {PostUserTagRequest} [postUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserTagApi */ addUserTag(userId: string, postUserTagRequest?: PostUserTagRequest, options?: AxiosRequestConfig): Promise>; /** * 自分の指定したタグの状態を変更します。 * @summary 自分のタグを編集 * @param {string} tagId タグUUID * @param {PatchUserTagRequest} [patchUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserTagApi */ editMyUserTag(tagId: string, patchUserTagRequest?: PatchUserTagRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーの指定したタグの状態を変更します。 他人の状態は変更できません。 * @summary ユーザーのタグを編集 * @param {string} userId ユーザーUUID * @param {string} tagId タグUUID * @param {PatchUserTagRequest} [patchUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserTagApi */ editUserTag(userId: string, tagId: string, patchUserTagRequest?: PatchUserTagRequest, options?: AxiosRequestConfig): Promise>; /** * 自分に付けられているタグの配列を取得します。 * @summary 自分のタグリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserTagApi */ getMyUserTags(options?: AxiosRequestConfig): Promise>; /** * 指定したタグの情報を取得します。 * @summary タグ情報を取得 * @param {string} tagId タグUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserTagApi */ getTag(tagId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーのタグリストを取得します。 * @summary ユーザーのタグリストを取得 * @param {string} userId ユーザーUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserTagApi */ getUserTags(userId: string, options?: AxiosRequestConfig): Promise>; /** * 既に存在しないタグを削除しようとした場合は204を返します。 * @summary 自分からタグを削除します * @param {string} tagId タグUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserTagApi */ removeMyUserTag(tagId: string, options?: AxiosRequestConfig): Promise>; /** * 既に存在しないタグを削除しようとした場合は204を返します。 * @summary ユーザーからタグを削除します * @param {string} userId ユーザーUUID * @param {string} tagId タグUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserTagApi */ removeUserTag(userId: string, tagId: string, options?: AxiosRequestConfig): Promise>; } /** * WebhookApi - axios parameter creator * @export */ declare const WebhookApiAxiosParamCreator: (configuration?: Configuration) => { /** * 指定したWebhookのアイコン画像を変更します。 * @summary Webhookのアイコンを変更 * @param {string} webhookId WebhookUUID * @param {File} file アイコン画像(2MB,`Config.Imaging.MaxPixels`(default: 2560*1600)までのpng, jpeg, gif) * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeWebhookIcon: (webhookId: string, file: File, options?: AxiosRequestConfig) => Promise; /** * Webhookを新規作成します。 `secret`が空文字の場合、insecureウェブフックが作成されます。 * @summary Webhookを新規作成 * @param {PostWebhookRequest} [postWebhookRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWebhook: (postWebhookRequest?: PostWebhookRequest, options?: AxiosRequestConfig) => Promise; /** * 指定したWebhookを削除します。 Webhookによって投稿されたメッセージは削除されません。 * @summary Webhookを削除 * @param {string} webhookId WebhookUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWebhook: (webhookId: string, options?: AxiosRequestConfig) => Promise; /** * 指定されたWebhookが投稿したメッセージを削除します。 * @summary Webhookの投稿メッセージを削除 * @param {string} webhookId WebhookUUID * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWebhookMessage: (webhookId: string, messageId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したWebhookの情報を変更します。 * @summary Webhook情報を変更 * @param {string} webhookId WebhookUUID * @param {PatchWebhookRequest} [patchWebhookRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editWebhook: (webhookId: string, patchWebhookRequest?: PatchWebhookRequest, options?: AxiosRequestConfig) => Promise; /** * 指定したWebhookの詳細を取得します。 * @summary Webhook情報を取得 * @param {string} webhookId WebhookUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhook: (webhookId: string, options?: AxiosRequestConfig) => Promise; /** * 指定したWebhookのアイコン画像を取得します * @summary Webhookのアイコンを取得 * @param {string} webhookId WebhookUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhookIcon: (webhookId: string, options?: AxiosRequestConfig) => Promise; /** * 指定されたWebhookが投稿したメッセージのリストを返します。 * @summary Webhookの投稿メッセージのリストを取得 * @param {string} webhookId WebhookUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {string} [since] 取得する時間範囲の開始日時 * @param {string} [until] 取得する時間範囲の終了日時 * @param {boolean} [inclusive] 範囲の端を含めるかどうか * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhookMessages: (webhookId: string, limit?: number, offset?: number, since?: string, until?: string, inclusive?: boolean, order?: "asc" | "desc", options?: AxiosRequestConfig) => Promise; /** * Webhookのリストを取得します。 allがtrueで無い場合は、自分がオーナーのWebhookのリストを返します。 * @summary Webhook情報のリストを取得します * @param {boolean} [all] 全てのWebhookを取得します。権限が必要です。 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhooks: (all?: boolean, options?: AxiosRequestConfig) => Promise; /** * Webhookにメッセージを投稿します。 secureなウェブフックに対しては`X-TRAQ-Signature`ヘッダーが必須です。 アーカイブされているチャンネルには投稿できません。 * @summary Webhookを送信 * @param {string} webhookId WebhookUUID * @param {string} [xTRAQSignature] リクエストボディシグネチャ(Secretが設定されている場合は必須) * @param {string} [xTRAQChannelId] 投稿先のチャンネルID(変更する場合) * @param {number} [embed] メンション・チャンネルリンクを自動埋め込みする場合に1を指定する * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ postWebhook: (webhookId: string, xTRAQSignature?: string, xTRAQChannelId?: string, embed?: number, body?: string, options?: AxiosRequestConfig) => Promise; }; /** * WebhookApi - functional programming interface * @export */ declare const WebhookApiFp: (configuration?: Configuration) => { /** * 指定したWebhookのアイコン画像を変更します。 * @summary Webhookのアイコンを変更 * @param {string} webhookId WebhookUUID * @param {File} file アイコン画像(2MB,`Config.Imaging.MaxPixels`(default: 2560*1600)までのpng, jpeg, gif) * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeWebhookIcon(webhookId: string, file: File, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Webhookを新規作成します。 `secret`が空文字の場合、insecureウェブフックが作成されます。 * @summary Webhookを新規作成 * @param {PostWebhookRequest} [postWebhookRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWebhook(postWebhookRequest?: PostWebhookRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したWebhookを削除します。 Webhookによって投稿されたメッセージは削除されません。 * @summary Webhookを削除 * @param {string} webhookId WebhookUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWebhook(webhookId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定されたWebhookが投稿したメッセージを削除します。 * @summary Webhookの投稿メッセージを削除 * @param {string} webhookId WebhookUUID * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWebhookMessage(webhookId: string, messageId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したWebhookの情報を変更します。 * @summary Webhook情報を変更 * @param {string} webhookId WebhookUUID * @param {PatchWebhookRequest} [patchWebhookRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editWebhook(webhookId: string, patchWebhookRequest?: PatchWebhookRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したWebhookの詳細を取得します。 * @summary Webhook情報を取得 * @param {string} webhookId WebhookUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhook(webhookId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定したWebhookのアイコン画像を取得します * @summary Webhookのアイコンを取得 * @param {string} webhookId WebhookUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhookIcon(webhookId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 指定されたWebhookが投稿したメッセージのリストを返します。 * @summary Webhookの投稿メッセージのリストを取得 * @param {string} webhookId WebhookUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {string} [since] 取得する時間範囲の開始日時 * @param {string} [until] 取得する時間範囲の終了日時 * @param {boolean} [inclusive] 範囲の端を含めるかどうか * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhookMessages(webhookId: string, limit?: number, offset?: number, since?: string, until?: string, inclusive?: boolean, order?: "asc" | "desc", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Webhookのリストを取得します。 allがtrueで無い場合は、自分がオーナーのWebhookのリストを返します。 * @summary Webhook情報のリストを取得します * @param {boolean} [all] 全てのWebhookを取得します。権限が必要です。 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhooks(all?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Webhookにメッセージを投稿します。 secureなウェブフックに対しては`X-TRAQ-Signature`ヘッダーが必須です。 アーカイブされているチャンネルには投稿できません。 * @summary Webhookを送信 * @param {string} webhookId WebhookUUID * @param {string} [xTRAQSignature] リクエストボディシグネチャ(Secretが設定されている場合は必須) * @param {string} [xTRAQChannelId] 投稿先のチャンネルID(変更する場合) * @param {number} [embed] メンション・チャンネルリンクを自動埋め込みする場合に1を指定する * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ postWebhook(webhookId: string, xTRAQSignature?: string, xTRAQChannelId?: string, embed?: number, body?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * WebhookApi - factory interface * @export */ declare const WebhookApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * 指定したWebhookのアイコン画像を変更します。 * @summary Webhookのアイコンを変更 * @param {string} webhookId WebhookUUID * @param {File} file アイコン画像(2MB,`Config.Imaging.MaxPixels`(default: 2560*1600)までのpng, jpeg, gif) * @param {*} [options] Override http request option. * @throws {RequiredError} */ changeWebhookIcon(webhookId: string, file: File, options?: any): AxiosPromise; /** * Webhookを新規作成します。 `secret`が空文字の場合、insecureウェブフックが作成されます。 * @summary Webhookを新規作成 * @param {PostWebhookRequest} [postWebhookRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWebhook(postWebhookRequest?: PostWebhookRequest, options?: any): AxiosPromise; /** * 指定したWebhookを削除します。 Webhookによって投稿されたメッセージは削除されません。 * @summary Webhookを削除 * @param {string} webhookId WebhookUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWebhook(webhookId: string, options?: any): AxiosPromise; /** * 指定されたWebhookが投稿したメッセージを削除します。 * @summary Webhookの投稿メッセージを削除 * @param {string} webhookId WebhookUUID * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWebhookMessage(webhookId: string, messageId: string, options?: any): AxiosPromise; /** * 指定したWebhookの情報を変更します。 * @summary Webhook情報を変更 * @param {string} webhookId WebhookUUID * @param {PatchWebhookRequest} [patchWebhookRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ editWebhook(webhookId: string, patchWebhookRequest?: PatchWebhookRequest, options?: any): AxiosPromise; /** * 指定したWebhookの詳細を取得します。 * @summary Webhook情報を取得 * @param {string} webhookId WebhookUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhook(webhookId: string, options?: any): AxiosPromise; /** * 指定したWebhookのアイコン画像を取得します * @summary Webhookのアイコンを取得 * @param {string} webhookId WebhookUUID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhookIcon(webhookId: string, options?: any): AxiosPromise; /** * 指定されたWebhookが投稿したメッセージのリストを返します。 * @summary Webhookの投稿メッセージのリストを取得 * @param {string} webhookId WebhookUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {string} [since] 取得する時間範囲の開始日時 * @param {string} [until] 取得する時間範囲の終了日時 * @param {boolean} [inclusive] 範囲の端を含めるかどうか * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhookMessages(webhookId: string, limit?: number, offset?: number, since?: string, until?: string, inclusive?: boolean, order?: "asc" | "desc", options?: any): AxiosPromise>; /** * Webhookのリストを取得します。 allがtrueで無い場合は、自分がオーナーのWebhookのリストを返します。 * @summary Webhook情報のリストを取得します * @param {boolean} [all] 全てのWebhookを取得します。権限が必要です。 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhooks(all?: boolean, options?: any): AxiosPromise>; /** * Webhookにメッセージを投稿します。 secureなウェブフックに対しては`X-TRAQ-Signature`ヘッダーが必須です。 アーカイブされているチャンネルには投稿できません。 * @summary Webhookを送信 * @param {string} webhookId WebhookUUID * @param {string} [xTRAQSignature] リクエストボディシグネチャ(Secretが設定されている場合は必須) * @param {string} [xTRAQChannelId] 投稿先のチャンネルID(変更する場合) * @param {number} [embed] メンション・チャンネルリンクを自動埋め込みする場合に1を指定する * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ postWebhook(webhookId: string, xTRAQSignature?: string, xTRAQChannelId?: string, embed?: number, body?: string, options?: any): AxiosPromise; }; /** * WebhookApi - object-oriented interface * @export * @class WebhookApi * @extends {BaseAPI} */ declare class WebhookApi extends BaseAPI { /** * 指定したWebhookのアイコン画像を変更します。 * @summary Webhookのアイコンを変更 * @param {string} webhookId WebhookUUID * @param {File} file アイコン画像(2MB,`Config.Imaging.MaxPixels`(default: 2560*1600)までのpng, jpeg, gif) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhookApi */ changeWebhookIcon(webhookId: string, file: File, options?: AxiosRequestConfig): Promise>; /** * Webhookを新規作成します。 `secret`が空文字の場合、insecureウェブフックが作成されます。 * @summary Webhookを新規作成 * @param {PostWebhookRequest} [postWebhookRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhookApi */ createWebhook(postWebhookRequest?: PostWebhookRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したWebhookを削除します。 Webhookによって投稿されたメッセージは削除されません。 * @summary Webhookを削除 * @param {string} webhookId WebhookUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhookApi */ deleteWebhook(webhookId: string, options?: AxiosRequestConfig): Promise>; /** * 指定されたWebhookが投稿したメッセージを削除します。 * @summary Webhookの投稿メッセージを削除 * @param {string} webhookId WebhookUUID * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhookApi */ deleteWebhookMessage(webhookId: string, messageId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したWebhookの情報を変更します。 * @summary Webhook情報を変更 * @param {string} webhookId WebhookUUID * @param {PatchWebhookRequest} [patchWebhookRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhookApi */ editWebhook(webhookId: string, patchWebhookRequest?: PatchWebhookRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したWebhookの詳細を取得します。 * @summary Webhook情報を取得 * @param {string} webhookId WebhookUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhookApi */ getWebhook(webhookId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したWebhookのアイコン画像を取得します * @summary Webhookのアイコンを取得 * @param {string} webhookId WebhookUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhookApi */ getWebhookIcon(webhookId: string, options?: AxiosRequestConfig): Promise>; /** * 指定されたWebhookが投稿したメッセージのリストを返します。 * @summary Webhookの投稿メッセージのリストを取得 * @param {string} webhookId WebhookUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {string} [since] 取得する時間範囲の開始日時 * @param {string} [until] 取得する時間範囲の終了日時 * @param {boolean} [inclusive] 範囲の端を含めるかどうか * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhookApi */ getWebhookMessages(webhookId: string, limit?: number, offset?: number, since?: string, until?: string, inclusive?: boolean, order?: 'asc' | 'desc', options?: AxiosRequestConfig): Promise>; /** * Webhookのリストを取得します。 allがtrueで無い場合は、自分がオーナーのWebhookのリストを返します。 * @summary Webhook情報のリストを取得します * @param {boolean} [all] 全てのWebhookを取得します。権限が必要です。 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhookApi */ getWebhooks(all?: boolean, options?: AxiosRequestConfig): Promise>; /** * Webhookにメッセージを投稿します。 secureなウェブフックに対しては`X-TRAQ-Signature`ヘッダーが必須です。 アーカイブされているチャンネルには投稿できません。 * @summary Webhookを送信 * @param {string} webhookId WebhookUUID * @param {string} [xTRAQSignature] リクエストボディシグネチャ(Secretが設定されている場合は必須) * @param {string} [xTRAQChannelId] 投稿先のチャンネルID(変更する場合) * @param {number} [embed] メンション・チャンネルリンクを自動埋め込みする場合に1を指定する * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhookApi */ postWebhook(webhookId: string, xTRAQSignature?: string, xTRAQChannelId?: string, embed?: number, body?: string, options?: AxiosRequestConfig): Promise>; } /** * WebrtcApi - axios parameter creator * @export */ declare const WebrtcApiAxiosParamCreator: (configuration?: Configuration) => { /** * 現在のWebRTC状態を取得します。 * @summary WebRTC状態を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebRTCState: (options?: AxiosRequestConfig) => Promise; /** * Skyway WebRTC用の認証API * @summary Skyway用認証API * @param {PostWebRTCAuthenticateRequest} [postWebRTCAuthenticateRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ postWebRTCAuthenticate: (postWebRTCAuthenticateRequest?: PostWebRTCAuthenticateRequest, options?: AxiosRequestConfig) => Promise; }; /** * WebrtcApi - functional programming interface * @export */ declare const WebrtcApiFp: (configuration?: Configuration) => { /** * 現在のWebRTC状態を取得します。 * @summary WebRTC状態を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebRTCState(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Skyway WebRTC用の認証API * @summary Skyway用認証API * @param {PostWebRTCAuthenticateRequest} [postWebRTCAuthenticateRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ postWebRTCAuthenticate(postWebRTCAuthenticateRequest?: PostWebRTCAuthenticateRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * WebrtcApi - factory interface * @export */ declare const WebrtcApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * 現在のWebRTC状態を取得します。 * @summary WebRTC状態を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebRTCState(options?: any): AxiosPromise; /** * Skyway WebRTC用の認証API * @summary Skyway用認証API * @param {PostWebRTCAuthenticateRequest} [postWebRTCAuthenticateRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ postWebRTCAuthenticate(postWebRTCAuthenticateRequest?: PostWebRTCAuthenticateRequest, options?: any): AxiosPromise; }; /** * WebrtcApi - object-oriented interface * @export * @class WebrtcApi * @extends {BaseAPI} */ declare class WebrtcApi extends BaseAPI { /** * 現在のWebRTC状態を取得します。 * @summary WebRTC状態を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebrtcApi */ getWebRTCState(options?: AxiosRequestConfig): Promise>; /** * Skyway WebRTC用の認証API * @summary Skyway用認証API * @param {PostWebRTCAuthenticateRequest} [postWebRTCAuthenticateRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebrtcApi */ postWebRTCAuthenticate(postWebRTCAuthenticateRequest?: PostWebRTCAuthenticateRequest, options?: AxiosRequestConfig): Promise>; } declare class Apis extends BaseAPI { /** * パブリックチャンネルの直近の投稿メッセージを作成日時の降順で取得します。 `all`が`true`でない場合、購読チャンネルのみのタイムラインを取得します * @summary アクテビティタイムラインを取得 * @param {number} [limit] 取得する件数 * @param {boolean} [all] 全てのチャンネルのタイムラインを取得する * @param {boolean} [perChannel] 同じチャンネルのメッセージは最新のもののみ取得するか * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ActivityApi */ getActivityTimeline(limit?: number, all?: boolean, perChannel?: boolean, options?: AxiosRequestConfig): Promise>; /** * 現在オンラインな(SSEまたはWSが接続中)ユーザーのUUIDのリストを返します。 * @summary オンラインユーザーリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ActivityApi */ getOnlineUsers(options?: AxiosRequestConfig): Promise>; /** * 自分に紐付けられている外部ログインアカウント一覧を取得します。 * @summary 外部ログインアカウント一覧を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ getMyExternalAccounts(options?: AxiosRequestConfig): Promise>; /** * 自分のログインセッションのリストを取得します。 * @summary 自分のログインセッションリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ getMySessions(options?: AxiosRequestConfig): Promise>; /** * 自分に外部ログインアカウントを紐付けます。 指定した`providerName`がサーバー側で有効である必要があります。 リクエストが受理された場合、外部サービスの認証画面にリダイレクトされ、認証される必要があります。 * @summary 外部ログインアカウントを紐付ける * @param {PostLinkExternalAccount} [postLinkExternalAccount] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ linkExternalAccount(postLinkExternalAccount?: PostLinkExternalAccount, options?: AxiosRequestConfig): Promise>; /** * ログインします。 * @summary ログイン * @param {string} [redirect] リダイレクト先 * @param {PostLoginRequest} [postLoginRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthenticationApi */ login(redirect?: string, postLoginRequest?: PostLoginRequest, options?: AxiosRequestConfig): Promise>; /** * ログアウトします。 * @summary ログアウト * @param {string} [redirect] リダイレクト先 * @param {boolean} [all] 全てのセッションでログアウトするかどうか * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthenticationApi */ logout(redirect?: string, all?: boolean, options?: AxiosRequestConfig): Promise>; /** * 指定した自分のセッションを無効化(ログアウト)します。 既に存在しない・無効化されているセッションを指定した場合も`204`を返します。 * @summary セッションを無効化 * @param {string} sessionId セッションUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ revokeMySession(sessionId: string, options?: AxiosRequestConfig): Promise>; /** * 自分に紐付けられている外部ログインアカウントの紐付けを解除します。 * @summary 外部ログインアカウントの紐付けを解除 * @param {PostUnlinkExternalAccount} [postUnlinkExternalAccount] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ unlinkExternalAccount(postUnlinkExternalAccount?: PostUnlinkExternalAccount, options?: AxiosRequestConfig): Promise>; /** * 指定したBOTを有効化します。 対象のBOTの管理権限が必要です。 * @summary BOTをアクティベート * @param {string} botId BOTUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BotApi */ activateBot(botId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したBOTのアイコン画像を変更を変更します。 対象のBOTの管理権限が必要です。 * @summary BOTのアイコン画像を変更 * @param {string} botId BOTUUID * @param {File} file アイコン画像(2MB,`Config.Imaging.MaxPixels`(default: 2560*1600)までのpng, jpeg, gif) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BotApi */ changeBotIcon(botId: string, file: File, options?: AxiosRequestConfig): Promise>; /** * # BOT WebSocketプロトコル ## 送信 `コマンド:引数1:引数2:...` のような形式のTextMessageをサーバーに送信することで、このWebSocketセッションに対する設定が実行できます。 ### `rtcstate`コマンド 自分のWebRTC状態を変更します。 他のコネクションが既に状態を保持している場合、変更することができません。 `rtcstate:{チャンネルID}:({状態}:{セッションID})*` チャンネルIDにnullもしくは空文字を指定するか、状態にnullもしくは空文字を指定した場合、WebRTC状態はリセットされます。 `rtcstate:null`, `rtcstate:`, `rtcstate:channelId:null`, `rtcstate:channelId:` コネクションが切断された場合、自分のWebRTC状態はリセットされます。 ## 受信 TextMessageとして各種イベントが`type`、`reqId`、`body`を持つJSONとして非同期に送られます。 `body`の内容はHTTP Modeの場合のRequest Bodyと同様です。 例外として`ERROR`イベントは`reqId`を持ちません。 例: PINGイベント `{\"type\":\"PING\",\"reqId\":\"requestId\",\"body\":{\"eventTime\":\"2019-05-07T04:50:48.582586882Z\"}}` ### `ERROR` コマンドの引数が不正などの理由でコマンドが受理されなかった場合に送られます。 非同期に送られるため、必ずしもコマンドとの対応関係を確定できないことに注意してください。 本番環境ではERRORが送られないようにすることが望ましいです。 `{\"type\":\"ERROR\",\"body\":\"message\"}` * @summary WebSocket Mode BOT用通知ストリームに接続します * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BotApi */ connectBotWS(options?: AxiosRequestConfig): Promise>; /** * BOTを作成します。 作成後に購読イベントの設定を行う必要があります。 さらにHTTP Modeの場合はアクティベーションを行う必要があります。 * @summary BOTを作成 * @param {PostBotRequest} [postBotRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BotApi */ createBot(postBotRequest?: PostBotRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したBOTを削除します。 対象のBOTの管理権限が必要です。 * @summary BOTを削除 * @param {string} botId BOTUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BotApi */ deleteBot(botId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したBOTの情報を変更します。 対象のBOTの管理権限が必要です。 BOT開発者UUIDを変更した場合は、変更先ユーザーにBOT管理権限が移譲され、自分自身は権限を失います。 * @summary BOT情報を変更 * @param {string} botId BOTUUID * @param {PatchBotRequest} [patchBotRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BotApi */ editBot(botId: string, patchBotRequest?: PatchBotRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したBOTのBOT情報を取得します。 BOT詳細情報を取得する場合は、対象のBOTの管理権限が必要です。 * @summary BOT情報を取得 * @param {string} botId BOTUUID * @param {boolean} [detail] 詳細情報を含めるかどうか * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BotApi */ getBot(botId: string, detail?: boolean, options?: AxiosRequestConfig): Promise>; /** * 指定したBOTのアイコン画像を取得を取得します。 * @summary BOTのアイコン画像を取得 * @param {string} botId BOTUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BotApi */ getBotIcon(botId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したBOTのイベントログを取得します。 対象のBOTの管理権限が必要です。 * @summary BOTのイベントログを取得 * @param {string} botId BOTUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BotApi */ getBotLogs(botId: string, limit?: number, offset?: number, options?: AxiosRequestConfig): Promise>; /** * BOT情報のリストを取得します。 allを指定しない場合、自分が開発者のBOTのみを返します。 * @summary BOTリストを取得 * @param {boolean} [all] 全てのBOTを取得するかどうか * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BotApi */ getBots(all?: boolean, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルに参加しているBOTのリストを取得します。 * @summary チャンネル参加中のBOTのリストを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ getChannelBots(channelId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したBOTを無効化します。対象のBOTの管理権限が必要です。 * @summary BOTをインアクティベート * @param {string} botId BOTUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BotApi */ inactivateBot(botId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したBOTを指定したチャンネルに参加させます。 チャンネルに参加したBOTは、そのチャンネルの各種イベントを受け取るようになります。 対象のBOTの管理権限が必要です。 * @summary BOTをチャンネルに参加させる * @param {string} botId BOTUUID * @param {PostBotActionJoinRequest} [postBotActionJoinRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BotApi */ letBotJoinChannel(botId: string, postBotActionJoinRequest?: PostBotActionJoinRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したBOTを指定したチャンネルから退出させます。 対象のBOTの管理権限が必要です。 * @summary BOTをチャンネルから退出させる * @param {string} botId BOTUUID * @param {PostBotActionLeaveRequest} [postBotActionLeaveRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BotApi */ letBotLeaveChannel(botId: string, postBotActionLeaveRequest?: PostBotActionLeaveRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したBOTの現在の各種トークンを無効化し、再発行を行います。 対象のBOTの管理権限が必要です。 * @summary BOTのトークンを再発行 * @param {string} botId BOTUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BotApi */ reissueBot(botId: string, options?: AxiosRequestConfig): Promise>; /** * チャンネルを作成します。 階層が6以上になるチャンネルは作成できません。 * @summary チャンネルを作成 * @param {PostChannelRequest} [postChannelRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ createChannel(postChannelRequest?: PostChannelRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルの情報を変更します。 変更には権限が必要です。 ルートチャンネルに移動させる場合は、`parent`に`00000000-0000-0000-0000-000000000000`を指定してください。 * @summary チャンネル情報を変更 * @param {string} channelId チャンネルUUID * @param {PatchChannelRequest} [patchChannelRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ editChannel(channelId: string, patchChannelRequest?: PatchChannelRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルの通知購読者を編集します。 リクエストに含めなかったユーザーの通知購読状態は変更しません。 また、存在しないユーザーを指定した場合は無視されます。 * @summary チャンネルの通知購読者を編集 * @param {string} channelId チャンネルUUID * @param {PatchChannelSubscribersRequest} [patchChannelSubscribersRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationApi */ editChannelSubscribers(channelId: string, patchChannelSubscribersRequest?: PatchChannelSubscribersRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルのトピックを編集します。 アーカイブされているチャンネルのトピックは編集できません。 * @summary チャンネルトピックを編集 * @param {string} channelId チャンネルUUID * @param {PutChannelTopicRequest} [putChannelTopicRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ editChannelTopic(channelId: string, putChannelTopicRequest?: PutChannelTopicRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルの情報を取得します。 * @summary チャンネル情報を取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ getChannel(channelId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルのイベントリストを取得します。 * @summary チャンネルイベントのリストを取得 * @param {string} channelId チャンネルUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {string} [since] 取得する時間範囲の開始日時 * @param {string} [until] 取得する時間範囲の終了日時 * @param {boolean} [inclusive] 範囲の端を含めるかどうか * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ getChannelEvents(channelId: string, limit?: number, offset?: number, since?: string, until?: string, inclusive?: boolean, order?: 'asc' | 'desc', options?: AxiosRequestConfig): Promise>; /** * 指定されたチャンネルのパスを取得します。 * @summary 指定したチャンネルパスを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ getChannelPath(channelId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルにピン留めされているピンメッセージのリストを取得します。 * @summary チャンネルピンのリストを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PinApi */ getChannelPins(channelId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルの統計情報を取得します。 * @summary チャンネル統計情報を取得 * @param {string} channelId チャンネルUUID * @param {boolean} [excludeDeletedMessages] 削除されたメッセージを除外するかどうか(デフォルト false) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ getChannelStats(channelId: string, excludeDeletedMessages?: boolean, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルを通知購読しているユーザーのUUIDのリストを取得します。 * @summary チャンネルの通知購読者のリストを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationApi */ getChannelSubscribers(channelId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルのトピックを取得します。 * @summary チャンネルトピックを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ getChannelTopic(channelId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルの閲覧者のリストを取得します。 * @summary チャンネル閲覧者リストを取得 * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ getChannelViewers(channelId: string, options?: AxiosRequestConfig): Promise>; /** * チャンネルのリストを取得します。 * @summary チャンネルリストを取得 * @param {boolean} [includeDm] ダイレクトメッセージチャンネルをレスポンスに含めるかどうか * @param {string} [path] パスが一致するチャンネルのみを取得する * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ getChannels(includeDm?: boolean, path?: string, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルのメッセージのリストを取得します。 * @summary チャンネルメッセージのリストを取得 * @param {string} channelId チャンネルUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {string} [since] 取得する時間範囲の開始日時 * @param {string} [until] 取得する時間範囲の終了日時 * @param {boolean} [inclusive] 範囲の端を含めるかどうか * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessageApi */ getMessages(channelId: string, limit?: number, offset?: number, since?: string, until?: string, inclusive?: boolean, order?: 'asc' | 'desc', options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーとのダイレクトメッセージチャンネルの情報を返します。 ダイレクトメッセージチャンネルが存在しなかった場合、自動的に作成されます。 * @summary DMチャンネル情報を取得 * @param {string} userId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ getUserDMChannel(userId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルにメッセージを投稿します。 embedをtrueに指定すると、メッセージ埋め込みが自動で行われます。 アーカイブされているチャンネルに投稿することはできません。 * @summary チャンネルにメッセージを投稿 * @param {string} channelId チャンネルUUID * @param {PostMessageRequest} [postMessageRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessageApi */ postMessage(channelId: string, postMessageRequest?: PostMessageRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルの通知購読者を設定します。 リクエストに含めなかったユーザーの通知購読状態はオフになります。 また、存在しないユーザーを指定した場合は無視されます。 * @summary チャンネルの通知購読者を設定 * @param {string} channelId チャンネルUUID * @param {PutChannelSubscribersRequest} [putChannelSubscribersRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationApi */ setChannelSubscribers(channelId: string, putChannelSubscribersRequest?: PutChannelSubscribersRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したメッセージを指定したクリップフォルダに追加します。 * @summary メッセージをクリップフォルダに追加 * @param {string} folderId クリップフォルダUUID * @param {PostClipFolderMessageRequest} [postClipFolderMessageRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ClipApi */ clipMessage(folderId: string, postClipFolderMessageRequest?: PostClipFolderMessageRequest, options?: AxiosRequestConfig): Promise>; /** * クリップフォルダを作成します。 既にあるフォルダと同名のフォルダを作成することは可能です。 * @summary クリップフォルダを作成 * @param {PostClipFolderRequest} [postClipFolderRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ClipApi */ createClipFolder(postClipFolderRequest?: PostClipFolderRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したクリップフォルダを削除します。 * @summary クリップフォルダを削除 * @param {string} folderId クリップフォルダUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ClipApi */ deleteClipFolder(folderId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したクリップフォルダの情報を編集します。 * @summary クリップフォルダ情報を編集 * @param {string} folderId クリップフォルダUUID * @param {PatchClipFolderRequest} [patchClipFolderRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ClipApi */ editClipFolder(folderId: string, patchClipFolderRequest?: PatchClipFolderRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したクリップフォルダの情報を取得します。 * @summary クリップフォルダ情報を取得 * @param {string} folderId クリップフォルダUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ClipApi */ getClipFolder(folderId: string, options?: AxiosRequestConfig): Promise>; /** * 自身が所有するクリップフォルダのリストを取得します。 * @summary クリップフォルダのリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ClipApi */ getClipFolders(options?: AxiosRequestConfig): Promise>; /** * 指定したフォルダ内のクリップのリストを取得します。 `order`を指定しない場合、クリップした日時の新しい順で返されます。 * @summary フォルダ内のクリップのリストを取得 * @param {string} folderId クリップフォルダUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ClipApi */ getClips(folderId: string, limit?: number, offset?: number, order?: 'asc' | 'desc', options?: AxiosRequestConfig): Promise>; /** * 対象のメッセージの自分のクリップの一覧を返します。 * @summary 自分のクリップを取得 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessageApi */ getMessageClips(messageId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したフォルダから指定したメッセージのクリップを除外します。 既に外されているメッセージを指定した場合は204を返します。 * @summary メッセージをクリップフォルダから除外 * @param {string} folderId クリップフォルダUUID * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ClipApi */ unclipMessage(folderId: string, messageId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したファイルを削除します。 指定したファイルの削除権限が必要です。 * @summary ファイルを削除 * @param {string} fileId ファイルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FileApi */ deleteFile(fileId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したファイル本体を取得します。 指定したファイルへのアクセス権限が必要です。 * @summary ファイルをダウンロード * @param {string} fileId ファイルUUID * @param {number} [dl] このクエリパラメータは廃止されており、意味を持ちません（現在、このパラメータが0の場合も1の場合もレスポンスにはContent-Dispositionヘッダーが付与されます） * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FileApi */ getFile(fileId: string, dl?: number, options?: AxiosRequestConfig): Promise>; /** * 指定したファイルのメタ情報を取得します。 指定したファイルへのアクセス権限が必要です。 * @summary ファイルメタを取得 * @param {string} fileId ファイルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FileApi */ getFileMeta(fileId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したクエリでファイルメタのリストを取得します。 クエリパラメータ`channelId`, `mine`の少なくともいずれかが必須です。 * @summary ファイルメタのリストを取得 * @param {string} [channelId] アップロード先チャンネルUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {string} [since] 取得する時間範囲の開始日時 * @param {string} [until] 取得する時間範囲の終了日時 * @param {boolean} [inclusive] 範囲の端を含めるかどうか * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {boolean} [mine] アップロード者が自分のファイルのみを取得するか * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FileApi */ getFiles(channelId?: string, limit?: number, offset?: number, since?: string, until?: string, inclusive?: boolean, order?: 'asc' | 'desc', mine?: boolean, options?: AxiosRequestConfig): Promise>; /** * 指定したファイルのサムネイル画像を取得します。 指定したファイルへのアクセス権限が必要です。 * @summary サムネイル画像を取得 * @param {string} fileId ファイルUUID * @param {ThumbnailType} [type] 取得するサムネイルのタイプ * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FileApi */ getThumbnailImage(fileId: string, type?: ThumbnailType, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルにファイルをアップロードします。 アーカイブされているチャンネルにはアップロード出来ません。 * @summary ファイルをアップロード * @param {File} file ファイル本体 * @param {string} channelId アップロード先チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FileApi */ postFile(file: File, channelId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したグループに管理者を追加します。 対象のユーザーグループの管理者権限が必要です。 * @summary グループ管理者を追加 * @param {string} groupId ユーザーグループUUID * @param {PostUserGroupAdminRequest} [postUserGroupAdminRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupApi */ addUserGroupAdmin(groupId: string, postUserGroupAdminRequest?: PostUserGroupAdminRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したグループにメンバーを追加します。 対象のユーザーグループの管理者権限が必要です。 * @summary グループメンバーを追加 * @param {string} groupId ユーザーグループUUID * @param {AddUserGroupMemberRequest} [addUserGroupMemberRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupApi */ addUserGroupMember(groupId: string, addUserGroupMemberRequest?: AddUserGroupMemberRequest, options?: AxiosRequestConfig): Promise>; /** * ユーザーグループのアイコンを変更します。 対象のユーザーグループの管理者権限が必要です。 * @summary ユーザーグループのアイコンを変更 * @param {string} groupId ユーザーグループUUID * @param {File} file アイコン画像(2MB,`Config.Imaging.MaxPixels`(default: 2560*1600)までのpng, jpeg, gif) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupApi */ changeUserGroupIcon(groupId: string, file: File, options?: AxiosRequestConfig): Promise>; /** * ユーザーグループを作成します。 作成者は自動的にグループ管理者になります。 * @summary ユーザーグループを作成 * @param {PostUserGroupRequest} [postUserGroupRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupApi */ createUserGroup(postUserGroupRequest?: PostUserGroupRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーグループを削除します。 対象のユーザーグループの管理者権限が必要です。 * @summary ユーザーグループを削除 * @param {string} groupId ユーザーグループUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupApi */ deleteUserGroup(groupId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーグループの情報を編集します。 対象のユーザーグループの管理者権限が必要です。 * @summary ユーザーグループを編集 * @param {string} groupId ユーザーグループUUID * @param {PatchUserGroupRequest} [patchUserGroupRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupApi */ editUserGroup(groupId: string, patchUserGroupRequest?: PatchUserGroupRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーグループ内の指定したユーザーの属性を編集します。 対象のユーザーグループの管理者権限が必要です。 * @summary グループメンバーを編集 * @param {string} groupId ユーザーグループUUID * @param {string} userId ユーザーUUID * @param {PatchGroupMemberRequest} [patchGroupMemberRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupApi */ editUserGroupMember(groupId: string, userId: string, patchGroupMemberRequest?: PatchGroupMemberRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーグループの情報を取得します。 * @summary ユーザーグループを取得 * @param {string} groupId ユーザーグループUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupApi */ getUserGroup(groupId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したグループの管理者のリストを取得します。 * @summary グループ管理者を取得 * @param {string} groupId ユーザーグループUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupApi */ getUserGroupAdmins(groupId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したグループのメンバーのリストを取得します。 * @summary グループメンバーを取得 * @param {string} groupId ユーザーグループUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupApi */ getUserGroupMembers(groupId: string, options?: AxiosRequestConfig): Promise>; /** * ユーザーグループのリストを取得します。 * @summary ユーザーグループのリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupApi */ getUserGroups(options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーグループから指定した管理者を削除します。 対象のユーザーグループの管理者権限が必要です。 グループから管理者が存在しなくなる場合は400エラーを返します。 * @summary グループ管理者を削除 * @param {string} groupId ユーザーグループUUID * @param {string} userId ユーザーUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupApi */ removeUserGroupAdmin(groupId: string, userId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーグループから指定したユーザーを削除します。 既にグループから削除されているメンバーを指定した場合は204を返します。 対象のユーザーグループの管理者権限が必要です。 * @summary グループメンバーを削除 * @param {string} groupId ユーザーグループUUID * @param {string} userId ユーザーUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupApi */ removeUserGroupMember(groupId: string, userId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したグループから全てのメンバーを削除します。 対象のユーザーグループの管理者権限が必要です。 * @summary グループメンバーを一括削除 * @param {string} groupId ユーザーグループUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupApi */ removeUserGroupMembers(groupId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したチャンネルをスターチャンネルに追加します。 スター済みのチャンネルIDを指定した場合、204を返します。 不正なチャンネルIDを指定した場合、400を返します。 * @summary チャンネルをスターに追加 * @param {PostStarRequest} [postStarRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StarApi */ addMyStar(postStarRequest?: PostStarRequest, options?: AxiosRequestConfig): Promise>; /** * 自分に新しくタグを追加します。 * @summary 自分にタグを追加 * @param {PostUserTagRequest} [postUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserTagApi */ addMyUserTag(postUserTagRequest?: PostUserTagRequest, options?: AxiosRequestConfig): Promise>; /** * 自分のアイコン画像を変更します。 * @summary 自分のアイコン画像を変更 * @param {File} file アイコン画像(2MB,`Config.Imaging.MaxPixels`(default: 2560*1600)までのpng, jpeg, gif) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ changeMyIcon(file: File, options?: AxiosRequestConfig): Promise>; /** * メッセージ引用通知の設定情報を変更します * @summary メッセージ引用通知の設定情報を変更 * @param {PutNotifyCitationRequest} [putNotifyCitationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ changeMyNotifyCitation(putNotifyCitationRequest?: PutNotifyCitationRequest, options?: AxiosRequestConfig): Promise>; /** * 自身のパスワードを変更します。 * @summary 自分のパスワードを変更 * @param {PutMyPasswordRequest} [putMyPasswordRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ changeMyPassword(putMyPasswordRequest?: PutMyPasswordRequest, options?: AxiosRequestConfig): Promise>; /** * 自身のユーザー情報を変更します。 * @summary 自分のユーザー情報を変更 * @param {PatchMeRequest} [patchMeRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ editMe(patchMeRequest?: PatchMeRequest, options?: AxiosRequestConfig): Promise>; /** * 自分の指定したタグの状態を変更します。 * @summary 自分のタグを編集 * @param {string} tagId タグUUID * @param {PatchUserTagRequest} [patchUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserTagApi */ editMyUserTag(tagId: string, patchUserTagRequest?: PatchUserTagRequest, options?: AxiosRequestConfig): Promise>; /** * 自身のユーザー詳細情報を取得します。 * @summary 自分のユーザー詳細を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ getMe(options?: AxiosRequestConfig): Promise>; /** * 自身のチャンネル購読状態を取得します。 * @summary 自分のチャンネル購読状態を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationApi */ getMyChannelSubscriptions(options?: AxiosRequestConfig): Promise>; /** * 自分のアイコン画像を取得します。 * @summary 自分のアイコン画像を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ getMyIcon(options?: AxiosRequestConfig): Promise>; /** * メッセージ引用通知の設定情報を変更します。 * @summary メッセージ引用通知の設定情報を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ getMyNotifyCitation(options?: AxiosRequestConfig): Promise>; /** * 自身のQRコードを取得します。 返されたQRコードまたはトークンは、発行後の5分間のみ有効です * @summary QRコードを取得 * @param {boolean} [token] 画像でなくトークン文字列で返すかどうか * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ getMyQRCode(token?: boolean, options?: AxiosRequestConfig): Promise>; /** * 自分のスタンプ履歴を最大100件まで取得します。 結果は降順で返されます。 このAPIが返すスタンプ履歴は厳密な履歴ではありません。 * @summary スタンプ履歴を取得 * @param {number} [limit] 件数 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ getMyStampHistory(limit?: number, options?: AxiosRequestConfig): Promise>; /** * 自分のスタンプレコメンドを最大200件まで取得します。 結果は推薦度の高い順で返されます。 スタンプを使用したことがないユーザーの場合は空配列が返されます。 * @summary スタンプレコメンドを取得 * @param {number} [limit] 件数 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ getMyStampRecommendations(limit?: number, options?: AxiosRequestConfig): Promise>; /** * 自分がスターしているチャンネルのUUIDの配列を取得します。 * @summary スターチャンネルリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StarApi */ getMyStars(options?: AxiosRequestConfig): Promise>; /** * 有効な自分に発行されたOAuth2トークンのリストを取得します。 * @summary 有効トークンのリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof Oauth2Api */ getMyTokens(options?: AxiosRequestConfig): Promise>; /** * 自分が現在未読のチャンネルの未読情報を取得します。 * @summary 未読チャンネルを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationApi */ getMyUnreadChannels(options?: AxiosRequestConfig): Promise>; /** * 自分に付けられているタグの配列を取得します。 * @summary 自分のタグリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserTagApi */ getMyUserTags(options?: AxiosRequestConfig): Promise>; /** * 自身のチャンネル閲覧状態一覧を取得します。 * @summary 自身のチャンネル閲覧状態一覧を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationApi */ getMyViewStates(options?: AxiosRequestConfig): Promise>; /** * OIDCトークンを用いてユーザー詳細を取得します。 OIDC UserInfo Endpointです。 * @summary 自分のユーザー詳細を取得 (OIDC UserInfo) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ getOIDCUserInfo(options?: AxiosRequestConfig): Promise>; /** * ユーザー設定を取得します。 * @summary ユーザー設定を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MeApi */ getUserSettings(options?: AxiosRequestConfig): Promise>; /** * 自分が未読のチャンネルを既読にします。 * @summary チャンネルを既読にする * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationApi */ readChannel(channelId: string, options?: AxiosRequestConfig): Promise>; /** * 自身のFCMデバイスを登録します。 * @summary FCMデバイスを登録 * @param {PostMyFCMDeviceRequest} [postMyFCMDeviceRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationApi */ registerFCMDevice(postMyFCMDeviceRequest?: PostMyFCMDeviceRequest, options?: AxiosRequestConfig): Promise>; /** * 既にスターから削除されているチャンネルを指定した場合は204を返します。 * @summary チャンネルをスターから削除します * @param {string} channelId チャンネルUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StarApi */ removeMyStar(channelId: string, options?: AxiosRequestConfig): Promise>; /** * 既に存在しないタグを削除しようとした場合は204を返します。 * @summary 自分からタグを削除します * @param {string} tagId タグUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserTagApi */ removeMyUserTag(tagId: string, options?: AxiosRequestConfig): Promise>; /** * 自分の指定したトークンの認可を取り消します。 * @summary トークンの認可を取り消す * @param {string} tokenId OAuth2トークンUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof Oauth2Api */ revokeMyToken(tokenId: string, options?: AxiosRequestConfig): Promise>; /** * 自身の指定したチャンネルの購読レベルを設定します。 * @summary チャンネル購読レベルを設定 * @param {string} channelId チャンネルUUID * @param {PutChannelSubscribeLevelRequest} [putChannelSubscribeLevelRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationApi */ setChannelSubscribeLevel(channelId: string, putChannelSubscribeLevelRequest?: PutChannelSubscribeLevelRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したメッセージに指定したスタンプを押します。 * @summary スタンプを押す * @param {string} messageId メッセージUUID * @param {string} stampId スタンプUUID * @param {PostMessageStampRequest} [postMessageStampRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ addMessageStamp(messageId: string, stampId: string, postMessageStampRequest?: PostMessageStampRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したメッセージをピン留めします。 アーカイブされているチャンネルのメッセージ・存在しないメッセージ・チャンネル当たりの上限数を超えたメッセージのピン留めはできません。 * @summary ピン留めする * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PinApi */ createPin(messageId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したメッセージを削除します。 自身が投稿したメッセージと自身が管理権限を持つWebhookとBOTが投稿したメッセージのみ削除することができます。 アーカイブされているチャンネルのメッセージを編集することは出来ません。 * @summary メッセージを削除 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessageApi */ deleteMessage(messageId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したメッセージを編集します。 自身が投稿したメッセージのみ編集することができます。 アーカイブされているチャンネルのメッセージを編集することは出来ません。 * @summary メッセージを編集 * @param {string} messageId メッセージUUID * @param {PostMessageRequest} [postMessageRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessageApi */ editMessage(messageId: string, postMessageRequest?: PostMessageRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーとのダイレクトメッセージのリストを取得します。 * @summary ダイレクトメッセージのリストを取得 * @param {string} userId ユーザーUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {string} [since] 取得する時間範囲の開始日時 * @param {string} [until] 取得する時間範囲の終了日時 * @param {boolean} [inclusive] 範囲の端を含めるかどうか * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ getDirectMessages(userId: string, limit?: number, offset?: number, since?: string, until?: string, inclusive?: boolean, order?: 'asc' | 'desc', options?: AxiosRequestConfig): Promise>; /** * 指定したメッセージを取得します。 * @summary メッセージを取得 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessageApi */ getMessage(messageId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したメッセージに押されているスタンプのリストを取得します。 * @summary メッセージのスタンプリストを取得 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ getMessageStamps(messageId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したメッセージのピン留め情報を取得します。 * @summary ピン留めを取得 * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PinApi */ getPin(messageId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーにダイレクトメッセージを送信します。 * @summary ダイレクトメッセージを送信 * @param {string} userId ユーザーUUID * @param {PostMessageRequest} [postMessageRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ postDirectMessage(userId: string, postMessageRequest?: PostMessageRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したメッセージから指定した自身が押したスタンプを削除します。 * @summary スタンプを消す * @param {string} messageId メッセージUUID * @param {string} stampId スタンプUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ removeMessageStamp(messageId: string, stampId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したメッセージのピン留めを外します。 * @summary ピン留めを外す * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PinApi */ removePin(messageId: string, options?: AxiosRequestConfig): Promise>; /** * メッセージを検索します。 * @summary メッセージを検索 * @param {string} [word] 検索ワード Simple-Query-String-Syntaxをパースして検索します * @param {string} [after] 投稿日時が指定日時より後 * @param {string} [before] 投稿日時が指定日時より前 * @param {string} [_in] メッセージが投稿されたチャンネル * @param {Array} [to] メンションされたユーザー * @param {Array} [from] メッセージを投稿したユーザー * @param {string} [citation] 引用しているメッセージ * @param {boolean} [bot] メッセージを投稿したユーザーがBotかどうか * @param {boolean} [hasURL] メッセージがURLを含むか * @param {boolean} [hasAttachments] メッセージが添付ファイルを含むか * @param {boolean} [hasImage] メッセージが画像を含むか * @param {boolean} [hasVideo] メッセージが動画を含むか * @param {boolean} [hasAudio] メッセージが音声ファイルを含むか * @param {number} [limit] 検索結果から取得するメッセージの最大件数 * @param {number} [offset] 検索結果から取得するメッセージのオフセット * @param {'createdAt' | '-createdAt' | 'updatedAt' | '-updatedAt'} [sort] ソート順 (作成日時が新しい `createdAt`, 作成日時が古い `-createdAt`, 更新日時が新しい `updatedAt`, 更新日時が古い `-updatedAt`) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessageApi */ searchMessages(word?: string, after?: string, before?: string, _in?: string, to?: Array, from?: Array, citation?: string, bot?: boolean, hasURL?: boolean, hasAttachments?: boolean, hasImage?: boolean, hasVideo?: boolean, hasAudio?: boolean, limit?: number, offset?: number, sort?: 'createdAt' | '-createdAt' | 'updatedAt' | '-updatedAt', options?: AxiosRequestConfig): Promise>; /** * # WebSocketプロトコル ## 送信 `コマンド:引数1:引数2:...`のような形式のTextMessageをサーバーに送信することで、このWebSocketセッションに対する設定が実行できる。 ### `viewstate`コマンド このWebSocketセッションが見ているチャンネル(イベントを受け取るチャンネル)を設定する。 現時点では1つのセッションに対して1つのチャンネルしか設定できない。 `viewstate:{チャンネルID}:{閲覧状態}` + チャンネルID: 対象のチャンネルID + 閲覧状態: `none`, `monitoring`, `editing` 最初の`viewstate`コマンドを送る前、または`viewstate:null`, `viewstate:`を送信した後は、このセッションはどこのチャンネルも見ていないことになる。 ### `rtcstate`コマンド 自分のWebRTC状態を変更する。 他のコネクションが既に状態を保持している場合、変更することができません。 `rtcstate:{チャンネルID}:({状態}:{セッションID})*` コネクションが切断された場合、自分のWebRTC状態はリセットされます。 ### `timeline_streaming`コマンド 全てのパブリックチャンネルの`MESSAGE_CREATED`イベントを受け取るかどうかを設定する。 初期状態は`off`です。 `timeline_streaming:(on|off|true|false)` ## 受信 TextMessageとして各種イベントが`type`と`body`を持つJSONとして非同期に送られます。 例: ```json {\"type\":\"USER_ONLINE\",\"body\":{\"id\":\"7dd8e07f-7f5d-4331-9176-b56a4299768b\"}} ``` ## イベント一覧 ### `USER_JOINED` ユーザーが新規登録された。 対象: 全員 + `id`: 登録されたユーザーのId ### `USER_UPDATED` ユーザーの情報が更新された。 対象: 全員 + `id`: 情報が更新されたユーザーのId ### `USER_TAGS_UPDATED` ユーザーのタグが更新された。 対象: 全員 + `id`: タグが更新されたユーザーのId + `tag_id`: 更新されたタグのId ### `USER_ICON_UPDATED` ユーザーのアイコンが更新された。 対象: 全員 + `id`: アイコンが更新されたユーザーのId ### `USER_WEBRTC_STATE_CHANGED` ユーザーのWebRTCの状態が変化した 対象: 全員 + `user_id`: 変更があったユーザーのId + `channel_id`: ユーザーの変更後の接続チャンネルのId + `sessions`: ユーザーの変更後の状態(配列) + `state`: 状態 + `sessionId`: セッションID ### `USER_VIEWSTATE_CHANGED` ユーザーのチャンネルの閲覧状態が変化した 対象: 変化したWSセッションを含めた、該当ユーザーのWSセッション全て + `view_states`: 変化したWSセッションを含めた、該当ユーザーの変更後の状態(配列) + `key`: WSセッションの識別子 + `channel_id`: 閲覧しているチャンネルId + `state`: 閲覧状態 ### `USER_ONLINE` ユーザーがオンラインになった。 対象: 全員 + `id`: オンラインになったユーザーのId ### `USER_OFFLINE` ユーザーがオフラインになった。 対象: 全員 + `id`: オフラインになったユーザーのId ### `USER_GROUP_CREATED` ユーザーグループが作成された 対象: 全員 + `id`: 作成されたユーザーグループのId ### `USER_GROUP_UPDATED` ユーザーグループが更新された 対象: 全員 + `id`: 作成されたユーザーグループのId ### `USER_GROUP_DELETED` ユーザーグループが削除された 対象: 全員 + `id`: 削除されたユーザーグループのId ### `CHANNEL_CREATED` チャンネルが新規作成された。 対象: 該当チャンネルを閲覧可能な全員 + `id`: 作成されたチャンネルのId + `dm_user_id`: (DMの場合のみ) DM相手のユーザーId ### `CHANNEL_UPDATED` チャンネルの情報が変更された。 対象: 該当チャンネルを閲覧可能な全員 + `id`: 変更があったチャンネルのId + `dm_user_id`: (DMの場合のみ) DM相手のユーザーId ### `CHANNEL_DELETED` チャンネルが削除された。 対象: 該当チャンネルを閲覧可能な全員 + `id`: 削除されたチャンネルのId + `dm_user_id`: (DMの場合のみ) DM相手のユーザーId ### `CHANNEL_STARED` 自分がチャンネルをスターした。 対象: 自分 + `id`: スターしたチャンネルのId ### `CHANNEL_UNSTARED` 自分がチャンネルのスターを解除した。 対象: 自分 + `id`: スターしたチャンネルのId ### `CHANNEL_VIEWERS_CHANGED` チャンネルの閲覧者が変化した。 対象: 該当チャンネルを閲覧しているユーザー + `id`: 変化したチャンネルのId + `viewers`: 変化後の閲覧者(配列) + `userId`: ユーザーId + `state`: 閲覧状態 + `updatedAt`: 閲覧状態の更新日時 ### `CHANNEL_SUBSCRIBERS_CHANGED` チャンネルの購読者が変化した。 対象: 該当チャンネルを閲覧しているユーザー + `id`: 変化したチャンネルのId ### `MESSAGE_CREATED` メッセージが投稿された。 対象: 投稿チャンネルを閲覧しているユーザー・投稿チャンネルに通知をつけているユーザー・メンションを受けたユーザー + `id`: 投稿されたメッセージのId + `is_citing`: 投稿されたメッセージがWebSocketを接続しているユーザーの投稿を引用しているかどうか ### `MESSAGE_UPDATED` メッセージが更新された。 対象: 投稿チャンネルを閲覧しているユーザー + `id`: 更新されたメッセージのId ### `MESSAGE_DELETED` メッセージが削除された。 対象: 投稿チャンネルを閲覧しているユーザー + `id`: 削除されたメッセージのId ### `MESSAGE_STAMPED` メッセージにスタンプが押された。 対象: 投稿チャンネルを閲覧しているユーザー + `message_id`: メッセージId + `user_id`: スタンプを押したユーザーのId + `stamp_id`: スタンプのId + `count`: そのユーザーが押した数 + `created_at`: そのユーザーがそのスタンプをそのメッセージに最初に押した日時 ### `MESSAGE_UNSTAMPED` メッセージからスタンプが外された。 対象: 投稿チャンネルを閲覧しているユーザー + `message_id`: メッセージId + `user_id`: スタンプを押したユーザーのId + `stamp_id`: スタンプのId ### `MESSAGE_PINNED` メッセージがピン留めされた。 対象: 投稿チャンネルを閲覧しているユーザー + `message_id`: ピンされたメッセージのID + `channel_id`: ピンされたメッセージのチャンネルID ### `MESSAGE_UNPINNED` ピン留めされたメッセージのピンが外された。 対象: 投稿チャンネルを閲覧しているユーザー + `message_id`: ピンが外されたメッセージのID + `channel_id`: ピンが外されたメッセージのチャンネルID ### `MESSAGE_READ` 自分があるチャンネルのメッセージを読んだ。 対象: 自分 + `id`: 読んだチャンネルId ### `STAMP_CREATED` スタンプが新しく追加された。 対象: 全員 + `id`: 作成されたスタンプのId ### `STAMP_UPDATED` スタンプが修正された。 対象: 全員 + `id`: 修正されたスタンプのId ### `STAMP_DELETED` スタンプが削除された。 対象: 全員 + `id`: 削除されたスタンプのId ### `STAMP_PALETTE_CREATED` スタンプパレットが新しく追加された。 対象: 自分 + `id`: 作成されたスタンプパレットのId ### `STAMP_PALETTE_UPDATED` スタンプパレットが修正された。 対象: 自分 + `id`: 修正されたスタンプパレットのId ### `STAMP_PALETTE_DELETED` スタンプパレットが削除された。 対象: 自分 + `id`: 削除されたスタンプパレットのId ### `CLIP_FOLDER_CREATED` クリップフォルダーが作成された。 対象：自分 + `id`: 作成されたクリップフォルダーのId ### `CLIP_FOLDER_UPDATED` クリップフォルダーが修正された。 対象: 自分 + `id`: 更新されたクリップフォルダーのId ### `CLIP_FOLDER_DELETED` クリップフォルダーが削除された。 対象: 自分 + `id`: 削除されたクリップフォルダーのId ### `CLIP_FOLDER_MESSAGE_DELETED` クリップフォルダーからメッセージが除外された。 対象: 自分 + `folder_id`: メッセージが除外されたクリップフォルダーのId + `message_id`: クリップフォルダーから除外されたメッセージのId ### `CLIP_FOLDER_MESSAGE_ADDED` クリップフォルダーにメッセージが追加された。 対象: 自分 + `folder_id`: メッセージが追加されたクリップフォルダーのId + `message_id`: クリップフォルダーに追加されたメッセージのId ### `QALL_ROOM_STATE_CHANGED` ルーム状態が変更された。 対象: 全員 + `room_id`: 変更されたルームのId + `state`: 変更後のルーム状態 + `roomId`: ルームのID + `participants`: ルーム内の参加者(配列) + `identity`: ユーザーID_RandomUUID + `name`: 表示名 + `joinedAt`: 参加した時刻 + `attributes`: ユーザーに関連付けられたカスタム属性 + `canPublish`: 発言権限 + `isWebinar`: ウェビナールームかどうか + `metadata`: ルームに関連付けられたカスタム属性 ### `QALL_SOUNDBOARD_ITEM_CREATED` サウンドボードアイテムが作成された。 対象: 全員 + `sound_id`: 作成されたサウンドのId + `name`: サウンド名 + `creator_id`: 作成者のId ### `QALL_SOUNDBOARD_ITEM_DELETED` サウンドボードアイテムが削除された。 対象: 全員 + `sound_id`: 削除されたサウンドのId * @summary WebSocket通知ストリームに接続します * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationApi */ ws(options?: AxiosRequestConfig): Promise>; /** * OAuth2クライアントを作成します。 * @summary OAuth2クライアントを作成 * @param {PostClientRequest} [postClientRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof Oauth2Api */ createClient(postClientRequest?: PostClientRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したOAuth2クライアントを削除します。 対象のクライアントの管理権限が必要です。正常に削除された場合、このクライアントに対する認可は全て取り消されます。 * @summary OAuth2クライアントを削除 * @param {string} clientId OAuth2クライアントUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof Oauth2Api */ deleteClient(clientId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したOAuth2クライアントの情報を変更します。 対象のクライアントの管理権限が必要です。 クライアント開発者UUIDを変更した場合は、変更先ユーザーにクライアント管理権限が移譲され、自分自身は権限を失います。 * @summary OAuth2クライアント情報を変更 * @param {string} clientId OAuth2クライアントUUID * @param {PatchClientRequest} [patchClientRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof Oauth2Api */ editClient(clientId: string, patchClientRequest?: PatchClientRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したOAuth2クライアントの情報を取得します。 詳細情報の取得には対象のクライアントの管理権限が必要です。 * @summary OAuth2クライアント情報を取得 * @param {string} clientId OAuth2クライアントUUID * @param {boolean} [detail] 詳細情報を含めるかどうか * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof Oauth2Api */ getClient(clientId: string, detail?: boolean, options?: AxiosRequestConfig): Promise>; /** * 自身が開発者のOAuth2クライアントのリストを取得します。 `all`が`true`の場合、全開発者の全クライアントのリストを返します。 * @summary OAuth2クライアントのリストを取得 * @param {boolean} [all] 全てのクライアントを取得するかどうか * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof Oauth2Api */ getClients(all?: boolean, options?: AxiosRequestConfig): Promise>; /** * OAuth2 認可エンドポイント * @summary OAuth2 認可エンドポイント * @param {string} clientId * @param {OAuth2ResponseType} [responseType] * @param {string} [redirectUri] * @param {string} [scope] * @param {string} [state] * @param {string} [codeChallenge] * @param {string} [codeChallengeMethod] * @param {string} [nonce] * @param {OAuth2Prompt} [prompt] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof Oauth2Api */ getOAuth2Authorize(clientId: string, responseType?: OAuth2ResponseType, redirectUri?: string, scope?: string, state?: string, codeChallenge?: string, codeChallengeMethod?: string, nonce?: string, prompt?: OAuth2Prompt, options?: AxiosRequestConfig): Promise>; /** * OAuth2 認可エンドポイント * @summary OAuth2 認可エンドポイント * @param {string} clientId * @param {OAuth2ResponseType} [responseType] * @param {string} [redirectUri] * @param {string} [scope] * @param {string} [state] * @param {string} [codeChallenge] * @param {string} [codeChallengeMethod] * @param {string} [nonce] * @param {OAuth2Prompt} [prompt] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof Oauth2Api */ postOAuth2Authorize(clientId: string, responseType?: OAuth2ResponseType, redirectUri?: string, scope?: string, state?: string, codeChallenge?: string, codeChallengeMethod?: string, nonce?: string, prompt?: OAuth2Prompt, options?: AxiosRequestConfig): Promise>; /** * OAuth2 認可承諾 * @summary OAuth2 認可承諾API * @param {string} submit 承諾する場合は\\\"approve\\\" * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof Oauth2Api */ postOAuth2AuthorizeDecide(submit: string, options?: AxiosRequestConfig): Promise>; /** * OAuth2 トークンエンドポイント * @summary OAuth2 トークンエンドポイント * @param {string} grantType * @param {string} [code] * @param {string} [redirectUri] * @param {string} [clientId] * @param {string} [codeVerifier] * @param {string} [username] * @param {string} [password] * @param {string} [scope] * @param {string} [refreshToken] * @param {string} [clientSecret] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof Oauth2Api */ postOAuth2Token(grantType: string, code?: string, redirectUri?: string, clientId?: string, codeVerifier?: string, username?: string, password?: string, scope?: string, refreshToken?: string, clientSecret?: string, options?: AxiosRequestConfig): Promise>; /** * 自分が許可している指定したOAuthクライアントのアクセストークンを全てRevokeします。 * @summary OAuthクライアントのトークンを削除 * @param {string} clientId OAuth2クライアントUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof Oauth2Api */ revokeClientTokens(clientId: string, options?: AxiosRequestConfig): Promise>; /** * OAuth2 トークン無効化エンドポイント * @summary OAuth2 トークン無効化エンドポイント * @param {string} token 無効化するOAuth2トークンまたはOAuth2リフレッシュトークン * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof Oauth2Api */ revokeOAuth2Token(token: string, options?: AxiosRequestConfig): Promise>; /** * 指定されたURLのOGP情報のキャッシュを削除します。 * @summary OGP情報のキャッシュを削除 * @param {string} url OGPのキャッシュを削除したいURL * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OgpApi */ deleteOgpCache(url: string, options?: AxiosRequestConfig): Promise>; /** * 指定されたURLのOGP情報を取得します。 指定されたURLに対するOGP情報が見つからなかった場合、typeがemptyに設定された空のOGP情報を返します。 * @summary OGP情報を取得 * @param {string} url OGPを取得したいURL * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof OgpApi */ getOgp(url: string, options?: AxiosRequestConfig): Promise>; /** * ユーザーのアイコン画像を取得します。 * @summary ユーザーのアイコン画像を取得 * @param {string} username ユーザー名 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PublicApi */ getPublicUserIcon(username: string, options?: AxiosRequestConfig): Promise>; /** * サーバーバージョン及びサーバーフラグ情報を取得します。 * @summary バージョンを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PublicApi */ getServerVersion(options?: AxiosRequestConfig): Promise>; /** * ルーム内の参加者の発言権限を変更します。 * @summary ルームでの発言権限を変更 * @param {string} roomId ルームUUID * @param {Array} qallParticipantRequest 発言権限を変更する参加者の情報 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof QallApi */ changeParticipantRole(roomId: string, qallParticipantRequest: Array, options?: AxiosRequestConfig): Promise>; /** * 指定したルームに参加するためのLiveKitトークンを取得します。 * @summary LiveKitトークンを取得 * @param {string} [roomId] ルームUUID * @param {boolean} [isWebinar] ウェビナールームかどうか(デフォルト false) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof QallApi */ getLiveKitToken(roomId?: string, isWebinar?: boolean, options?: AxiosRequestConfig): Promise>; /** * 接続可能なLiveKitエンドポイントを取得します。 * @summary LiveKitエンドポイントを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof QallApi */ getQallEndpoints(options?: AxiosRequestConfig): Promise>; /** * ルームのメタデータを取得します。 * @summary ルームのメタデータを取得 * @param {string} roomId ルームUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof QallApi */ getRoomMetadata(roomId: string, options?: AxiosRequestConfig): Promise>; /** * 現在存在する(またはアクティブな)ルームと、そのルームに所属している参加者情報を取得します。 * @summary ルームと参加者の一覧を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof QallApi */ getRooms(options?: AxiosRequestConfig): Promise>; /** * DBに保存されたサウンドボード情報を取得します。 各アイテムには soundId, soundName, stampId が含まれます。 * @summary サウンドボード用の音声一覧を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof QallApi */ getSoundboardList(options?: AxiosRequestConfig): Promise>; /** * LiveKit側で設定したWebhookから呼び出されるエンドポイントです。 参加者の入室・退出などのイベントを受け取り、サーバ内で処理を行います。 * @summary LiveKit Webhook受信 * @param {object} body * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof QallApi */ liveKitWebhook(body: object, options?: AxiosRequestConfig): Promise>; /** * 15秒程度の短い音声ファイルを multipart/form-data で送信し、S3(互換ストレージ)にアップロードします。 クライアントは「soundName」というフィールドを送信し、それをDBに保存して関連付けを行います。 また、サーバ側で soundId を自動生成し、S3のファイル名に使用します。 * @summary サウンドボード用の短い音声ファイルをアップロード * @param {File} audio アップロードする音声ファイル(20秒以内) * @param {string} soundName ユーザが自由につけるサウンド名 * @param {string} [stampId] アイコンスタンプID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof QallApi */ postSoundboard(audio: File, soundName: string, stampId?: string, options?: AxiosRequestConfig): Promise>; /** * S3上にある音声ファイルの署名付きURLを生成し、 Ingressを介して指定ルームに音声を流します。 該当ルームに参加しているユーザであれば再生可能とします。 * @summary アップロード済み音声を LiveKit ルームで再生 * @param {SoundboardPlayRequest} soundboardPlayRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof QallApi */ postSoundboardPlay(soundboardPlayRequest: SoundboardPlayRequest, options?: AxiosRequestConfig): Promise>; /** * ルームのメタデータを更新します。 * @summary ルームのメタデータを更新 * @param {string} roomId ルームUUID * @param {QallMetadataRequest} qallMetadataRequest ルームのメタデータ * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof QallApi */ updateRoomMetadata(roomId: string, qallMetadataRequest: QallMetadataRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したスタンプの画像を変更します。 * @summary スタンプ画像を変更 * @param {string} stampId スタンプUUID * @param {File} file スタンプ画像(1MBまでのpng, jpeg, gif) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ changeStampImage(stampId: string, file: File, options?: AxiosRequestConfig): Promise>; /** * スタンプを新規作成します。 * @summary スタンプを作成 * @param {string} name スタンプ名 * @param {File} file スタンプ画像(1MBまでのpng, jpeg, gif) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ createStamp(name: string, file: File, options?: AxiosRequestConfig): Promise>; /** * スタンプパレットを作成します。 * @summary スタンプパレットを作成 * @param {PostStampPaletteRequest} [postStampPaletteRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ createStampPalette(postStampPaletteRequest?: PostStampPaletteRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したスタンプを削除します。 対象のスタンプの削除権限が必要です。 * @summary スタンプを削除 * @param {string} stampId スタンプUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ deleteStamp(stampId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したスタンプパレットを削除します。 対象のスタンプパレットの管理権限が必要です。 * @summary スタンプパレットを削除 * @param {string} paletteId スタンプパレットUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ deleteStampPalette(paletteId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したスタンプの情報を変更します。 * @summary スタンプ情報を変更 * @param {string} stampId スタンプUUID * @param {PatchStampRequest} [patchStampRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ editStamp(stampId: string, patchStampRequest?: PatchStampRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したスタンプパレットを編集します。 リクエストのスタンプの配列の順番は保存されて変更されます。 対象のスタンプパレットの管理権限が必要です。 * @summary スタンプパレットを編集 * @param {string} paletteId スタンプパレットUUID * @param {PatchStampPaletteRequest} [patchStampPaletteRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ editStampPalette(paletteId: string, patchStampPaletteRequest?: PatchStampPaletteRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したスタンプの情報を取得します。 * @summary スタンプ情報を取得 * @param {string} stampId スタンプUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ getStamp(stampId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したIDのスタンプ画像を返します。 * @summary スタンプ画像を取得 * @param {string} stampId スタンプUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ getStampImage(stampId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したスタンプパレットの情報を取得します。 * @summary スタンプパレットを取得 * @param {string} paletteId スタンプパレットUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ getStampPalette(paletteId: string, options?: AxiosRequestConfig): Promise>; /** * 自身が所有しているスタンプパレットのリストを取得します。 * @summary スタンプパレットのリストを取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ getStampPalettes(options?: AxiosRequestConfig): Promise>; /** * 指定したスタンプの統計情報を取得します。 * @summary スタンプ統計情報を取得 * @param {string} stampId スタンプUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ getStampStats(stampId: string, options?: AxiosRequestConfig): Promise>; /** * スタンプのリストを取得します。 * @summary スタンプリストを取得 * @param {boolean} [includeUnicode] Unicode絵文字を含ませるかどうか Deprecated: typeクエリを指定しなければ全てのスタンプを取得できるため、そちらを利用してください * @param {'unicode' | 'original'} [type] 取得するスタンプの種類 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StampApi */ getStamps(includeUnicode?: boolean, type?: 'unicode' | 'original', options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーに指定したタグを追加します。 Webhookユーザーにタグを追加することは出来ません。 * @summary ユーザーにタグを追加 * @param {string} userId ユーザーUUID * @param {PostUserTagRequest} [postUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserTagApi */ addUserTag(userId: string, postUserTagRequest?: PostUserTagRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーのアイコン画像を変更します。 管理者権限が必要です。 * @summary ユーザーのアイコン画像を変更します * @param {string} userId ユーザーUUID * @param {File} file アイコン画像(2MB,`Config.Imaging.MaxPixels`(default: 2560*1600)までのpng, jpeg, gif) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ changeUserIcon(userId: string, file: File, options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーのパスワードを変更します。 管理者権限が必要です。 * @summary ユーザーのパスワードを変更 * @param {string} userId ユーザーUUID * @param {PutUserPasswordRequest} [putUserPasswordRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ changeUserPassword(userId: string, putUserPasswordRequest?: PutUserPasswordRequest, options?: AxiosRequestConfig): Promise>; /** * ユーザーを登録します。 管理者権限が必要です。 * @summary ユーザーを登録 * @param {PostUserRequest} [postUserRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ createUser(postUserRequest?: PostUserRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーの情報を変更します。 管理者権限が必要です。 * @summary ユーザー情報を変更 * @param {string} userId ユーザーUUID * @param {PatchUserRequest} [patchUserRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ editUser(userId: string, patchUserRequest?: PatchUserRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーの指定したタグの状態を変更します。 他人の状態は変更できません。 * @summary ユーザーのタグを編集 * @param {string} userId ユーザーUUID * @param {string} tagId タグUUID * @param {PatchUserTagRequest} [patchUserTagRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserTagApi */ editUserTag(userId: string, tagId: string, patchUserTagRequest?: PatchUserTagRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーの詳細情報を取得します。 * @summary ユーザー詳細情報を取得 * @param {string} userId ユーザーUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ getUser(userId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーのアイコン画像を取得します。 * @summary ユーザーのアイコン画像を取得 * @param {string} userId ユーザーUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ getUserIcon(userId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーの統計情報を取得します。 * @summary ユーザー統計情報を取得 * @param {string} userId ユーザーUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ getUserStats(userId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したユーザーのタグリストを取得します。 * @summary ユーザーのタグリストを取得 * @param {string} userId ユーザーUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserTagApi */ getUserTags(userId: string, options?: AxiosRequestConfig): Promise>; /** * ユーザーのリストを取得します。 `include-suspended`を指定しない場合、レスポンスにはユーザーアカウント状態が\"1: 有効\"であるユーザーのみが含まれます。 `include-suspended`と`name`を同時に指定することはできません。 * @summary ユーザーのリストを取得 * @param {boolean} [includeSuspended] アカウントがアクティブでないユーザーを含め、全てのユーザーを取得するかどうか * @param {string} [name] 名前が一致するアカウントのみを取得する * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ getUsers(includeSuspended?: boolean, name?: string, options?: AxiosRequestConfig): Promise>; /** * 既に存在しないタグを削除しようとした場合は204を返します。 * @summary ユーザーからタグを削除します * @param {string} userId ユーザーUUID * @param {string} tagId タグUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserTagApi */ removeUserTag(userId: string, tagId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したタグの情報を取得します。 * @summary タグ情報を取得 * @param {string} tagId タグUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserTagApi */ getTag(tagId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したWebhookのアイコン画像を変更します。 * @summary Webhookのアイコンを変更 * @param {string} webhookId WebhookUUID * @param {File} file アイコン画像(2MB,`Config.Imaging.MaxPixels`(default: 2560*1600)までのpng, jpeg, gif) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhookApi */ changeWebhookIcon(webhookId: string, file: File, options?: AxiosRequestConfig): Promise>; /** * Webhookを新規作成します。 `secret`が空文字の場合、insecureウェブフックが作成されます。 * @summary Webhookを新規作成 * @param {PostWebhookRequest} [postWebhookRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhookApi */ createWebhook(postWebhookRequest?: PostWebhookRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したWebhookを削除します。 Webhookによって投稿されたメッセージは削除されません。 * @summary Webhookを削除 * @param {string} webhookId WebhookUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhookApi */ deleteWebhook(webhookId: string, options?: AxiosRequestConfig): Promise>; /** * 指定されたWebhookが投稿したメッセージを削除します。 * @summary Webhookの投稿メッセージを削除 * @param {string} webhookId WebhookUUID * @param {string} messageId メッセージUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhookApi */ deleteWebhookMessage(webhookId: string, messageId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したWebhookの情報を変更します。 * @summary Webhook情報を変更 * @param {string} webhookId WebhookUUID * @param {PatchWebhookRequest} [patchWebhookRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhookApi */ editWebhook(webhookId: string, patchWebhookRequest?: PatchWebhookRequest, options?: AxiosRequestConfig): Promise>; /** * 指定したWebhookの詳細を取得します。 * @summary Webhook情報を取得 * @param {string} webhookId WebhookUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhookApi */ getWebhook(webhookId: string, options?: AxiosRequestConfig): Promise>; /** * 指定したWebhookのアイコン画像を取得します * @summary Webhookのアイコンを取得 * @param {string} webhookId WebhookUUID * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhookApi */ getWebhookIcon(webhookId: string, options?: AxiosRequestConfig): Promise>; /** * 指定されたWebhookが投稿したメッセージのリストを返します。 * @summary Webhookの投稿メッセージのリストを取得 * @param {string} webhookId WebhookUUID * @param {number} [limit] 取得する件数 * @param {number} [offset] 取得するオフセット * @param {string} [since] 取得する時間範囲の開始日時 * @param {string} [until] 取得する時間範囲の終了日時 * @param {boolean} [inclusive] 範囲の端を含めるかどうか * @param {'asc' | 'desc'} [order] 昇順か降順か * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhookApi */ getWebhookMessages(webhookId: string, limit?: number, offset?: number, since?: string, until?: string, inclusive?: boolean, order?: 'asc' | 'desc', options?: AxiosRequestConfig): Promise>; /** * Webhookのリストを取得します。 allがtrueで無い場合は、自分がオーナーのWebhookのリストを返します。 * @summary Webhook情報のリストを取得します * @param {boolean} [all] 全てのWebhookを取得します。権限が必要です。 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhookApi */ getWebhooks(all?: boolean, options?: AxiosRequestConfig): Promise>; /** * Webhookにメッセージを投稿します。 secureなウェブフックに対しては`X-TRAQ-Signature`ヘッダーが必須です。 アーカイブされているチャンネルには投稿できません。 * @summary Webhookを送信 * @param {string} webhookId WebhookUUID * @param {string} [xTRAQSignature] リクエストボディシグネチャ(Secretが設定されている場合は必須) * @param {string} [xTRAQChannelId] 投稿先のチャンネルID(変更する場合) * @param {number} [embed] メンション・チャンネルリンクを自動埋め込みする場合に1を指定する * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhookApi */ postWebhook(webhookId: string, xTRAQSignature?: string, xTRAQChannelId?: string, embed?: number, body?: string, options?: AxiosRequestConfig): Promise>; /** * 現在のWebRTC状態を取得します。 * @summary WebRTC状態を取得 * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebrtcApi */ getWebRTCState(options?: AxiosRequestConfig): Promise>; /** * Skyway WebRTC用の認証API * @summary Skyway用認証API * @param {PostWebRTCAuthenticateRequest} [postWebRTCAuthenticateRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebrtcApi */ postWebRTCAuthenticate(postWebRTCAuthenticateRequest?: PostWebRTCAuthenticateRequest, options?: AxiosRequestConfig): Promise>; } export { type ActiveOAuth2Token, ActivityApi, ActivityApiAxiosParamCreator, ActivityApiFactory, ActivityApiFp, type ActivityTimelineMessage, type AddUserGroupMemberRequest, Apis, AuthenticationApi, AuthenticationApiAxiosParamCreator, AuthenticationApiFactory, AuthenticationApiFp, type Bot, BotApi, BotApiAxiosParamCreator, BotApiFactory, BotApiFp, type BotDetail, type BotEventLog, BotEventResult, BotMode, BotState, type BotTokens, type BotUser, type Channel, ChannelApi, ChannelApiAxiosParamCreator, ChannelApiFactory, ChannelApiFp, type ChannelEvent, type ChannelEventDetail, ChannelEventTypeEnum, type ChannelList, type ChannelPath, type ChannelStats, type ChannelStatsStamp, type ChannelStatsUser, ChannelSubscribeLevel, type ChannelTopic, ChannelViewState, type ChannelViewer, type ChildCreatedEvent, ClipApi, ClipApiAxiosParamCreator, ClipApiFactory, ClipApiFp, type ClipFolder, type ClippedMessage, Configuration, type ConfigurationParameters, type DMChannel, type ExternalProviderUser, FileApi, FileApiAxiosParamCreator, FileApiFactory, FileApiFp, type FileInfo, type FileInfoThumbnail, type ForcedNotificationChangedEvent, type GetBot200Response, type GetClient200Response, type GetMyStampRecommendations200ResponseInner, type GetNotifyCitation, GroupApi, GroupApiAxiosParamCreator, GroupApiFactory, GroupApiFp, type LoginSession, MeApi, MeApiAxiosParamCreator, MeApiFactory, MeApiFp, type Message, MessageApi, MessageApiAxiosParamCreator, MessageApiFactory, MessageApiFp, type MessageClip, type MessagePin, type MessageSearchResult, type MessageStamp, type MyChannelViewState, type MyUserDetail, type NameChangedEvent, NotificationApi, NotificationApiAxiosParamCreator, NotificationApiFactory, NotificationApiFp, type OAuth2Client, type OAuth2ClientDetail, OAuth2Prompt, OAuth2ResponseType, OAuth2Scope, type OAuth2Token, type OIDCTraqUserInfo, type OIDCUserInfo, Oauth2Api, Oauth2ApiAxiosParamCreator, Oauth2ApiFactory, Oauth2ApiFp, type Ogp, OgpApi, OgpApiAxiosParamCreator, OgpApiFactory, OgpApiFp, type OgpMedia, type ParentChangedEvent, type PatchBotRequest, type PatchChannelRequest, type PatchChannelSubscribersRequest, type PatchClientRequest, type PatchClipFolderRequest, type PatchGroupMemberRequest, type PatchMeRequest, type PatchStampPaletteRequest, type PatchStampRequest, type PatchUserGroupRequest, type PatchUserRequest, type PatchUserTagRequest, type PatchWebhookRequest, type Pin, type PinAddedEvent, PinApi, PinApiAxiosParamCreator, PinApiFactory, PinApiFp, type PinRemovedEvent, type PostBotActionJoinRequest, type PostBotActionLeaveRequest, type PostBotRequest, type PostChannelRequest, type PostClientRequest, type PostClipFolderMessageRequest, type PostClipFolderRequest, type PostLinkExternalAccount, type PostLoginRequest, type PostMessageRequest, type PostMessageStampRequest, type PostMyFCMDeviceRequest, type PostStampPaletteRequest, type PostStarRequest, type PostUnlinkExternalAccount, type PostUserGroupAdminRequest, type PostUserGroupRequest, type PostUserRequest, type PostUserTagRequest, type PostWebRTCAuthenticateRequest, type PostWebhookRequest, PublicApi, PublicApiAxiosParamCreator, PublicApiFactory, PublicApiFp, type PutChannelSubscribeLevelRequest, type PutChannelSubscribersRequest, type PutChannelTopicRequest, type PutMyPasswordRequest, type PutNotifyCitationRequest, type PutUserPasswordRequest, QallApi, QallApiAxiosParamCreator, QallApiFactory, QallApiFp, type QallEndpointResponse, type QallMetadataRequest, type QallMetadataResponse, type QallParticipant, type QallParticipantRequest, type QallParticipantRequestUsersInner, type QallParticipantResponse, type QallParticipantResponseResultsInner, type QallRoomStateChangedEvent, type QallRoomStateChangedEventRoomStatesInner, type QallRoomStateChangedEventRoomStatesInnerParticipantsInner, type QallRoomWithParticipants, type QallRoomsListResponse, type QallSoundboardItemCreatedEvent, type QallSoundboardItemDeletedEvent, type QallTokenResponse, type Session, type SoundboardItem, type SoundboardListResponse, type SoundboardPlayRequest, type SoundboardPlayResponse, type SoundboardUploadResponse, type Stamp, StampApi, StampApiAxiosParamCreator, StampApiFactory, StampApiFp, type StampHistoryEntry, type StampPalette, type StampStats, type StampWithThumbnail, StarApi, StarApiAxiosParamCreator, StarApiFactory, StarApiFp, type SubscribersChangedEvent, type Tag, type ThumbnailInfo, ThumbnailType, type TopicChangedEvent, type UnreadChannel, type User, UserAccountState, UserApi, UserApiAxiosParamCreator, UserApiFactory, UserApiFp, type UserDetail, type UserGroup, type UserGroupMember, type UserGroupMembers, UserPermission, type UserSettings, type UserStats, type UserStatsStamp, type UserSubscribeState, type UserTag, UserTagApi, UserTagApiAxiosParamCreator, UserTagApiFactory, UserTagApiFp, type Version, type VersionFlags, type VisibilityChangedEvent, type WebRTCAuthenticateResult, type WebRTCUserState, type WebRTCUserStates, type Webhook, WebhookApi, WebhookApiAxiosParamCreator, WebhookApiFactory, WebhookApiFp, WebrtcApi, WebrtcApiAxiosParamCreator, WebrtcApiFactory, WebrtcApiFp };