IdeaService

Index

Constructors

• constructor

Properties

• httpRequest

Methods

• ideaCreate
• ideaInfo
• ideaList
• ideaReactionCreate
• ideaReactionRemove
• ideaRemove

Constructors

constructor

• new IdeaService(httpRequest: BaseHttpRequest): IdeaService

• Parameters

  • httpRequest: BaseHttpRequest

  Returns IdeaService

Properties

publicreadonlyhttpRequest

httpRequest: BaseHttpRequest

Methods

publicideaCreate

• ideaCreate(__namedParameters: { requestBody: CreateIdeaParam }): CancelablePromise<{ data?: CreateIdeaResponse }>

• Create an idea Bot-compatible Creates a idea in a channel.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: CreateIdeaParam }

  Returns CancelablePromise<{ data?: CreateIdeaResponse }>

  any Successfully created the idea.

publicideaInfo

• ideaInfo(__namedParameters: { id: string }): CancelablePromise<{ data?: GetIdeaResponse }>

• Get an idea's information Bot-compatible Retrieves information about an idea.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { id: string }

  Returns CancelablePromise<{ data?: GetIdeaResponse }>

  any Successfully retrieved information about the idea.

publicideaList

• ideaList(__namedParameters: { channelId: string; limit?: number; offset?: string }): CancelablePromise<{ data?: GetIdeaListResponse }>

• List out ideas Bot-compatible Lists out a given number of ideas in a channel. This method uses the Swit API's pagination scheme.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { channelId: string; limit?: number; offset?: string }

  Returns CancelablePromise<{ data?: GetIdeaListResponse }>

  any Successfully retrieved the ideas.

publicideaReactionCreate

• ideaReactionCreate(__namedParameters: { requestBody: AddIdeaReactionParam }): CancelablePromise<{ data?: AddIdeaReactionResponse }>

• React to an idea Adds a reaction emoji to an idea.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: AddIdeaReactionParam }

  Returns CancelablePromise<{ data?: AddIdeaReactionResponse }>

  any Successfully added the reaction.

publicideaReactionRemove

• ideaReactionRemove(__namedParameters: { requestBody: DelIdeaReactionParam }): CancelablePromise<any>

• Remove a reaction emoji from an idea Removes a reaction emoji from an idea.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: DelIdeaReactionParam }

  Returns CancelablePromise<any>

  any Successfully removed the reaction.

publicideaRemove

• ideaRemove(__namedParameters: { requestBody: DelIdeaParam }): CancelablePromise<any>

• Delete an idea Bot-compatible Deletes an idea in a channel.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: DelIdeaParam }

  Returns CancelablePromise<any>

  any Successfully deleted the idea.