Comment

(comment)

Overview

Available Operations

create_kms_comment - Create a comment
create_task_comment - Create a comment
get_kms_comment - Retrieve a comment
get_task_comment - Retrieve a comment
list_kms_comments - List all comments
list_task_comments - List all comments
patch_kms_comment - Update a comment
patch_task_comment - Update a comment
remove_kms_comment - Remove a comment
remove_task_comment - Remove a comment
update_kms_comment - Update a comment
update_task_comment - Update a comment

create_kms_comment

Create a comment

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.comment.create_kms_comment(connection_id="<id>", kms_comment=::UnifiedRubySDK::Shared::KmsComment.new(
  content: "<value>",
), fields_=[
  "<value>",
])

if ! res.kms_comment.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`kms_comment`	T.nilable(::UnifiedRubySDK::Shared::KmsComment)	➖	N/A
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::CreateKmsCommentResponse)

create_task_comment

Create a comment

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.comment.create_task_comment(connection_id="<id>", task_comment=::UnifiedRubySDK::Shared::TaskComment.new(
  task_id: "<id>",
  text: "<value>",
), fields_=[
  "<value>",
])

if ! res.task_comment.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`task_comment`	T.nilable(::UnifiedRubySDK::Shared::TaskComment)	➖	N/A
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::CreateTaskCommentResponse)

get_kms_comment

Retrieve a comment

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.comment.get_kms_comment(connection_id="<id>", id="<id>", fields_=[
  "<value>",
])

if ! res.kms_comment.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Comment
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::GetKmsCommentResponse)

get_task_comment

Retrieve a comment

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.comment.get_task_comment(connection_id="<id>", id="<id>", fields_=[
  "<value>",
])

if ! res.task_comment.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Comment
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::GetTaskCommentResponse)

list_kms_comments

List all comments

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)


req = ::UnifiedRubySDK::Operations::ListKmsCommentsRequest.new(
  connection_id: "<id>",
)
    
res = s.comment.list_kms_comments(req)

if ! res.kms_comments.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	::UnifiedRubySDK::Operations::ListKmsCommentsRequest	✔️	The request object to use for the request.

Response

T.nilable(::UnifiedRubySDK::Operations::ListKmsCommentsResponse)

list_task_comments

List all comments

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)


req = ::UnifiedRubySDK::Operations::ListTaskCommentsRequest.new(
  connection_id: "<id>",
)
    
res = s.comment.list_task_comments(req)

if ! res.task_comments.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`request`	::UnifiedRubySDK::Operations::ListTaskCommentsRequest	✔️	The request object to use for the request.

Response

T.nilable(::UnifiedRubySDK::Operations::ListTaskCommentsResponse)

patch_kms_comment

Update a comment

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.comment.patch_kms_comment(connection_id="<id>", id="<id>", kms_comment=::UnifiedRubySDK::Shared::KmsComment.new(
  content: "<value>",
), fields_=[
  "<value>",
])

if ! res.kms_comment.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Comment
`kms_comment`	T.nilable(::UnifiedRubySDK::Shared::KmsComment)	➖	N/A
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::PatchKmsCommentResponse)

patch_task_comment

Update a comment

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.comment.patch_task_comment(connection_id="<id>", id="<id>", task_comment=::UnifiedRubySDK::Shared::TaskComment.new(
  task_id: "<id>",
  text: "<value>",
), fields_=[
  "<value>",
])

if ! res.task_comment.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Comment
`task_comment`	T.nilable(::UnifiedRubySDK::Shared::TaskComment)	➖	N/A
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::PatchTaskCommentResponse)

remove_kms_comment

Remove a comment

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.comment.remove_kms_comment(connection_id="<id>", id="<id>")

if res.status_code == 200
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Comment

Response

T.nilable(::UnifiedRubySDK::Operations::RemoveKmsCommentResponse)

remove_task_comment

Remove a comment

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.comment.remove_task_comment(connection_id="<id>", id="<id>")

if res.status_code == 200
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Comment

Response

T.nilable(::UnifiedRubySDK::Operations::RemoveTaskCommentResponse)

update_kms_comment

Update a comment

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.comment.update_kms_comment(connection_id="<id>", id="<id>", kms_comment=::UnifiedRubySDK::Shared::KmsComment.new(
  content: "<value>",
), fields_=[
  "<value>",
])

if ! res.kms_comment.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Comment
`kms_comment`	T.nilable(::UnifiedRubySDK::Shared::KmsComment)	➖	N/A
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::UpdateKmsCommentResponse)

update_task_comment

Update a comment

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.comment.update_task_comment(connection_id="<id>", id="<id>", task_comment=::UnifiedRubySDK::Shared::TaskComment.new(
  task_id: "<id>",
  text: "<value>",
), fields_=[
  "<value>",
])

if ! res.task_comment.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
`connection_id`	::String	✔️	ID of the connection
`id`	::String	✔️	ID of the Comment
`task_comment`	T.nilable(::UnifiedRubySDK::Shared::TaskComment)	➖	N/A
`fields_`	T::Array<::String>	➖	Comma-delimited fields to return

Response

T.nilable(::UnifiedRubySDK::Operations::UpdateTaskCommentResponse)

Files

README.md

Latest commit

History

README.md

File metadata and controls

Comment

Overview

Available Operations

create_kms_comment

Example Usage

Parameters

Response

create_task_comment

Example Usage

Parameters

Response

get_kms_comment

Example Usage

Parameters

Response

get_task_comment

Example Usage

Parameters

Response

list_kms_comments

Example Usage

Parameters

Response

list_task_comments

Example Usage

Parameters

Response

patch_kms_comment

Example Usage

Parameters

Response

patch_task_comment

Example Usage

Parameters

Response

remove_kms_comment

Example Usage

Parameters

Response

remove_task_comment

Example Usage

Parameters

Response

update_kms_comment

Example Usage

Parameters

Response

update_task_comment

Example Usage

Parameters

Response