@cedricziel/aha-js
v1.2.5
Published
OpenAPI client for @cedricziel/aha-js
Downloads
167
Maintainers
Readme
@cedricziel/[email protected]
This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:
Environment
- Node.js
- Webpack
- Browserify
Language level
- ES5 - you must have a Promises/A+ library installed
- ES6
Module system
- CommonJS
- ES6 module system
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)
Building
To build and compile the typescript sources to javascript use:
npm install
npm run buildPublishing
First build the package then run npm publish
Consuming
navigate to the folder of your consuming project and run one of the following commands.
published:
npm install @cedricziel/[email protected] --saveunPublished (not recommended):
npm install PATH_TO_GENERATED_PACKAGE --saveDocumentation for API Endpoints
All URIs are relative to https://mycompany.aha.io/api/v1
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- CommentsApi | commentsCreateEpic | POST /epics/{epic_id}/comments | Create a comment on an epic CommentsApi | commentsCreateFeature | POST /features/{feature_id}/comments | Create a comment on a feature CommentsApi | commentsCreateIdea | POST /ideas/{idea_id}/comments | Create a comment on an idea CommentsApi | commentsCreateInitiative | POST /initiatives/{initiative_id}/comments | Create a comment on an initiative CommentsApi | commentsCreateRequirement | POST /requirements/{requirement_id}/comments | Create a comment on a requirement CommentsApi | commentsGetEpic | GET /epics/{epic_id}/comments | List comments on an epic CommentsApi | commentsGetGoal | GET /goals/{goal_id}/comments | List comments on a goal CommentsApi | commentsGetIdea | GET /ideas/{idea_id}/comments | List comments on an idea CommentsApi | commentsGetInitiative | GET /initiatives/{initiative_id}/comments | List comments on an initiative CommentsApi | commentsGetProduct | GET /products/{product_id}/comments | List comments in a product CommentsApi | commentsGetRelease | GET /releases/{release_id}/comments | List comments on a release CommentsApi | commentsGetReleasePhase | GET /release_phases/{release_phase_id}/comments | List comments on a release phase CommentsApi | commentsGetRequirement | GET /requirements/{requirement_id}/comments | List comments on a requirement CommentsApi | commentsGetTodo | GET /todos/{todo_id}/comments | List comments on a to-do CompetitorsApi | competitorsCreate | POST /products/{product_id}/competitors | Create a competitor CompetitorsApi | competitorsDelete | DELETE /competitors/{competitor_id} | Delete a competitor CompetitorsApi | competitorsGet | GET /competitors/{competitor_id} | Get a specific competitor CompetitorsApi | competitorsListProduct | GET /products/{product_id}/competitors | List competitors in a product CompetitorsApi | competitorsUpdate | PUT /competitors/{competitor_id} | Update a competitor DefaultApi | featuresIdCustomFieldsPut | PUT /features/{id}/custom_fields | DefaultApi | featuresIdCustomFieldsTagPut | PUT /features/{id}/custom_fields/tag | DefaultApi | featuresIdDelete | DELETE /features/{id} | DefaultApi | featuresIdGet | GET /features/{id} | DefaultApi | featuresIdPut | PUT /features/{id} | DefaultApi | releasesReleaseIdFeaturesGet | GET /releases/{release_id}/features | DefaultApi | releasesReleaseIdFeaturesPost | POST /releases/{release_id}/features | EpicsApi | commentsCreateEpic | POST /epics/{epic_id}/comments | Create a comment on an epic EpicsApi | commentsGetEpic | GET /epics/{epic_id}/comments | List comments on an epic EpicsApi | epicsCreateInProduct | POST /products/{product_id}/epics | Create an epic in a product EpicsApi | epicsCreateInRelease | POST /releases/{release_id}/epics | Create an epic in a release EpicsApi | epicsDelete | DELETE /epics/{epic_id} | Delete an epic EpicsApi | epicsGet | GET /epics/{epic_id} | Get a specific epic EpicsApi | epicsList | GET /epics | List epics EpicsApi | epicsListByGoal | GET /goals/{goal_id}/epics | List epics associated with a goal EpicsApi | epicsListByInitiative | GET /initiatives/{initiative_id}/epics | List epics associated with an initiative EpicsApi | epicsListInProduct | GET /products/{product_id}/epics | List epics in a product EpicsApi | epicsListInRelease | GET /releases/{release_id}/epics | List epics in a release EpicsApi | epicsUpdate | PUT /epics/{epic_id} | Update an epic FeaturesApi | commentsCreateFeature | POST /features/{feature_id}/comments | Create a comment on a feature FeaturesApi | featuresIdCustomFieldsWorksheetPut | PUT /features/{id}/custom_fields/worksheet | Update a feature's custom worksheet fields FeaturesApi | featuresIdEpicPut | PUT /features/{id}/epic | Update a feature's epic FeaturesApi | featuresIdGoalsPut | PUT /features/{id}/goals | Update a feature's goals FeaturesApi | featuresIdProgressPut | PUT /features/{id}/progress | Update a feature's progress FeaturesApi | featuresIdProgressSourcePut | PUT /features/{id}/progress_source | Update a feature's progress source FeaturesApi | featuresIdReleasePut | PUT /features/{id}/release | Update a feature's release FeaturesApi | featuresIdScorePut | PUT /features/{id}/score | Update a feature's score FeaturesApi | featuresIdTagsPut | PUT /features/{id}/tags | Update a feature's tags with an array FeaturesApi | featuresList | GET /features | List features GoalsApi | commentsGetGoal | GET /goals/{goal_id}/comments | List comments on a goal GoalsApi | epicsListByGoal | GET /goals/{goal_id}/epics | List epics associated with a goal GoalsApi | goalsCreate | POST /goals | Create a goal GoalsApi | goalsDelete | DELETE /goals/{id} | Delete a goal GoalsApi | goalsGet | GET /goals/{id} | Get a goal GoalsApi | goalsList | GET /goals | List goals GoalsApi | goalsUpdate | PUT /goals/{id} | Update a goal GoalsApi | goalsUpdateProgress | PUT /goals/{id}/progress | Update goal progress IdeaOrganizationsApi | ideaOrganizationsCreate | POST /idea_organizations | Create an idea organization IdeaOrganizationsApi | ideaOrganizationsDelete | DELETE /idea_organizations/{id} | Delete an idea organization IdeaOrganizationsApi | ideaOrganizationsGet | GET /idea_organizations/{id} | Get an idea organization IdeaOrganizationsApi | ideaOrganizationsList | GET /idea_organizations | List idea organizations IdeaOrganizationsApi | ideaOrganizationsUpdate | PUT /idea_organizations/{id} | Update an idea organization IdeaVotesApi | ideasCreateEndorsement | POST /ideas/{id}/endorsements | Create an endorsement (proxy vote) IdeaVotesApi | ideasGetEndorsements | GET /ideas/{id}/endorsements | Get endorsements for an idea IdeasApi | commentsCreateIdea | POST /ideas/{idea_id}/comments | Create a comment on an idea IdeasApi | commentsGetIdea | GET /ideas/{idea_id}/comments | List comments on an idea IdeasApi | ideasCreate | POST /products/{product_id}/ideas | Create an idea IdeasApi | ideasCreateByPortalUser | POST /products/{product_id}/ideas/portal_user | Create an idea created by a ideas portal user IdeasApi | ideasCreateEndorsement | POST /ideas/{id}/endorsements | Create an endorsement (proxy vote) IdeasApi | ideasCreateWithCategory | POST /products/{product_id}/ideas/with_category | Create an idea with a category IdeasApi | ideasCreateWithScore | POST /products/{product_id}/ideas/with_score | Create an idea with a score IdeasApi | ideasDelete | DELETE /ideas/{id} | Delete an idea IdeasApi | ideasGetById | GET /ideas/{id} | Get a specific idea IdeasApi | ideasGetEndorsements | GET /ideas/{id}/endorsements | Get endorsements for an idea IdeasApi | ideasGetVotes | GET /ideas/{id}/votes | Get votes for an idea IdeasApi | ideasGetWatchers | GET /ideas/{id}/watchers | Get idea watchers IdeasApi | ideasList | GET /ideas | List ideas IdeasApi | ideasListProduct | GET /products/{product_id}/ideas | List ideas for a product IdeasApi | ideasMarkSpam | POST /ideas/{id}/spam | Mark idea as spam IdeasApi | ideasPromote | POST /ideas/{id}/promote | Promote an idea IdeasApi | ideasUnmarkSpam | DELETE /ideas/{id}/spam | Unmark idea as spam IdeasApi | ideasUpdate | PUT /ideas/{id} | Update an idea IdeasApi | ideasUpdateWatchers | PUT /ideas/{id}/watchers | Update idea watchers IdeasApi | ideasVote | POST /ideas/{id}/votes | Vote on an idea InitiativesApi | commentsCreateInitiative | POST /initiatives/{initiative_id}/comments | Create a comment on an initiative InitiativesApi | commentsGetInitiative | GET /initiatives/{initiative_id}/comments | List comments on an initiative InitiativesApi | epicsListByInitiative | GET /initiatives/{initiative_id}/epics | List epics associated with an initiative InitiativesApi | initiativesCreate | POST /products/{product_id}/initiatives | Create an initiative InitiativesApi | initiativesGet | GET /initiatives/{id} | Get a specific initiative InitiativesApi | initiativesList | GET /initiatives | List initiatives MeApi | meGetAssignedRecords | GET /me/assigned | Get records assigned to current user MeApi | meGetPendingTasks | GET /me/tasks | Get pending tasks assigned to current user MeApi | meGetProfile | GET /me | Get current user profile ProductsApi | commentsGetProduct | GET /products/{product_id}/comments | List comments in a product ProductsApi | productsGet | GET /products/{id} | Get a specific product ProductsApi | productsList | GET /products | List products in the account ReleasePhasesApi | commentsGetReleasePhase | GET /release_phases/{release_phase_id}/comments | List comments on a release phase ReleasePhasesApi | releasePhasesCreate | POST /release_phases | Create a release phase ReleasePhasesApi | releasePhasesDelete | DELETE /release_phases/{id} | Delete a release phase ReleasePhasesApi | releasePhasesGet | GET /release_phases/{id} | Get a specific release phase ReleasePhasesApi | releasePhasesList | GET /release_phases | List release phases in the account ReleasePhasesApi | releasePhasesUpdate | PUT /release_phases/{id} | Update a release phase ReleasesApi | commentsGetRelease | GET /releases/{release_id}/comments | List comments on a release ReleasesApi | productReleasesList | GET /products/{product_id}/releases | List releases for a product ReleasesApi | releasesCreate | POST /products/{product_id}/releases | Create a release ReleasesApi | releasesDelete | DELETE /releases/{id} | Delete a release ReleasesApi | releasesGet | GET /releases/{id} | Get a release ReleasesApi | releasesList | GET /releases | List releases ReleasesApi | releasesUpdate | PUT /releases/{id} | Update a release RequirementsApi | commentsCreateRequirement | POST /requirements/{requirement_id}/comments | Create a comment on a requirement RequirementsApi | commentsGetRequirement | GET /requirements/{requirement_id}/comments | List comments on a requirement RequirementsApi | requirementsDelete | DELETE /requirements/{id} | Delete a requirement RequirementsApi | requirementsGet | GET /requirements/{id} | Get a specific requirement RequirementsApi | requirementsUpdate | PUT /requirements/{id} | Update a requirement StrategicModelsApi | strategicModelsCreate | POST /strategic_models | Create a strategic model StrategicModelsApi | strategicModelsDelete | DELETE /strategic_models/{id} | Delete a strategic model StrategicModelsApi | strategicModelsGet | GET /strategic_models/{id} | Get a strategic model StrategicModelsApi | strategicModelsList | GET /strategic_models | List strategic models StrategicModelsApi | strategicModelsUpdate | PUT /strategic_models/{id} | Update a strategic model ToDosApi | commentsGetTodo | GET /todos/{todo_id}/comments | List comments on a to-do ToDosApi | todosCreate | POST /todos | Create a to-do ToDosApi | todosDelete | DELETE /todos/{id} | Delete a to-do ToDosApi | todosGet | GET /todos/{id} | Get a specific to-do ToDosApi | todosList | GET /todos | List to-dos ToDosApi | todosUpdate | PUT /todos/{id} | Update a to-do UsersApi | usersGet | GET /users/{id} | Get a specific user UsersApi | usersList | GET /users | List users
Documentation For Models
- Attachment
- Comment
- CommentCreateRequest
- CommentsGetEpic200Response
- Competitor
- CompetitorCreateRequest
- CompetitorCreateRequestCompetitor
- CompetitorUpdateRequest
- CompetitorUpdateRequestCompetitor
- CompetitorsListProduct200Response
- CustomField
- CustomFieldValue
- Epic
- EpicCreateRequest
- EpicCreateRequestEpic
- EpicDescription
- EpicUpdateRequest
- EpicUpdateRequestEpic
- EpicsList200Response
- Feature
- FeatureCreateRequest
- FeatureCreateRequestFeature
- FeatureCreateRequestFeatureAssignedToUser
- FeatureCreateRequestFeatureAssignedToUserOneOf
- FeatureCreateRequestFeatureScoreFactsInner
- FeatureCreateRequestFeatureWorkflowStatus
- FeatureCreateResponse
- FeatureDescription
- FeatureGetResponse
- FeatureIntegrationFieldsInner
- FeatureProject
- FeatureRelease
- FeatureUpdateRequest
- FeatureUpdateRequestFeature
- FeatureUpdateResponse
- FeatureWorkflowKind
- FeatureWorkflowStatus
- FeatureWorkflowStatusTimesInner
- FeaturesIdCustomFieldsWorksheetPutRequest
- FeaturesIdCustomFieldsWorksheetPutRequestFeature
- FeaturesIdCustomFieldsWorksheetPutRequestFeatureCustomFields
- FeaturesIdEpicPutRequest
- FeaturesIdEpicPutRequestFeature
- FeaturesIdGoalsPutRequest
- FeaturesIdGoalsPutRequestFeature
- FeaturesIdProgressPutRequest
- FeaturesIdProgressPutRequestFeature
- FeaturesIdProgressSourcePutRequest
- FeaturesIdProgressSourcePutRequestFeature
- FeaturesIdReleasePutRequest
- FeaturesIdReleasePutRequestFeature
- FeaturesIdScorePutRequest
- FeaturesIdScorePutRequestFeature
- FeaturesIdScorePutRequestFeatureScoreFactsInner
- FeaturesIdTagsPutRequest
- FeaturesIdTagsPutRequestFeature
- FeaturesListResponse
- FeaturesListResponsePagination
- Goal
- GoalCreateRequest
- GoalCreateRequestKeyResultsInner
- GoalGetResponse
- GoalInitiativesInner
- GoalKeyResultsInner
- GoalProgressUpdateRequest
- GoalProgressUpdateRequestKeyResultsInner
- GoalUpdateRequest
- GoalUpdateRequestKeyResultsInner
- GoalsListResponse
- GoalsListResponsePagination
- IdeaCreateByPortalUserRequest
- IdeaCreateByPortalUserRequestIdea
- IdeaCreateByPortalUserRequestIdeaCreatedByPortalUser
- IdeaCreateRequest
- IdeaCreateRequestIdea
- IdeaCreateRequestIdeaScoreFactsInner
- IdeaEndorsementRequest
- IdeaOrganization
- IdeaOrganizationCreateRequest
- IdeaOrganizationGetResponse
- IdeaOrganizationUpdateRequest
- IdeaOrganizationsListResponse
- IdeaOrganizationsListResponsePagination
- IdeaPromoteRequest
- IdeaResponse
- IdeaResponseIdea
- IdeaResponseIdeaAssignedToUser
- IdeaResponseIdeaCreatedByPortalUser
- IdeaResponseIdeaCreatedByUser
- IdeaResponseIdeaScoreFactsInner
- IdeaResponseIdeaWorkflowStatusTimesInner
- IdeaUpdateRequest
- IdeaUpdateRequestScoreFactsInner
- IdeaVoteRequest
- IdeaWatchersRequest
- IdeaWatchersRequestWatchersInner
- IdeasCreateEndorsement201Response
- IdeasCreateEndorsement201ResponseEndorsement
- IdeasCreateEndorsement201ResponseIdea
- IdeasGetEndorsements200Response
- IdeasGetEndorsements200ResponseEndorsementsInner
- IdeasGetEndorsements200ResponseEndorsementsInnerCreatedByUser
- IdeasGetVotes200Response
- IdeasGetVotes200ResponsePagination
- IdeasGetVotes200ResponseVotesInner
- IdeasGetVotes200ResponseVotesInnerUser
- IdeasGetWatchers200Response
- IdeasGetWatchers200ResponseWatchersInner
- IdeasListResponse
- IdeasListResponseIdeasInner
- IdeasListResponseIdeasInnerDescription
- IdeasListResponseIdeasInnerWorkflowStatus
- IdeasListResponsePagination
- IdeasPromote200Response
- IdeasPromote200ResponsePromotedRecord
- IdeasVote200Response
- IdeasVote200ResponseIdea
- IdeasVote200ResponseVote
- InitiativeCreateRequest
- InitiativeCreateRequestInitiative
- InitiativeCreateRequestInitiativeTimeFrame
- InitiativeCreateRequestInitiativeWorkflowStatus
- InitiativeResponse
- InitiativeResponseInitiative
- InitiativeResponseInitiativeAssignedToUser
- InitiativeResponseInitiativeCreatedByUser
- InitiativeResponseInitiativeProject
- InitiativeResponseInitiativeTimeFrame
- InitiativeResponseInitiativeWorkflowStatusTimesInner
- InitiativesListResponse
- InitiativesListResponseInitiativesInner
- InitiativesListResponseInitiativesInnerAssignedToUser
- InitiativesListResponseInitiativesInnerCreatedByUser
- InitiativesListResponseInitiativesInnerTimeFrame
- IntegrationField
- IntegrationFieldIntegratable
- MeAssignedRecordsResponse
- MeAssignedRecordsResponsePagination
- MeAssignedRecordsResponseRecordsInner
- MeAssignedRecordsResponseRecordsInnerAssignedToUser
- MeAssignedRecordsResponseRecordsInnerWorkflowStatus
- MePendingTasksResponse
- MePendingTasksResponsePagination
- MePendingTasksResponseTasksInner
- MePendingTasksResponseTasksInnerAssignedByUser
- MeProfileResponse
- MeProfileResponseUser
- Product
- ProductGetResponse
- ProductsListResponse
- Release
- ReleaseCreateRequest
- ReleaseGetResponse
- ReleasePhase
- ReleasePhaseCreateRequest
- ReleasePhaseCreateRequestReleasePhase
- ReleasePhaseDescription
- ReleasePhaseRelease
- ReleasePhaseUpdateRequest
- ReleasePhaseUpdateRequestReleasePhase
- ReleasePhasesCreate201Response
- ReleasePhasesInner
- ReleasePhasesList200Response
- ReleaseUpdateRequest
- ReleaseWorkflowStatusTimesInner
- ReleasesListResponse
- ReleasesListResponsePagination
- Requirement
- RequirementAssignedToUser
- RequirementDescription
- RequirementFeature
- RequirementFullTagsInner
- RequirementUpdateRequest
- RequirementUpdateRequestRequirement
- RequirementUpdateRequestRequirementAssignedToUser
- RequirementUpdateRequestRequirementWorkflowStatus
- RequirementWorkflowStatus
- RequirementWorkflowStatusTimesInner
- RequirementsGet200Response
- StrategicModel
- StrategicModelCreateRequest
- StrategicModelGetResponse
- StrategicModelUpdateRequest
- StrategicModelsListResponse
- StrategicModelsListResponsePagination
- Todo
- TodoCreateRequest
- TodoCreateRequestTask
- TodoTaskable
- TodoUpdateRequest
- TodoUpdateRequestTask
- TodosCreate201Response
- TodosList200Response
- User
Documentation For Authorization
Authentication schemes defined for the API:
OAuth2
- Type: OAuth
- Flow: accessCode
- Authorization URL: https://{subdomain}.aha.io/oauth/authorize
- Scopes: N/A
BearerAuth
- Type: Bearer authentication (JWT)
