skillsconnect

package
v1.7.80 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 28, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// SkillsServiceCreateSkillGroupProcedure is the fully-qualified name of the SkillsService's
	// CreateSkillGroup RPC.
	SkillsServiceCreateSkillGroupProcedure = "/api.v1alpha1.org.skills.SkillsService/CreateSkillGroup"
	// SkillsServiceListSkillGroupsProcedure is the fully-qualified name of the SkillsService's
	// ListSkillGroups RPC.
	SkillsServiceListSkillGroupsProcedure = "/api.v1alpha1.org.skills.SkillsService/ListSkillGroups"
	// SkillsServiceUpdateSkillGroupProcedure is the fully-qualified name of the SkillsService's
	// UpdateSkillGroup RPC.
	SkillsServiceUpdateSkillGroupProcedure = "/api.v1alpha1.org.skills.SkillsService/UpdateSkillGroup"
	// SkillsServiceGetSkillGroupProcedure is the fully-qualified name of the SkillsService's
	// GetSkillGroup RPC.
	SkillsServiceGetSkillGroupProcedure = "/api.v1alpha1.org.skills.SkillsService/GetSkillGroup"
	// SkillsServiceDeleteSkillGroupProcedure is the fully-qualified name of the SkillsService's
	// DeleteSkillGroup RPC.
	SkillsServiceDeleteSkillGroupProcedure = "/api.v1alpha1.org.skills.SkillsService/DeleteSkillGroup"
	// SkillsServiceRemoveSkillFromAllGroupsProcedure is the fully-qualified name of the SkillsService's
	// RemoveSkillFromAllGroups RPC.
	SkillsServiceRemoveSkillFromAllGroupsProcedure = "/api.v1alpha1.org.skills.SkillsService/RemoveSkillFromAllGroups"
	// SkillsServiceAssignSkillGroupsProcedure is the fully-qualified name of the SkillsService's
	// AssignSkillGroups RPC.
	SkillsServiceAssignSkillGroupsProcedure = "/api.v1alpha1.org.skills.SkillsService/AssignSkillGroups"
	// SkillsServiceUpdateUsersOnSkillGroupProcedure is the fully-qualified name of the SkillsService's
	// UpdateUsersOnSkillGroup RPC.
	SkillsServiceUpdateUsersOnSkillGroupProcedure = "/api.v1alpha1.org.skills.SkillsService/UpdateUsersOnSkillGroup"
	// SkillsServiceRevokeSkillGroupsProcedure is the fully-qualified name of the SkillsService's
	// RevokeSkillGroups RPC.
	SkillsServiceRevokeSkillGroupsProcedure = "/api.v1alpha1.org.skills.SkillsService/RevokeSkillGroups"
	// SkillsServiceGetUserSkillGroupsProcedure is the fully-qualified name of the SkillsService's
	// GetUserSkillGroups RPC.
	SkillsServiceGetUserSkillGroupsProcedure = "/api.v1alpha1.org.skills.SkillsService/GetUserSkillGroups"
	// SkillsServiceGetUserSkillsProcedure is the fully-qualified name of the SkillsService's
	// GetUserSkills RPC.
	SkillsServiceGetUserSkillsProcedure = "/api.v1alpha1.org.skills.SkillsService/GetUserSkills"
	// SkillsServiceGetSkillGroupMembersProcedure is the fully-qualified name of the SkillsService's
	// GetSkillGroupMembers RPC.
	SkillsServiceGetSkillGroupMembersProcedure = "/api.v1alpha1.org.skills.SkillsService/GetSkillGroupMembers"
	// SkillsServiceListSkillGroupsMembersProcedure is the fully-qualified name of the SkillsService's
	// ListSkillGroupsMembers RPC.
	SkillsServiceListSkillGroupsMembersProcedure = "/api.v1alpha1.org.skills.SkillsService/ListSkillGroupsMembers"
	// SkillsServiceGetAgentSkillsProcedure is the fully-qualified name of the SkillsService's
	// GetAgentSkills RPC.
	SkillsServiceGetAgentSkillsProcedure = "/api.v1alpha1.org.skills.SkillsService/GetAgentSkills"
	// SkillsServiceListSkillsForCurrentAgentProcedure is the fully-qualified name of the
	// SkillsService's ListSkillsForCurrentAgent RPC.
	SkillsServiceListSkillsForCurrentAgentProcedure = "/api.v1alpha1.org.skills.SkillsService/ListSkillsForCurrentAgent"
)

These constants are the fully-qualified names of the RPCs defined in this package. They're exposed at runtime as Spec.Procedure and as the final two segments of the HTTP route.

Note that these are different from the fully-qualified method names used by google.golang.org/protobuf/reflect/protoreflect. To convert from these constants to reflection-formatted method names, remove the leading slash and convert the remaining slash to a period.

View Source
const (
	// SkillsServiceName is the fully-qualified name of the SkillsService service.
	SkillsServiceName = "api.v1alpha1.org.skills.SkillsService"
)

Variables

This section is empty.

Functions

func NewSkillsServiceHandler

