synapse-react-client/dist/utils/APIConstants.d.ts

[](https://badge.fury.io/js/synapse-react-client) [](https://github.com/prettier/prettie

/**
 * Separating API endpoints into their own constants file
 */
import { ObjectType } from '@sage-bionetworks/synapse-types';
export declare const BACKEND_ENDPOINT: string;
export declare const REPO = "/repo/v1";
export declare const AUTH = "/auth/v1";
export declare const FILE = "/file/v1";
export declare const OAUTH_ID: (id: string | number) => string;
export declare const OAUTH_CLIENT_ACL: (id: string | number) => string;
export declare const ENTITY = "/repo/v1/entity";
export declare const ENTITY_ALIAS: (alias: string) => string;
export declare const ENTITY_ID: (id: string | number) => string;
/**
 * Some services allow (but do not require) you to specify the version in the path.
 */
export declare const ENTITY_ID_VERSION: (id: string | number, version?: string | number) => string;
export declare const ENTITY_ID_VERSIONS: (id: string | number) => string;
export declare const ENTITY_BUNDLE_V2: (id: string | number, version?: string | number) => string;
export declare const ENTITY_ACCESS: (id: string | number) => string;
export declare const ENTITY_ACL: (id: string | number) => string;
export declare const ENTITY_EVALUATION: (id: string | number) => string;
export declare const ENTITY_PATH: (id: string | number) => string;
export declare const ENTITY_PERMISSIONS: (id: string | number) => string;
export declare const ENTITY_HEADER_BY_ID: (id: string | number) => string;
export declare const ENTITY_HEADERS = "/repo/v1/entity/header";
export declare const ENTITY_JSON: (id: string | number) => string;
export declare const ENTITY_VERSION_JSON: (id: string | number, versionNumber: number) => string;
export declare const ENTITY_SCHEMA: (id: string | number) => string;
export declare const ENTITY_SCHEMA_BINDING: (id: string | number) => string;
export declare const ENTITY_SCHEMA_VALIDATION: (id: string | number) => string;
export declare const ENTITY_ACCESS_REQUIREMENTS: (entityId: string | number) => string;
export declare const TABLE_QUERY_ASYNC_START: (id: string | number) => string;
export declare const TABLE_QUERY_ASYNC_GET: (entityId: string | number, asyncJobToken: string) => string;
export declare const ASYNCHRONOUS_JOB_TOKEN: (asyncJobToken: string) => string;
export declare const USER_PROFILE_ENDPOINT = "/repo/v1/userProfile";
export declare const SCHEMA = "/repo/v1/schema";
export declare const REGISTERED_SCHEMA = "/repo/v1/schema/type/registered";
export declare const REGISTERED_SCHEMA_ID: (schema$id: string | number) => string;
export declare const SCHEMA_VALIDATION_START = "/repo/v1/schema/type/validation/async/start";
export declare const SCHEMA_VALIDATION_GET: (asyncJobId: string | number) => string;
export declare const USER = "/repo/v1/user";
export declare const USER_BUNDLE = "/repo/v1/user/bundle";
export declare const USER_ID: (id: string | number) => string;
export declare const USER_ID_BUNDLE: (id: string | number) => string;
export declare const USER_PROFILE = "/repo/v1/userProfile";
export declare const USER_PROFILE_ID: (id: string | number) => string;
export declare const NOTIFICATION_EMAIL = "/repo/v1/notificationEmail";
export declare const ALIAS_AVAILABLE = "/repo/v1/principal/available";
export declare const REGISTER_ACCOUNT_STEP_1: (portalEndpoint: string) => string;
export declare const REGISTER_ACCOUNT_STEP_2 = "/repo/v1/account2";
export declare const TERMS_OF_USE = "/auth/v1/termsOfUse2";
export declare const TERMS_OF_USE_INFO = "/auth/v1/termsOfUse2/info";
export declare const TERMS_OF_USE_STATUS = "/auth/v1/termsOfUse2/status";
export declare const PROJECT_STORAGE_USAGE: (projectId: string) => string;
export declare const VERIFICATION_SUBMISSION = "/repo/v1/verificationSubmission";
export declare const VERIFICATION_SUBMISSION_STATE: (id: string) => string;
export declare const CHANGE_PASSWORD = "/auth/v1/user/changePassword";
export declare const ACCESS_REQUIREMENT = "/repo/v1/accessRequirement";
export declare const ACCESS_REQUIREMENT_SEARCH = "/repo/v1/accessRequirement/search";
export declare const ACCESS_REQUEST_SUBMISSION_SEARCH = "/repo/v1/dataAccessSubmission/search";
export declare const ACCESS_REQUIREMENT_BY_ID: (id: string | number) => string;
export declare const ACCESS_REQUIREMENT_ACL: (id: string | number) => string;
export declare const ACCESS_REQUIREMENT_STATUS: (id: string | number) => string;
export declare const ACCESS_REQUIREMENT_WIKI_PAGE_KEY: (id: string | number) => string;
export declare const FAVORITES = "/repo/v1/favorite";
export declare const USER_GROUP_HEADERS = "/repo/v1/userGroupHeaders";
export declare const USER_GROUP_HEADERS_BATCH = "/repo/v1/userGroupHeaders/batch";
export declare const DATA_ACCESS_SUBMISSION_BY_ID: (id: string | number) => string;
export declare const PROFILE_IMAGE_PREVIEW: (userId: string) => string;
export declare const APPROVED_SUBMISSION_INFO: (accessRequirementId: string | number) => string;
export declare const EVALUATION = "/repo/v1/evaluation";
export declare const EVALUATION_BY_ID: (id: string | number) => string;
export declare const ACTIVITY_FOR_ENTITY: (entityId: string, versionNumber?: string) => string;
export declare const TRASHCAN = "/repo/v1/trashcan";
export declare const TRASHCAN_VIEW = "/repo/v1/trashcan/view";
export declare const TRASHCAN_RESTORE: (id: string) => string;
export declare const TRASHCAN_PURGE: (id: string) => string;
export declare const TEAM: (teamId: string | number) => string;
export declare const TEAM_ID_MEMBER_ID: (teamId: string | number, memberId: string | number) => string;
export declare const TEAM_MEMBERS: (teamId: string | number) => string;
export declare const TEAM_MEMBER = "/repo/v1/teamMember/?teamEndpoint=https://www.synapse.org/Team:&notificationUnsubscribeEndpoint=https://www.synapse.org/SignedToken:";
export declare const TEAM_ID_MEMBER_ID_WITH_NOTIFICATION: (teamId: string | number, memberId: string | number) => string;
export declare const MEMBERSHIP_INVITATION: (id: string) => string;
export declare const INVITEE_VERIFICATION_SIGNED_TOKEN: (id: string) => string;
export declare const BIND_INVITATION_TO_AUTHENTICATED_USER: (id: string) => string;
export declare const FORUM = "/repo/v1/forum";
export declare const FORUM_THREAD: (id: string) => string;
export declare const THREAD = "/repo/v1/thread";
export declare const THREAD_ID: (id: string) => string;
export declare const THREAD_REPLIES: (id: string) => string;
export declare const AGENT = "/repo/v1/agent";
export declare const AGENT_SESSION = "/repo/v1/agent/session";
export declare const UPDATE_AGENT_SESSION: (sessionId?: string) => string;
export declare const LIST_AGENT_SESSIONS = "/repo/v1/agent/sessions/list";
export declare const AGENT_SESSION_HISTORY: (sessionId?: string) => string;
export declare const START_CHAT_ASYNC = "/repo/v1/agent/chat/async/start";
export declare const GET_CHAT_ASYNC: (jobId: string | number) => string;
export declare const AGENT_CHAT_TRACE: (jobId: string | number) => string;
export declare const DOI = "/repo/v1/doi";
export declare const DOI_ASSOCIATION = "/repo/v1/doi/association";
export declare const ACCESS_APPROVAL = "/repo/v1/accessApproval";
export declare const ACCESS_APPROVAL_BY_ID: (id: string | number) => string;
export declare const DATA_ACCESS_REQUEST = "/repo/v1/dataAccessRequest";
export declare const DATA_ACCESS_REQUEST_SUBMISSION: (id: string | number) => string;
export declare const ACCESS_REQUIREMENT_DATA_ACCESS_REQUEST_FOR_UPDATE: (accessRequirementId: string | number) => string;
export declare const RESEARCH_PROJECT = "/repo/v1/researchProject";
export declare const ACCESS_REQUIREMENT_RESEARCH_PROJECT_FOR_UPDATE: (accessRequirementId: string | number) => string;
export declare const FILE_HANDLE = "/file/v1/fileHandle";
export declare const FILE_HANDLE_BATCH = "/file/v1/fileHandle/batch";
export declare const PROJECTS = "/repo/v1/projects";
export declare const ENTITY_ACTIONS_REQUIRED: (entityId: string) => string;
export declare const WIKI_OBJECT_TYPE: (objectType: ObjectType) => string;
export declare const WIKI_PAGE: (ownerObjectType: ObjectType, ownerObjectId: string) => string;
export declare const WIKI_PAGE_ID: (ownerObjectType: ObjectType, ownerObjectId: string, wikiPageId: string | undefined) => string;
export declare const SESSION_ACCESS_TOKEN = "/auth/v1/sessionAccessToken";
export declare const ALL_USER_SESSION_TOKENS: (targetUserId: string | number) => string;
//# sourceMappingURL=APIConstants.d.ts.map