pbxv2

package
v1.7.75 Latest Latest
Warning

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

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

Documentation

Index

Constants

View Source
const (
	PBXService_ListPBXUsers_FullMethodName          = "/services.pbx.v2.PBXService/ListPBXUsers"
	PBXService_GetPBXUser_FullMethodName            = "/services.pbx.v2.PBXService/GetPBXUser"
	PBXService_ListRingGroups_FullMethodName        = "/services.pbx.v2.PBXService/ListRingGroups"
	PBXService_GetRingGroup_FullMethodName          = "/services.pbx.v2.PBXService/GetRingGroup"
	PBXService_GetSIPAccount_FullMethodName         = "/services.pbx.v2.PBXService/GetSIPAccount"
	PBXService_ListSIPAccounts_FullMethodName       = "/services.pbx.v2.PBXService/ListSIPAccounts"
	PBXService_UpdateSIPAccount_FullMethodName      = "/services.pbx.v2.PBXService/UpdateSIPAccount"
	PBXService_UpdateRingGroup_FullMethodName       = "/services.pbx.v2.PBXService/UpdateRingGroup"
	PBXService_CreateRingGroup_FullMethodName       = "/services.pbx.v2.PBXService/CreateRingGroup"
	PBXService_DeleteRingGroup_FullMethodName       = "/services.pbx.v2.PBXService/DeleteRingGroup"
	PBXService_AssignRandomExtension_FullMethodName = "/services.pbx.v2.PBXService/AssignRandomExtension"
)

Variables

View Source
var (
	RingStrategy_name = map[int32]string{
		0: "RING_STRATEGY_UNSPECIFIED",
		1: "RING_STRATEGY_RING_ALL",
		2: "RING_STRATEGY_ROUND_ROBIN",
		3: "RING_STRATEGY_RANDOM",
		4: "RING_STRATEGY_ORDERED",
	}
	RingStrategy_value = map[string]int32{
		"RING_STRATEGY_UNSPECIFIED": 0,
		"RING_STRATEGY_RING_ALL":    1,
		"RING_STRATEGY_ROUND_ROBIN": 2,
		"RING_STRATEGY_RANDOM":      3,
		"RING_STRATEGY_ORDERED":     4,
	}
)

Enum value maps for RingStrategy.

View Source
var File_services_pbx_v2_service_proto protoreflect.FileDescriptor
View Source
var PBXService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "services.pbx.v2.PBXService",
	HandlerType: (*PBXServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ListPBXUsers",
			Handler:    _PBXService_ListPBXUsers_Handler,
		},
		{
			MethodName: "GetPBXUser",
			Handler:    _PBXService_GetPBXUser_Handler,
		},
		{
			MethodName: "ListRingGroups",
			Handler:    _PBXService_ListRingGroups_Handler,
		},
		{
			MethodName: "GetRingGroup",
			Handler:    _PBXService_GetRingGroup_Handler,
		},
		{
			MethodName: "GetSIPAccount",
			Handler:    _PBXService_GetSIPAccount_Handler,
		},
		{
			MethodName: "ListSIPAccounts",
			Handler:    _PBXService_ListSIPAccounts_Handler,
		},
		{
			MethodName: "UpdateSIPAccount",
			Handler:    _PBXService_UpdateSIPAccount_Handler,
		},
		{
			MethodName: "UpdateRingGroup",
			Handler:    _PBXService_UpdateRingGroup_Handler,
		},
		{
			MethodName: "CreateRingGroup",
			Handler:    _PBXService_CreateRingGroup_Handler,
		},
		{
			MethodName: "DeleteRingGroup",
			Handler:    _PBXService_DeleteRingGroup_Handler,
		},
		{
			MethodName: "AssignRandomExtension",
			Handler:    _PBXService_AssignRandomExtension_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "services/pbx/v2/service.proto",
}

PBXService_ServiceDesc is the grpc.ServiceDesc for PBXService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterPBXServiceServer

func RegisterPBXServiceServer(s grpc.ServiceRegistrar, srv PBXServiceServer)

Types

type AssignRandomExtensionRequest

type AssignRandomExtensionRequest struct {
	// contains filtered or unexported fields
}

func (*AssignRandomExtensionRequest) Descriptor deprecated

func (*AssignRandomExtensionRequest) Descriptor() ([]byte, []int)

Deprecated: Use AssignRandomExtensionRequest.ProtoReflect.Descriptor instead.

func (*AssignRandomExtensionRequest) ProtoMessage

func (*AssignRandomExtensionRequest) ProtoMessage()

func (*AssignRandomExtensionRequest) ProtoReflect

func (*AssignRandomExtensionRequest) Reset

func (x *AssignRandomExtensionRequest) Reset()

func (*AssignRandomExtensionRequest) String

type AssignRandomExtensionResponse

type AssignRandomExtensionResponse struct {
	Extension string `protobuf:"bytes,1,opt,name=extension,proto3" json:"extension,omitempty"`
	// contains filtered or unexported fields
}

func (*AssignRandomExtensionResponse) Descriptor deprecated

func (*AssignRandomExtensionResponse) Descriptor() ([]byte, []int)

Deprecated: Use AssignRandomExtensionResponse.ProtoReflect.Descriptor instead.

func (*AssignRandomExtensionResponse) GetExtension

func (x *AssignRandomExtensionResponse) GetExtension() string

func (*AssignRandomExtensionResponse) ProtoMessage

func (*AssignRandomExtensionResponse) ProtoMessage()

func (*AssignRandomExtensionResponse) ProtoReflect

func (*AssignRandomExtensionResponse) Reset

func (x *AssignRandomExtensionResponse) Reset()

func (*AssignRandomExtensionResponse) String

type CreateRingGroupRequest

