README.md

Actions

Overview

Retrieve Actions metadata and definitions.

Available Operations

• build_action_embeddings - Rebuild action embeddings for semantic search
• list_actions_meta - List all actions metadata
• rpc_action - Make an RPC call to an action
• search_actions - Search connector actions by semantic similarity

build_action_embeddings

Rebuild action embeddings for semantic search

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Shared::ActionBuildDto.new(
  connector_key: 'slack'
)
res = s.actions.build_action_embeddings(request: req)

unless res.action_build_response_dto.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
request	Models::Shared::ActionBuildDto	✔️	The request object to use for the request.

Response

T.nilable(Models::Operations::StackoneBuildActionEmbeddingsResponse)

Errors

Error Type	Status Code	Content Type
Models::Errors::BadRequestResponse	400	application/json
Models::Errors::UnauthorizedResponse	401	application/json
Models::Errors::ForbiddenResponse	403	application/json
Models::Errors::NotFoundResponse	404	application/json
Models::Errors::RequestTimedOutResponse	408	application/json
Models::Errors::ConflictResponse	409	application/json
Models::Errors::UnprocessableEntityResponse	422	application/json
Models::Errors::TooManyRequestsResponse	429	application/json
Models::Errors::InternalServerErrorResponse	500	application/json
Models::Errors::NotImplementedResponse	501	application/json
Models::Errors::BadGatewayResponse	502	application/json
Errors::APIError	4XX, 5XX	*/*

list_actions_meta

Retrieves a list of all actions metadata

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Operations::StackoneListActionsMetaRequest.new(
  exclude: [
    Models::Operations::Exclude::ACTIONS,
  ],
  filter: Models::Operations::Filter.new(
    account_ids: 'account1,account2',
    action_key: 'action1',
    connectors: 'connector1,connector2'
  ),
  group_by: '["connector"]',
  include: [
    Models::Operations::Include::ACTION_DETAILS,
  ],
  search: 'employee'
)
res = s.actions.list_actions_meta(request: req)

unless res.actions_meta_paginated.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
request	Models::Operations::StackoneListActionsMetaRequest	✔️	The request object to use for the request.

Response

T.nilable(Models::Operations::StackoneListActionsMetaResponse)

Errors

Error Type	Status Code	Content Type
Models::Errors::BadRequestResponse	400	application/json
Models::Errors::UnauthorizedResponse	401	application/json
Models::Errors::ForbiddenResponse	403	application/json
Models::Errors::NotFoundResponse	404	application/json
Models::Errors::RequestTimedOutResponse	408	application/json
Models::Errors::ConflictResponse	409	application/json
Models::Errors::UnprocessableEntityResponse	422	application/json
Models::Errors::TooManyRequestsResponse	429	application/json
Models::Errors::InternalServerErrorResponse	500	application/json
Models::Errors::NotImplementedResponse	501	application/json
Models::Errors::BadGatewayResponse	502	application/json
Errors::APIError	4XX, 5XX	*/*

rpc_action

Makes a remote procedure call to the specified action

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Shared::ActionsRpcRequestDto.new(
  action: 'create_employee',
  body: {
    'data' => 'example',
  },
  headers: {
    'Content-Type' => 'application/json',
  },
  path: {
    'id' => '123',
  },
  query: Models::Shared::Query.new(
    debug: false
  )
)
res = s.actions.rpc_action(request: req)

unless res.actions_rpc_response.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
request	Models::Shared::ActionsRpcRequestDto	✔️	The request object to use for the request.

Response

T.nilable(Models::Operations::StackoneRpcActionResponse)

Errors

Error Type	Status Code	Content Type
Models::Errors::BadRequestResponse	400	application/json
Models::Errors::UnauthorizedResponse	401	application/json
Models::Errors::ForbiddenResponse	403	application/json
Models::Errors::NotFoundResponse	404	application/json
Models::Errors::RequestTimedOutResponse	408	application/json
Models::Errors::ConflictResponse	409	application/json
Models::Errors::UnprocessableEntityResponse	422	application/json
Models::Errors::TooManyRequestsResponse	429	application/json
Models::Errors::InternalServerErrorResponse	500	application/json
Models::Errors::NotImplementedResponse	501	application/json
Models::Errors::BadGatewayResponse	502	application/json
Errors::APIError	4XX, 5XX	*/*

search_actions

Search connector actions by semantic similarity

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)

req = Models::Shared::ActionSearchDto.new(
  connector: 'slack',
  query: 'send a message'
)
res = s.actions.search_actions(request: req)

unless res.action_search_response_dto.nil?
  # handle response
end

Parameters

Parameter	Type	Required	Description
request	Models::Shared::ActionSearchDto	✔️	The request object to use for the request.

Response

T.nilable(Models::Operations::StackoneSearchActionsResponse)

Errors

Error Type	Status Code	Content Type
Models::Errors::BadRequestResponse	400	application/json
Models::Errors::UnauthorizedResponse	401	application/json
Models::Errors::ForbiddenResponse	403	application/json
Models::Errors::NotFoundResponse	404	application/json
Models::Errors::RequestTimedOutResponse	408	application/json
Models::Errors::ConflictResponse	409	application/json
Models::Errors::UnprocessableEntityResponse	422	application/json
Models::Errors::TooManyRequestsResponse	429	application/json
Models::Errors::InternalServerErrorResponse	500	application/json
Models::Errors::NotImplementedResponse	501	application/json
Models::Errors::BadGatewayResponse	502	application/json
Errors::APIError	4XX, 5XX	*/*