Documentation ¶
Index ¶
- Constants
- Variables
- func RegisterPBXServiceServer(s grpc.ServiceRegistrar, srv PBXServiceServer)
- type AssignRandomExtensionRequest
- func (*AssignRandomExtensionRequest) Descriptor() ([]byte, []int)deprecated
- func (*AssignRandomExtensionRequest) ProtoMessage()
- func (x *AssignRandomExtensionRequest) ProtoReflect() protoreflect.Message
- func (x *AssignRandomExtensionRequest) Reset()
- func (x *AssignRandomExtensionRequest) String() string
- type AssignRandomExtensionResponse
- func (*AssignRandomExtensionResponse) Descriptor() ([]byte, []int)deprecated
- func (x *AssignRandomExtensionResponse) GetExtension() int32
- func (*AssignRandomExtensionResponse) ProtoMessage()
- func (x *AssignRandomExtensionResponse) ProtoReflect() protoreflect.Message
- func (x *AssignRandomExtensionResponse) Reset()
- func (x *AssignRandomExtensionResponse) String() string
- type CreateRingGroupRequest
- func (*CreateRingGroupRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CreateRingGroupRequest) GetDescription() string
- func (x *CreateRingGroupRequest) GetExtension() int32
- func (x *CreateRingGroupRequest) GetName() string
- func (x *CreateRingGroupRequest) GetPbxUserIds() []string
- func (x *CreateRingGroupRequest) GetRingStrategy() RingStrategy
- func (*CreateRingGroupRequest) ProtoMessage()
- func (x *CreateRingGroupRequest) ProtoReflect() protoreflect.Message
- func (x *CreateRingGroupRequest) Reset()
- func (x *CreateRingGroupRequest) String() string
- type CreateRingGroupResponse
- func (*CreateRingGroupResponse) Descriptor() ([]byte, []int)deprecated
- func (x *CreateRingGroupResponse) GetGroup() *RingGroup
- func (*CreateRingGroupResponse) ProtoMessage()
- func (x *CreateRingGroupResponse) ProtoReflect() protoreflect.Message
- func (x *CreateRingGroupResponse) Reset()
- func (x *CreateRingGroupResponse) String() string
- type DeleteRingGroupRequest
- func (*DeleteRingGroupRequest) Descriptor() ([]byte, []int)deprecated
- func (x *DeleteRingGroupRequest) GetGroupId() string
- func (*DeleteRingGroupRequest) ProtoMessage()
- func (x *DeleteRingGroupRequest) ProtoReflect() protoreflect.Message
- func (x *DeleteRingGroupRequest) Reset()
- func (x *DeleteRingGroupRequest) String() string
- type DeleteRingGroupResponse
- type PBXServiceClient
- type PBXServiceServer
- type PBXUser
- func (*PBXUser) Descriptor() ([]byte, []int)deprecated
- func (x *PBXUser) GetOrgUserId() string
- func (x *PBXUser) GetPbxUserId() string
- func (x *PBXUser) GetSipAccounts() []*SIPAccount
- func (*PBXUser) ProtoMessage()
- func (x *PBXUser) ProtoReflect() protoreflect.Message
- func (x *PBXUser) Reset()
- func (x *PBXUser) String() string
- type QueryPbxUsersRequest
- func (*QueryPbxUsersRequest) Descriptor() ([]byte, []int)deprecated
- func (x *QueryPbxUsersRequest) GetPbxUserId() string
- func (x *QueryPbxUsersRequest) GetResponseMask() *fieldmaskpb.FieldMask
- func (*QueryPbxUsersRequest) ProtoMessage()
- func (x *QueryPbxUsersRequest) ProtoReflect() protoreflect.Message
- func (x *QueryPbxUsersRequest) Reset()
- func (x *QueryPbxUsersRequest) String() string
- type QueryPbxUsersResponse
- func (*QueryPbxUsersResponse) Descriptor() ([]byte, []int)deprecated
- func (x *QueryPbxUsersResponse) GetUsers() []*PBXUser
- func (*QueryPbxUsersResponse) ProtoMessage()
- func (x *QueryPbxUsersResponse) ProtoReflect() protoreflect.Message
- func (x *QueryPbxUsersResponse) Reset()
- func (x *QueryPbxUsersResponse) String() string
- type QueryRingGroupsRequest
- func (*QueryRingGroupsRequest) Descriptor() ([]byte, []int)deprecated
- func (x *QueryRingGroupsRequest) GetGroupId() string
- func (x *QueryRingGroupsRequest) GetResponseMask() *fieldmaskpb.FieldMask
- func (*QueryRingGroupsRequest) ProtoMessage()
- func (x *QueryRingGroupsRequest) ProtoReflect() protoreflect.Message
- func (x *QueryRingGroupsRequest) Reset()
- func (x *QueryRingGroupsRequest) String() string
- type QueryRingGroupsResponse
- func (*QueryRingGroupsResponse) Descriptor() ([]byte, []int)deprecated
- func (x *QueryRingGroupsResponse) GetGroups() []*RingGroup
- func (*QueryRingGroupsResponse) ProtoMessage()
- func (x *QueryRingGroupsResponse) ProtoReflect() protoreflect.Message
- func (x *QueryRingGroupsResponse) Reset()
- func (x *QueryRingGroupsResponse) String() string
- type RingGroup
- func (*RingGroup) Descriptor() ([]byte, []int)deprecated
- func (x *RingGroup) GetDescription() string
- func (x *RingGroup) GetExtension() int32
- func (x *RingGroup) GetId() string
- func (x *RingGroup) GetName() string
- func (x *RingGroup) GetPbxUsers() []*PBXUser
- func (x *RingGroup) GetRingStrategy() RingStrategy
- func (*RingGroup) ProtoMessage()
- func (x *RingGroup) ProtoReflect() protoreflect.Message
- func (x *RingGroup) Reset()
- func (x *RingGroup) String() string
- type RingStrategy
- func (RingStrategy) Descriptor() protoreflect.EnumDescriptor
- func (x RingStrategy) Enum() *RingStrategy
- func (RingStrategy) EnumDescriptor() ([]byte, []int)deprecated
- func (x RingStrategy) Number() protoreflect.EnumNumber
- func (x RingStrategy) String() string
- func (RingStrategy) Type() protoreflect.EnumType
- type SIPAccount
- func (*SIPAccount) Descriptor() ([]byte, []int)deprecated
- func (x *SIPAccount) GetExtension() int32
- func (x *SIPAccount) GetIsActive() bool
- func (x *SIPAccount) GetRingGroups() []*RingGroup
- func (x *SIPAccount) GetSipId() string
- func (*SIPAccount) ProtoMessage()
- func (x *SIPAccount) ProtoReflect() protoreflect.Message
- func (x *SIPAccount) Reset()
- func (x *SIPAccount) String() string
- type UnimplementedPBXServiceServer
- func (UnimplementedPBXServiceServer) AssignRandomExtension(context.Context, *AssignRandomExtensionRequest) (*AssignRandomExtensionResponse, error)
- func (UnimplementedPBXServiceServer) CreateRingGroup(context.Context, *CreateRingGroupRequest) (*CreateRingGroupResponse, error)
- func (UnimplementedPBXServiceServer) DeleteRingGroup(context.Context, *DeleteRingGroupRequest) (*DeleteRingGroupResponse, error)
- func (UnimplementedPBXServiceServer) QueryPbxUsers(context.Context, *QueryPbxUsersRequest) (*QueryPbxUsersResponse, error)
- func (UnimplementedPBXServiceServer) QueryRingGroups(context.Context, *QueryRingGroupsRequest) (*QueryRingGroupsResponse, error)
- func (UnimplementedPBXServiceServer) UpdatePbxUser(context.Context, *UpdatePbxUserRequest) (*UpdatePbxUserResponse, error)
- func (UnimplementedPBXServiceServer) UpdateRingGroup(context.Context, *UpdateRingGroupRequest) (*UpdateRingGroupResponse, error)
- type UnsafePBXServiceServer
- type UpdatePbxUserRequest
- func (*UpdatePbxUserRequest) Descriptor() ([]byte, []int)deprecated
- func (x *UpdatePbxUserRequest) GetUpdateMask() *fieldmaskpb.FieldMask
- func (x *UpdatePbxUserRequest) GetUser() *PBXUser
- func (*UpdatePbxUserRequest) ProtoMessage()
- func (x *UpdatePbxUserRequest) ProtoReflect() protoreflect.Message
- func (x *UpdatePbxUserRequest) Reset()
- func (x *UpdatePbxUserRequest) String() string
- type UpdatePbxUserResponse
- func (*UpdatePbxUserResponse) Descriptor() ([]byte, []int)deprecated
- func (x *UpdatePbxUserResponse) GetUser() *PBXUser
- func (*UpdatePbxUserResponse) ProtoMessage()
- func (x *UpdatePbxUserResponse) ProtoReflect() protoreflect.Message
- func (x *UpdatePbxUserResponse) Reset()
- func (x *UpdatePbxUserResponse) String() string
- type UpdateRingGroupRequest
- func (*UpdateRingGroupRequest) Descriptor() ([]byte, []int)deprecated
- func (x *UpdateRingGroupRequest) GetGroup() *RingGroup
- func (x *UpdateRingGroupRequest) GetUpdateMask() *fieldmaskpb.FieldMask
- func (*UpdateRingGroupRequest) ProtoMessage()
- func (x *UpdateRingGroupRequest) ProtoReflect() protoreflect.Message
- func (x *UpdateRingGroupRequest) Reset()
- func (x *UpdateRingGroupRequest) String() string
- type UpdateRingGroupResponse
- func (*UpdateRingGroupResponse) Descriptor() ([]byte, []int)deprecated
- func (x *UpdateRingGroupResponse) GetGroup() *RingGroup
- func (*UpdateRingGroupResponse) ProtoMessage()
- func (x *UpdateRingGroupResponse) ProtoReflect() protoreflect.Message
- func (x *UpdateRingGroupResponse) Reset()
- func (x *UpdateRingGroupResponse) String() string
Constants ¶
const ( PBXService_QueryPbxUsers_FullMethodName = "/services.pbx.v1.PBXService/QueryPbxUsers" PBXService_QueryRingGroups_FullMethodName = "/services.pbx.v1.PBXService/QueryRingGroups" PBXService_UpdatePbxUser_FullMethodName = "/services.pbx.v1.PBXService/UpdatePbxUser" PBXService_UpdateRingGroup_FullMethodName = "/services.pbx.v1.PBXService/UpdateRingGroup" PBXService_CreateRingGroup_FullMethodName = "/services.pbx.v1.PBXService/CreateRingGroup" PBXService_DeleteRingGroup_FullMethodName = "/services.pbx.v1.PBXService/DeleteRingGroup" PBXService_AssignRandomExtension_FullMethodName = "/services.pbx.v1.PBXService/AssignRandomExtension" )
Variables ¶
var ( RingStrategy_name = map[int32]string{ 0: "RING_STRATEGY_UNSPECIFIED", 1: "RING_STRATEGY_RING_ALL", 2: "RING_STRATEGY_ROUND_ROBIN", 3: "RING_STRATEGY_RANDOM", } RingStrategy_value = map[string]int32{ "RING_STRATEGY_UNSPECIFIED": 0, "RING_STRATEGY_RING_ALL": 1, "RING_STRATEGY_ROUND_ROBIN": 2, "RING_STRATEGY_RANDOM": 3, } )
Enum value maps for RingStrategy.
var File_services_pbx_v1_service_proto protoreflect.FileDescriptor
var PBXService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "services.pbx.v1.PBXService", HandlerType: (*PBXServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "QueryPbxUsers", Handler: _PBXService_QueryPbxUsers_Handler, }, { MethodName: "QueryRingGroups", Handler: _PBXService_QueryRingGroups_Handler, }, { MethodName: "UpdatePbxUser", Handler: _PBXService_UpdatePbxUser_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/v1/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 (x *AssignRandomExtensionRequest) ProtoReflect() protoreflect.Message
func (*AssignRandomExtensionRequest) Reset ¶
func (x *AssignRandomExtensionRequest) Reset()
func (*AssignRandomExtensionRequest) String ¶
func (x *AssignRandomExtensionRequest) String() string
type AssignRandomExtensionResponse ¶
type AssignRandomExtensionResponse struct { Extension int32 `protobuf:"varint,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() int32
func (*AssignRandomExtensionResponse) ProtoMessage ¶
func (*AssignRandomExtensionResponse) ProtoMessage()
func (*AssignRandomExtensionResponse) ProtoReflect ¶
func (x *AssignRandomExtensionResponse) ProtoReflect() protoreflect.Message
func (*AssignRandomExtensionResponse) Reset ¶
func (x *AssignRandomExtensionResponse) Reset()
func (*AssignRandomExtensionResponse) String ¶
func (x *AssignRandomExtensionResponse) String() string
type CreateRingGroupRequest ¶
type CreateRingGroupRequest struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Required: The name of the group. Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"` // Optional: The description of the group. RingStrategy RingStrategy `` // Optional: The ring strategy of the group. /* 132-byte string literal not displayed */ PbxUserIds []string `protobuf:"bytes,4,rep,name=pbx_user_ids,json=pbxUserIds,proto3" json:"pbx_user_ids,omitempty"` // Optional: The PBX user IDs to add to the group. Extension int32 `protobuf:"varint,5,opt,name=extension,proto3" json:"extension,omitempty"` // Optional: The extension for the ring group. // contains filtered or unexported fields }
func (*CreateRingGroupRequest) Descriptor
deprecated
func (*CreateRingGroupRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateRingGroupRequest.ProtoReflect.Descriptor instead.
func (*CreateRingGroupRequest) GetDescription ¶
func (x *CreateRingGroupRequest) GetDescription() string
func (*CreateRingGroupRequest) GetExtension ¶ added in v1.7.37
func (x *CreateRingGroupRequest) GetExtension() int32
func (*CreateRingGroupRequest) GetName ¶
func (x *CreateRingGroupRequest) GetName() string
func (*CreateRingGroupRequest) GetPbxUserIds ¶
func (x *CreateRingGroupRequest) GetPbxUserIds() []string
func (*CreateRingGroupRequest) GetRingStrategy ¶
func (x *CreateRingGroupRequest) GetRingStrategy() RingStrategy
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 PBXServiceClient ¶
type PBXServiceClient interface { // Queries details of PBX Users based on specified criteria for 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. QueryPbxUsers(ctx context.Context, in *QueryPbxUsersRequest, opts ...grpc.CallOption) (*QueryPbxUsersResponse, error) // Queries details of Ring Groups based on specified criteria for 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. QueryRingGroups(ctx context.Context, in *QueryRingGroupsRequest, opts ...grpc.CallOption) (*QueryRingGroupsResponse, error) // Updates details of a PBX User for the authenticated callers ORG. // Allows for updating, activating, and deactivating a user. // 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. UpdatePbxUser(ctx context.Context, in *UpdatePbxUserRequest, opts ...grpc.CallOption) (*UpdatePbxUserResponse, 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.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.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.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 { // Queries details of PBX Users based on specified criteria for 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. QueryPbxUsers(context.Context, *QueryPbxUsersRequest) (*QueryPbxUsersResponse, error) // Queries details of Ring Groups based on specified criteria for 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. QueryRingGroups(context.Context, *QueryRingGroupsRequest) (*QueryRingGroupsResponse, error) // Updates details of a PBX User for the authenticated callers ORG. // Allows for updating, activating, and deactivating a user. // 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. UpdatePbxUser(context.Context, *UpdatePbxUserRequest) (*UpdatePbxUserResponse, 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.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.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.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"` SipAccounts []*SIPAccount `protobuf:"bytes,3,rep,name=sip_accounts,json=sipAccounts,proto3" json:"sip_accounts,omitempty"` // contains filtered or unexported fields }
------------------------- Entity Definitions -------------------------
func (*PBXUser) Descriptor
deprecated
func (*PBXUser) GetOrgUserId ¶
func (*PBXUser) GetPbxUserId ¶
func (*PBXUser) GetSipAccounts ¶
func (x *PBXUser) GetSipAccounts() []*SIPAccount
func (*PBXUser) ProtoMessage ¶
func (*PBXUser) ProtoMessage()
func (*PBXUser) ProtoReflect ¶
func (x *PBXUser) ProtoReflect() protoreflect.Message
type QueryPbxUsersRequest ¶
type QueryPbxUsersRequest struct { PbxUserId string `protobuf:"bytes,1,opt,name=pbx_user_id,json=pbxUserId,proto3" json:"pbx_user_id,omitempty"` // Optional: If you want to fetch a specific user by ID. ResponseMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=response_mask,json=responseMask,proto3" json:"response_mask,omitempty"` // Fields to be returned in the response. // contains filtered or unexported fields }
-------------------------
RPC Messages
-------------------------
func (*QueryPbxUsersRequest) Descriptor
deprecated
func (*QueryPbxUsersRequest) Descriptor() ([]byte, []int)
Deprecated: Use QueryPbxUsersRequest.ProtoReflect.Descriptor instead.
func (*QueryPbxUsersRequest) GetPbxUserId ¶
func (x *QueryPbxUsersRequest) GetPbxUserId() string
func (*QueryPbxUsersRequest) GetResponseMask ¶
func (x *QueryPbxUsersRequest) GetResponseMask() *fieldmaskpb.FieldMask
func (*QueryPbxUsersRequest) ProtoMessage ¶
func (*QueryPbxUsersRequest) ProtoMessage()
func (*QueryPbxUsersRequest) ProtoReflect ¶
func (x *QueryPbxUsersRequest) ProtoReflect() protoreflect.Message
func (*QueryPbxUsersRequest) Reset ¶
func (x *QueryPbxUsersRequest) Reset()
func (*QueryPbxUsersRequest) String ¶
func (x *QueryPbxUsersRequest) String() string
type QueryPbxUsersResponse ¶
type QueryPbxUsersResponse struct { Users []*PBXUser `protobuf:"bytes,1,rep,name=users,proto3" json:"users,omitempty"` // contains filtered or unexported fields }
func (*QueryPbxUsersResponse) Descriptor
deprecated
func (*QueryPbxUsersResponse) Descriptor() ([]byte, []int)
Deprecated: Use QueryPbxUsersResponse.ProtoReflect.Descriptor instead.
func (*QueryPbxUsersResponse) GetUsers ¶
func (x *QueryPbxUsersResponse) GetUsers() []*PBXUser
func (*QueryPbxUsersResponse) ProtoMessage ¶
func (*QueryPbxUsersResponse) ProtoMessage()
func (*QueryPbxUsersResponse) ProtoReflect ¶
func (x *QueryPbxUsersResponse) ProtoReflect() protoreflect.Message
func (*QueryPbxUsersResponse) Reset ¶
func (x *QueryPbxUsersResponse) Reset()
func (*QueryPbxUsersResponse) String ¶
func (x *QueryPbxUsersResponse) String() string
type QueryRingGroupsRequest ¶
type QueryRingGroupsRequest struct { GroupId string `protobuf:"bytes,1,opt,name=group_id,json=groupId,proto3" json:"group_id,omitempty"` // Optional: If you want to fetch a specific group by ID. ResponseMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=response_mask,json=responseMask,proto3" json:"response_mask,omitempty"` // Fields to be returned in the response. // contains filtered or unexported fields }
func (*QueryRingGroupsRequest) Descriptor
deprecated
func (*QueryRingGroupsRequest) Descriptor() ([]byte, []int)
Deprecated: Use QueryRingGroupsRequest.ProtoReflect.Descriptor instead.
func (*QueryRingGroupsRequest) GetGroupId ¶
func (x *QueryRingGroupsRequest) GetGroupId() string
func (*QueryRingGroupsRequest) GetResponseMask ¶
func (x *QueryRingGroupsRequest) GetResponseMask() *fieldmaskpb.FieldMask
func (*QueryRingGroupsRequest) ProtoMessage ¶
func (*QueryRingGroupsRequest) ProtoMessage()
func (*QueryRingGroupsRequest) ProtoReflect ¶
func (x *QueryRingGroupsRequest) ProtoReflect() protoreflect.Message
func (*QueryRingGroupsRequest) Reset ¶
func (x *QueryRingGroupsRequest) Reset()
func (*QueryRingGroupsRequest) String ¶
func (x *QueryRingGroupsRequest) String() string
type QueryRingGroupsResponse ¶
type QueryRingGroupsResponse struct { Groups []*RingGroup `protobuf:"bytes,1,rep,name=groups,proto3" json:"groups,omitempty"` // contains filtered or unexported fields }
func (*QueryRingGroupsResponse) Descriptor
deprecated
func (*QueryRingGroupsResponse) Descriptor() ([]byte, []int)
Deprecated: Use QueryRingGroupsResponse.ProtoReflect.Descriptor instead.
func (*QueryRingGroupsResponse) GetGroups ¶
func (x *QueryRingGroupsResponse) GetGroups() []*RingGroup
func (*QueryRingGroupsResponse) ProtoMessage ¶
func (*QueryRingGroupsResponse) ProtoMessage()
func (*QueryRingGroupsResponse) ProtoReflect ¶
func (x *QueryRingGroupsResponse) ProtoReflect() protoreflect.Message
func (*QueryRingGroupsResponse) Reset ¶
func (x *QueryRingGroupsResponse) Reset()
func (*QueryRingGroupsResponse) String ¶
func (x *QueryRingGroupsResponse) 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 int32 `protobuf:"varint,4,opt,name=extension,proto3" json:"extension,omitempty"` RingStrategy RingStrategy `` /* 132-byte string literal not displayed */ PbxUsers []*PBXUser `protobuf:"bytes,6,rep,name=pbx_users,json=pbxUsers,proto3" json:"pbx_users,omitempty"` // contains filtered or unexported fields }
func (*RingGroup) Descriptor
deprecated
func (*RingGroup) GetDescription ¶
func (*RingGroup) GetExtension ¶
func (*RingGroup) GetPbxUsers ¶
func (*RingGroup) GetRingStrategy ¶
func (x *RingGroup) GetRingStrategy() RingStrategy
func (*RingGroup) ProtoMessage ¶
func (*RingGroup) ProtoMessage()
func (*RingGroup) ProtoReflect ¶
func (x *RingGroup) ProtoReflect() protoreflect.Message
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 )
func (RingStrategy) Descriptor ¶
func (RingStrategy) Descriptor() protoreflect.EnumDescriptor
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 (x RingStrategy) Number() protoreflect.EnumNumber
func (RingStrategy) String ¶
func (x RingStrategy) String() string
func (RingStrategy) Type ¶
func (RingStrategy) Type() protoreflect.EnumType
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 int32 `protobuf:"varint,3,opt,name=extension,proto3" json:"extension,omitempty"` RingGroups []*RingGroup `protobuf:"bytes,4,rep,name=ring_groups,json=ringGroups,proto3" json:"ring_groups,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() int32
func (*SIPAccount) GetIsActive ¶
func (x *SIPAccount) GetIsActive() bool
func (*SIPAccount) GetRingGroups ¶
func (x *SIPAccount) GetRingGroups() []*RingGroup
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.
NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.
func (UnimplementedPBXServiceServer) AssignRandomExtension ¶
func (UnimplementedPBXServiceServer) AssignRandomExtension(context.Context, *AssignRandomExtensionRequest) (*AssignRandomExtensionResponse, error)
func (UnimplementedPBXServiceServer) CreateRingGroup ¶
func (UnimplementedPBXServiceServer) CreateRingGroup(context.Context, *CreateRingGroupRequest) (*CreateRingGroupResponse, error)
func (UnimplementedPBXServiceServer) DeleteRingGroup ¶
func (UnimplementedPBXServiceServer) DeleteRingGroup(context.Context, *DeleteRingGroupRequest) (*DeleteRingGroupResponse, error)
func (UnimplementedPBXServiceServer) QueryPbxUsers ¶
func (UnimplementedPBXServiceServer) QueryPbxUsers(context.Context, *QueryPbxUsersRequest) (*QueryPbxUsersResponse, error)
func (UnimplementedPBXServiceServer) QueryRingGroups ¶
func (UnimplementedPBXServiceServer) QueryRingGroups(context.Context, *QueryRingGroupsRequest) (*QueryRingGroupsResponse, error)
func (UnimplementedPBXServiceServer) UpdatePbxUser ¶
func (UnimplementedPBXServiceServer) UpdatePbxUser(context.Context, *UpdatePbxUserRequest) (*UpdatePbxUserResponse, error)
func (UnimplementedPBXServiceServer) UpdateRingGroup ¶
func (UnimplementedPBXServiceServer) UpdateRingGroup(context.Context, *UpdateRingGroupRequest) (*UpdateRingGroupResponse, error)
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 UpdatePbxUserRequest ¶
type UpdatePbxUserRequest struct { User *PBXUser `protobuf:"bytes,1,opt,name=user,proto3" json:"user,omitempty"` // The user 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 (*UpdatePbxUserRequest) Descriptor
deprecated
func (*UpdatePbxUserRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdatePbxUserRequest.ProtoReflect.Descriptor instead.
func (*UpdatePbxUserRequest) GetUpdateMask ¶
func (x *UpdatePbxUserRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdatePbxUserRequest) GetUser ¶
func (x *UpdatePbxUserRequest) GetUser() *PBXUser
func (*UpdatePbxUserRequest) ProtoMessage ¶
func (*UpdatePbxUserRequest) ProtoMessage()
func (*UpdatePbxUserRequest) ProtoReflect ¶
func (x *UpdatePbxUserRequest) ProtoReflect() protoreflect.Message
func (*UpdatePbxUserRequest) Reset ¶
func (x *UpdatePbxUserRequest) Reset()
func (*UpdatePbxUserRequest) String ¶
func (x *UpdatePbxUserRequest) String() string
type UpdatePbxUserResponse ¶
type UpdatePbxUserResponse struct { User *PBXUser `protobuf:"bytes,1,opt,name=user,proto3" json:"user,omitempty"` // contains filtered or unexported fields }
func (*UpdatePbxUserResponse) Descriptor
deprecated
func (*UpdatePbxUserResponse) Descriptor() ([]byte, []int)
Deprecated: Use UpdatePbxUserResponse.ProtoReflect.Descriptor instead.
func (*UpdatePbxUserResponse) GetUser ¶
func (x *UpdatePbxUserResponse) GetUser() *PBXUser
func (*UpdatePbxUserResponse) ProtoMessage ¶
func (*UpdatePbxUserResponse) ProtoMessage()
func (*UpdatePbxUserResponse) ProtoReflect ¶
func (x *UpdatePbxUserResponse) ProtoReflect() protoreflect.Message
func (*UpdatePbxUserResponse) Reset ¶
func (x *UpdatePbxUserResponse) Reset()
func (*UpdatePbxUserResponse) String ¶
func (x *UpdatePbxUserResponse) String() string
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