func NewSkillsServiceHandler(svc SkillsServiceHandler, opts ...connect_go.HandlerOption) (string, http.Handler)

NewSkillsServiceHandler builds an HTTP handler from the service implementation. It returns the path on which to mount the handler and the handler itself.

By default, handlers support the Connect, gRPC, and gRPC-Web protocols with the binary Protobuf and JSON codecs. They also support gzip compression.

Types

type SkillsServiceClient

type SkillsServiceClient interface {
	// CreateSkillGroup creates a new skill group.
	CreateSkillGroup(context.Context, *connect_go.Request[skills.CreateSkillGroupRequest]) (*connect_go.Response[skills.CreateSkillGroupResponse], error)
	// ListSkillGroups lists the skill groups belonging to an organization.
	ListSkillGroups(context.Context, *connect_go.Request[skills.ListSkillGroupsRequest]) (*connect_go.Response[skills.ListSkillGroupsResponse], error)
	// UpdateSkillGroup updates a single skill group.
	UpdateSkillGroup(context.Context, *connect_go.Request[skills.UpdateSkillGroupRequest]) (*connect_go.Response[skills.UpdateSkillGroupResponse], error)
	// GetSkillGroup gets a single skill group.
	GetSkillGroup(context.Context, *connect_go.Request[skills.GetSkillGroupRequest]) (*connect_go.Response[skills.GetSkillGroupResponse], error)
	// DeleteSkillGroup deletes a skill group.
	DeleteSkillGroup(context.Context, *connect_go.Request[skills.DeleteSkillGroupRequest]) (*connect_go.Response[skills.DeleteSkillGroupResponse], error)
	// RemoveSkillFromAllGroups removes a skill from all skill groups which contain it.
	RemoveSkillFromAllGroups(context.Context, *connect_go.Request[skills.RemoveSkillFromAllGroupsRequest]) (*connect_go.Response[skills.RemoveSkillFromAllGroupsResponse], error)
	// AssignSkillGroups assigns a user to the given skill groups.
	AssignSkillGroups(context.Context, *connect_go.Request[skills.AssignSkillGroupsRequest]) (*connect_go.Response[skills.AssignSkillGroupsResponse], error)
	// UpdateUsersOnSkillGroup updates a skill groups assigned users.
	UpdateUsersOnSkillGroup(context.Context, *connect_go.Request[skills.UpdateUsersOnSkillGroupRequest]) (*connect_go.Response[skills.UpdateUsersOnSkillGroupResponse], error)
	// RevokeSkillGroups revokes the given skill groups from a user.
	RevokeSkillGroups(context.Context, *connect_go.Request[skills.RevokeSkillGroupsRequest]) (*connect_go.Response[skills.RevokeSkillGroupsResponse], error)
	// GetUserSkillGroups gets the skill groups assigned to a user.
	GetUserSkillGroups(context.Context, *connect_go.Request[skills.GetUserSkillGroupsRequest]) (*connect_go.Response[skills.GetUserSkillGroupsResponse], error)
	// GetUserSkills gets a user's skill proficiencies.
	GetUserSkills(context.Context, *connect_go.Request[skills.GetUserSkillsRequest]) (*connect_go.Response[skills.GetUserSkillsResponse], error)
	// GetSkillGroupMembers gets the members of a skill group.
	GetSkillGroupMembers(context.Context, *connect_go.Request[skills.GetSkillGroupMembersRequest]) (*connect_go.Response[skills.GetSkillGroupMembersResponse], error)
	// ListSkillGroupsMembers gets the members of a skill group for each skill group in an Org.
	ListSkillGroupsMembers(context.Context, *connect_go.Request[skills.ListSkillGroupsMembersRequest]) (*connect_go.Response[skills.ListSkillGroupsMembersResponse], error)
	// Gets the skills of the requesting agent. This includes agent skills, hunt group skills, and extension skills(PBX).
	// Skills will be returned as a value pair (name, level).
	// For agent skills, the name of each skill will be the agent_skill_sid.
	// All other skills' names (hunt group and PBX) will be given special formats.
	// The requesting agent and hunt_group_sid skills will be defaulted to the max level (1000 and 100 respectively).
	//
	// Required permissions:
	//
	//	NONE
	//
	// Errors:
	//   - grpc.Invalid: the hunt_group_sid in the request in invalid.
	GetAgentSkills(context.Context, *connect_go.Request[skills.GetAgentSkillsRequest]) (*connect_go.Response[skills.GetAgentSkillsResponse], error)
	// Returns a list of skills for the current agent.
	ListSkillsForCurrentAgent(context.Context, *connect_go.Request[skills.ListSkillsForCurrentAgentRequest]) (*connect_go.Response[skills.ListSkillsForCurrentAgentResponse], error)
}

SkillsServiceClient is a client for the api.v1alpha1.org.skills.SkillsService service.

func NewSkillsServiceClient

func NewSkillsServiceClient(httpClient connect_go.HTTPClient, baseURL string, opts ...connect_go.ClientOption) SkillsServiceClient