type CreateRingGroupRequest struct {
	Group *RingGroup `protobuf:"bytes,1,opt,name=group,proto3" json:"group,omitempty"` // Fields to be added into new Ring Group
	// contains filtered or unexported fields
}

func (*CreateRingGroupRequest) Descriptor deprecated

func (*CreateRingGroupRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateRingGroupRequest.ProtoReflect.Descriptor instead.

func (*CreateRingGroupRequest) GetGroup

func (x *CreateRingGroupRequest) GetGroup() *RingGroup

func (*CreateRingGroupRequest) ProtoMessage

func (*CreateRingGroupRequest) ProtoMessage()

func (*CreateRingGroupRequest) ProtoReflect

func (x *CreateRingGroupRequest) ProtoReflect() protoreflect.Message

func (*CreateRingGroupRequest) Reset

func (x *CreateRingGroupRequest) Reset()

func (*CreateRingGroupRequest) String

func (x *CreateRingGroupRequest) String() string

type CreateRingGroupResponse

type CreateRingGroupResponse struct {
	Group *RingGroup `protobuf:"bytes,1,opt,name=group,proto3" json:"group,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateRingGroupResponse) Descriptor deprecated

func (*CreateRingGroupResponse) Descriptor() ([]byte, []int)

Deprecated: Use CreateRingGroupResponse.ProtoReflect.Descriptor instead.

func (*CreateRingGroupResponse) GetGroup

func (x *CreateRingGroupResponse) GetGroup() *RingGroup

func (*CreateRingGroupResponse) ProtoMessage

func (*CreateRingGroupResponse) ProtoMessage()

func (*CreateRingGroupResponse) ProtoReflect

func (x *CreateRingGroupResponse) ProtoReflect() protoreflect.Message

func (*CreateRingGroupResponse) Reset

func (x *CreateRingGroupResponse) Reset()

func (*CreateRingGroupResponse) String

func (x *CreateRingGroupResponse) String() string

type DeleteRingGroupRequest

type DeleteRingGroupRequest struct {
	GroupId string `protobuf:"bytes,1,opt,name=group_id,json=groupId,proto3" json:"group_id,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteRingGroupRequest) Descriptor deprecated

func (*DeleteRingGroupRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteRingGroupRequest.ProtoReflect.Descriptor instead.

func (*DeleteRingGroupRequest) GetGroupId

func (x *DeleteRingGroupRequest) GetGroupId() string

func (*DeleteRingGroupRequest) ProtoMessage

func (*DeleteRingGroupRequest) ProtoMessage()

func (*DeleteRingGroupRequest) ProtoReflect

func (x *DeleteRingGroupRequest) ProtoReflect() protoreflect.Message

func (*DeleteRingGroupRequest) Reset

func (x *DeleteRingGroupRequest) Reset()

func (*DeleteRingGroupRequest) String

func (x *DeleteRingGroupRequest) String() string

type DeleteRingGroupResponse

type DeleteRingGroupResponse struct {
	// contains filtered or unexported fields
}

func (*DeleteRingGroupResponse) Descriptor deprecated

func (*DeleteRingGroupResponse) Descriptor() ([]byte, []int)

Deprecated: Use DeleteRingGroupResponse.ProtoReflect.Descriptor instead.

func (*DeleteRingGroupResponse) ProtoMessage

func (*DeleteRingGroupResponse) ProtoMessage()

func (*DeleteRingGroupResponse) ProtoReflect

func (x *DeleteRingGroupResponse) ProtoReflect() protoreflect.Message

func (*DeleteRingGroupResponse) Reset

func (x *DeleteRingGroupResponse) Reset()

func (*DeleteRingGroupResponse) String

func (x *DeleteRingGroupResponse) String() string

type GetPBXUserRequest

type GetPBXUserRequest struct {
	PbxUserId string `protobuf:"bytes,1,opt,name=pbx_user_id,json=pbxUserId,proto3" json:"pbx_user_id,omitempty"` // Required: To fetch a specific user by ID.
	// contains filtered or unexported fields
}

func (*GetPBXUserRequest) Descriptor deprecated

func (*GetPBXUserRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetPBXUserRequest.ProtoReflect.Descriptor instead.

func (*GetPBXUserRequest) GetPbxUserId

func (x *GetPBXUserRequest) GetPbxUserId() string

func (*GetPBXUserRequest) ProtoMessage

func (*GetPBXUserRequest) ProtoMessage()

func (*GetPBXUserRequest) ProtoReflect

func (x *GetPBXUserRequest) ProtoReflect() protoreflect.Message

func (*GetPBXUserRequest) Reset

func (x *GetPBXUserRequest) Reset()

func (*GetPBXUserRequest) String

func (x *GetPBXUserRequest) String() string

type GetPBXUserResponse

type GetPBXUserResponse struct {
	User *PBXUser `protobuf:"bytes,1,opt,name=user,proto3" json:"user,omitempty"`
	// contains filtered or unexported fields
}

func (*GetPBXUserResponse) Descriptor deprecated

func (*GetPBXUserResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetPBXUserResponse.ProtoReflect.Descriptor instead.

func (*GetPBXUserResponse) GetUser

func (x *GetPBXUserResponse) GetUser() *PBXUser

func (*GetPBXUserResponse) ProtoMessage

func (*GetPBXUserResponse) ProtoMessage()

func (*GetPBXUserResponse) ProtoReflect

func (x *GetPBXUserResponse) ProtoReflect() protoreflect.Message

func (*GetPBXUserResponse) Reset

func (x *GetPBXUserResponse) Reset()

func (*GetPBXUserResponse) String

func (x *GetPBXUserResponse) String() string

type GetRingGroupRequest

type GetRingGroupRequest struct {
	RingGroupId string `protobuf:"bytes,1,opt,name=ring_group_id,json=ringGroupId,proto3" json:"ring_group_id,omitempty"` // Required: To fetch a specific group by ID.
	// contains filtered or unexported fields
}

func (*GetRingGroupRequest) Descriptor deprecated

func (*GetRingGroupRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetRingGroupRequest.ProtoReflect.Descriptor instead.

func (*GetRingGroupRequest) GetRingGroupId

func (x *GetRingGroupRequest) GetRingGroupId() string

func (*GetRingGroupRequest) ProtoMessage

func (*GetRingGroupRequest) ProtoMessage()

func (*GetRingGroupRequest) ProtoReflect

func (x *GetRingGroupRequest) ProtoReflect() protoreflect.Message

func (*GetRingGroupRequest) Reset

func (x *GetRingGroupRequest) Reset()

func (*GetRingGroupRequest) String

func (x *GetRingGroupRequest) String() string

type GetRingGroupResponse

type GetRingGroupResponse struct {
	Group *RingGroup `protobuf:"bytes,1,opt,name=group,proto3" json:"group,omitempty"`
	// contains filtered or unexported fields
}

func (*GetRingGroupResponse) Descriptor deprecated

func (*GetRingGroupResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetRingGroupResponse.ProtoReflect.Descriptor instead.

func (*GetRingGroupResponse) GetGroup

func (x *GetRingGroupResponse) GetGroup() *RingGroup

func (*GetRingGroupResponse) ProtoMessage

func (*GetRingGroupResponse) ProtoMessage()

func (*GetRingGroupResponse) ProtoReflect

func (x *GetRingGroupResponse) ProtoReflect() protoreflect.Message

func (*GetRingGroupResponse) Reset

func (x *GetRingGroupResponse) Reset()

func (*GetRingGroupResponse) String

func (x *GetRingGroupResponse) String() string

type GetSIPAccountRequest

type GetSIPAccountRequest struct {
	SipAccountId string `protobuf:"bytes,1,opt,name=sip_account_id,json=sipAccountId,proto3" json:"sip_account_id,omitempty"`
	// contains filtered or unexported fields
}

func (*GetSIPAccountRequest) Descriptor deprecated

func (*GetSIPAccountRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetSIPAccountRequest.ProtoReflect.Descriptor instead.

func (*GetSIPAccountRequest) GetSipAccountId added in v1.7.61

func (x *GetSIPAccountRequest) GetSipAccountId() string

func (*GetSIPAccountRequest) ProtoMessage

func (*GetSIPAccountRequest) ProtoMessage()

func (*GetSIPAccountRequest) ProtoReflect

func (x *GetSIPAccountRequest) ProtoReflect() protoreflect.Message

func (*GetSIPAccountRequest) Reset

func (x *GetSIPAccountRequest) Reset()

func (*GetSIPAccountRequest) String

func (x *GetSIPAccountRequest) String() string

type GetSIPAccountResponse

type GetSIPAccountResponse struct {
	SipAccount []*SIPAccount `protobuf:"bytes,1,rep,name=sip_account,json=sipAccount,proto3" json:"sip_account,omitempty"`
	// contains filtered or unexported fields
}

func (*GetSIPAccountResponse) Descriptor deprecated

func (*GetSIPAccountResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetSIPAccountResponse.ProtoReflect.Descriptor instead.

func (*GetSIPAccountResponse) GetSipAccount

func (x *GetSIPAccountResponse) GetSipAccount() []*SIPAccount

func (*GetSIPAccountResponse) ProtoMessage

func (*GetSIPAccountResponse) ProtoMessage()

func (*GetSIPAccountResponse) ProtoReflect

func (x *GetSIPAccountResponse) ProtoReflect() protoreflect.Message

func (*GetSIPAccountResponse) Reset

func (x *GetSIPAccountResponse) Reset()

func (*GetSIPAccountResponse) String

func (x *GetSIPAccountResponse) String() string

type ListPBXUsersRequest

type ListPBXUsersRequest struct {
	// contains filtered or unexported fields
}

-------------------------

RPC Messages

-------------------------

func (*ListPBXUsersRequest) Descriptor deprecated

func (*ListPBXUsersRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListPBXUsersRequest.ProtoReflect.Descriptor instead.

func (*ListPBXUsersRequest) ProtoMessage

func (*ListPBXUsersRequest) ProtoMessage()

func (*ListPBXUsersRequest) ProtoReflect

func (x *ListPBXUsersRequest) ProtoReflect() protoreflect.Message

func (*ListPBXUsersRequest) Reset

func (x *ListPBXUsersRequest) Reset()

func (*ListPBXUsersRequest) String

func (x *ListPBXUsersRequest) String() string

type ListPBXUsersResponse

type ListPBXUsersResponse struct {
	Users []*PBXUser `protobuf:"bytes,1,rep,name=users,proto3" json:"users,omitempty"`
	// contains filtered or unexported fields
}

func (*ListPBXUsersResponse) Descriptor deprecated

func (*ListPBXUsersResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListPBXUsersResponse.ProtoReflect.Descriptor instead.

func (*ListPBXUsersResponse) GetUsers

func (x *ListPBXUsersResponse) GetUsers() []*PBXUser

func (*ListPBXUsersResponse) ProtoMessage

func (*ListPBXUsersResponse) ProtoMessage()

func (*ListPBXUsersResponse) ProtoReflect

func (x *ListPBXUsersResponse) ProtoReflect() protoreflect.Message

func (*ListPBXUsersResponse) Reset

func (x *ListPBXUsersResponse) Reset()

func (*ListPBXUsersResponse) String

func (x *ListPBXUsersResponse) String() string

type ListRingGroupsRequest

type ListRingGroupsRequest struct {
	// contains filtered or unexported fields
}

func (*ListRingGroupsRequest) Descriptor deprecated

func (*ListRingGroupsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListRingGroupsRequest.ProtoReflect.Descriptor instead.

func (*ListRingGroupsRequest) ProtoMessage

func (*ListRingGroupsRequest) ProtoMessage()

func (*ListRingGroupsRequest) ProtoReflect

func (x *ListRingGroupsRequest) ProtoReflect() protoreflect.Message

func (*ListRingGroupsRequest) Reset

func (x *ListRingGroupsRequest) Reset()

func (*ListRingGroupsRequest) String

func (x *ListRingGroupsRequest) String() string

type ListRingGroupsResponse

type ListRingGroupsResponse struct {
	Groups []*RingGroup `protobuf:"bytes,1,rep,name=groups,proto3" json:"groups,omitempty"`
	// contains filtered or unexported fields
}

func (*ListRingGroupsResponse) Descriptor deprecated

func (*ListRingGroupsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListRingGroupsResponse.ProtoReflect.Descriptor instead.

func (*ListRingGroupsResponse) GetGroups

func (x *ListRingGroupsResponse) GetGroups() []*RingGroup

func (*ListRingGroupsResponse) ProtoMessage

func (*ListRingGroupsResponse) ProtoMessage()

func (*ListRingGroupsResponse) ProtoReflect

func (x *ListRingGroupsResponse) ProtoReflect() protoreflect.Message

func (*ListRingGroupsResponse) Reset

func (x *ListRingGroupsResponse) Reset()

func (*ListRingGroupsResponse) String

func (x *ListRingGroupsResponse) String() string

type ListSIPAccountsRequest

type ListSIPAccountsRequest struct {
	// contains filtered or unexported fields
}

func (*ListSIPAccountsRequest) Descriptor deprecated

func (*ListSIPAccountsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListSIPAccountsRequest.ProtoReflect.Descriptor instead.

func (*ListSIPAccountsRequest) ProtoMessage

func (*ListSIPAccountsRequest) ProtoMessage()

func (*ListSIPAccountsRequest) ProtoReflect

func (x *ListSIPAccountsRequest) ProtoReflect() protoreflect.Message

func (*ListSIPAccountsRequest) Reset

func (x *ListSIPAccountsRequest) Reset()

func (*ListSIPAccountsRequest) String

func (x *ListSIPAccountsRequest) String() string

type ListSIPAccountsResponse

type ListSIPAccountsResponse struct {
	SipAccounts []*SIPAccount `protobuf:"bytes,1,rep,name=sip_accounts,json=sipAccounts,proto3" json:"sip_accounts,omitempty"`
	// contains filtered or unexported fields
}

func (*ListSIPAccountsResponse) Descriptor deprecated

func (*ListSIPAccountsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListSIPAccountsResponse.ProtoReflect.Descriptor instead.

func (*ListSIPAccountsResponse) GetSipAccounts

func (x *ListSIPAccountsResponse) GetSipAccounts() []*SIPAccount

func (*ListSIPAccountsResponse) ProtoMessage

func (*ListSIPAccountsResponse) ProtoMessage()

func (*ListSIPAccountsResponse) ProtoReflect

func (x *ListSIPAccountsResponse) ProtoReflect() protoreflect.Message

func (*ListSIPAccountsResponse) Reset

func (x *ListSIPAccountsResponse) Reset()

func (*ListSIPAccountsResponse) String

func (x *ListSIPAccountsResponse) String() string

type PBXServiceClient

type PBXServiceClient interface {
	// Returns details of all PBX Users associated with the authenticated callers ORG
	// Required permissions:
	//
	//	PBX-MANAGER
	//
	// Errors:
	//   - grpc.PermissionDenied: Caller doesn't have the required permissions.
	//   - grpc.Internal: An internal error occurred.
	//   - grpc.Unavailable: The operation is currently unavailable. Likely a transient issue with a downstream service.
	ListPBXUsers(ctx context.Context, in *ListPBXUsersRequest, opts ...grpc.CallOption) (*ListPBXUsersResponse, error)
	// Returns details of the PBX User associated with the pbx_user_id
	// Required permissions:
	//
	//	PBX-MANAGER
	//
	// Errors:
	//   - grpc.InvalidArgument: The request is invalid.
	//   - grpc.PermissionDenied: Caller doesn't have the required permissions.
	//   - grpc.Internal: An internal error occurred.
	//   - grpc.NotFound: The user does not exist or is not in the caller's ORG.
	//   - grpc.Unavailable: The operation is currently unavailable. Likely a transient issue with a downstream service.
	GetPBXUser(ctx context.Context, in *GetPBXUserRequest, opts ...grpc.CallOption) (*GetPBXUserResponse, error)
	// Returns details of all Ring Groups associated with the authenticated callers ORG
	// Required permissions:
	//
	//	PBX-MANAGER
	//
	// Errors:
	//   - grpc.PermissionDenied: Caller doesn't have the required permissions.
	//   - grpc.Internal: An internal error occurred.
	//   - grpc.Unavailable: The operation is currently unavailable. Likely a transient issue with a downstream service.
	ListRingGroups(ctx context.Context, in *ListRingGroupsRequest, opts ...grpc.CallOption) (*ListRingGroupsResponse, error)
	// Returns details of the Ring Group associated with the ring_group_id
	// Required permissions:
	//
	//	PBX-MANAGER
	//
	// Errors:
	//   - grpc.InvalidArgument: The request is invalid.
	//   - grpc.PermissionDenied: Caller doesn't have the required permissions.
	//   - grpc.Internal: An internal error occurred.
	//   - grpc.NotFound: The group does not exist or is not in the caller's ORG.
	//   - grpc.Unavailable: The operation is currently unavailable. Likely a transient issue with a downstream service.
	GetRingGroup(ctx context.Context, in *GetRingGroupRequest, opts ...grpc.CallOption) (*GetRingGroupResponse, error)
	// Returns details of the SIP Account associated with the sip_id
	// Required permissions:
	//
	//	PBX-MANAGER
	//
	// Errors:
	//   - grpc.InvalidArgument: The request is invalid.
	//   - grpc.PermissionDenied: Caller doesn't have the required permissions.
	//   - grpc.Internal: An internal error occurred.
	//   - grpc.NotFound: The group does not exist or is not in the caller's ORG.
	//   - grpc.Unavailable: The operation is currently unavailable. Likely a transient issue with a downstream service.
	GetSIPAccount(ctx context.Context, in *GetSIPAccountRequest, opts ...grpc.CallOption) (*GetSIPAccountResponse, error)
	// Returns details of all SIP Accounts associated with the authenticated callers ORG
	// Required permissions:
	//
	//	PBX-MANAGER
	//
	// Errors:
	//   - grpc.PermissionDenied: Caller doesn't have the required permissions.
	//   - grpc.Internal: An internal error occurred.
	//   - grpc.Unavailable: The operation is currently unavailable. Likely a transient issue with a downstream service.
	ListSIPAccounts(ctx context.Context, in *ListSIPAccountsRequest, opts ...grpc.CallOption) (*ListSIPAccountsResponse, error)
	// Updates details of the SIP Account for the specific SIP Account within the authenticated callers ORG.
	// Allows for updating, activating, and deactivating a user.
	// Required permissions:
	//
	//	PBX-MANAGER
	//
	// Errors:
	//   - grpc.InvalidArgument: The request is invalid.
	//   - grpc.AlreadyExists: The extension already exists
	//   - grpc.PermissionDenied: Caller doesn't have the required permissions.
	//   - grpc.Internal: An internal error occurred.
	//   - grpc.Unavailable: The operation is currently unavailable. Likely a transient issue with a downstream service.
	UpdateSIPAccount(ctx context.Context, in *UpdateSIPAccountRequest, opts ...grpc.CallOption) (*UpdateSIPAccountResponse, error)
	// Updates details of a Ring Group for the authenticated callers ORG. This operation acts as an "upsert".
	//   - If the groupID is in the update mask and the group exists, the group will be updated.
	//   - If the groupID is not in the update mask a group will be created.
	//
	// Allows for creating and updating a ring group.
	// Required permissions:
	//
	//	PBX-MANAGER
	//
	// Errors:
	//   - grpc.InvalidArgument: The request is invalid.
	//   - grpc.AlreadyExists: The extension or name already exists.
	//   - grpc.PermissionDenied: Caller doesn't have the required permissions.
	//   - grpc.Internal: An internal error occurred.
	//   - grpc.Unavailable: The operation is currently unavailable. Likely a transient issue with a downstream service.
	UpdateRingGroup(ctx context.Context, in *UpdateRingGroupRequest, opts ...grpc.CallOption) (*UpdateRingGroupResponse, error)
	// Creates a ring group for the authenticated caller's ORG.
	// Required permissions:
	//
	//	PBX-MANAGER
	//
	// Errors:
	//   - grpc.InvalidArgument: The request is invalid.
	//   - grpc.OutOfRange: The request has fields that are out of range of constraints
	//   - grpc.AlreadyExists: The extension or name already exists.
	//   - grpc.PermissionDenied: Caller doesn't have the required permissions.
	//   - grpc.Internal: An internal error occurred.
	//   - grpc.Unavailable: The operation is currently unavailable. Likely a transient issue with a downstream service.
	CreateRingGroup(ctx context.Context, in *CreateRingGroupRequest, opts ...grpc.CallOption) (*CreateRingGroupResponse, error)
	// Deletes a specific Ring Group for the authenticated caller's ORG.
	// Required permissions:
	//
	//	PBX-MANAGER
	//
	// Errors:
	//   - grpc.InvalidArgument: The groupID is an invalid format.
	//   - grpc.NotFound: The group does not exist or is not in the caller's ORG.
	//   - grpc.PermissionDenied: Caller doesn't have the required permissions.
	//   - grpc.Internal: An internal error occurred.
	//   - grpc.Unavailable: The operation is currently unavailable. Likely a transient issue with a downstream service.
	DeleteRingGroup(ctx context.Context, in *DeleteRingGroupRequest, opts ...grpc.CallOption) (*DeleteRingGroupResponse, error)
	// Assigns a random extension either to a PBX user or a Ring Group
	// Required permissions:
	//
	//	PBX-MANAGER
	//
	// Errors:
	//   - grpc.PermissionDenied: Caller doesn't have the required permissions.
	//   - grpc.NotFound: No free extension found.
	//   - grpc.Internal: An internal error occurred.
	//   - grpc.Unavailable: The operation is currently unavailable. Likely a transient issue with a downstream service.
	AssignRandomExtension(ctx context.Context, in *AssignRandomExtensionRequest, opts ...grpc.CallOption) (*AssignRandomExtensionResponse, error)
}

PBXServiceClient is the client API for PBXService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewPBXServiceClient

func NewPBXServiceClient(cc grpc.ClientConnInterface) PBXServiceClient

type PBXServiceServer

type PBXServiceServer interface {
	// Returns details of all PBX Users associated with the authenticated callers ORG
	// Required permissions:
	//
	//	PBX-MANAGER
	//
	// Errors:
	//   - grpc.PermissionDenied: Caller doesn't have the required permissions.
	//   - grpc.Internal: An internal error occurred.
	//   - grpc.Unavailable: The operation is currently unavailable. Likely a transient issue with a downstream service.
	ListPBXUsers(context.Context, *ListPBXUsersRequest) (*ListPBXUsersResponse, error)
	// Returns details of the PBX User associated with the pbx_user_id
	// Required permissions:
	//
	//	PBX-MANAGER
	//
	// Errors:
	//   - grpc.InvalidArgument: The request is invalid.
	//   - grpc.PermissionDenied: Caller doesn't have the required permissions.
	//   - grpc.Internal: An internal error occurred.
	//   - grpc.NotFound: The user does not exist or is not in the caller's ORG.
	//   - grpc.Unavailable: The operation is currently unavailable. Likely a transient issue with a downstream service.
	GetPBXUser(context.Context, *GetPBXUserRequest) (*GetPBXUserResponse, error)
	// Returns details of all Ring Groups associated with the authenticated callers ORG
	// Required permissions:
	//
	//	PBX-MANAGER
	//
	// Errors:
	//   - grpc.PermissionDenied: Caller doesn't have the required permissions.
	//   - grpc.Internal: An internal error occurred.
	//   - grpc.Unavailable: The operation is currently unavailable. Likely a transient issue with a downstream service.
	ListRingGroups(context.Context, *ListRingGroupsRequest) (*ListRingGroupsResponse, error)
	// Returns details of the Ring Group associated with the ring_group_id
	// Required permissions:
	//
	//	PBX-MANAGER
	//
	// Errors:
	//   - grpc.InvalidArgument: The request is invalid.
	//   - grpc.PermissionDenied: Caller doesn't have the required permissions.
	//   - grpc.Internal: An internal error occurred.
	//   - grpc.NotFound: The group does not exist or is not in the caller's ORG.
	//   - grpc.Unavailable: The operation is currently unavailable. Likely a transient issue with a downstream service.
	GetRingGroup(context.Context, *GetRingGroupRequest) (*GetRingGroupResponse, error)
	// Returns details of the SIP Account associated with the sip_id
	// Required permissions:
	//
	//	PBX-MANAGER
	//
	// Errors:
	//   - grpc.InvalidArgument: The request is invalid.
	//   - grpc.PermissionDenied: Caller doesn't have the required permissions.
	//   - grpc.Internal: An internal error occurred.
	//   - grpc.NotFound: The group does not exist or is not in the caller's ORG.
	//   - grpc.Unavailable: The operation is currently unavailable. Likely a transient issue with a downstream service.
	GetSIPAccount(context.Context, *GetSIPAccountRequest) (*GetSIPAccountResponse, error)
	// Returns details of all SIP Accounts associated with the authenticated callers ORG
	// Required permissions:
	//
	//	PBX-MANAGER
	//
	// Errors:
	//   - grpc.PermissionDenied: Caller doesn't have the required permissions.
	//   - grpc.Internal: An internal error occurred.
	//   - grpc.Unavailable: The operation is currently unavailable. Likely a transient issue with a downstream service.
	ListSIPAccounts(context.Context, *ListSIPAccountsRequest) (*ListSIPAccountsResponse, error)
	// Updates details of the SIP Account for the specific SIP Account within the authenticated callers ORG.
	// Allows for updating, activating, and deactivating a user.
	// Required permissions:
	//
	//	PBX-MANAGER
	//
	// Errors:
	//   - grpc.InvalidArgument: The request is invalid.
	//   - grpc.AlreadyExists: The extension already exists
	//   - grpc.PermissionDenied: Caller doesn't have the required permissions.
	//   - grpc.Internal: An internal error occurred.
	//   - grpc.Unavailable: The operation is currently unavailable. Likely a transient issue with a downstream service.
	UpdateSIPAccount(context.Context, *UpdateSIPAccountRequest) (*UpdateSIPAccountResponse, error)
	// Updates details of a Ring Group for the authenticated callers ORG. This operation acts as an "upsert".
	//   - If the groupID is in the update mask and the group exists, the group will be updated.
	//   - If the groupID is not in the update mask a group will be created.
	//
	// Allows for creating and updating a ring group.
	// Required permissions:
	//
	//	PBX-MANAGER
	//
	// Errors:
	//   - grpc.InvalidArgument: The request is invalid.
	//   - grpc.AlreadyExists: The extension or name already exists.
	//   - grpc.PermissionDenied: Caller doesn't have the required permissions.
	//   - grpc.Internal: An internal error occurred.
	//   - grpc.Unavailable: The operation is currently unavailable. Likely a transient issue with a downstream service.
	UpdateRingGroup(context.Context, *UpdateRingGroupRequest) (*UpdateRingGroupResponse, error)
	// Creates a ring group for the authenticated caller's ORG.
	// Required permissions:
	//
	//	PBX-MANAGER
	//
	// Errors:
	//   - grpc.InvalidArgument: The request is invalid.
	//   - grpc.OutOfRange: The request has fields that are out of range of constraints
	//   - grpc.AlreadyExists: The extension or name already exists.
	//   - grpc.PermissionDenied: Caller doesn't have the required permissions.
	//   - grpc.Internal: An internal error occurred.
	//   - grpc.Unavailable: The operation is currently unavailable. Likely a transient issue with a downstream service.
	CreateRingGroup(context.Context, *CreateRingGroupRequest) (*CreateRingGroupResponse, error)
	// Deletes a specific Ring Group for the authenticated caller's ORG.
	// Required permissions:
	//
	//	PBX-MANAGER
	//
	// Errors:
	//   - grpc.InvalidArgument: The groupID is an invalid format.
	//   - grpc.NotFound: The group does not exist or is not in the caller's ORG.
	//   - grpc.PermissionDenied: Caller doesn't have the required permissions.
	//   - grpc.Internal: An internal error occurred.
	//   - grpc.Unavailable: The operation is currently unavailable. Likely a transient issue with a downstream service.
	DeleteRingGroup(context.Context, *DeleteRingGroupRequest) (*DeleteRingGroupResponse, error)
	// Assigns a random extension either to a PBX user or a Ring Group
	// Required permissions:
	//
	//	PBX-MANAGER
	//
	// Errors:
	//   - grpc.PermissionDenied: Caller doesn't have the required permissions.
	//   - grpc.NotFound: No free extension found.
	//   - grpc.Internal: An internal error occurred.
	//   - grpc.Unavailable: The operation is currently unavailable. Likely a transient issue with a downstream service.
	AssignRandomExtension(context.Context, *AssignRandomExtensionRequest) (*AssignRandomExtensionResponse, error)
	// contains filtered or unexported methods
}

PBXServiceServer is the server API for PBXService service. All implementations must embed UnimplementedPBXServiceServer for forward compatibility

type PBXUser

type PBXUser struct {
	PbxUserId     string   `protobuf:"bytes,1,opt,name=pbx_user_id,json=pbxUserId,proto3" json:"pbx_user_id,omitempty"`
	OrgUserId     string   `protobuf:"bytes,2,opt,name=org_user_id,json=orgUserId,proto3" json:"org_user_id,omitempty"`
	SipAccountIds []string `protobuf:"bytes,3,rep,name=sip_account_ids,json=sipAccountIds,proto3" json:"sip_account_ids,omitempty"`
	// contains filtered or unexported fields
}

------------------------- Entity Definitions -------------------------

func (*PBXUser) Descriptor deprecated

func (*PBXUser) Descriptor() ([]byte, []int)

Deprecated: Use PBXUser.ProtoReflect.Descriptor instead.

func (*PBXUser) GetOrgUserId

func (x *PBXUser) GetOrgUserId() string

func (*PBXUser) GetPbxUserId

func (x *PBXUser) GetPbxUserId() string

func (*PBXUser) GetSipAccountIds

func (x *PBXUser) GetSipAccountIds() []string

func (*PBXUser) ProtoMessage

func (*PBXUser) ProtoMessage()

func (*PBXUser) ProtoReflect

func (x *PBXUser) ProtoReflect() protoreflect.Message

func (*PBXUser) Reset

func (x *PBXUser) Reset()

func (*PBXUser) String

func (x *PBXUser) String() string

type RingGroup

type RingGroup struct {
	Id            string       `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Name          string       `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	Description   string       `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	Extension     string       `protobuf:"bytes,4,opt,name=extension,proto3" json:"extension,omitempty"`
	RingStrategy  RingStrategy `` /* 132-byte string literal not displayed */
	SipAccountIds []string     `protobuf:"bytes,6,rep,name=sip_account_ids,json=sipAccountIds,proto3" json:"sip_account_ids,omitempty"`
	// contains filtered or unexported fields
}

func (*RingGroup) Descriptor deprecated

func (*RingGroup) Descriptor() ([]byte, []int)

Deprecated: Use RingGroup.ProtoReflect.Descriptor instead.

func (*RingGroup) GetDescription

func (x *RingGroup) GetDescription() string

func (*RingGroup) GetExtension

func (x *RingGroup) GetExtension() string

func (*RingGroup) GetId

func (x *RingGroup) GetId() string

func (*RingGroup) GetName

func (x *RingGroup) GetName() string

func (*RingGroup) GetRingStrategy

func (x *RingGroup) GetRingStrategy() RingStrategy

func (*RingGroup) GetSipAccountIds

func (x *RingGroup) GetSipAccountIds() []string

func (*RingGroup) ProtoMessage

func (*RingGroup) ProtoMessage()

func (*RingGroup) ProtoReflect

func (x *RingGroup) ProtoReflect() protoreflect.Message

func (*RingGroup) Reset

func (x *RingGroup) Reset()

func (*RingGroup) String

func (x *RingGroup) String() string

type RingStrategy

type RingStrategy int32

------------------------- Enums -------------------------

const (
	RingStrategy_RING_STRATEGY_UNSPECIFIED RingStrategy = 0
	RingStrategy_RING_STRATEGY_RING_ALL    RingStrategy = 1
	RingStrategy_RING_STRATEGY_ROUND_ROBIN RingStrategy = 2
	RingStrategy_RING_STRATEGY_RANDOM      RingStrategy = 3
	RingStrategy_RING_STRATEGY_ORDERED     RingStrategy = 4
)

func (RingStrategy) Descriptor

func (RingStrategy) Enum

func (x RingStrategy) Enum() *RingStrategy

func (RingStrategy) EnumDescriptor deprecated

func (RingStrategy) EnumDescriptor() ([]byte, []int)

Deprecated: Use RingStrategy.Descriptor instead.

func (RingStrategy) Number

func (RingStrategy) String

func (x RingStrategy) String() string

func (RingStrategy) Type

type SIPAccount

type SIPAccount struct {
	SipId        string   `protobuf:"bytes,1,opt,name=sip_id,json=sipId,proto3" json:"sip_id,omitempty"`
	IsActive     bool     `protobuf:"varint,2,opt,name=is_active,json=isActive,proto3" json:"is_active,omitempty"`
	Extension    string   `protobuf:"bytes,3,opt,name=extension,proto3" json:"extension,omitempty"`
	RingGroupIds []string `protobuf:"bytes,4,rep,name=ring_group_ids,json=ringGroupIds,proto3" json:"ring_group_ids,omitempty"`
	OrgUserId    string   `protobuf:"bytes,5,opt,name=org_user_id,json=orgUserId,proto3" json:"org_user_id,omitempty"`
	// contains filtered or unexported fields
}

func (*SIPAccount) Descriptor deprecated

func (*SIPAccount) Descriptor() ([]byte, []int)

Deprecated: Use SIPAccount.ProtoReflect.Descriptor instead.

func (*SIPAccount) GetExtension

func (x *SIPAccount) GetExtension() string

func (*SIPAccount) GetIsActive

func (x *SIPAccount) GetIsActive() bool

func (*SIPAccount) GetOrgUserId

func (x *SIPAccount) GetOrgUserId() string

func (*SIPAccount) GetRingGroupIds

func (x *SIPAccount) GetRingGroupIds() []string

func (*SIPAccount) GetSipId

func (x *SIPAccount) GetSipId() string

func (*SIPAccount) ProtoMessage

func (*SIPAccount) ProtoMessage()

func (*SIPAccount) ProtoReflect

func (x *SIPAccount) ProtoReflect() protoreflect.Message

func (*SIPAccount) Reset

func (x *SIPAccount) Reset()

func (*SIPAccount) String

func (x *SIPAccount) String() string

type UnimplementedPBXServiceServer

type UnimplementedPBXServiceServer struct {
}

UnimplementedPBXServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedPBXServiceServer) CreateRingGroup

func (UnimplementedPBXServiceServer) DeleteRingGroup

func (UnimplementedPBXServiceServer) GetPBXUser

func (UnimplementedPBXServiceServer) GetRingGroup

func (UnimplementedPBXServiceServer) GetSIPAccount

func (UnimplementedPBXServiceServer) ListPBXUsers

func (UnimplementedPBXServiceServer) ListRingGroups

func (UnimplementedPBXServiceServer) ListSIPAccounts

func (UnimplementedPBXServiceServer) UpdateRingGroup

func (UnimplementedPBXServiceServer) UpdateSIPAccount

type UnsafePBXServiceServer

type UnsafePBXServiceServer interface {
	// contains filtered or unexported methods
}

UnsafePBXServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to PBXServiceServer will result in compilation errors.

type UpdateRingGroupRequest

type UpdateRingGroupRequest struct {
	Group      *RingGroup             `protobuf:"bytes,1,opt,name=group,proto3" json:"group,omitempty"`
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"` // Fields to be modified.
	// contains filtered or unexported fields
}

func (*UpdateRingGroupRequest) Descriptor deprecated

func (*UpdateRingGroupRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateRingGroupRequest.ProtoReflect.Descriptor instead.

func (*UpdateRingGroupRequest) GetGroup

func (x *UpdateRingGroupRequest) GetGroup() *RingGroup

func (*UpdateRingGroupRequest) GetUpdateMask

func (x *UpdateRingGroupRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateRingGroupRequest) ProtoMessage

func (*UpdateRingGroupRequest) ProtoMessage()

func (*UpdateRingGroupRequest) ProtoReflect

func (x *UpdateRingGroupRequest) ProtoReflect() protoreflect.Message

func (*UpdateRingGroupRequest) Reset

func (x *UpdateRingGroupRequest) Reset()

func (*UpdateRingGroupRequest) String

func (x *UpdateRingGroupRequest) String() string

type UpdateRingGroupResponse

type UpdateRingGroupResponse struct {
	Group *RingGroup `protobuf:"bytes,1,opt,name=group,proto3" json:"group,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateRingGroupResponse) Descriptor deprecated

func (*UpdateRingGroupResponse) Descriptor() ([]byte, []int)

Deprecated: Use UpdateRingGroupResponse.ProtoReflect.Descriptor instead.

func (*UpdateRingGroupResponse) GetGroup

func (x *UpdateRingGroupResponse) GetGroup() *RingGroup

func (*UpdateRingGroupResponse) ProtoMessage

func (*UpdateRingGroupResponse) ProtoMessage()

func (*UpdateRingGroupResponse) ProtoReflect

func (x *UpdateRingGroupResponse) ProtoReflect() protoreflect.Message

func (*UpdateRingGroupResponse) Reset

func (x *UpdateRingGroupResponse) Reset()

func (*UpdateRingGroupResponse) String

func (x *UpdateRingGroupResponse) String() string

type UpdateSIPAccountRequest

type UpdateSIPAccountRequest struct {
	SipAccount *SIPAccount            `protobuf:"bytes,1,opt,name=sip_account,json=sipAccount,proto3" json:"sip_account,omitempty"` // The sip account details to update.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"` // Fields to be updated.
	// contains filtered or unexported fields
}

func (*UpdateSIPAccountRequest) Descriptor deprecated

func (*UpdateSIPAccountRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateSIPAccountRequest.ProtoReflect.Descriptor instead.

func (*UpdateSIPAccountRequest) GetSipAccount

func (x *UpdateSIPAccountRequest) GetSipAccount() *SIPAccount

func (*UpdateSIPAccountRequest) GetUpdateMask

func (x *UpdateSIPAccountRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateSIPAccountRequest) ProtoMessage

func (*UpdateSIPAccountRequest) ProtoMessage()

func (*UpdateSIPAccountRequest) ProtoReflect

func (x *UpdateSIPAccountRequest) ProtoReflect() protoreflect.Message

func (*UpdateSIPAccountRequest) Reset

func (x *UpdateSIPAccountRequest) Reset()

func (*UpdateSIPAccountRequest) String

func (x *UpdateSIPAccountRequest) String() string

type UpdateSIPAccountResponse

type UpdateSIPAccountResponse struct {
	SipAccount *SIPAccount `protobuf:"bytes,1,opt,name=sip_account,json=sipAccount,proto3" json:"sip_account,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateSIPAccountResponse) Descriptor deprecated

func (*UpdateSIPAccountResponse) Descriptor() ([]byte, []int)

Deprecated: Use UpdateSIPAccountResponse.ProtoReflect.Descriptor instead.

func (*UpdateSIPAccountResponse) GetSipAccount

func (x *UpdateSIPAccountResponse) GetSipAccount() *SIPAccount

func (*UpdateSIPAccountResponse) ProtoMessage

func (*UpdateSIPAccountResponse) ProtoMessage()

func (*UpdateSIPAccountResponse) ProtoReflect

func (x *UpdateSIPAccountResponse) ProtoReflect() protoreflect.Message

func (*UpdateSIPAccountResponse) Reset

func (x *UpdateSIPAccountResponse) Reset()

func (*UpdateSIPAccountResponse) String

func (x *UpdateSIPAccountResponse) String() string

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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