Conversations

(Conversations)

Overview

Operations related to Conversations

Available Operations

ListComments - List comments for a conversation
CreateComment - Create a comment for a conversation
GetComment - Get a conversation comment
DeleteComment - Delete a conversation comment
UpdateComment - Update a conversation comment
ListCommentReactions - List reactions for a conversation comment
CreateCommentReaction - Create a reaction for a conversation comment
DeleteCommentReaction - Delete a reaction from a conversation comment

ListComments

ALPHA - List all of the comments that have been added to the organization

Example Usage

package main

import(
	"firehydrant"
	"context"
	"log"
)

func main() {
    s := firehydrant.New(
        firehydrant.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    ctx := context.Background()
    res, err := s.Conversations.ListComments(ctx, "<id>", nil, nil, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`conversationID`	string	✔️	N/A
`before`	*time.Time	➖	An ISO8601 timestamp that allows filtering for comments posted before the provided time.
`after`	*time.Time	➖	An ISO8601 timestamp that allows filtering for comments posted after the provided time.
`sort`	*operations.Sort	➖	Allows sorting comments by the time they were posted, ascending or descending.
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.ListConversationCommentsResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
sdkerrors.Unauthorized	401, 403, 407, 511	application/json
sdkerrors.NotFound	404, 501, 505	application/json
sdkerrors.Timeout	408, 504	application/json
sdkerrors.RateLimited	429	application/json
sdkerrors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
sdkerrors.SDKError	4XX, 5XX	/

CreateComment

ALPHA - Creates a comment for a project

Example Usage

package main

import(
	"firehydrant"
	"context"
	"firehydrant/models/components"
	"log"
)

func main() {
    s := firehydrant.New(
        firehydrant.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    ctx := context.Background()
    res, err := s.Conversations.CreateComment(ctx, "<id>", components.PostV1ConversationsConversationIDComments{
        Body: "<value>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`conversationID`	string	✔️	N/A
`postV1ConversationsConversationIDComments`	components.PostV1ConversationsConversationIDComments	✔️	N/A
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.CreateConversationCommentResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
sdkerrors.Unauthorized	401, 403, 407, 511	application/json
sdkerrors.NotFound	404, 501, 505	application/json
sdkerrors.Timeout	408, 504	application/json
sdkerrors.RateLimited	429	application/json
sdkerrors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
sdkerrors.SDKError	4XX, 5XX	/

GetComment

ALPHA - Retrieves a single comment by ID

Example Usage

package main

import(
	"firehydrant"
	"context"
	"log"
)

func main() {
    s := firehydrant.New(
        firehydrant.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    ctx := context.Background()
    res, err := s.Conversations.GetComment(ctx, "<id>", "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`commentID`	string	✔️	N/A
`conversationID`	string	✔️	N/A
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.GetConversationCommentResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
sdkerrors.Unauthorized	401, 403, 407, 511	application/json
sdkerrors.NotFound	404, 501, 505	application/json
sdkerrors.Timeout	408, 504	application/json
sdkerrors.RateLimited	429	application/json
sdkerrors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
sdkerrors.SDKError	4XX, 5XX	/

DeleteComment

ALPHA - Archive a comment

Example Usage

package main

import(
	"firehydrant"
	"context"
	"log"
)

func main() {
    s := firehydrant.New(
        firehydrant.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    ctx := context.Background()
    res, err := s.Conversations.DeleteComment(ctx, "<id>", "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`commentID`	string	✔️	N/A
`conversationID`	string	✔️	N/A
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.DeleteConversationCommentResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
sdkerrors.Unauthorized	401, 403, 407, 511	application/json
sdkerrors.NotFound	404, 501, 505	application/json
sdkerrors.Timeout	408, 504	application/json
sdkerrors.RateLimited	429	application/json
sdkerrors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
sdkerrors.SDKError	4XX, 5XX	/

UpdateComment

ALPHA - Update a comment's attributes

Example Usage

package main

import(
	"firehydrant"
	"context"
	"firehydrant/models/components"
	"log"
)

func main() {
    s := firehydrant.New(
        firehydrant.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    ctx := context.Background()
    res, err := s.Conversations.UpdateComment(ctx, "<id>", "<id>", components.PatchV1ConversationsConversationIDCommentsCommentID{})
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`commentID`	string	✔️	N/A
`conversationID`	string	✔️	N/A
`patchV1ConversationsConversationIDCommentsCommentID`	components.PatchV1ConversationsConversationIDCommentsCommentID	✔️	N/A
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.UpdateConversationCommentResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
sdkerrors.Unauthorized	401, 403, 407, 511	application/json
sdkerrors.NotFound	404, 501, 505	application/json
sdkerrors.Timeout	408, 504	application/json
sdkerrors.RateLimited	429	application/json
sdkerrors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
sdkerrors.SDKError	4XX, 5XX	/

ListCommentReactions

ALPHA - List all of the reactions that have been added to a comment

Example Usage

package main

import(
	"firehydrant"
	"context"
	"log"
)

func main() {
    s := firehydrant.New(
        firehydrant.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    ctx := context.Background()
    res, err := s.Conversations.ListCommentReactions(ctx, "<id>", "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`conversationID`	string	✔️	N/A
`commentID`	string	✔️	N/A
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.ListConversationCommentReactionsResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
sdkerrors.Unauthorized	401, 403, 407, 511	application/json
sdkerrors.NotFound	404, 501, 505	application/json
sdkerrors.Timeout	408, 504	application/json
sdkerrors.RateLimited	429	application/json
sdkerrors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
sdkerrors.SDKError	4XX, 5XX	/

CreateCommentReaction

ALPHA - Create a reaction on a comment

Example Usage

package main

import(
	"firehydrant"
	"context"
	"firehydrant/models/components"
	"log"
)

func main() {
    s := firehydrant.New(
        firehydrant.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    ctx := context.Background()
    res, err := s.Conversations.CreateCommentReaction(ctx, "<id>", "<id>", components.PostV1ConversationsConversationIDCommentsCommentIDReactions{
        Reaction: "<value>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`conversationID`	string	✔️	N/A
`commentID`	string	✔️	N/A
`postV1ConversationsConversationIDCommentsCommentIDReactions`	components.PostV1ConversationsConversationIDCommentsCommentIDReactions	✔️	N/A
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.CreateConversationCommentReactionResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
sdkerrors.Unauthorized	401, 403, 407, 511	application/json
sdkerrors.NotFound	404, 501, 505	application/json
sdkerrors.Timeout	408, 504	application/json
sdkerrors.RateLimited	429	application/json
sdkerrors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
sdkerrors.SDKError	4XX, 5XX	/

DeleteCommentReaction

ALPHA - Archive a reaction

Example Usage

package main

import(
	"firehydrant"
	"context"
	"log"
)

func main() {
    s := firehydrant.New(
        firehydrant.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    ctx := context.Background()
    res, err := s.Conversations.DeleteCommentReaction(ctx, "<id>", "<id>", "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
`ctx`	context.Context	✔️	The context to use for the request.
`reactionID`	string	✔️	N/A
`conversationID`	string	✔️	N/A
`commentID`	string	✔️	N/A
`opts`	[]operations.Option	➖	The options for this request.

Response

*operations.DeleteConversationCommentReactionResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
sdkerrors.Unauthorized	401, 403, 407, 511	application/json
sdkerrors.NotFound	404, 501, 505	application/json
sdkerrors.Timeout	408, 504	application/json
sdkerrors.RateLimited	429	application/json
sdkerrors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
sdkerrors.SDKError	4XX, 5XX	/

Files

README.md

Latest commit

History

README.md

File metadata and controls

Conversations

Overview

Available Operations

ListComments

Example Usage

Parameters

Response

Errors

CreateComment

Example Usage

Parameters

Response

Errors

GetComment

Example Usage

Parameters

Response

Errors

DeleteComment

Example Usage

Parameters

Response

Errors

UpdateComment

Example Usage

Parameters

Response

Errors

ListCommentReactions

Example Usage

Parameters

Response

Errors

CreateCommentReaction

Example Usage

Parameters

Response

Errors

DeleteCommentReaction

Example Usage

Parameters

Response

Errors