NewSkillsServiceClient constructs a client for the api.v1alpha1.org.skills.SkillsService service. By default, it uses the Connect protocol with the binary Protobuf Codec, asks for gzipped responses, and sends uncompressed requests. To use the gRPC or gRPC-Web protocols, supply the connect.WithGRPC() or connect.WithGRPCWeb() options.

The URL supplied here should be the base URL for the Connect or gRPC server (for example, http://api.acme.com or https://acme.com/grpc).

type SkillsServiceHandler

type SkillsServiceHandler interface {
	// CreateSkillGroup creates a new skill group.
	CreateSkillGroup(context.Context, *connect_go.Request[skills.CreateSkillGroupRequest]) (*connect_go.Response[skills.CreateSkillGroupResponse], error)
	// ListSkillGroups lists the skill groups belonging to an organization.
	ListSkillGroups(context.Context, *connect_go.Request[skills.ListSkillGroupsRequest]) (*connect_go.Response[skills.ListSkillGroupsResponse], error)
	// UpdateSkillGroup updates a single skill group.
	UpdateSkillGroup(context.Context, *connect_go.Request[skills.UpdateSkillGroupRequest]) (*connect_go.Response[skills.UpdateSkillGroupResponse], error)
	// GetSkillGroup gets a single skill group.
	GetSkillGroup(context.Context, *connect_go.Request[skills.GetSkillGroupRequest]) (*connect_go.Response[skills.GetSkillGroupResponse], error)
	// DeleteSkillGroup deletes a skill group.
	DeleteSkillGroup(context.Context, *connect_go.Request[skills.DeleteSkillGroupRequest]) (*connect_go.Response[skills.DeleteSkillGroupResponse], error)
	// RemoveSkillFromAllGroups removes a skill from all skill groups which contain it.
	RemoveSkillFromAllGroups(context.Context, *connect_go.Request[skills.RemoveSkillFromAllGroupsRequest]) (*connect_go.Response[skills.RemoveSkillFromAllGroupsResponse], error)
	// AssignSkillGroups assigns a user to the given skill groups.
	AssignSkillGroups(context.Context, *connect_go.Request[skills.AssignSkillGroupsRequest]) (*connect_go.Response[skills.AssignSkillGroupsResponse], error)
	// UpdateUsersOnSkillGroup updates a skill groups assigned users.
	UpdateUsersOnSkillGroup(context.Context, *connect_go.Request[skills.UpdateUsersOnSkillGroupRequest]) (*connect_go.Response[skills.UpdateUsersOnSkillGroupResponse], error)
	// RevokeSkillGroups revokes the given skill groups from a user.
	RevokeSkillGroups(context.Context, *connect_go.Request[skills.RevokeSkillGroupsRequest]) (*connect_go.Response[skills.RevokeSkillGroupsResponse], error)
	// GetUserSkillGroups gets the skill groups assigned to a user.
	GetUserSkillGroups(context.Context, *connect_go.Request[skills.GetUserSkillGroupsRequest]) (*connect_go.Response[skills.GetUserSkillGroupsResponse], error)
	// GetUserSkills gets a user's skill proficiencies.
	GetUserSkills(context.Context, *connect_go.Request[skills.GetUserSkillsRequest]) (*connect_go.Response[skills.GetUserSkillsResponse], error)
	// GetSkillGroupMembers gets the members of a skill group.
	GetSkillGroupMembers(context.Context, *connect_go.Request[skills.GetSkillGroupMembersRequest]) (*connect_go.Response[skills.GetSkillGroupMembersResponse], error)
	// ListSkillGroupsMembers gets the members of a skill group for each skill group in an Org.
	ListSkillGroupsMembers(context.Context, *connect_go.Request[skills.ListSkillGroupsMembersRequest]) (*connect_go.Response[skills.ListSkillGroupsMembersResponse], error)
	// Gets the skills of the requesting agent. This includes agent skills, hunt group skills, and extension skills(PBX).
	// Skills will be returned as a value pair (name, level).
	// For agent skills, the name of each skill will be the agent_skill_sid.
	// All other skills' names (hunt group and PBX) will be given special formats.
	// The requesting agent and hunt_group_sid skills will be defaulted to the max level (1000 and 100 respectively).
	//
	// Required permissions:
	//
	//	NONE
	//
	// Errors:
	//   - grpc.Invalid: the hunt_group_sid in the request in invalid.
	GetAgentSkills(context.Context, *connect_go.Request[skills.GetAgentSkillsRequest]) (*connect_go.Response[skills.GetAgentSkillsResponse], error)
	// Returns a list of skills for the current agent.
	ListSkillsForCurrentAgent(context.Context, *connect_go.Request[skills.ListSkillsForCurrentAgentRequest]) (*connect_go.Response[skills.ListSkillsForCurrentAgentResponse], error)
}

SkillsServiceHandler is an implementation of the api.v1alpha1.org.skills.SkillsService service.

type UnimplementedSkillsServiceHandler

type UnimplementedSkillsServiceHandler struct{}

UnimplementedSkillsServiceHandler returns CodeUnimplemented from all methods.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL