pbxv1

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

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

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
}

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

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

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

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)
}

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
}

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
}

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
}

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

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
}

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

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
}

type RingStrategy int32

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
}

type UnimplementedPBXServiceServer struct {
}

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

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
}

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

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
}

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