@cedricziel/aha-js

v2.0.1

Published

a month ago

OpenAPI client for @cedricziel/aha-js

0High
0Medium
0Low

cedricziel

axios typescript openapi-client openapi-generator @cedricziel/aha-js

@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 build

Publishing

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] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to https://company.aha.io/api/v1

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AccountBackupsApi | accountBackupsByIdGet | GET /account_backups/{id} | Get a specific account backup AccountBackupsApi | accountBackupsByIdTgGet | GET /account_backups/{id}.tgz | Download an account backup AccountBackupsApi | accountBackupsGet | GET /account_backups | List account backups AccountBackupsApi | accountBackupsPost | POST /account_backups | Create an account backup AssistantUsageApi | usageAssistantUsersGet | GET /usage/assistant_users | List assistant users within a time window AttachmentsApi | attachmentsByAttachmentDelete | DELETE /attachments/{attachment_id} | Delete an attachment AttachmentsApi | commentsByCommentAttachmentsPost | POST /comments/{comment_id}/attachments | Create an attachment on a comment AttachmentsApi | customFieldValuesByCustomFieldValueAttachmentsPost | POST /custom_field_values/{custom_field_value_id}/attachments | Create an attachment on a custom attachment field AttachmentsApi | customFieldsByCustomFieldAttachmentsPost | POST /custom_fields/{custom_field_id}/attachments | Create an attachment on a custom note field AttachmentsApi | ideaCommentsByIdeaCommentAttachmentsPost | POST /idea_comments/{idea_comment_id}/attachments | Create an attachment on an idea comment AttachmentsApi | notesByNoteAttachmentsPost | POST /notes/{note_id}/attachments | Create an attachment on a record description AttachmentsApi | tasksByTaskAttachmentsPost | POST /tasks/{task_id}/attachments | Create an attachment on a to-do AuditsApi | auditsGet | GET /audits | Retrieve record history with a user field change CapacityEstimateValuesApi | capacityInvestmentsByIdEstimateValuesGet | GET /capacity_investments/{id}/estimate_values | List estimate values for a capacity investment CapacityEstimateValuesApi | capacityInvestmentsByIdEstimateValuesPost | POST /capacity_investments/{id}/estimate_values | Create estimate values for a capacity investment CapacityEstimateValuesApi | estimateValuesByIdDelete | DELETE /estimate_values/{id} | Delete an estimate value CapacityEstimateValuesApi | estimateValuesByIdPut | PUT /estimate_values/{id} | Update an estimate value CapacityInvestmentsApi | capacityInvestmentsByIdGet | GET /capacity_investments/{id} | Get a capacity investment CapacityInvestmentsApi | capacityInvestmentsByIdPut | PUT /capacity_investments/{id} | Update a capacity investment CapacityInvestmentsApi | epicsByEpicCapacityInvestmentsGet | GET /epics/{epic_id}/capacity_investments | List capacity investments for an epic CapacityInvestmentsApi | epicsByEpicCapacityInvestmentsPost | POST /epics/{epic_id}/capacity_investments | Create a capacity investment on an epic CapacityInvestmentsApi | featuresByFeatureCapacityInvestmentsGet | GET /features/{feature_id}/capacity_investments | List capacity investments for a feature CapacityInvestmentsApi | featuresByFeatureCapacityInvestmentsPost | POST /features/{feature_id}/capacity_investments | Create a capacity investment on a feature CapacityInvestmentsApi | initiativesByInitiativeCapacityInvestmentsGet | GET /initiatives/{initiative_id}/capacity_investments | List capacity investments for an initiative CapacityInvestmentsApi | initiativesByInitiativeCapacityInvestmentsPost | POST /initiatives/{initiative_id}/capacity_investments | Create a capacity investment on an initiative CapacityInvestmentsApi | productsByProductCapacityInvestmentsGet | GET /products/{product_id}/capacity_investments | List capacity investments for a product CapacityScenariosApi | capacityScenariosByIdGet | GET /capacity_scenarios/{id} | Get a capacity scenario CapacityScenariosApi | capacityScenariosGet | GET /capacity_scenarios | List capacity scenarios CommentsApi | commentsByIdDelete | DELETE /comments/{id} | Delete a comment CommentsApi | commentsByIdGet | GET /comments/{id} | Get a specific comment CommentsApi | commentsByIdPut | PUT /comments/{id} | Update a comment CommentsApi | epicsByEpicCommentsGet | GET /epics/{epic_id}/comments | List comments on an epic CommentsApi | epicsByEpicCommentsPost | POST /epics/{epic_id}/comments | Create a comment on an epic CommentsApi | featuresByFeatureCommentsGet | GET /features/{feature_id}/comments | List comments on a feature CommentsApi | featuresByFeatureCommentsPost | POST /features/{feature_id}/comments | Create a comment on a feature CommentsApi | goalsByGoalCommentsGet | GET /goals/{goal_id}/comments | List comments on a goal CommentsApi | goalsByGoalCommentsPost | POST /goals/{goal_id}/comments | Create a comment on a goal CommentsApi | ideasByIdeaCommentsGet | GET /ideas/{idea_id}/comments | List comments on an idea CommentsApi | ideasByIdeaCommentsPost | POST /ideas/{idea_id}/comments | Create an internal comment for an idea CommentsApi | initiativesByInitiativeCommentsGet | GET /initiatives/{initiative_id}/comments | List comments on an initiative CommentsApi | initiativesByInitiativeCommentsPost | POST /initiatives/{initiative_id}/comments | Create a comment on an initiative CommentsApi | pagesByPageCommentsGet | GET /pages/{page_id}/comments | List comments on a note CommentsApi | pagesByPageCommentsPost | POST /pages/{page_id}/comments | Create a comment on a note CommentsApi | productsByProjectCommentsGet | GET /products/{project_id}/comments | List comments in a product CommentsApi | releasePhasesByReleasePhaseCommentsGet | GET /release_phases/{release_phase_id}/comments | List comments on a release phase CommentsApi | releasePhasesByReleasePhaseCommentsPost | POST /release_phases/{release_phase_id}/comments | Create a comment on a release phase CommentsApi | releasesByReleaseCommentsGet | GET /releases/{release_id}/comments | List comments on a release CommentsApi | releasesByReleaseCommentsPost | POST /releases/{release_id}/comments | Create a comment on a release CommentsApi | requirementsByRequirementCommentsGet | GET /requirements/{requirement_id}/comments | List comments on a requirement CommentsApi | requirementsByRequirementCommentsPost | POST /requirements/{requirement_id}/comments | Create a comment on a requirement CommentsApi | tasksByTaskCommentsGet | GET /tasks/{task_id}/comments | List comments on a to-do CommentsApi | tasksByTaskCommentsPost | POST /tasks/{task_id}/comments | Create a comment on a to-do CompetitorsApi | competitorsByIdGet | GET /competitors/{id} | Get a specific competitor CompetitorsApi | productsByProductCompetitorsByIdDelete | DELETE /products/{product_id}/competitors/{id} | Delete a competitor CompetitorsApi | productsByProductCompetitorsByIdPut | PUT /products/{product_id}/competitors/{id} | Update a competitor CompetitorsApi | productsByProductCompetitorsGet | GET /products/{product_id}/competitors | List competitors in a product CompetitorsApi | productsByProductCompetitorsPost | POST /products/{product_id}/competitors | Create a competitor CreativeBriefsApi | creativeBriefsByIdGet | GET /creative_briefs/{id} | Get a specific creative_brief CreativeBriefsApi | productsByProductCreativeBriefsByIdDelete | DELETE /products/{product_id}/creative_briefs/{id} | Delete a creative brief CreativeBriefsApi | productsByProductCreativeBriefsByIdPut | PUT /products/{product_id}/creative_briefs/{id} | Update a creative brief CreativeBriefsApi | productsByProductCreativeBriefsGet | GET /products/{product_id}/creative_briefs | List creative briefs in a product CreativeBriefsApi | productsByProductCreativeBriefsPost | POST /products/{product_id}/creative_briefs | Create a creative brief CustomFieldOptionsApi | customFieldDefinitionsByCustomFieldDefinitionCustomFieldOptionsByIdDelete | DELETE /custom_field_definitions/{custom_field_definition_id}/custom_field_options/{id} | Delete a custom field option CustomFieldOptionsApi | customFieldDefinitionsByCustomFieldDefinitionCustomFieldOptionsByIdPut | PUT /custom_field_definitions/{custom_field_definition_id}/custom_field_options/{id} | Update a custom field option CustomFieldOptionsApi | customFieldDefinitionsByCustomFieldDefinitionCustomFieldOptionsGet | GET /custom_field_definitions/{custom_field_definition_id}/custom_field_options | List all custom field options CustomFieldOptionsApi | customFieldDefinitionsByCustomFieldDefinitionCustomFieldOptionsPost | POST /custom_field_definitions/{custom_field_definition_id}/custom_field_options | Create a custom field option CustomFieldsApi | customFieldDefinitionsByCustomFieldDefinitionOptionsGet | GET /custom_field_definitions/{custom_field_definition_id}/options | List options for a custom field CustomFieldsApi | customFieldDefinitionsGet | GET /custom_field_definitions | List all custom fields CustomLayoutsApi | screenDefinitionsByIdGet | GET /screen_definitions/{id} | Get a custom layout by ID CustomLayoutsApi | screenDefinitionsGet | GET /screen_definitions | List all custom layouts CustomReportsApi | bookmarksCustomPivotsByReportGet | GET /bookmarks/custom_pivots/{report_id} | Get the list view of a saved report CustomTableRecordsApi | customObjectRecordsByIdDelete | DELETE /custom_object_records/{id} | Delete a custom table record CustomTableRecordsApi | customObjectRecordsByIdGet | GET /custom_object_records/{id} | Get a specific custom table record CustomTableRecordsApi | customObjectRecordsByIdPut | PUT /custom_object_records/{id} | Update a custom table record CustomTableRecordsApi | productsByProductCustomObjectsByKeyRecordsGet | GET /products/{product_id}/custom_objects/{key}/records | List records in a custom table for a product CustomTableRecordsApi | productsByProductCustomObjectsByKeyRecordsPost | POST /products/{product_id}/custom_objects/{key}/records | Create a custom table record DeletionsApi | deletionsByIdRestorePost | POST /deletions/{id}/restore | restore a specific record DeletionsApi | deletionsGet | GET /deletions | List contents of recycle bin DiscoveryGroupsApi | discoveryGroupsByIdDelete | DELETE /discovery_groups/{id} | Delete group DiscoveryGroupsApi | discoveryGroupsByIdGet | GET /discovery_groups/{id} | Get a specific group DiscoveryGroupsApi | discoveryGroupsByIdPut | PUT /discovery_groups/{id} | Update group DiscoveryGroupsApi | discoveryGroupsGet | GET /discovery_groups | List discovery groups DiscoveryGroupsApi | discoveryGroupsPost | POST /discovery_groups | Create a group EpicsApi | epicsByIdDelete | DELETE /epics/{id} | Delete an epic EpicsApi | epicsByIdGet | GET /epics/{id} | Get a specific epic EpicsApi | epicsByIdPut | PUT /epics/{id} | Update an epic EpicsApi | epicsGet | GET /epics | List epics EpicsApi | goalsByGoalEpicsGet | GET /goals/{goal_id}/epics | List epics associated with a goal EpicsApi | initiativesByInitiativeEpicsGet | GET /initiatives/{initiative_id}/epics | List epics associated with an initiative EpicsApi | productsByProductEpicsGet | GET /products/{product_id}/epics | List epics in a product EpicsApi | productsByProductEpicsPost | POST /products/{product_id}/epics | Create an epic in the default release EpicsApi | releasesByReleaseEpicsGet | GET /releases/{release_id}/epics | List epics in a release EpicsApi | releasesByReleaseEpicsPost | POST /releases/{release_id}/epics | Create an epic FeaturesApi | epicsByEpicFeaturesGet | GET /epics/{epic_id}/features | List features in an epic FeaturesApi | featuresByIdConvertToEpicPost | POST /features/{id}/convert_to_epic | Convert a feature to an epic FeaturesApi | featuresByIdDelete | DELETE /features/{id} | Delete a feature FeaturesApi | featuresByIdGet | GET /features/{id} | Get a specific feature FeaturesApi | featuresByIdPut | PUT /features/{id} | Update a feature FeaturesApi | featuresGet | GET /features | List features FeaturesApi | goalsByGoalFeaturesGet | GET /goals/{goal_id}/features | List features associated with a goal FeaturesApi | initiativesByInitiativeFeaturesGet | GET /initiatives/{initiative_id}/features | List features associated with an initiative FeaturesApi | productsByProductFeaturesGet | GET /products/{product_id}/features | List features in a product FeaturesApi | releasesByReleaseFeaturesGet | GET /releases/{release_id}/features | List features in a release FeaturesApi | releasesByReleaseFeaturesPost | POST /releases/{release_id}/features | Create a feature GoalsApi | goalsByIdGet | GET /goals/{id} | Get a specific goal GoalsApi | goalsByIdPut | PUT /goals/{id} | Update a goal GoalsApi | goalsGet | GET /goals | List goals GoalsApi | initiativesByInitiativeGoalsGet | GET /initiatives/{initiative_id}/goals | List goals associated with an initiative GoalsApi | productsByProductGoalsByIdDelete | DELETE /products/{product_id}/goals/{id} | Delete a goal GoalsApi | productsByProductGoalsByIdPut | PUT /products/{product_id}/goals/{id} | Update a goal GoalsApi | productsByProductGoalsGet | GET /products/{product_id}/goals | List goals in a product GoalsApi | productsByProductGoalsPost | POST /products/{product_id}/goals | Create a goal HistoricalAuditsApi | historicalAuditsGet | GET /historical_audits | Read the contents of the historical index HistoricalAuditsApi | historicalAuditsPost | POST /historical_audits | Create an audit search IdeaCategoriesApi | productsByProductIdeaCategoriesGet | GET /products/{product_id}/idea_categories | List idea categories in a product IdeaCategoriesApi | productsByProductIdeaCategoriesPost | POST /products/{product_id}/idea_categories | Create a nested idea category IdeaCommentsApi | ideaCommentsByIdPut | PUT /idea_comments/{id} | Mark an idea comment as spam IdeaCommentsApi | ideasByIdeaIdeaCommentsByIdDelete | DELETE /ideas/{idea_id}/idea_comments/{id} | Delete an idea comment IdeaCommentsApi | ideasByIdeaIdeaCommentsGet | GET /ideas/{idea_id}/idea_comments | List idea comments for an idea IdeaCommentsApi | ideasByIdeaIdeaCommentsPost | POST /ideas/{idea_id}/idea_comments | Create an idea comment created by an Aha! user (specified by id) IdeaOrganizationsApi | ideaOrganizationsByIdDelete | DELETE /idea_organizations/{id} | Delete organization IdeaOrganizationsApi | ideaOrganizationsByIdGet | GET /idea_organizations/{id} | Get a specific organization IdeaOrganizationsApi | ideaOrganizationsByIdPut | PUT /idea_organizations/{id} | Update a idea organization IdeaOrganizationsApi | ideaOrganizationsGet | GET /idea_organizations | List idea organizations IdeaOrganizationsApi | ideaOrganizationsPost | POST /idea_organizations | Create an idea organization IdeaPortalsApi | ideaPortalsGet | GET /idea_portals | List all idea portals in an account IdeaPortalsApi | productsByProductIdeaPortalsGet | GET /products/{product_id}/idea_portals | List idea portals in a product IdeaPortalsApi | productsByProductIdeaPortalsPost | POST /products/{product_id}/idea_portals | Add idea portals to a product IdeaPortalsApi | productsByProductIdeaPortalsPut | PUT /products/{product_id}/idea_portals | Replace the idea portals linked to a product IdeaSubscriptionsApi | ideasByIdeaSubscriptionsByIdDelete | DELETE /ideas/{idea_id}/subscriptions/{id} | Delete an idea subscription IdeaSubscriptionsApi | ideasByIdeaSubscriptionsByIdGet | GET /ideas/{idea_id}/subscriptions/{id} | Get a specific subscription for an idea IdeaSubscriptionsApi | ideasByIdeaSubscriptionsGet | GET /ideas/{idea_id}/subscriptions | List subscriptions for an idea IdeaSubscriptionsApi | ideasByIdeaSubscriptionsPost | POST /ideas/{idea_id}/subscriptions | Create an idea subscription IdeaThemesApi | ideaThemesByIdDelete | DELETE /idea_themes/{id} | Delete an idea theme IdeaThemesApi | ideaThemesByIdGet | GET /idea_themes/{id} | Get a specific idea theme IdeaThemesApi | ideaThemesByIdPut | PUT /idea_themes/{id} | Update an idea theme IdeaThemesApi | ideaThemesGet | GET /idea_themes | List idea themes IdeaThemesApi | ideaThemesPost | POST /idea_themes | Create an idea theme IdeaUsersApi | ideaUsersByIdDelete | DELETE /idea_users/{id} | Delete an idea user IdeaUsersApi | ideaUsersByIdGet | GET /idea_users/{id} | Get a specific idea user IdeaUsersApi | ideaUsersByIdPut | PUT /idea_users/{id} | Remove an idea user's discovery_groups IdeaUsersApi | ideaUsersGet | GET /idea_users | List idea users for an account IdeaUsersApi | ideaUsersPost | POST /idea_users | Create a idea user IdeaVotesApi | ideaOrganizationsByIdeaOrganizationEndorsementsGet | GET /idea_organizations/{idea_organization_id}/endorsements | List votes for an organization IdeaVotesApi | ideasByIdeaEndorsementsByIdDelete | DELETE /ideas/{idea_id}/endorsements/{id} | Delete an idea vote IdeaVotesApi | ideasByIdeaEndorsementsByIdGet | GET /ideas/{idea_id}/endorsements/{id} | Get a specific vote for an idea IdeaVotesApi | ideasByIdeaEndorsementsByIdPut | PUT /ideas/{idea_id}/endorsements/{id} | Update an idea vote IdeaVotesApi | ideasByIdeaEndorsementsGet | GET /ideas/{idea_id}/endorsements | Get all related idea organizations for votes associated with an idea IdeaVotesApi | ideasByIdeaEndorsementsPost | POST /ideas/{idea_id}/endorsements | Create a proxy vote IdeaVotesApi | ideasEndorsementsGet | GET /ideas/endorsements | List votes for an account IdeasApi | ideasByIdDelete | DELETE /ideas/{id} | Delete an idea IdeasApi | ideasByIdGet | GET /ideas/{id} | Get a specific idea IdeasApi | ideasByIdPromotePut | PUT /ideas/{id}/promote | Promote an idea IdeasApi | ideasByIdPut | PUT /ideas/{id} | Update a idea IdeasApi | ideasGet | GET /ideas | List ideas IdeasApi | ideasRelatedGet | GET /ideas/related | List ideas related to a particular term IdeasApi | productsByProductIdeasGet | GET /products/{product_id}/ideas | List ideas for a product IdeasApi | productsByProductIdeasPost | POST /products/{product_id}/ideas | Create an idea IdeasPortalUserSubscriptionsApi | ideaPortalsByIdeaPortalPortalUsersByPortalUserPortalUserSubscriptionsGet | GET /idea_portals/{idea_portal_id}/portal_users/{portal_user_id}/portal_user_subscriptions | List a portal user's preferences for the portal summary email IdeasPortalUserSubscriptionsApi | ideaPortalsByIdeaPortalPortalUsersByPortalUserPortalUserSubscriptionsPost | POST /idea_portals/{idea_portal_id}/portal_users/{portal_user_id}/portal_user_subscriptions | Set a portal user's preferences to specific categories IdeasPortalUserSubscriptionsApi | ideaPortalsByIdeaPortalPortalUsersByPortalUserPortalUserSubscriptionsSubscribeToAllPost | POST /idea_portals/{idea_portal_id}/portal_users/{portal_user_id}/portal_user_subscriptions/subscribe_to_all | Subscribe a portal user to updates from all projects and categories IdeasPortalUsersApi | ideaPortalsByIdeaPortalPortalUsersByIdDelete | DELETE /idea_portals/{idea_portal_id}/portal_users/{id} | Delete a portal user IdeasPortalUsersApi | ideaPortalsByIdeaPortalPortalUsersByIdGet | GET /idea_portals/{idea_portal_id}/portal_users/{id} | Get a specific portal user IdeasPortalUsersApi | ideaPortalsByIdeaPortalPortalUsersByIdPut | PUT /idea_portals/{idea_portal_id}/portal_users/{id} | Unsubscribe portal user from all communications IdeasPortalUsersApi | ideaPortalsByIdeaPortalPortalUsersGet | GET /idea_portals/{idea_portal_id}/portal_users | List portal users for a specific idea user IdeasPortalUsersApi | ideaPortalsByIdeaPortalPortalUsersPost | POST /idea_portals/{idea_portal_id}/portal_users | Create a portal user IdeasPortalUsersApi | portalUsersByIdGet | GET /portal_users/{id} | Get a specific portal user in the account IdeasPortalUsersApi | portalUsersGet | GET /portal_users | List all portal users in the account IdentityProvidersApi | identityProvidersByIdGet | GET /identity_providers/{id} | Get a specific identity provider IdentityProvidersApi | identityProvidersGet | GET /identity_providers | List active identity providers that can be used for SSO InitiativesApi | goalsByGoalInitiativesGet | GET /goals/{goal_id}/initiatives | List initiatives associated with a goal InitiativesApi | initiativesByIdGet | GET /initiatives/{id} | Get a specific initiative InitiativesApi | initiativesByIdPut | PUT /initiatives/{id} | Update a initiative InitiativesApi | initiativesGet | GET /initiatives | List initiatives InitiativesApi | productsByProductInitiativesByIdDelete | DELETE /products/{product_id}/initiatives/{id} | Delete an initiative InitiativesApi | productsByProductInitiativesByIdPut | PUT /products/{product_id}/initiatives/{id} | Update an initiative InitiativesApi | productsByProductInitiativesGet | GET /products/{product_id}/initiatives | List initiatives in a product InitiativesApi | productsByProductInitiativesPost | POST /products/{product_id}/initiatives | Create an initiative IntegrationChangeJobsApi | integrationChangeJobsByIdGet | GET /integration_change_jobs/{id} | Get a successfully completed job IntegrationChangesApi | integrationChangesPost | POST /integration_changes | Send a record to an integration IntegrationFieldsApi | epicsByEpicIntegrationsByIntegrationFieldsPost | POST /epics/{epic_id}/integrations/{integration_id}/fields | Create an integration field for a epic by integration ID IntegrationFieldsApi | epicsFieldsByFieldNameValueByFieldValueGet | GET /epics/fields/{field_name}/value/{field_value} | List epics with an associated integration field value IntegrationFieldsApi | featuresByFeatureIntegrationsByIntegrationFieldsByFieldNameGet | GET /features/{feature_id}/integrations/{integration_id}/fields/{field_name} | Get a specific integration field value IntegrationFieldsApi | featuresByFeatureIntegrationsByIntegrationFieldsPost | POST /features/{feature_id}/integrations/{integration_id}/fields | Create an integration field for a feature by integration ID IntegrationFieldsApi | featuresFieldsByFieldNameValueByFieldValueGet | GET /features/fields/{field_name}/value/{field_value} | List features with an associated integration field value IntegrationFieldsApi | ideaEndorsementsByIdeaEndorsementIntegrationsByIntegrationFieldsPost | POST /idea_endorsements/{idea_endorsement_id}/integrations/{integration_id}/fields | Create an integration field for an idea vote IntegrationFieldsApi | ideaEndorsementsFieldsByFieldNameValueByFieldValueGet | GET /idea_endorsements/fields/{field_name}/value/{field_value} | List idea votes with an associated integration field value IntegrationFieldsApi | ideaUsersByIdeaUserIntegrationsByIntegrationFieldsPost | POST /idea_users/{idea_user_id}/integrations/{integration_id}/fields | Create an integration field for an idea user IntegrationFieldsApi | ideasByIdeaIntegrationsByIntegrationFieldsPost | POST /ideas/{idea_id}/integrations/{integration_id}/fields | Create an integration field for an idea by integration ID IntegrationFieldsApi | ideasFieldsByFieldNameValueByFieldValueGet | GET /ideas/fields/{field_name}/value/{field_value} | List ideas with an associated integration field value IntegrationFieldsApi | initiativesFieldsByFieldNameValueByFieldValueGet | GET /initiatives/fields/{field_name}/value/{field_value} | List initiatives with an associated integration field value IntegrationFieldsApi | integrationFieldsByIdDelete | DELETE /integration_fields/{id} | Delete an integration field IntegrationFieldsApi | integrationsByIntegrationFieldsByFieldNameValueByFieldValueGet | GET /integrations/{integration_id}/fields/{field_name}/value/{field_value} | List records with an associated integration field value IntegrationFieldsApi | releasesFieldsByFieldNameValueByFieldValueGet | GET /releases/fields/{field_name}/value/{field_value} | List releases with an associated integration field value IntegrationFieldsApi | requirementsFieldsByFieldNameValueByFieldValueGet | GET /requirements/fields/{field_name}/value/{field_value} | List requirements with an associated integration field value IntegrationsApi | integrationsGet | GET /integrations | List integrations for an account IntegrationsApi | integrationsPost | POST /integrations | Create an integration for an account IntegrationsApi | productsByProductIntegrationsByIntegrationGet | GET /products/{product_id}/integrations/{integration_id} | Get a specific integration IntegrationsApi | productsByProductIntegrationsByIntegrationPut | PUT /products/{product_id}/integrations/{integration_id} | Enable integration IntegrationsApi | productsByProductIntegrationsGet | GET /products/{product_id}/integrations | List integrations for a product IntegrationsApi | productsByProductIntegrationsPost | POST /products/{product_id}/integrations | Create an integration based on a template for a product KeyResultsApi | goalsByGoalKeyResultsGet | GET /goals/{goal_id}/key_results | List key results for a goal KeyResultsApi | goalsByGoalKeyResultsPost | POST /goals/{goal_id}/key_results | Create a key result KeyResultsApi | keyResultsByIdDelete | DELETE /key_results/{id} | Delete a key result KeyResultsApi | keyResultsByIdGet | GET /key_results/{id} | Get a specific key result KeyResultsApi | keyResultsByIdPut | PUT /key_results/{id} | Update a key result KnowledgeBasePagesApi | knowledgeBasesByKnowledgeBasePagesByIdGet | GET /knowledge_bases/{knowledge_base_id}/pages/{id} | Get a specific published document KnowledgeBasePagesApi | knowledgeBasesByKnowledgeBasePagesGet | GET /knowledge_bases/{knowledge_base_id}/pages | List published documents for a knowledge base KnowledgeBasesApi | knowledgeBasesByIdGet | GET /knowledge_bases/{id} | Get a specific knowledge base MeApi | meAssignedGet | GET /me/assigned | Handle invalid record type filter MeApi | meGet | GET /me | Get the current user profile MeApi | meTasksGet | GET /me/tasks | List pending tasks assigned to the current user NotesApi | pagesByIdDelete | DELETE /pages/{id} | Delete a note NotesApi | pagesByIdGet | GET /pages/{id} | Get a specific note NotesApi | pagesByIdPublishPost | POST /pages/{id}/publish | Publish a note to knowledge bases NotesApi | pagesByIdPut | PUT /pages/{id} | Update a note NotesApi | pagesByIdUnpublishPost | POST /pages/{id}/unpublish | Unpublish a note from knowledge bases NotesApi | productsByProductPagesGet | GET /products/{product_id}/pages | List notes for a product NotesApi | productsByProductPagesPost | POST /products/{product_id}/pages | Create a note PaidSeatGroupsApi | paidSeatGroupsByIdModifyUserPost | POST /paid_seat_groups/{id}/modify_user | Adds the user to the paid seat group PaidSeatGroupsApi | paidSeatGroupsByIdPut | PUT /paid_seat_groups/{id} | Updates the paid seat group PaidSeatGroupsApi | paidSeatGroupsGet | GET /paid_seat_groups | List the administered paid seat groups PersonasApi | personasByIdGet | GET /personas/{id} | Get a specific persona PersonasApi | productsByProductPersonasByIdDelete | DELETE /products/{product_id}/personas/{id} | Delete a persona PersonasApi | productsByProductPersonasByIdPut | PUT /products/{product_id}/personas/{id} | Update a persona PersonasApi | productsByProductPersonasGet | GET /products/{product_id}/personas | List personas in a product PersonasApi | productsByProductPersonasPost | POST /products/{product_id}/personas | Create a persona ProductsApi | productsByIdGet | GET /products/{id} | Get a product with its applied workspace template ProductsApi | productsByIdPut | PUT /products/{id} | Update a product ProductsApi | productsGet | GET /products | List products (including Aha! Develop teams in the account) ProductsApi | productsPost | POST /products | Create a product RecordLinksApi | byRecordTypeByIdRecordLinksPost | POST /{record_type}/{id}/record_links | Create a record link for a epic RecordLinksApi | featuresByIdRecordLinksGet | GET /features/{id}/record_links | List record links for a feature RecordLinksApi | recordLinksByIdDelete | DELETE /record_links/{id} | Delete a record link RecordLinksApi | recordLinksByIdGet | GET /record_links/{id} | Get a specific record link ReleasePhasesApi | releasePhasesByIdDelete | DELETE /release_phases/{id} | Delete a release phase ReleasePhasesApi | releasePhasesByIdGet | GET /release_phases/{id} | Get a specific release phase ReleasePhasesApi | releasePhasesByIdPut | PUT /release_phases/{id} | Update a release phase ReleasePhasesApi | releasePhasesGet | GET /release_phases | List release phases in the account ReleasePhasesApi | releasePhasesPost | POST /release_phases | Create a release milestone ReleasePhasesApi | releasesByIdReleasePhasesGet | GET /releases/{id}/release_phases | List release phases for a release ReleasesApi | goalsByGoalReleasesGet | GET /goals/{goal_id}/releases | List releases associated with a goal ReleasesApi | initiativesByInitiativeReleasesGet | GET /initiatives/{initiative_id}/releases | List releases associated with an initiative ReleasesApi | productsByProductReleasesByIdDelete | DELETE /products/{product_id}/releases/{id} | Delete a release ReleasesApi | productsByProductReleasesByIdPut | PUT /products/{product_id}/releases/{id} | Add a release to a roll up release ReleasesApi | productsByProductReleasesGet | GET /products/{product_id}/releases | List releases in a product ReleasesApi | productsByProductReleasesPost | POST /products/{product_id}/releases | Create a parking lot release ReleasesApi | releasesByIdDuplicatePost | POST /releases/{id}/duplicate | Duplicate a release ReleasesApi | releasesByIdGet | GET /releases/{id} | Get a specific release ReleasesApi | releasesByIdPut | PUT /releases/{id} | Update a release ReleasesApi | releasesByReleaseReleasesGet | GET /releases/{release_id}/releases | List releases under a roll-up release ReleasesApi | rollUpReleasesByReleaseReleasesGet | GET /roll_up_releases/{release_id}/releases | List releases under a roll-up release RequirementsApi | featuresByFeatureRequirementsGet | GET /features/{feature_id}/requirements | Get requirements updated after a certain time RequirementsApi | featuresByFeatureRequirementsPost | POST /features/{feature_id}/requirements | Create a requirement RequirementsApi | requirementsByIdConvertToFeaturePost | POST /requirements/{id}/convert_to_feature | Convert a requirement to a feature RequirementsApi | requirementsByIdDelete | DELETE /requirements/{id} | Delete a requirement RequirementsApi | requirementsByIdGet | GET /requirements/{id} | Get a specific requirement RequirementsApi | requirementsByIdPut | PUT /requirements/{id} | Update a requirement RollUpReleasesApi | productsByProductRollUpReleasesGet | GET /products/{product_id}/roll_up_releases | List roll up releases in a product RollUpReleasesApi | productsByProductRollUpReleasesPost | POST /products/{product_id}/roll_up_releases | Create a project with a roll up release RollUpReleasesApi | rollUpReleasesByIdGet | GET /roll_up_releases/{id} | Get a specific roll up release RollUpReleasesApi | rollUpReleasesByIdPut | PUT /roll_up_releases/{id} | Add a project to a roll up release SchedulableChangesApi | schedulableChangesByIdDelete | DELETE /schedulable_changes/{id} | Delete a schedulable change SchedulableChangesApi | schedulableChangesByIdPut | PUT /schedulable_changes/{id} | Update a schedulable change SchedulableChangesApi | schedulableChangesBySchedulableChangeUpdateTeamMembershipsPut | PUT /schedulable_changes/{schedulable_change_id}/update_team_memberships | Update a scheduled change's team memberships SchedulableChangesApi | schedulableChangesGet | GET /schedulable_changes | List schedulable changes SchedulableChangesApi | schedulableChangesPost | POST /schedulable_changes | Create a schedulable change SchedulesApi | schedulesGet | GET /schedules | List schedules StrategicModelsApi | strategyModelsByIdGet | GET /strategy_models/{id} | Get a specific strategic model StrategicModelsApi | strategyModelsGet | GET /strategy_models | List strategic models StrategicPositioningsApi | strategyPositionsByIdGet | GET /strategy_positions/{id} | Get a specific strategic positioning StrategicPositioningsApi | strategyPositionsGet | GET /strategy_positions | List strategic positionings StrategicVisionsApi | strategyVisionsByIdGet | GET /strategy_visions/{id} | Get a specific strategic vision StrategicVisionsApi | strategyVisionsGet | GET /strategy_visions | List strategic visions TeamMembersApi | teamMembersByIdDelete | DELETE /team_members/{id} | Delete a virtual team member TeamMembersApi | teamMembersGet | GET /team_members | List virtual team members TeamMembersApi | teamMembersPost | POST /team_members | Create a virtual user TeamMembershipsApi | teamsByTeamTeamMembershipsByIdDelete | DELETE /teams/{team_id}/team_memberships/{id} | Remove a user from a team TeamMembershipsApi | teamsByTeamTeamMembershipsGet | GET /teams/{team_id}/team_memberships | List team memberships for a team TeamMembershipsApi | teamsByTeamTeamMembershipsPost | POST /teams/{team_id}/team_memberships | Add user to a team TeamsApi | productsByProductTeamsGet | GET /products/{product_id}/teams | List teams in a product TeamsApi | productsByProductTeamsPost | POST /products/{product_id}/teams | Create a team associated with a product TeamsApi | teamsByIdDelete | DELETE /teams/{id} | Delete a team TeamsApi | teamsByIdGet | GET /teams/{id} | Get a specific team TeamsApi | teamsByIdPut | PUT /teams/{id} | Automatically calculate team's member count TeamsApi | teamsGet | GET /teams | List teams TeamsApi | teamsPost | POST /teams | Create a team TimeTrackingEventsApi | featuresByFeatureTimeTrackingEventsPost | POST /features/{feature_id}/time_tracking_events | Create a time tracking event for a feature with remaining estimate TimeTrackingEventsApi | initiativesByInitiativeTimeTrackingEventsPost | POST /initiatives/{initiative_id}/time_tracking_events | Create a time tracking event for an initiative TimeTrackingEventsApi | requirementsByRequirementTimeTrackingEventsPost | POST /requirements/{requirement_id}/time_tracking_events | Create a time tracking event for a requirement TimeTrackingEventsApi | timeTrackingEventsByIdDelete | DELETE /time_tracking_events/{id} | Delete a time tracking event ToDosApi | epicsByEpicTasksGet | GET /epics/{epic_id}/tasks | List to-dos associated with an epic ToDosApi | featuresByFeatureTasksGet | GET /features/{feature_id}/tasks | List to-dos associated with a feature ToDosApi | ideasByIdeaTasksGet | GET /ideas/{idea_id}/tasks | List to-dos associated with an idea ToDosApi | productsByProductTasksGet | GET /products/{product_id}/tasks | List to-dos associated with a product ToDosApi | releasesByReleaseTasksGet | GET /releases/{release_id}/tasks | List to-dos associated with a release ToDosApi | requirementsByRequirementTasksGet | GET /requirements/{requirement_id}/tasks | List to-dos associated with a requirement ToDosApi | tasksByIdDelete | DELETE /tasks/{id} | Delete a to-do ToDosApi | tasksByIdGet | GET /tasks/{id} | Get a specific to-do ToDosApi | tasksByIdPut | PUT /tasks/{id} | Update a to-do ToDosApi | tasksGet | GET /tasks | Get tasks updated after a certain time ToDosApi | tasksPost | POST /tasks | Create a task ToDosApi | usersByUserTasksGet | GET /users/{user_id}/tasks | List to-dos assigned to a user UsersApi | productsByProductUsersGet | GET /products/{product_id}/users | List users associated with a product UsersApi | productsByProductUsersPost | POST /products/{product_id}/users | Create a contributor user UsersApi | usersByIdGet | GET /users/{id} | Get a specific user UsersApi | usersByIdProductRolesByProductDelete | DELETE /users/{id}/product_roles/{product_id} | Delete a user's product role UsersApi | usersByIdProductRolesGet | GET /users/{id}/product_roles | List a user's product roles UsersApi | usersByIdProductRolesPost | POST /users/{id}/product_roles | Update a user's product roles UsersApi | usersByIdPut | PUT /users/{id} | Update a user UsersApi | usersByIdUserRolesByProductDelete | DELETE /users/{id}/user_roles/{product_id} | Delete a user's custom role UsersApi | usersByIdUserRolesGet | GET /users/{id}/user_roles | List a user's custom roles UsersApi | usersByIdUserRolesPost | POST /users/{id}/user_roles | Update a user's custom roles UsersApi | usersGet | GET /users | List users WebhooksApi | webhooksByTokenGet | GET /webhooks/{token} | Validate webhook endpoint WebhooksApi | webhooksByTokenPost | POST /webhooks/{token} | Handle Asana resthook confirmation WorkflowStatusTimesApi | epicsByEpicWorkflowStatusTimesGet | GET /epics/{epic_id}/workflow_status_times | List workflow status times for an epic WorkflowStatusTimesApi | epicsByEpicWorkflowStatusTimesPost | POST /epics/{epic_id}/workflow_status_times | Create a workflow status time for an epic WorkflowStatusTimesApi | featuresByFeatureWorkflowStatusTimesGet | GET /features/{feature_id}/workflow_status_times | List workflow status times for a feature WorkflowStatusTimesApi | featuresByFeatureWorkflowStatusTimesPost | POST /features/{feature_id}/workflow_status_times | Create a workflow status time for a feature WorkflowStatusTimesApi | ideasByIdeaWorkflowStatusTimesGet | GET /ideas/{idea_id}/workflow_status_times | List workflow status times for an idea WorkflowStatusTimesApi | ideasByIdeaWorkflowStatusTimesPost | POST /ideas/{idea_id}/workflow_status_times | Create a workflow status time for an idea WorkflowStatusTimesApi | initiativesByInitiativeWorkflowStatusTimesGet | GET /initiatives/{initiative_id}/workflow_status_times | List workflow status times for an initiative WorkflowStatusTimesApi | initiativesByInitiativeWorkflowStatusTimesPost | POST /initiatives/{initiative_id}/workflow_status_times | Create a workflow status time for an initiative WorkflowStatusTimesApi | keyResultsByKeyResultWorkflowStatusTimesGet | GET /key_results/{key_result_id}/workflow_status_times | List workflow status times for a key result WorkflowStatusTimesApi | keyResultsByKeyResultWorkflowStatusTimesPost | POST /key_results/{key_result_id}/workflow_status_times | Create a workflow status time for a key result WorkflowStatusTimesApi | masterFeaturesByMasterFeatureWorkflowStatusTimesGet | GET /master_features/{master_feature_id}/workflow_status_times | List workflow status times for a master feature WorkflowStatusTimesApi | masterFeaturesByMasterFeatureWorkflowStatusTimesPost | POST /master_features/{master_feature_id}/workflow_status_times | Create a workflow status time for a master feature WorkflowStatusTimesApi | pagesByPageWorkflowStatusTimesGet | GET /pages/{page_id}/workflow_status_times | List workflow status times for a page WorkflowStatusTimesApi | pagesByPageWorkflowStatusTimesPost | POST /pages/{page_id}/workflow_status_times | Create a workflow status time for a page WorkflowStatusTimesApi | releasesByReleaseWorkflowStatusTimesGet | GET /releases/{release_id}/workflow_status_times | List workflow status times for a release WorkflowStatusTimesApi | releasesByReleaseWorkflowStatusTimesPost | POST /releases/{release_id}/workflow_status_times | Create a workflow status time for a release WorkflowStatusTimesApi | requirementsByRequirementWorkflowStatusTimesGet | GET /requirements/{requirement_id}/workflow_status_times | List workflow status times for a requirement WorkflowStatusTimesApi | requirementsByRequirementWorkflowStatusTimesPost | POST /requirements/{requirement_id}/workflow_status_times | Create a workflow status time for a requirement WorkflowStatusTimesApi | workflowStatusTimesByIdDelete | DELETE /workflow_status_times/{id} | Delete a workflow status time WorkflowStatusTimesApi | workflowStatusTimesByIdGet | GET /workflow_status_times/{id} | Get a single workflow status time WorkflowStatusTimesApi | workflowStatusTimesByIdPut | PUT /workflow_status_times/{id} | Update a workflow status time WorkflowsApi | productsByProductWorkflowsGet | GET /products/{product_id}/workflows | List workflows WorkflowsApi | workflowsByIdGet | GET /workflows/{id} | Get a specific workflow

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

@cedricziel/[email protected]

Building

Publishing

Consuming

Documentation for API Endpoints

Documentation For Models