@suin/esa-api
Version:
esa.io APIクライアント
624 lines • 31.2 kB
JavaScript
;
/* tslint:disable */
/* eslint-disable */
/**
* esa API v1
* チームのナレッジ共有サービス[esa.io](https://esa.io/)のAPI v1の仕様書
*
* The version of the OpenAPI document: 1.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.StarApi = exports.StarApiFactory = exports.StarApiFp = exports.StarApiAxiosParamCreator = void 0;
const axios_1 = __importDefault(require("axios"));
// Some imports not used depending on template conditions
// @ts-ignore
const common_1 = require("../common");
// @ts-ignore
const base_1 = require("../base");
/**
* StarApi - axios parameter creator
* @export
*/
const StarApiAxiosParamCreator = function (configuration) {
return {
/**
* 指定されたコメントにStarをしたユーザ一覧を取得します。
* @summary コメントのStarを取得する
* @param {string} teamName チーム名
* @param {number} commentId コメントID
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getCommentStargazers: async (teamName, commentId, page, perPage, options = {}) => {
// verify required parameter 'teamName' is not null or undefined
(0, common_1.assertParamExists)("getCommentStargazers", "teamName", teamName);
// verify required parameter 'commentId' is not null or undefined
(0, common_1.assertParamExists)("getCommentStargazers", "commentId", commentId);
const localVarPath = `/teams/{team_name}/comments/{comment_id}/stargazers`
.replace(`{${"team_name"}}`, encodeURIComponent(String(teamName)))
.replace(`{${"comment_id"}}`, encodeURIComponent(String(commentId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = {
method: "GET",
...baseOptions,
...options,
};
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication AccessTokenHeader required
// http bearer authentication required
await (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
// authentication AccessTokenQueryParam required
await (0, common_1.setApiKeyToObject)(localVarQueryParameter, "access_token", configuration);
// authentication OAuth2 required
// oauth required
await (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2", ["read"], configuration);
if (page !== undefined) {
localVarQueryParameter["page"] = page;
}
if (perPage !== undefined) {
localVarQueryParameter["per_page"] = perPage;
}
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter, options.query);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {
...localVarHeaderParameter,
...headersFromBaseOptions,
...options.headers,
};
return {
url: (0, common_1.toPathString)(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* 指定された記事にStarをしたユーザ一覧を取得します。
* @summary 記事のStarを取得する
* @param {string} teamName チーム名
* @param {number} postNumber 記事ID
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPostStargazers: async (teamName, postNumber, page, perPage, options = {}) => {
// verify required parameter 'teamName' is not null or undefined
(0, common_1.assertParamExists)("getPostStargazers", "teamName", teamName);
// verify required parameter 'postNumber' is not null or undefined
(0, common_1.assertParamExists)("getPostStargazers", "postNumber", postNumber);
const localVarPath = `/teams/{team_name}/posts/{post_number}/stargazers`
.replace(`{${"team_name"}}`, encodeURIComponent(String(teamName)))
.replace(`{${"post_number"}}`, encodeURIComponent(String(postNumber)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = {
method: "GET",
...baseOptions,
...options,
};
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication AccessTokenHeader required
// http bearer authentication required
await (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
// authentication AccessTokenQueryParam required
await (0, common_1.setApiKeyToObject)(localVarQueryParameter, "access_token", configuration);
// authentication OAuth2 required
// oauth required
await (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2", ["read"], configuration);
if (page !== undefined) {
localVarQueryParameter["page"] = page;
}
if (perPage !== undefined) {
localVarQueryParameter["per_page"] = perPage;
}
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter, options.query);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {
...localVarHeaderParameter,
...headersFromBaseOptions,
...options.headers,
};
return {
url: (0, common_1.toPathString)(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* 指定されたコメントにStarをします。
* @summary コメントをStarする
* @param {string} teamName チーム名
* @param {number} commentId コメントID
* @param {NewStar} newStar
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
starComment: async (teamName, commentId, newStar, options = {}) => {
// verify required parameter 'teamName' is not null or undefined
(0, common_1.assertParamExists)("starComment", "teamName", teamName);
// verify required parameter 'commentId' is not null or undefined
(0, common_1.assertParamExists)("starComment", "commentId", commentId);
// verify required parameter 'newStar' is not null or undefined
(0, common_1.assertParamExists)("starComment", "newStar", newStar);
const localVarPath = `/teams/{team_name}/comments/{comment_id}/star`
.replace(`{${"team_name"}}`, encodeURIComponent(String(teamName)))
.replace(`{${"comment_id"}}`, encodeURIComponent(String(commentId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = {
method: "POST",
...baseOptions,
...options,
};
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication AccessTokenHeader required
// http bearer authentication required
await (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
// authentication AccessTokenQueryParam required
await (0, common_1.setApiKeyToObject)(localVarQueryParameter, "access_token", configuration);
// authentication OAuth2 required
// oauth required
await (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2", ["write"], configuration);
localVarHeaderParameter["Content-Type"] = "application/json";
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter, options.query);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {
...localVarHeaderParameter,
...headersFromBaseOptions,
...options.headers,
};
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(newStar, localVarRequestOptions, configuration);
return {
url: (0, common_1.toPathString)(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* 指定された記事にStarをします。
* @summary 記事をStarする
* @param {string} teamName チーム名
* @param {number} postNumber 記事ID
* @param {NewStar} newStar
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
starPost: async (teamName, postNumber, newStar, options = {}) => {
// verify required parameter 'teamName' is not null or undefined
(0, common_1.assertParamExists)("starPost", "teamName", teamName);
// verify required parameter 'postNumber' is not null or undefined
(0, common_1.assertParamExists)("starPost", "postNumber", postNumber);
// verify required parameter 'newStar' is not null or undefined
(0, common_1.assertParamExists)("starPost", "newStar", newStar);
const localVarPath = `/teams/{team_name}/posts/{post_number}/star`
.replace(`{${"team_name"}}`, encodeURIComponent(String(teamName)))
.replace(`{${"post_number"}}`, encodeURIComponent(String(postNumber)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = {
method: "POST",
...baseOptions,
...options,
};
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication AccessTokenHeader required
// http bearer authentication required
await (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
// authentication AccessTokenQueryParam required
await (0, common_1.setApiKeyToObject)(localVarQueryParameter, "access_token", configuration);
// authentication OAuth2 required
// oauth required
await (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2", ["write"], configuration);
localVarHeaderParameter["Content-Type"] = "application/json";
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter, options.query);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {
...localVarHeaderParameter,
...headersFromBaseOptions,
...options.headers,
};
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(newStar, localVarRequestOptions, configuration);
return {
url: (0, common_1.toPathString)(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* 指定されたコメントへのStarを取り消します。
* @summary コメントのStarを取り消す
* @param {string} teamName チーム名
* @param {number} commentId コメントID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
unstarComment: async (teamName, commentId, options = {}) => {
// verify required parameter 'teamName' is not null or undefined
(0, common_1.assertParamExists)("unstarComment", "teamName", teamName);
// verify required parameter 'commentId' is not null or undefined
(0, common_1.assertParamExists)("unstarComment", "commentId", commentId);
const localVarPath = `/teams/{team_name}/comments/{comment_id}/star`
.replace(`{${"team_name"}}`, encodeURIComponent(String(teamName)))
.replace(`{${"comment_id"}}`, encodeURIComponent(String(commentId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = {
method: "DELETE",
...baseOptions,
...options,
};
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication AccessTokenHeader required
// http bearer authentication required
await (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
// authentication AccessTokenQueryParam required
await (0, common_1.setApiKeyToObject)(localVarQueryParameter, "access_token", configuration);
// authentication OAuth2 required
// oauth required
await (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2", ["write"], configuration);
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter, options.query);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {
...localVarHeaderParameter,
...headersFromBaseOptions,
...options.headers,
};
return {
url: (0, common_1.toPathString)(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* 指定された記事へのStarを取り消します。
* @summary 記事のStarを取り消す
* @param {string} teamName チーム名
* @param {number} postNumber 記事ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
unstarPost: async (teamName, postNumber, options = {}) => {
// verify required parameter 'teamName' is not null or undefined
(0, common_1.assertParamExists)("unstarPost", "teamName", teamName);
// verify required parameter 'postNumber' is not null or undefined
(0, common_1.assertParamExists)("unstarPost", "postNumber", postNumber);
const localVarPath = `/teams/{team_name}/posts/{post_number}/star`
.replace(`{${"team_name"}}`, encodeURIComponent(String(teamName)))
.replace(`{${"post_number"}}`, encodeURIComponent(String(postNumber)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = {
method: "DELETE",
...baseOptions,
...options,
};
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication AccessTokenHeader required
// http bearer authentication required
await (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
// authentication AccessTokenQueryParam required
await (0, common_1.setApiKeyToObject)(localVarQueryParameter, "access_token", configuration);
// authentication OAuth2 required
// oauth required
await (0, common_1.setOAuthToObject)(localVarHeaderParameter, "OAuth2", ["write"], configuration);
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter, options.query);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {
...localVarHeaderParameter,
...headersFromBaseOptions,
...options.headers,
};
return {
url: (0, common_1.toPathString)(localVarUrlObj),
options: localVarRequestOptions,
};
},
};
};
exports.StarApiAxiosParamCreator = StarApiAxiosParamCreator;
/**
* StarApi - functional programming interface
* @export
*/
const StarApiFp = function (configuration) {
const localVarAxiosParamCreator = (0, exports.StarApiAxiosParamCreator)(configuration);
return {
/**
* 指定されたコメントにStarをしたユーザ一覧を取得します。
* @summary コメントのStarを取得する
* @param {string} teamName チーム名
* @param {number} commentId コメントID
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getCommentStargazers(teamName, commentId, page, perPage, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.getCommentStargazers(teamName, commentId, page, perPage, options);
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
},
/**
* 指定された記事にStarをしたユーザ一覧を取得します。
* @summary 記事のStarを取得する
* @param {string} teamName チーム名
* @param {number} postNumber 記事ID
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getPostStargazers(teamName, postNumber, page, perPage, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.getPostStargazers(teamName, postNumber, page, perPage, options);
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
},
/**
* 指定されたコメントにStarをします。
* @summary コメントをStarする
* @param {string} teamName チーム名
* @param {number} commentId コメントID
* @param {NewStar} newStar
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async starComment(teamName, commentId, newStar, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.starComment(teamName, commentId, newStar, options);
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
},
/**
* 指定された記事にStarをします。
* @summary 記事をStarする
* @param {string} teamName チーム名
* @param {number} postNumber 記事ID
* @param {NewStar} newStar
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async starPost(teamName, postNumber, newStar, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.starPost(teamName, postNumber, newStar, options);
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
},
/**
* 指定されたコメントへのStarを取り消します。
* @summary コメントのStarを取り消す
* @param {string} teamName チーム名
* @param {number} commentId コメントID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async unstarComment(teamName, commentId, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.unstarComment(teamName, commentId, options);
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
},
/**
* 指定された記事へのStarを取り消します。
* @summary 記事のStarを取り消す
* @param {string} teamName チーム名
* @param {number} postNumber 記事ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async unstarPost(teamName, postNumber, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.unstarPost(teamName, postNumber, options);
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
},
};
};
exports.StarApiFp = StarApiFp;
/**
* StarApi - factory interface
* @export
*/
const StarApiFactory = function (configuration, basePath, axios) {
const localVarFp = (0, exports.StarApiFp)(configuration);
return {
/**
* 指定されたコメントにStarをしたユーザ一覧を取得します。
* @summary コメントのStarを取得する
* @param {string} teamName チーム名
* @param {number} commentId コメントID
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getCommentStargazers(teamName, commentId, page, perPage, options) {
return localVarFp
.getCommentStargazers(teamName, commentId, page, perPage, options)
.then((request) => request(axios, basePath));
},
/**
* 指定された記事にStarをしたユーザ一覧を取得します。
* @summary 記事のStarを取得する
* @param {string} teamName チーム名
* @param {number} postNumber 記事ID
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPostStargazers(teamName, postNumber, page, perPage, options) {
return localVarFp
.getPostStargazers(teamName, postNumber, page, perPage, options)
.then((request) => request(axios, basePath));
},
/**
* 指定されたコメントにStarをします。
* @summary コメントをStarする
* @param {string} teamName チーム名
* @param {number} commentId コメントID
* @param {NewStar} newStar
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
starComment(teamName, commentId, newStar, options) {
return localVarFp
.starComment(teamName, commentId, newStar, options)
.then((request) => request(axios, basePath));
},
/**
* 指定された記事にStarをします。
* @summary 記事をStarする
* @param {string} teamName チーム名
* @param {number} postNumber 記事ID
* @param {NewStar} newStar
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
starPost(teamName, postNumber, newStar, options) {
return localVarFp
.starPost(teamName, postNumber, newStar, options)
.then((request) => request(axios, basePath));
},
/**
* 指定されたコメントへのStarを取り消します。
* @summary コメントのStarを取り消す
* @param {string} teamName チーム名
* @param {number} commentId コメントID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
unstarComment(teamName, commentId, options) {
return localVarFp
.unstarComment(teamName, commentId, options)
.then((request) => request(axios, basePath));
},
/**
* 指定された記事へのStarを取り消します。
* @summary 記事のStarを取り消す
* @param {string} teamName チーム名
* @param {number} postNumber 記事ID
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
unstarPost(teamName, postNumber, options) {
return localVarFp
.unstarPost(teamName, postNumber, options)
.then((request) => request(axios, basePath));
},
};
};
exports.StarApiFactory = StarApiFactory;
/**
* StarApi - object-oriented interface
* @export
* @class StarApi
* @extends {BaseAPI}
*/
class StarApi extends base_1.BaseAPI {
/**
* 指定されたコメントにStarをしたユーザ一覧を取得します。
* @summary コメントのStarを取得する
* @param {StarApiGetCommentStargazersRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof StarApi
*/
getCommentStargazers(requestParameters, options) {
return (0, exports.StarApiFp)(this.configuration)
.getCommentStargazers(requestParameters.teamName, requestParameters.commentId, requestParameters.page, requestParameters.perPage, options)
.then((request) => request(this.axios, this.basePath));
}
/**
* 指定された記事にStarをしたユーザ一覧を取得します。
* @summary 記事のStarを取得する
* @param {StarApiGetPostStargazersRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof StarApi
*/
getPostStargazers(requestParameters, options) {
return (0, exports.StarApiFp)(this.configuration)
.getPostStargazers(requestParameters.teamName, requestParameters.postNumber, requestParameters.page, requestParameters.perPage, options)
.then((request) => request(this.axios, this.basePath));
}
/**
* 指定されたコメントにStarをします。
* @summary コメントをStarする
* @param {StarApiStarCommentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof StarApi
*/
starComment(requestParameters, options) {
return (0, exports.StarApiFp)(this.configuration)
.starComment(requestParameters.teamName, requestParameters.commentId, requestParameters.newStar, options)
.then((request) => request(this.axios, this.basePath));
}
/**
* 指定された記事にStarをします。
* @summary 記事をStarする
* @param {StarApiStarPostRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof StarApi
*/
starPost(requestParameters, options) {
return (0, exports.StarApiFp)(this.configuration)
.starPost(requestParameters.teamName, requestParameters.postNumber, requestParameters.newStar, options)
.then((request) => request(this.axios, this.basePath));
}
/**
* 指定されたコメントへのStarを取り消します。
* @summary コメントのStarを取り消す
* @param {StarApiUnstarCommentRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof StarApi
*/
unstarComment(requestParameters, options) {
return (0, exports.StarApiFp)(this.configuration)
.unstarComment(requestParameters.teamName, requestParameters.commentId, options)
.then((request) => request(this.axios, this.basePath));
}
/**
* 指定された記事へのStarを取り消します。
* @summary 記事のStarを取り消す
* @param {StarApiUnstarPostRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof StarApi
*/
unstarPost(requestParameters, options) {
return (0, exports.StarApiFp)(this.configuration)
.unstarPost(requestParameters.teamName, requestParameters.postNumber, options)
.then((request) => request(this.axios, this.basePath));
}
}
exports.StarApi = StarApi;
//# sourceMappingURL=star-api.js.map