Package se.bjurr.bitbucketcloud.gen.api

Interface AddonApi

@Path("/addon") @Generated(value="org.openapitools.codegen.languages.JavaJAXRSSpecServerCodegen", date="2025-07-17T16:07:08.420911588+02:00[Europe/Stockholm]", comments="Generator version: 7.14.0") public interface AddonApi
Represents a collection of functions to interact with the API endpoints.

  • Method Details

    • addonDelete

      @DELETE @Produces("application/json") Error addonDelete()
      Returns:
      Unexpected error.

    • addonLinkersGet

      @GET @Path("/linkers") @Produces("application/json") Error addonLinkersGet()
      Returns:
      Unexpected error.

    • addonLinkersLinkerKeyGet

      @GET @Path("/linkers/{linker_key}") @Produces("application/json") Error addonLinkersLinkerKeyGet(@PathParam("linker_key") String linkerKey)
      Parameters:
      linkerKey -
      Returns:
      Unexpected error.

    • addonLinkersLinkerKeyValuesDelete

      @DELETE @Path("/linkers/{linker_key}/values") @Produces("application/json") Error addonLinkersLinkerKeyValuesDelete(@PathParam("linker_key") String linkerKey)
      Parameters:
      linkerKey -
      Returns:
      Unexpected error.

    • addonLinkersLinkerKeyValuesDelete_1

      @DELETE @Path("/linkers/{linker_key}/values/") @Produces("application/json") Error addonLinkersLinkerKeyValuesDelete_1(@PathParam("linker_key") String linkerKey)
      Parameters:
      linkerKey -
      Returns:
      Unexpected error.

    • addonLinkersLinkerKeyValuesGet

      @GET @Path("/linkers/{linker_key}/values") @Produces("application/json") Error addonLinkersLinkerKeyValuesGet(@PathParam("linker_key") String linkerKey)
      Parameters:
      linkerKey -
      Returns:
      Unexpected error.

    • addonLinkersLinkerKeyValuesGet_2

      @GET @Path("/linkers/{linker_key}/values/") @Produces("application/json") Error addonLinkersLinkerKeyValuesGet_2(@PathParam("linker_key") String linkerKey)
      Parameters:
      linkerKey -
      Returns:
      Unexpected error.

    • addonLinkersLinkerKeyValuesPost

      @POST @Path("/linkers/{linker_key}/values") @Produces("application/json") Error addonLinkersLinkerKeyValuesPost(@PathParam("linker_key") String linkerKey)
      Parameters:
      linkerKey -
      Returns:
      Unexpected error.

    • addonLinkersLinkerKeyValuesPut

      @PUT @Path("/linkers/{linker_key}/values") @Produces("application/json") Error addonLinkersLinkerKeyValuesPut(@PathParam("linker_key") String linkerKey)
      Parameters:
      linkerKey -
      Returns:
      Unexpected error.

    • addonPut

      @PUT @Produces("application/json") Error addonPut()
      Returns:
      Unexpected error.

    • addonUsersTargetUserEventsEventKeyPost

      @POST @Path("/users/{target_user}/events/{event_key}") void addonUsersTargetUserEventsEventKeyPost(@PathParam("target_user") String targetUser, @PathParam("event_key") String eventKey)
      POST a new custom event. The data within the event body will be hydrated by Bitbucket. For example, the following event submission would result in subscribers for the event receiving the full repository object corresponding to the UUID. ``` $ curl -X POST -H \"Content-Type: application/json\" -d '{ \"mynumdata\": \"12345\", \"repository\": { \"type\": \"repository\", \"uuid\": \"{be95aa1f-c0b2-47f6-99d1-bf5d3a0f850f}\" }}' https://api.bitbucket.org/2.0/addon/users/myuser/events/com.example.app%3Amyevent ``` Use the optional `fields` property of the custom event Connect module where the event is defined to add additional fields to the expanded payload sent to listeners. For example, the `customEvents` module in the app descriptor for the previous example would look like this: ``` 'modules': { 'customEvents': { 'com.example.app:myevent': { 'schema': { 'properties': { 'mynumdata': {'type': 'number'}, 'repository': {'$ref': '#/definitions/repository'} } }, 'fields': ['repository.owner'] } } } ``` By specifying fields as above, the repository owner will also be sent to subscribers of the event.
      Parameters:
      targetUser - The account the app is installed in. This can either be the username or the UUID of the account, surrounded by curly-braces, for example: `{account UUID}`. An account is either a team or user.
      eventKey - The key of the event, which corresponds to an event defined in the connect app descriptor.