members

package
v1.1.97 Latest Latest
Warning

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

Go to latest
Published: Apr 2, 2024 License: MIT Imports: 20 Imported by: 1

Documentation

Overview

Package members is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source
const (
	Members_CreateProgram_FullMethodName                    = "/members.Members/createProgram"
	Members_UpdateProgram_FullMethodName                    = "/members.Members/updateProgram"
	Members_GetProgram_FullMethodName                       = "/members.Members/getProgram"
	Members_CopyProgram_FullMethodName                      = "/members.Members/copyProgram"
	Members_DeleteProgram_FullMethodName                    = "/members.Members/deleteProgram"
	Members_ListProgramsDeprecated_FullMethodName           = "/members.Members/listProgramsDeprecated"
	Members_ListPrograms_FullMethodName                     = "/members.Members/listPrograms"
	Members_CreateTier_FullMethodName                       = "/members.Members/createTier"
	Members_UpdateTier_FullMethodName                       = "/members.Members/updateTier"
	Members_GetTier_FullMethodName                          = "/members.Members/getTier"
	Members_DeleteTier_FullMethodName                       = "/members.Members/deleteTier"
	Members_ListTiersDeprecated_FullMethodName              = "/members.Members/listTiersDeprecated"
	Members_ListTiers_FullMethodName                        = "/members.Members/listTiers"
	Members_EnrolMember_FullMethodName                      = "/members.Members/enrolMember"
	Members_EnrolMemberPublic_FullMethodName                = "/members.Members/enrolMemberPublic"
	Members_GetMemberRecordById_FullMethodName              = "/members.Members/getMemberRecordById"
	Members_GetMemberRecordByExternalId_FullMethodName      = "/members.Members/getMemberRecordByExternalId"
	Members_CheckInMember_FullMethodName                    = "/members.Members/checkInMember"
	Members_CheckOutMember_FullMethodName                   = "/members.Members/checkOutMember"
	Members_ListMembersDeprecated_FullMethodName            = "/members.Members/listMembersDeprecated"
	Members_ListMembers_FullMethodName                      = "/members.Members/listMembers"
	Members_UpdateMember_FullMethodName                     = "/members.Members/updateMember"
	Members_EarnPoints_FullMethodName                       = "/members.Members/earnPoints"
	Members_BurnPoints_FullMethodName                       = "/members.Members/burnPoints"
	Members_SetPoints_FullMethodName                        = "/members.Members/setPoints"
	Members_ChangeMemberTier_FullMethodName                 = "/members.Members/changeMemberTier"
	Members_UpdateMembersBySegment_FullMethodName           = "/members.Members/updateMembersBySegment"
	Members_DeleteMembersBySegment_FullMethodName           = "/members.Members/deleteMembersBySegment"
	Members_DeleteMember_FullMethodName                     = "/members.Members/deleteMember"
	Members_CountMembersDeprecated_FullMethodName           = "/members.Members/countMembersDeprecated"
	Members_CountMembers_FullMethodName                     = "/members.Members/countMembers"
	Members_GetMessageHistoryForMember_FullMethodName       = "/members.Members/getMessageHistoryForMember"
	Members_GetMetaKeysForProgram_FullMethodName            = "/members.Members/getMetaKeysForProgram"
	Members_RenewMembersExpiry_FullMethodName               = "/members.Members/renewMembersExpiry"
	Members_UpdateMemberExpiry_FullMethodName               = "/members.Members/updateMemberExpiry"
	Members_PatchPerson_FullMethodName                      = "/members.Members/patchPerson"
	Members_CountMemberEvents_FullMethodName                = "/members.Members/countMemberEvents"
	Members_ListMemberEvents_FullMethodName                 = "/members.Members/listMemberEvents"
	Members_GetMemberEventMetaKeysForProgram_FullMethodName = "/members.Members/getMemberEventMetaKeysForProgram"
	Members_ListEventsForMember_FullMethodName              = "/members.Members/listEventsForMember"
	Members_DeleteMemberEvents_FullMethodName               = "/members.Members/deleteMemberEvents"
	Members_DeleteEventsForMember_FullMethodName            = "/members.Members/deleteEventsForMember"
	Members_DeleteMemberEvent_FullMethodName                = "/members.Members/deleteMemberEvent"
	Members_GetProgramEnrolment_FullMethodName              = "/members.Members/getProgramEnrolment"
)

Variables

View Source
var (
	MemberStatus_name = map[int32]string{
		0: "ENROLLED",
		1: "ACTIVE",
		2: "CHECKED_IN",
		3: "EXPIRED",
		4: "CHECKED_OUT",
		5: "DELETED",
	}
	MemberStatus_value = map[string]int32{
		"ENROLLED":    0,
		"ACTIVE":      1,
		"CHECKED_IN":  2,
		"EXPIRED":     3,
		"CHECKED_OUT": 4,
		"DELETED":     5,
	}
)

Enum value maps for MemberStatus.

View Source
var (
	MemberEvents_name = map[int32]string{
		0: "EVENT_MEMBER_DO_NOT_USE",
		1: "EVENT_MEMBER_CHECKED_IN",
		2: "EVENT_MEMBER_CHECKED_OUT",
		3: "EVENT_MEMBER_VERIFIED",
		4: "EVENT_MEMBER_POINTS_EARNED",
		5: "EVENT_MEMBER_POINTS_BURNED",
		6: "EVENT_MEMBER_POINTS_SET",
		7: "EVENT_MEMBER_TIER_CHANGED",
	}
	MemberEvents_value = map[string]int32{
		"EVENT_MEMBER_DO_NOT_USE":    0,
		"EVENT_MEMBER_CHECKED_IN":    1,
		"EVENT_MEMBER_CHECKED_OUT":   2,
		"EVENT_MEMBER_VERIFIED":      3,
		"EVENT_MEMBER_POINTS_EARNED": 4,
		"EVENT_MEMBER_POINTS_BURNED": 5,
		"EVENT_MEMBER_POINTS_SET":    6,
		"EVENT_MEMBER_TIER_CHANGED":  7,
	}
)

Enum value maps for MemberEvents.

View Source
var (
	ProgramAutoUpDownGradeTierType_name = map[int32]string{
		0: "UPDOWNGRADE_POINTS",
		1: "UPDOWNGRADE_SECONDARY_POINTS",
		2: "UPDOWNGRADE_TIER_POINTS",
		3: "UPDOWNGRADE_VISITS",
	}
	ProgramAutoUpDownGradeTierType_value = map[string]int32{
		"UPDOWNGRADE_POINTS":           0,
		"UPDOWNGRADE_SECONDARY_POINTS": 1,
		"UPDOWNGRADE_TIER_POINTS":      2,
		"UPDOWNGRADE_VISITS":           3,
	}
)

Enum value maps for ProgramAutoUpDownGradeTierType.

View Source
var (
	BalanceType_name = map[int32]string{
		0: "BALANCE_TYPE_STRING",
		1: "BALANCE_TYPE_INT",
		2: "BALANCE_TYPE_DOUBLE",
		3: "BALANCE_TYPE_MONEY",
	}
	BalanceType_value = map[string]int32{
		"BALANCE_TYPE_STRING": 0,
		"BALANCE_TYPE_INT":    1,
		"BALANCE_TYPE_DOUBLE": 2,
		"BALANCE_TYPE_MONEY":  3,
	}
)

Enum value maps for BalanceType.

View Source
var (
	ProfileImageSetting_name = map[int32]string{
		0: "PROFILE_IMAGE_NONE",
		1: "PROFILE_IMAGE_OPTIONAL",
		2: "PROFILE_IMAGE_REQUIRED",
	}
	ProfileImageSetting_value = map[string]int32{
		"PROFILE_IMAGE_NONE":     0,
		"PROFILE_IMAGE_OPTIONAL": 1,
		"PROFILE_IMAGE_REQUIRED": 2,
	}
)

Enum value maps for ProfileImageSetting.

View Source
var (
	RecoverPassDelivery_name = map[int32]string{
		0: "DELIVERY_REDIRECT",
		1: "DELIVERY_EMAIL",
		2: "DELIVERY_SMS",
	}
	RecoverPassDelivery_value = map[string]int32{
		"DELIVERY_REDIRECT": 0,
		"DELIVERY_EMAIL":    1,
		"DELIVERY_SMS":      2,
	}
)

Enum value maps for RecoverPassDelivery.

View Source
var File_io_member_a_rpc_proto protoreflect.FileDescriptor
View Source
var File_io_member_event_proto protoreflect.FileDescriptor
View Source
var File_io_member_member_events_proto protoreflect.FileDescriptor
View Source
var File_io_member_member_proto protoreflect.FileDescriptor
View Source
var File_io_member_program_proto protoreflect.FileDescriptor
View Source
var File_io_member_tier_proto protoreflect.FileDescriptor
View Source
var Members_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "members.Members",
	HandlerType: (*MembersServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "createProgram",
			Handler:    _Members_CreateProgram_Handler,
		},
		{
			MethodName: "updateProgram",
			Handler:    _Members_UpdateProgram_Handler,
		},
		{
			MethodName: "getProgram",
			Handler:    _Members_GetProgram_Handler,
		},
		{
			MethodName: "copyProgram",
			Handler:    _Members_CopyProgram_Handler,
		},
		{
			MethodName: "deleteProgram",
			Handler:    _Members_DeleteProgram_Handler,
		},
		{
			MethodName: "createTier",
			Handler:    _Members_CreateTier_Handler,
		},
		{
			MethodName: "updateTier",
			Handler:    _Members_UpdateTier_Handler,
		},
		{
			MethodName: "getTier",
			Handler:    _Members_GetTier_Handler,
		},
		{
			MethodName: "deleteTier",
			Handler:    _Members_DeleteTier_Handler,
		},
		{
			MethodName: "enrolMember",
			Handler:    _Members_EnrolMember_Handler,
		},
		{
			MethodName: "enrolMemberPublic",
			Handler:    _Members_EnrolMemberPublic_Handler,
		},
		{
			MethodName: "getMemberRecordById",
			Handler:    _Members_GetMemberRecordById_Handler,
		},
		{
			MethodName: "getMemberRecordByExternalId",
			Handler:    _Members_GetMemberRecordByExternalId_Handler,
		},
		{
			MethodName: "checkInMember",
			Handler:    _Members_CheckInMember_Handler,
		},
		{
			MethodName: "checkOutMember",
			Handler:    _Members_CheckOutMember_Handler,
		},
		{
			MethodName: "updateMember",
			Handler:    _Members_UpdateMember_Handler,
		},
		{
			MethodName: "earnPoints",
			Handler:    _Members_EarnPoints_Handler,
		},
		{
			MethodName: "burnPoints",
			Handler:    _Members_BurnPoints_Handler,
		},
		{
			MethodName: "setPoints",
			Handler:    _Members_SetPoints_Handler,
		},
		{
			MethodName: "changeMemberTier",
			Handler:    _Members_ChangeMemberTier_Handler,
		},
		{
			MethodName: "updateMembersBySegment",
			Handler:    _Members_UpdateMembersBySegment_Handler,
		},
		{
			MethodName: "deleteMembersBySegment",
			Handler:    _Members_DeleteMembersBySegment_Handler,
		},
		{
			MethodName: "deleteMember",
			Handler:    _Members_DeleteMember_Handler,
		},
		{
			MethodName: "countMembersDeprecated",
			Handler:    _Members_CountMembersDeprecated_Handler,
		},
		{
			MethodName: "countMembers",
			Handler:    _Members_CountMembers_Handler,
		},
		{
			MethodName: "getMetaKeysForProgram",
			Handler:    _Members_GetMetaKeysForProgram_Handler,
		},
		{
			MethodName: "renewMembersExpiry",
			Handler:    _Members_RenewMembersExpiry_Handler,
		},
		{
			MethodName: "updateMemberExpiry",
			Handler:    _Members_UpdateMemberExpiry_Handler,
		},
		{
			MethodName: "patchPerson",
			Handler:    _Members_PatchPerson_Handler,
		},
		{
			MethodName: "countMemberEvents",
			Handler:    _Members_CountMemberEvents_Handler,
		},
		{
			MethodName: "getMemberEventMetaKeysForProgram",
			Handler:    _Members_GetMemberEventMetaKeysForProgram_Handler,
		},
		{
			MethodName: "deleteMemberEvents",
			Handler:    _Members_DeleteMemberEvents_Handler,
		},
		{
			MethodName: "deleteEventsForMember",
			Handler:    _Members_DeleteEventsForMember_Handler,
		},
		{
			MethodName: "deleteMemberEvent",
			Handler:    _Members_DeleteMemberEvent_Handler,
		},
		{
			MethodName: "getProgramEnrolment",
			Handler:    _Members_GetProgramEnrolment_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "listProgramsDeprecated",
			Handler:       _Members_ListProgramsDeprecated_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "listPrograms",
			Handler:       _Members_ListPrograms_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "listTiersDeprecated",
			Handler:       _Members_ListTiersDeprecated_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "listTiers",
			Handler:       _Members_ListTiers_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "listMembersDeprecated",
			Handler:       _Members_ListMembersDeprecated_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "listMembers",
			Handler:       _Members_ListMembers_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "getMessageHistoryForMember",
			Handler:       _Members_GetMessageHistoryForMember_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "listMemberEvents",
			Handler:       _Members_ListMemberEvents_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "listEventsForMember",
			Handler:       _Members_ListEventsForMember_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "io/member/a_rpc.proto",
}

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

Functions

func RegisterMembersHandler

func RegisterMembersHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterMembersHandler registers the http handlers for service Members to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterMembersHandlerClient

func RegisterMembersHandlerClient(ctx context.Context, mux *runtime.ServeMux, client MembersClient) error

RegisterMembersHandlerClient registers the http handlers for service Members to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "MembersClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "MembersClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "MembersClient" to call the correct interceptors.

func RegisterMembersHandlerFromEndpoint

func RegisterMembersHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterMembersHandlerFromEndpoint is same as RegisterMembersHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterMembersHandlerServer

func RegisterMembersHandlerServer(ctx context.Context, mux *runtime.ServeMux, server MembersServer) error

RegisterMembersHandlerServer registers the http handlers for service Members to "mux". UnaryRPC :call MembersServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterMembersHandlerFromEndpoint instead.

func RegisterMembersServer

func RegisterMembersServer(s grpc.ServiceRegistrar, srv MembersServer)

Types

type BalanceType

type BalanceType int32
const (
	BalanceType_BALANCE_TYPE_STRING BalanceType = 0
	BalanceType_BALANCE_TYPE_INT    BalanceType = 1
	BalanceType_BALANCE_TYPE_DOUBLE BalanceType = 2
	BalanceType_BALANCE_TYPE_MONEY  BalanceType = 3
)

func (BalanceType) Descriptor

func (BalanceType) Enum

func (x BalanceType) Enum() *BalanceType

func (BalanceType) EnumDescriptor deprecated

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

Deprecated: Use BalanceType.Descriptor instead.

func (BalanceType) Number

func (x BalanceType) Number() protoreflect.EnumNumber

func (BalanceType) String

func (x BalanceType) String() string

func (BalanceType) Type

type ChangeTierRequest

type ChangeTierRequest struct {

	// PassKit generated member ID (22 characters). Required if externalMemberId and programId are not provided.
	// @tag: validateUpdate:"required_without=ExternalMemberId"
	MemberId string `protobuf:"bytes,1,opt,name=memberId,proto3" json:"memberId,omitempty" validateUpdate:"required_without=ExternalMemberId"`
	// External member ID. Required if id is not provided.
	// @tag: validateUpdate:"omitempty"
	ExternalMemberId string `protobuf:"bytes,2,opt,name=externalMemberId,proto3" json:"externalMemberId,omitempty" validateUpdate:"omitempty"`
	// Program ID which member belongs to. Required if id is not provided.
	// @tag: validateUpdate:"required_with=ExternalMemberId"
	ProgramId string `protobuf:"bytes,3,opt,name=programId,proto3" json:"programId,omitempty" validateUpdate:"required_with=ExternalMemberId"`
	// Indicates the ID of the tier.
	// @tag: validateUpdate:"required"
	TierId string `protobuf:"bytes,4,opt,name=tierId,proto3" json:"tierId,omitempty" validateUpdate:"required"`
	// @tag: validateUpdate:"omitempty"
	EventDetails *EventDetails `protobuf:"bytes,7,opt,name=eventDetails,proto3" json:"eventDetails,omitempty" validateUpdate:"omitempty"`
	// contains filtered or unexported fields
}

func (*ChangeTierRequest) Descriptor deprecated

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

Deprecated: Use ChangeTierRequest.ProtoReflect.Descriptor instead.

func (*ChangeTierRequest) GetEventDetails

func (x *ChangeTierRequest) GetEventDetails() *EventDetails

func (*ChangeTierRequest) GetExternalMemberId

func (x *ChangeTierRequest) GetExternalMemberId() string

func (*ChangeTierRequest) GetMemberId

func (x *ChangeTierRequest) GetMemberId() string

func (*ChangeTierRequest) GetProgramId

func (x *ChangeTierRequest) GetProgramId() string

func (*ChangeTierRequest) GetTierId

func (x *ChangeTierRequest) GetTierId() string

func (*ChangeTierRequest) ProtoMessage

func (*ChangeTierRequest) ProtoMessage()

func (*ChangeTierRequest) ProtoReflect

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

func (*ChangeTierRequest) Reset

func (x *ChangeTierRequest) Reset()

func (*ChangeTierRequest) String

func (x *ChangeTierRequest) String() string

type CustomExternalId

type CustomExternalId struct {

	// Field name which becomes a source of external id value. Available unique names are: null, person.emailAddress, person.mobileNumber.
	// @tag: validateGeneric:"omitempty,oneof=null person.emailAddress person.mobileNumber startswith=meta." validateCreate:"omitempty,oneof=null person.emailAddress person.mobileNumber|startswith=meta." validateUpdate:"omitempty,oneof=null person.emailAddress person.mobileNumber|startswith=meta."
	FieldUniqueName string `` /* 369-byte string literal not displayed */
	// Error message shown when provided value has been taken already.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	ErrorMessage string `` /* 159-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*CustomExternalId) Descriptor deprecated

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

Deprecated: Use CustomExternalId.ProtoReflect.Descriptor instead.

func (*CustomExternalId) GetErrorMessage

func (x *CustomExternalId) GetErrorMessage() string

func (*CustomExternalId) GetFieldUniqueName

func (x *CustomExternalId) GetFieldUniqueName() string

func (*CustomExternalId) ProtoMessage

func (*CustomExternalId) ProtoMessage()

func (*CustomExternalId) ProtoReflect

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

func (*CustomExternalId) Reset

func (x *CustomExternalId) Reset()

func (*CustomExternalId) String

func (x *CustomExternalId) String() string

type EarnBurnPointsRequest

type EarnBurnPointsRequest struct {

	// Internal PassKit ID.
	// @tag: validateGeneric:"required_without=ExternalId"
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty" validateGeneric:"required_without=ExternalId"`
	// External member ID.
	// @tag: validateGeneric:"required_without=Id"
	ExternalId string `protobuf:"bytes,2,opt,name=externalId,proto3" json:"externalId,omitempty" validateGeneric:"required_without=Id"`
	// Required if externalId is set.
	// @tag: validateGeneric:"required_without=Id"
	ProgramId string `protobuf:"bytes,3,opt,name=programId,proto3" json:"programId,omitempty" validateGeneric:"required_without=Id"`
	// The amount of primary points earned or burnt. The amount needs to be greater than or equal to 0.
	// @tag: validateGeneric:"required_without_all=SecondaryPoints TierPoints,gte=0"
	Points float32 `` /* 139-byte string literal not displayed */
	// The amount of secondary points earned or burnt. The amount needs to be greater than or equal to 0.
	// @tag: validateGeneric:"required_without_all=Points TierPoints,gte=0"
	SecondaryPoints float32 `` /* 148-byte string literal not displayed */
	// The amount of tier points earned or burnt. The amount needs to be greater than or equal to 0.
	// @tag: validateGeneric:"required_without_all=Points SecondaryPoints"
	TierPoints uint32 `` /* 136-byte string literal not displayed */
	// @tag: validateGeneric:"omitempty"
	EventDetails *EventDetails `protobuf:"bytes,7,opt,name=eventDetails,proto3" json:"eventDetails,omitempty" validateGeneric:"omitempty"`
	// Optional field to change the tierIf of the member.
	// @tag: validateGeneric:"omitempty"
	TierId string `protobuf:"bytes,8,opt,name=tierId,proto3" json:"tierId,omitempty" validateGeneric:"omitempty"`
	// contains filtered or unexported fields
}

func (*EarnBurnPointsRequest) Descriptor deprecated

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

Deprecated: Use EarnBurnPointsRequest.ProtoReflect.Descriptor instead.

func (*EarnBurnPointsRequest) GetEventDetails

func (x *EarnBurnPointsRequest) GetEventDetails() *EventDetails

func (*EarnBurnPointsRequest) GetExternalId

func (x *EarnBurnPointsRequest) GetExternalId() string

func (*EarnBurnPointsRequest) GetId

func (x *EarnBurnPointsRequest) GetId() string

func (*EarnBurnPointsRequest) GetPoints

func (x *EarnBurnPointsRequest) GetPoints() float32

func (*EarnBurnPointsRequest) GetProgramId

func (x *EarnBurnPointsRequest) GetProgramId() string

func (*EarnBurnPointsRequest) GetSecondaryPoints

func (x *EarnBurnPointsRequest) GetSecondaryPoints() float32

func (*EarnBurnPointsRequest) GetTierId

func (x *EarnBurnPointsRequest) GetTierId() string

func (*EarnBurnPointsRequest) GetTierPoints

func (x *EarnBurnPointsRequest) GetTierPoints() uint32

func (*EarnBurnPointsRequest) ProtoMessage

func (*EarnBurnPointsRequest) ProtoMessage()

func (*EarnBurnPointsRequest) ProtoReflect

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

func (*EarnBurnPointsRequest) Reset

func (x *EarnBurnPointsRequest) Reset()

func (*EarnBurnPointsRequest) String

func (x *EarnBurnPointsRequest) String() string

type EventCaptureSettings

type EventCaptureSettings struct {

	// Can be used to set data retention on event data. The key is the MemberEvents ENUM. Value is the data retention in days from the date the event record is created in the PassKit database.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	EventDataRetentionSettings map[uint32]uint32 `` /* 277-byte string literal not displayed */
	// If set, sends an SMS with unique link to member's registered phone number on check-in. Member will have to click the link and show unique code to merchant / attendant.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	SmsConfirmUponCheckIn bool `` /* 178-byte string literal not displayed */
	// If set, sends an Email with unique link to member's registered email on check-in. Member will have to click the link and show unique code to merchant / attendant.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	EmailConfirmUponCheckIn bool `` /* 182-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*EventCaptureSettings) Descriptor deprecated

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

Deprecated: Use EventCaptureSettings.ProtoReflect.Descriptor instead.

func (*EventCaptureSettings) GetEmailConfirmUponCheckIn

func (x *EventCaptureSettings) GetEmailConfirmUponCheckIn() bool

func (*EventCaptureSettings) GetEventDataRetentionSettings

func (x *EventCaptureSettings) GetEventDataRetentionSettings() map[uint32]uint32

func (*EventCaptureSettings) GetSmsConfirmUponCheckIn

func (x *EventCaptureSettings) GetSmsConfirmUponCheckIn() bool

func (*EventCaptureSettings) ProtoMessage

func (*EventCaptureSettings) ProtoMessage()

func (*EventCaptureSettings) ProtoReflect

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

func (*EventCaptureSettings) Reset

func (x *EventCaptureSettings) Reset()

func (*EventCaptureSettings) String

func (x *EventCaptureSettings) String() string

type EventDetails

type EventDetails struct {

	// Address the event took place.
	// @tag: validateCreate:"omitempty,max=255"
	Address string `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty" validateCreate:"omitempty,max=255"`
	// Latitude the event took place.
	// @tag: validateCreate:"omitempty"
	Lat float64 `protobuf:"fixed64,2,opt,name=lat,proto3" json:"lat,omitempty" validateCreate:"omitempty"`
	// Longitude the event took place.
	// @tag: validateCreate:"omitempty"
	Lon float64 `protobuf:"fixed64,3,opt,name=lon,proto3" json:"lon,omitempty" validateCreate:"omitempty"`
	// Altitude the event took place (in metres).
	// @tag: validateCreate:"omitempty"
	Alt int32 `protobuf:"varint,4,opt,name=alt,proto3" json:"alt,omitempty" validateCreate:"omitempty"`
	// External unique ID of the event.
	// @tag: validateCreate:"omitempty,max=255"
	ExternalEventId string `protobuf:"bytes,5,opt,name=externalEventId,proto3" json:"externalEventId,omitempty" validateCreate:"omitempty,max=255"`
	// External device ID of the device that was used to capture the event (for example when using an external scanning app).
	// @tag: validateCreate:"omitempty,max=255"
	ExternalDeviceId string `protobuf:"bytes,6,opt,name=externalDeviceId,proto3" json:"externalDeviceId,omitempty" validateCreate:"omitempty,max=255"`
	// External service ID of the service that was used for capturing the event (for example when using an external scanning app).
	// @tag: validateCreate:"omitempty,max=255"
	ExternalServiceId string `protobuf:"bytes,7,opt,name=externalServiceId,proto3" json:"externalServiceId,omitempty" validateCreate:"omitempty,max=255"`
	// Any meta data (for example gathered on scanning) that is relevant to the event (# of points earner, bill spent, device meta-data, etc).
	// @tag: validateCreate:"omitempty"
	MetaData map[string]string `` /* 184-byte string literal not displayed */
	// Any relevant notes for the event.
	// @tag: validateCreate:"omitempty"
	Notes string `protobuf:"bytes,9,opt,name=notes,proto3" json:"notes,omitempty" validateCreate:"omitempty"`
	// contains filtered or unexported fields
}

Details on the event. These info will be stored in Member Event.

func (*EventDetails) Descriptor deprecated

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

Deprecated: Use EventDetails.ProtoReflect.Descriptor instead.

func (*EventDetails) GetAddress

func (x *EventDetails) GetAddress() string

func (*EventDetails) GetAlt

func (x *EventDetails) GetAlt() int32

func (*EventDetails) GetExternalDeviceId

func (x *EventDetails) GetExternalDeviceId() string

func (*EventDetails) GetExternalEventId

func (x *EventDetails) GetExternalEventId() string

func (*EventDetails) GetExternalServiceId

func (x *EventDetails) GetExternalServiceId() string

func (*EventDetails) GetLat

func (x *EventDetails) GetLat() float64

func (*EventDetails) GetLon

func (x *EventDetails) GetLon() float64

func (*EventDetails) GetMetaData

func (x *EventDetails) GetMetaData() map[string]string

func (*EventDetails) GetNotes

func (x *EventDetails) GetNotes() string

func (*EventDetails) ProtoMessage

func (*EventDetails) ProtoMessage()

func (*EventDetails) ProtoReflect

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

func (*EventDetails) Reset

func (x *EventDetails) Reset()

func (*EventDetails) String

func (x *EventDetails) String() string

type GetMetaKeysResponse

type GetMetaKeysResponse struct {

	// An array of distinct meta keys.
	Keys []string `protobuf:"bytes,1,rep,name=keys,proto3" json:"keys,omitempty"`
	// contains filtered or unexported fields
}

func (*GetMetaKeysResponse) Descriptor deprecated

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

Deprecated: Use GetMetaKeysResponse.ProtoReflect.Descriptor instead.

func (*GetMetaKeysResponse) GetKeys

func (x *GetMetaKeysResponse) GetKeys() []string

func (*GetMetaKeysResponse) ProtoMessage

func (*GetMetaKeysResponse) ProtoMessage()

func (*GetMetaKeysResponse) ProtoReflect

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

func (*GetMetaKeysResponse) Reset

func (x *GetMetaKeysResponse) Reset()

func (*GetMetaKeysResponse) String

func (x *GetMetaKeysResponse) String() string

type ListProgramsResponse

type ListProgramsResponse struct {

	// An array of programs.
	Programs []*Program `protobuf:"bytes,1,rep,name=programs,proto3" json:"programs,omitempty"`
	// contains filtered or unexported fields
}

Contains an array of programs.

func (*ListProgramsResponse) Descriptor deprecated

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

Deprecated: Use ListProgramsResponse.ProtoReflect.Descriptor instead.

func (*ListProgramsResponse) GetPrograms

func (x *ListProgramsResponse) GetPrograms() []*Program

func (*ListProgramsResponse) ProtoMessage

func (*ListProgramsResponse) ProtoMessage()

func (*ListProgramsResponse) ProtoReflect

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

func (*ListProgramsResponse) Reset

func (x *ListProgramsResponse) Reset()

func (*ListProgramsResponse) String

func (x *ListProgramsResponse) String() string

type ListRequest

type ListRequest struct {

	// @tag: validateGeneric:"required" validateCreate:"required" validateUpdate:"required"
	ProgramId string `` /* 150-byte string literal not displayed */
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	Filters *io.Filters `` /* 149-byte string literal not displayed */
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	EmailAsCsv bool `` /* 156-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*ListRequest) Descriptor deprecated

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

Deprecated: Use ListRequest.ProtoReflect.Descriptor instead.

func (*ListRequest) GetEmailAsCsv

func (x *ListRequest) GetEmailAsCsv() bool

func (*ListRequest) GetFilters

func (x *ListRequest) GetFilters() *io.Filters

func (*ListRequest) GetProgramId

func (x *ListRequest) GetProgramId() string

func (*ListRequest) ProtoMessage

func (*ListRequest) ProtoMessage()

func (*ListRequest) ProtoReflect

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

func (*ListRequest) Reset

func (x *ListRequest) Reset()

func (*ListRequest) String

func (x *ListRequest) String() string

type ListRequestDeprecated

type ListRequestDeprecated struct {

	// @tag: validateGeneric:"required" validateCreate:"required" validateUpdate:"required"
	ProgramId string `` /* 150-byte string literal not displayed */
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	Pagination *io.Pagination `` /* 155-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*ListRequestDeprecated) Descriptor deprecated

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

Deprecated: Use ListRequestDeprecated.ProtoReflect.Descriptor instead.

func (*ListRequestDeprecated) GetPagination

func (x *ListRequestDeprecated) GetPagination() *io.Pagination

func (*ListRequestDeprecated) GetProgramId

func (x *ListRequestDeprecated) GetProgramId() string

func (*ListRequestDeprecated) ProtoMessage

func (*ListRequestDeprecated) ProtoMessage()

func (*ListRequestDeprecated) ProtoReflect

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

func (*ListRequestDeprecated) Reset

func (x *ListRequestDeprecated) Reset()

func (*ListRequestDeprecated) String

func (x *ListRequestDeprecated) String() string

type Member

type Member struct {

	// Id assigned by PassKit to represent the member record. It will be used as the serial number in Apple Wallet and as the Object identifier for Google Wallet. This field is not writable.
	// @tag: validateGeneric:"required" validateCreate:"-" validateUpdate:"-"
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty" validateGeneric:"required" validateCreate:"-" validateUpdate:"-"`
	// This can be used to set the 'external' ID of the member (i.e. the member ID as it's being used in your system). If provided then this can be used to query & update members. This field will be treated as unique within the program, and cannot be updated at a later stage.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	ExternalId string `` /* 155-byte string literal not displayed */
	// Grouping Identifier can be used to group members under the same membership (i.e. couple).
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	GroupingIdentifier string `` /* 171-byte string literal not displayed */
	// Indicates the ID of the tier this member is in.
	// @tag: validateGeneric:"omitempty" validateCreate:"required" validateUpdate:"omitempty"
	TierId string `` /* 146-byte string literal not displayed */
	// Indicates the ID of the program this member is in.
	// @tag: validateGeneric:"omitempty" validateCreate:"required" validateUpdate:"omitempty"
	ProgramId string `` /* 152-byte string literal not displayed */
	// Personal details of the member.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	Person *io.Person `` /* 147-byte string literal not displayed */
	// Any other meta fields for the member that are not covered in the protocol (i.e. you might want to captures sign-up location, and favorite coffee, for segmenting later on).
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	MetaData map[string]string `` /* 239-byte string literal not displayed */
	// Indicates if the member opted out to receive marketing promotions (defaults to false).
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	OptOut bool `` /* 149-byte string literal not displayed */
	// Points is formatted differently based on what is set on a program level. Program points.balance field can be set to: `int`, `double` or `money`.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	Points float32 `` /* 150-byte string literal not displayed */
	// Secondary Points is formatted differently based on what is set on a program level. Program secondaryPoints.balance field can be set to: `int`, `double` or `money`. Field can be utilised if your program tracks two points, i.e. loyalty point balance, and pre-paid cash balance.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	SecondaryPoints float32 `` /* 168-byte string literal not displayed */
	// Tier points can be set for programs that award tiers based on dedicated tier points. Tier points indicates the current amount of tier points someone has, and can be used by a member to check how many more tier points are required to switch to the next tier.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	TierPoints uint32 `` /* 157-byte string literal not displayed */
	// Indicates when the membership card expires. When the expiry date hits, it will automatically gray out the barcode. Records that have been expired for longer than 90 days will be permanently deleted.  A pass that has expired can be reactivated by updating the expiry date.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	ExpiryDate *timestamppb.Timestamp `` /* 156-byte string literal not displayed */
	// Member status.
	Status MemberStatus `protobuf:"varint,19,opt,name=status,proto3,enum=members.MemberStatus" json:"status,omitempty"`
	// Pass level overrides for proximity & images.
	PassOverrides *io.PassOverrides `protobuf:"bytes,20,opt,name=passOverrides,proto3" json:"passOverrides,omitempty"`
	// Pass Metadata.
	PassMetaData *io.Metadata `protobuf:"bytes,21,opt,name=passMetaData,proto3" json:"passMetaData,omitempty"`
	// placeholder for notes.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	Notes []*io.Note `` /* 146-byte string literal not displayed */
	// The date the current tier was awarded.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	CurrentTierAwarded *timestamppb.Timestamp `` /* 172-byte string literal not displayed */
	// The date the current tier expires.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	CurrentTierExpires *timestamppb.Timestamp `` /* 172-byte string literal not displayed */
	// The date the member was created in the PassKit system.
	// @tag: validateGeneric:"-" validateCreate:"-" validateUpdate:"-"
	Created *timestamppb.Timestamp `` /* 126-byte string literal not displayed */
	// The date the member was last updated in the PassKit system.
	// @tag: validateGeneric:"-" validateCreate:"-" validateUpdate:"-"
	Updated *timestamppb.Timestamp `` /* 126-byte string literal not displayed */
	// Optional field that holds the member profile image. Can either be an image URL or base64 image string.
	ProfileImage string `protobuf:"bytes,31,opt,name=profileImage,proto3" json:"profileImage,omitempty"`
	// Optional field to provide the operation that you want to perform when sending a member in an update request.  PUT will replace all values provided in the MemberRequest, whereas PATCH will ignore missing or falsey values.  To maintain compatibility with previous releases, the default value is PATCH.
	Operation io.Operation `protobuf:"varint,100,opt,name=operation,proto3,enum=io.Operation" json:"operation,omitempty"`
	// contains filtered or unexported fields
}

The member record

func (*Member) Descriptor deprecated

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

Deprecated: Use Member.ProtoReflect.Descriptor instead.

func (*Member) GetCreated

func (x *Member) GetCreated() *timestamppb.Timestamp

func (*Member) GetCurrentTierAwarded

func (x *Member) GetCurrentTierAwarded() *timestamppb.Timestamp

func (*Member) GetCurrentTierExpires

func (x *Member) GetCurrentTierExpires() *timestamppb.Timestamp

func (*Member) GetExpiryDate

func (x *Member) GetExpiryDate() *timestamppb.Timestamp

func (*Member) GetExternalId

func (x *Member) GetExternalId() string

func (*Member) GetGroupingIdentifier

func (x *Member) GetGroupingIdentifier() string

func (*Member) GetId

func (x *Member) GetId() string

func (*Member) GetMetaData

func (x *Member) GetMetaData() map[string]string

func (*Member) GetNotes

func (x *Member) GetNotes() []*io.Note

func (*Member) GetOperation added in v1.1.97

func (x *Member) GetOperation() io.Operation

func (*Member) GetOptOut

func (x *Member) GetOptOut() bool

func (*Member) GetPassMetaData

func (x *Member) GetPassMetaData() *io.Metadata

func (*Member) GetPassOverrides

func (x *Member) GetPassOverrides() *io.PassOverrides

func (*Member) GetPerson

func (x *Member) GetPerson() *io.Person

func (*Member) GetPoints

func (x *Member) GetPoints() float32

func (*Member) GetProfileImage

func (x *Member) GetProfileImage() string

func (*Member) GetProgramId

func (x *Member) GetProgramId() string

func (*Member) GetSecondaryPoints

func (x *Member) GetSecondaryPoints() float32

func (*Member) GetStatus

func (x *Member) GetStatus() MemberStatus

func (*Member) GetTierId

func (x *Member) GetTierId() string

func (*Member) GetTierPoints

func (x *Member) GetTierPoints() uint32

func (*Member) GetUpdated

func (x *Member) GetUpdated() *timestamppb.Timestamp

func (*Member) ProtoMessage

func (*Member) ProtoMessage()

func (*Member) ProtoReflect

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

func (*Member) Reset

func (x *Member) Reset()

func (*Member) String

func (x *Member) String() string

type MemberCheckInOutRequest

type MemberCheckInOutRequest struct {

	// PassKit generated member ID (22 characters). Required if externalMemberId and programId are not provided.
	// @tag: validateCreate:"required_without=ExternalMemberId"
	MemberId string `protobuf:"bytes,1,opt,name=memberId,proto3" json:"memberId,omitempty" validateCreate:"required_without=ExternalMemberId"`
	// External member ID. Required if id is not provided.
	// @tag: validateCreate:"required_without=MemberId"
	ExternalMemberId string `` /* 128-byte string literal not displayed */
	// Program ID which member belongs to. Required if id is not provided.
	// @tag: validateCreate:"required_without=MemberId"
	ProgramId string `protobuf:"bytes,3,opt,name=programId,proto3" json:"programId,omitempty" validateCreate:"required_without=MemberId"`
	// Address the event took place.
	// @tag: validateCreate:"omitempty,max=255"
	Address string `protobuf:"bytes,4,opt,name=address,proto3" json:"address,omitempty" validateCreate:"omitempty,max=255"`
	// Latitude the event took place.
	// @tag: validateCreate:"omitempty"
	Lat float64 `protobuf:"fixed64,5,opt,name=lat,proto3" json:"lat,omitempty" validateCreate:"omitempty"`
	// Longitude the event took place.
	// @tag: validateCreate:"omitempty"
	Lon float64 `protobuf:"fixed64,6,opt,name=lon,proto3" json:"lon,omitempty" validateCreate:"omitempty"`
	// Altitude the event took place (in metres).
	// @tag: validateCreate:"omitempty"
	Alt int32 `protobuf:"varint,7,opt,name=alt,proto3" json:"alt,omitempty" validateCreate:"omitempty"`
	// External unique ID of the event.
	// @tag: validateCreate:"omitempty,max=255"
	ExternalEventId string `protobuf:"bytes,8,opt,name=externalEventId,proto3" json:"externalEventId,omitempty" validateCreate:"omitempty,max=255"`
	// External device ID of the device that was used to capture the event (for example when using an external scanning app).
	// @tag: validateCreate:"omitempty,max=255"
	ExternalDeviceId string `protobuf:"bytes,9,opt,name=externalDeviceId,proto3" json:"externalDeviceId,omitempty" validateCreate:"omitempty,max=255"`
	// External service ID of the service that was used for capturing the event (for example when using an external scanning app).
	// @tag: validateCreate:"omitempty,max=255"
	ExternalServiceId string `protobuf:"bytes,10,opt,name=externalServiceId,proto3" json:"externalServiceId,omitempty" validateCreate:"omitempty,max=255"`
	// Any meta data (for example gathered on scanning) that is relevant to the event (# of points earner, bill spent, device meta-data, etc).
	// @tag: validateCreate:"omitempty"
	MetaData map[string]string `` /* 185-byte string literal not displayed */
	// Any relevant notes for the event.
	// @tag: validateCreate:"omitempty"
	Notes string `protobuf:"bytes,12,opt,name=notes,proto3" json:"notes,omitempty" validateCreate:"omitempty"`
	// contains filtered or unexported fields
}

func (*MemberCheckInOutRequest) Descriptor deprecated

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

Deprecated: Use MemberCheckInOutRequest.ProtoReflect.Descriptor instead.

func (*MemberCheckInOutRequest) GetAddress

func (x *MemberCheckInOutRequest) GetAddress() string

func (*MemberCheckInOutRequest) GetAlt

func (x *MemberCheckInOutRequest) GetAlt() int32

func (*MemberCheckInOutRequest) GetExternalDeviceId

func (x *MemberCheckInOutRequest) GetExternalDeviceId() string

func (*MemberCheckInOutRequest) GetExternalEventId

func (x *MemberCheckInOutRequest) GetExternalEventId() string

func (*MemberCheckInOutRequest) GetExternalMemberId

func (x *MemberCheckInOutRequest) GetExternalMemberId() string

func (*MemberCheckInOutRequest) GetExternalServiceId

func (x *MemberCheckInOutRequest) GetExternalServiceId() string

func (*MemberCheckInOutRequest) GetLat

func (x *MemberCheckInOutRequest) GetLat() float64

func (*MemberCheckInOutRequest) GetLon

func (x *MemberCheckInOutRequest) GetLon() float64

func (*MemberCheckInOutRequest) GetMemberId

func (x *MemberCheckInOutRequest) GetMemberId() string

func (*MemberCheckInOutRequest) GetMetaData

func (x *MemberCheckInOutRequest) GetMetaData() map[string]string

func (*MemberCheckInOutRequest) GetNotes

func (x *MemberCheckInOutRequest) GetNotes() string

func (*MemberCheckInOutRequest) GetProgramId

func (x *MemberCheckInOutRequest) GetProgramId() string

func (*MemberCheckInOutRequest) ProtoMessage

func (*MemberCheckInOutRequest) ProtoMessage()

func (*MemberCheckInOutRequest) ProtoReflect

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

func (*MemberCheckInOutRequest) Reset

func (x *MemberCheckInOutRequest) Reset()

func (*MemberCheckInOutRequest) String

func (x *MemberCheckInOutRequest) String() string

type MemberEvent

type MemberEvent struct {

	// PassKit generated Event ID. Not writable.
	// @tag: validateCreate:"omitempty"
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty" validateCreate:"omitempty"`
	// Member that the event belongs to. This does not contain the full member details, only the key data.
	// @tag: validateCreate:"required"
	Member *MemberMininmal `protobuf:"bytes,2,opt,name=member,proto3" json:"member,omitempty" validateCreate:"required"`
	// Event type.
	// @tag: validateCreate:"required"
	EventType MemberEvents `protobuf:"varint,3,opt,name=eventType,proto3,enum=members.MemberEvents" json:"eventType,omitempty" validateCreate:"required"`
	// Address the event took place.
	// @tag: validateCreate:"omitempty,max=255"
	Address string `protobuf:"bytes,4,opt,name=address,proto3" json:"address,omitempty" validateCreate:"omitempty,max=255"`
	// Latitude the event took place.
	// @tag: validateCreate:"omitempty"
	Lat float64 `protobuf:"fixed64,5,opt,name=lat,proto3" json:"lat,omitempty" validateCreate:"omitempty"`
	// Longitude the event took place.
	// @tag: validateCreate:"omitempty"
	Lon float64 `protobuf:"fixed64,6,opt,name=lon,proto3" json:"lon,omitempty" validateCreate:"omitempty"`
	// Altitude the event took place (in metres).
	// @tag: validateCreate:"omitempty"
	Alt int32 `protobuf:"varint,7,opt,name=alt,proto3" json:"alt,omitempty" validateCreate:"omitempty"`
	// External unique ID of the event.
	// @tag: validateCreate:"omitempty,max=255"
	ExternalId string `protobuf:"bytes,8,opt,name=externalId,proto3" json:"externalId,omitempty" validateCreate:"omitempty,max=255"`
	// External user ID of the logged in user that captured the event (for example when using an external scanning app).
	// @tag: validateCreate:"omitempty,max=255"
	ExternalUserId string `protobuf:"bytes,9,opt,name=externalUserId,proto3" json:"externalUserId,omitempty" validateCreate:"omitempty,max=255"`
	// External device ID of the device that was used to capture the event (for example when using an external scanning app).
	// @tag: validateCreate:"omitempty,max=255"
	ExternalDeviceId string `protobuf:"bytes,10,opt,name=externalDeviceId,proto3" json:"externalDeviceId,omitempty" validateCreate:"omitempty,max=255"`
	// External service ID of the service that was used for capturing the event (for example when using an external scanning app).
	// @tag: validateCreate:"omitempty,max=255"
	ExternalServiceId string `protobuf:"bytes,11,opt,name=externalServiceId,proto3" json:"externalServiceId,omitempty" validateCreate:"omitempty,max=255"`
	// Any meta data (for example gathered on scanning) that is relevant to the event (# of points earner, bill spent, device meta-data, etc).
	// @tag: validateCreate:"omitempty"
	MetaData map[string]string `` /* 185-byte string literal not displayed */
	// Any relevant notes for the event.
	// @tag: validateCreate:"omitempty"
	Notes string `protobuf:"bytes,13,opt,name=notes,proto3" json:"notes,omitempty" validateCreate:"omitempty"`
	// The event date.
	// @tag: validateCreate:"required"
	Date *timestamppb.Timestamp `protobuf:"bytes,14,opt,name=date,proto3" json:"date,omitempty" validateCreate:"required"`
	// The date until the event is retained in the PassKit database.
	// @tag: validateCreate:"omitempty"
	RetainedUntilDate *timestamppb.Timestamp `protobuf:"bytes,15,opt,name=retainedUntilDate,proto3" json:"retainedUntilDate,omitempty" validateCreate:"omitempty"`
	// The date the event record was created in the PassKit database.
	// @tag: validateCreate:"omitempty"
	Created *timestamppb.Timestamp `protobuf:"bytes,16,opt,name=created,proto3" json:"created,omitempty" validateCreate:"omitempty"`
	// contains filtered or unexported fields
}

The Member Event record

func (*MemberEvent) Descriptor deprecated

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

Deprecated: Use MemberEvent.ProtoReflect.Descriptor instead.

func (*MemberEvent) GetAddress

func (x *MemberEvent) GetAddress() string

func (*MemberEvent) GetAlt

func (x *MemberEvent) GetAlt() int32

func (*MemberEvent) GetCreated

func (x *MemberEvent) GetCreated() *timestamppb.Timestamp

func (*MemberEvent) GetDate

func (x *MemberEvent) GetDate() *timestamppb.Timestamp

func (*MemberEvent) GetEventType

func (x *MemberEvent) GetEventType() MemberEvents

func (*MemberEvent) GetExternalDeviceId

func (x *MemberEvent) GetExternalDeviceId() string

func (*MemberEvent) GetExternalId

func (x *MemberEvent) GetExternalId() string

func (*MemberEvent) GetExternalServiceId

func (x *MemberEvent) GetExternalServiceId() string

func (*MemberEvent) GetExternalUserId

func (x *MemberEvent) GetExternalUserId() string

func (*MemberEvent) GetId

func (x *MemberEvent) GetId() string

func (*MemberEvent) GetLat

func (x *MemberEvent) GetLat() float64

func (*MemberEvent) GetLon

func (x *MemberEvent) GetLon() float64

func (*MemberEvent) GetMember

func (x *MemberEvent) GetMember() *MemberMininmal

func (*MemberEvent) GetMetaData

func (x *MemberEvent) GetMetaData() map[string]string

func (*MemberEvent) GetNotes

func (x *MemberEvent) GetNotes() string

func (*MemberEvent) GetRetainedUntilDate

func (x *MemberEvent) GetRetainedUntilDate() *timestamppb.Timestamp

func (*MemberEvent) ProtoMessage

func (*MemberEvent) ProtoMessage()

func (*MemberEvent) ProtoReflect

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

func (*MemberEvent) Reset

func (x *MemberEvent) Reset()

func (*MemberEvent) String

func (x *MemberEvent) String() string

type MemberEvents

type MemberEvents int32
const (
	// Do not use
	MemberEvents_EVENT_MEMBER_DO_NOT_USE MemberEvents = 0
	// Used when a member is checked in by the checked in endpoint
	MemberEvents_EVENT_MEMBER_CHECKED_IN MemberEvents = 1
	// Used when a member is checked out by the checked out endpoint
	MemberEvents_EVENT_MEMBER_CHECKED_OUT MemberEvents = 2
	// Used when a member is verified by the verify endpoint
	MemberEvents_EVENT_MEMBER_VERIFIED MemberEvents = 3
	// Used when points are earned by the earn points endpoints
	MemberEvents_EVENT_MEMBER_POINTS_EARNED MemberEvents = 4
	// Used when points are added by the burn points endpoints
	MemberEvents_EVENT_MEMBER_POINTS_BURNED MemberEvents = 5
	// Used when points are set by the set points endpoints
	MemberEvents_EVENT_MEMBER_POINTS_SET MemberEvents = 6
	// Used when points the tier is changed
	MemberEvents_EVENT_MEMBER_TIER_CHANGED MemberEvents = 7
)

func (MemberEvents) Descriptor

func (MemberEvents) Enum

func (x MemberEvents) Enum() *MemberEvents

func (MemberEvents) EnumDescriptor deprecated

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

Deprecated: Use MemberEvents.Descriptor instead.

func (MemberEvents) Number

func (MemberEvents) String

func (x MemberEvents) String() string

func (MemberEvents) Type

type MemberExpiry

type MemberExpiry struct {

	// Internal PassKit ID.
	// @tag: validateUpdate:"required_without=ExternalId"
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty" validateUpdate:"required_without=ExternalId"`
	// External member ID.
	// @tag: validateUpdate:"required_without=Id"
	ExternalId string `protobuf:"bytes,2,opt,name=externalId,proto3" json:"externalId,omitempty" validateUpdate:"required_without=Id"`
	// Required if externalId is set.
	// @tag: validateUpdate:"required_without=Id"
	ProgramId string `protobuf:"bytes,3,opt,name=programId,proto3" json:"programId,omitempty" validateUpdate:"required_without=Id"`
	// Indicates when the membership card expires. When the expiry date hits, it will automatically gray out the barcode.
	// @tag: validateUpdate:"required"
	ExpiryDate *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=expiryDate,proto3" json:"expiryDate,omitempty" validateUpdate:"required"`
	// contains filtered or unexported fields
}

Used to update the expiry date of a member.

func (*MemberExpiry) Descriptor deprecated

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

Deprecated: Use MemberExpiry.ProtoReflect.Descriptor instead.

func (*MemberExpiry) GetExpiryDate

func (x *MemberExpiry) GetExpiryDate() *timestamppb.Timestamp

func (*MemberExpiry) GetExternalId

func (x *MemberExpiry) GetExternalId() string

func (*MemberExpiry) GetId

func (x *MemberExpiry) GetId() string

func (*MemberExpiry) GetProgramId

func (x *MemberExpiry) GetProgramId() string

func (*MemberExpiry) ProtoMessage

func (*MemberExpiry) ProtoMessage()

func (*MemberExpiry) ProtoReflect

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

func (*MemberExpiry) Reset

func (x *MemberExpiry) Reset()

func (*MemberExpiry) String

func (x *MemberExpiry) String() string

type MemberMininmal

type MemberMininmal struct {

	// Id assigned by PassKit to represent the member record. It will be used as the serial number in Apple Wallet and as the Object identifier for Google Wallet. This field is not writable.
	// @tag: validateCreate:"required,max=255"
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty" validateCreate:"required,max=255"`
	// This can be used to set the 'external' ID of the member (i.e. the member ID as it's being used in your system). If provided then this can be used to query & update members. This field will be treated as unique within the program, and cannot be updated at a later stage.
	ExternalId string `protobuf:"bytes,2,opt,name=externalId,proto3" json:"externalId,omitempty"`
	// Grouping Identifier can be used to group members under the same membership (i.e. couple).
	GroupingIdentifier string `protobuf:"bytes,3,opt,name=groupingIdentifier,proto3" json:"groupingIdentifier,omitempty"`
	// Indicates the ID of the tier this member is in.
	TierId string `protobuf:"bytes,4,opt,name=tierId,proto3" json:"tierId,omitempty"`
	// Indicates the ID of the program this member is in.
	ProgramId string `protobuf:"bytes,5,opt,name=programId,proto3" json:"programId,omitempty"`
	// Personal details of the member.
	Person *io.Person `protobuf:"bytes,6,opt,name=person,proto3" json:"person,omitempty"`
	// contains filtered or unexported fields
}

func (*MemberMininmal) Descriptor deprecated

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

Deprecated: Use MemberMininmal.ProtoReflect.Descriptor instead.

func (*MemberMininmal) GetExternalId

func (x *MemberMininmal) GetExternalId() string

func (*MemberMininmal) GetGroupingIdentifier

func (x *MemberMininmal) GetGroupingIdentifier() string

func (*MemberMininmal) GetId

func (x *MemberMininmal) GetId() string

func (*MemberMininmal) GetPerson

func (x *MemberMininmal) GetPerson() *io.Person

func (*MemberMininmal) GetProgramId

func (x *MemberMininmal) GetProgramId() string

func (*MemberMininmal) GetTierId

func (x *MemberMininmal) GetTierId() string

func (*MemberMininmal) ProtoMessage

func (*MemberMininmal) ProtoMessage()

func (*MemberMininmal) ProtoReflect

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

func (*MemberMininmal) Reset

func (x *MemberMininmal) Reset()

func (*MemberMininmal) String

func (x *MemberMininmal) String() string

type MemberPoints

type MemberPoints struct {

	// Internal PassKit ID.
	// @tag: validateGeneric:"required_without=ExternalId"
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty" validateGeneric:"required_without=ExternalId"`
	// External member ID.
	// @tag: validateGeneric:"required_without=Id"
	ExternalId string `protobuf:"bytes,2,opt,name=externalId,proto3" json:"externalId,omitempty" validateGeneric:"required_without=Id"`
	// Required if externalId is set.
	// @tag: validateGeneric:"required_without=Id"
	ProgramId string `protobuf:"bytes,3,opt,name=programId,proto3" json:"programId,omitempty" validateGeneric:"required_without=Id"`
	// The latest point balance.
	// @tag: validateGeneric:"required_without_all=SecondaryPoints TierPoints"
	Points float32 `` /* 133-byte string literal not displayed */
	// The latest secondary point balance.
	// @tag: validateGeneric:"required_without_all=Points TierPoints"
	SecondaryPoints float32 `` /* 142-byte string literal not displayed */
	// The latest tier point balance.
	// @tag: validateGeneric:"required_without_all=Points SecondaryPoints"
	TierPoints uint32 `` /* 136-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*MemberPoints) Descriptor deprecated

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

Deprecated: Use MemberPoints.ProtoReflect.Descriptor instead.

func (*MemberPoints) GetExternalId

func (x *MemberPoints) GetExternalId() string

func (*MemberPoints) GetId

func (x *MemberPoints) GetId() string

func (*MemberPoints) GetPoints

func (x *MemberPoints) GetPoints() float32

func (*MemberPoints) GetProgramId

func (x *MemberPoints) GetProgramId() string

func (*MemberPoints) GetSecondaryPoints

func (x *MemberPoints) GetSecondaryPoints() float32

func (*MemberPoints) GetTierPoints

func (x *MemberPoints) GetTierPoints() uint32

func (*MemberPoints) ProtoMessage

func (*MemberPoints) ProtoMessage()

func (*MemberPoints) ProtoReflect

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

func (*MemberPoints) Reset

func (x *MemberPoints) Reset()

func (*MemberPoints) String

func (x *MemberPoints) String() string

type MemberRecordByExternalIdRequest

type MemberRecordByExternalIdRequest struct {

	// Program ID.
	// @tag: validateGeneric:"required"
	ProgramId string `protobuf:"bytes,1,opt,name=programId,proto3" json:"programId,omitempty" validateGeneric:"required"`
	// External ID.
	// @tag: validateGeneric:"required"
	ExternalId string `protobuf:"bytes,2,opt,name=externalId,proto3" json:"externalId,omitempty" validateGeneric:"required"`
	// contains filtered or unexported fields
}

Used to request a digital membership pass by PassKit ID.

func (*MemberRecordByExternalIdRequest) Descriptor deprecated

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

Deprecated: Use MemberRecordByExternalIdRequest.ProtoReflect.Descriptor instead.

func (*MemberRecordByExternalIdRequest) GetExternalId

func (x *MemberRecordByExternalIdRequest) GetExternalId() string

func (*MemberRecordByExternalIdRequest) GetProgramId

func (x *MemberRecordByExternalIdRequest) GetProgramId() string

func (*MemberRecordByExternalIdRequest) ProtoMessage

func (*MemberRecordByExternalIdRequest) ProtoMessage()

func (*MemberRecordByExternalIdRequest) ProtoReflect

func (*MemberRecordByExternalIdRequest) Reset

func (*MemberRecordByExternalIdRequest) String

type MemberSegmentRequest

type MemberSegmentRequest struct {

	// Optional filter object; defines the segment.
	Filter *io.Filter `protobuf:"bytes,1,opt,name=filter,proto3" json:"filter,omitempty"`
	// Contains fields to update (optional: if used in update context).
	NewValues *Member `protobuf:"bytes,2,opt,name=newValues,proto3" json:"newValues,omitempty"`
	// contains filtered or unexported fields
}

Member segment allows us to segment members for listing or updating

func (*MemberSegmentRequest) Descriptor deprecated

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

Deprecated: Use MemberSegmentRequest.ProtoReflect.Descriptor instead.

func (*MemberSegmentRequest) GetFilter

func (x *MemberSegmentRequest) GetFilter() *io.Filter

func (*MemberSegmentRequest) GetNewValues

func (x *MemberSegmentRequest) GetNewValues() *Member

func (*MemberSegmentRequest) ProtoMessage

func (*MemberSegmentRequest) ProtoMessage()

func (*MemberSegmentRequest) ProtoReflect

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

func (*MemberSegmentRequest) Reset

func (x *MemberSegmentRequest) Reset()

func (*MemberSegmentRequest) String

func (x *MemberSegmentRequest) String() string

type MemberStatus

type MemberStatus int32

List of allowed member statuses

const (
	// Member has successfully enrolled in the program.
	MemberStatus_ENROLLED MemberStatus = 0
	// Member is active.
	MemberStatus_ACTIVE MemberStatus = 1
	// Member is checked in.
	MemberStatus_CHECKED_IN MemberStatus = 2
	// For expired members.
	MemberStatus_EXPIRED MemberStatus = 3
	// Member is checked out.
	MemberStatus_CHECKED_OUT MemberStatus = 4
	// For members who's records have been deleted.
	MemberStatus_DELETED MemberStatus = 5
)

func (MemberStatus) Descriptor

func (MemberStatus) Enum

func (x MemberStatus) Enum() *MemberStatus

func (MemberStatus) EnumDescriptor deprecated

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

Deprecated: Use MemberStatus.Descriptor instead.

func (MemberStatus) Number

func (MemberStatus) String

func (x MemberStatus) String() string

func (MemberStatus) Type

type MembersClient

type MembersClient interface {
	// Create a program record. Allows a user to specify program details around enrolment, renewal and cancellation processes. Optionally allows the user to set the GPS location / Beacons that will trigger a lock-screen alert.
	CreateProgram(ctx context.Context, in *Program, opts ...grpc.CallOption) (*io.Id, error)
	// Updates an existing program record.
	UpdateProgram(ctx context.Context, in *Program, opts ...grpc.CallOption) (*Program, error)
	// Gets an existing program record by id.
	GetProgram(ctx context.Context, in *io.Id, opts ...grpc.CallOption) (*Program, error)
	// Copies an existing program record to a new record, and allows for status of new program to be set; i.e. copy a draft to published (production) program. Will copy program AND related tier + template records.
	CopyProgram(ctx context.Context, in *ProgramCopyRequest, opts ...grpc.CallOption) (*io.Id, error)
	// Deletes an existing program record by id. Deleting a program results in all tiers, and members underneath it being invalidated and removed. Needs to be used with care.
	DeleteProgram(ctx context.Context, in *io.Id, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Lists all programs for the logged in user.
	ListProgramsDeprecated(ctx context.Context, in *io.Pagination, opts ...grpc.CallOption) (Members_ListProgramsDeprecatedClient, error)
	// Lists all programs for the logged in user.
	ListPrograms(ctx context.Context, in *io.Filters, opts ...grpc.CallOption) (Members_ListProgramsClient, error)
	// Create a new tier in an existing member program. Tiers allow a user to categorize their membership program; tiers allow for additional detail that is specific to that 'group' of members. A program needs at least one tier.
	CreateTier(ctx context.Context, in *Tier, opts ...grpc.CallOption) (*io.Id, error)
	// Updates a tier by tier id
	UpdateTier(ctx context.Context, in *Tier, opts ...grpc.CallOption) (*Tier, error)
	// Gets a tier by tier ID
	GetTier(ctx context.Context, in *TierRequestInput, opts ...grpc.CallOption) (*Tier, error)
	// Deletes a tier. Deleting a tier will invalidate and delete all the passes that are in the tier.
	DeleteTier(ctx context.Context, in *TierRequestInput, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Lists all the tiers.
	ListTiersDeprecated(ctx context.Context, in *ListRequestDeprecated, opts ...grpc.CallOption) (Members_ListTiersDeprecatedClient, error)
	// Lists all the tiers.
	ListTiers(ctx context.Context, in *ListRequest, opts ...grpc.CallOption) (Members_ListTiersClient, error)
	// Enrols a new member into a tier of a program. Returns the PassKit Member ID.
	EnrolMember(ctx context.Context, in *Member, opts ...grpc.CallOption) (*io.Id, error)
	// Enrols a new member into the default tier (lowest tier index) of a program. Returns the PassKit Member ID.
	EnrolMemberPublic(ctx context.Context, in *Member, opts ...grpc.CallOption) (*io.Id, error)
	GetMemberRecordById(ctx context.Context, in *io.Id, opts ...grpc.CallOption) (*Member, error)
	GetMemberRecordByExternalId(ctx context.Context, in *MemberRecordByExternalIdRequest, opts ...grpc.CallOption) (*Member, error)
	CheckInMember(ctx context.Context, in *MemberCheckInOutRequest, opts ...grpc.CallOption) (*MemberEvent, error)
	CheckOutMember(ctx context.Context, in *MemberCheckInOutRequest, opts ...grpc.CallOption) (*MemberEvent, error)
	ListMembersDeprecated(ctx context.Context, in *ListRequestDeprecated, opts ...grpc.CallOption) (Members_ListMembersDeprecatedClient, error)
	ListMembers(ctx context.Context, in *ListRequest, opts ...grpc.CallOption) (Members_ListMembersClient, error)
	UpdateMember(ctx context.Context, in *Member, opts ...grpc.CallOption) (*io.Id, error)
	// @todo: define callback
	EarnPoints(ctx context.Context, in *EarnBurnPointsRequest, opts ...grpc.CallOption) (*MemberPoints, error)
	// @todo: define callback
	BurnPoints(ctx context.Context, in *EarnBurnPointsRequest, opts ...grpc.CallOption) (*MemberPoints, error)
	SetPoints(ctx context.Context, in *SetPointsRequest, opts ...grpc.CallOption) (*MemberPoints, error)
	ChangeMemberTier(ctx context.Context, in *ChangeTierRequest, opts ...grpc.CallOption) (*MemberEvent, error)
	UpdateMembersBySegment(ctx context.Context, in *MemberSegmentRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	DeleteMembersBySegment(ctx context.Context, in *MemberSegmentRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	DeleteMember(ctx context.Context, in *Member, opts ...grpc.CallOption) (*emptypb.Empty, error)
	CountMembersDeprecated(ctx context.Context, in *ListRequestDeprecated, opts ...grpc.CallOption) (*io.Count, error)
	CountMembers(ctx context.Context, in *ListRequest, opts ...grpc.CallOption) (*io.Count, error)
	GetMessageHistoryForMember(ctx context.Context, in *io.Pagination, opts ...grpc.CallOption) (Members_GetMessageHistoryForMemberClient, error)
	GetMetaKeysForProgram(ctx context.Context, in *io.Id, opts ...grpc.CallOption) (*io.Strings, error)
	RenewMembersExpiry(ctx context.Context, in *UpdateExpiryRequest, opts ...grpc.CallOption) (*io.Count, error)
	UpdateMemberExpiry(ctx context.Context, in *MemberExpiry, opts ...grpc.CallOption) (*io.Id, error)
	PatchPerson(ctx context.Context, in *io.PersonRequest, opts ...grpc.CallOption) (*io.Id, error)
	CountMemberEvents(ctx context.Context, in *ListRequest, opts ...grpc.CallOption) (*io.Count, error)
	ListMemberEvents(ctx context.Context, in *ListRequest, opts ...grpc.CallOption) (Members_ListMemberEventsClient, error)
	GetMemberEventMetaKeysForProgram(ctx context.Context, in *io.Id, opts ...grpc.CallOption) (*io.Strings, error)
	ListEventsForMember(ctx context.Context, in *io.Id, opts ...grpc.CallOption) (Members_ListEventsForMemberClient, error)
	DeleteMemberEvents(ctx context.Context, in *ListRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	DeleteEventsForMember(ctx context.Context, in *io.Id, opts ...grpc.CallOption) (*emptypb.Empty, error)
	DeleteMemberEvent(ctx context.Context, in *io.Id, opts ...grpc.CallOption) (*emptypb.Empty, error)
	GetProgramEnrolment(ctx context.Context, in *io.Id, opts ...grpc.CallOption) (*io.EnrolmentUrls, error)
}

MembersClient is the client API for Members 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 NewMembersClient

func NewMembersClient(cc grpc.ClientConnInterface) MembersClient

type MembersServer

type MembersServer interface {
	// Create a program record. Allows a user to specify program details around enrolment, renewal and cancellation processes. Optionally allows the user to set the GPS location / Beacons that will trigger a lock-screen alert.
	CreateProgram(context.Context, *Program) (*io.Id, error)
	// Updates an existing program record.
	UpdateProgram(context.Context, *Program) (*Program, error)
	// Gets an existing program record by id.
	GetProgram(context.Context, *io.Id) (*Program, error)
	// Copies an existing program record to a new record, and allows for status of new program to be set; i.e. copy a draft to published (production) program. Will copy program AND related tier + template records.
	CopyProgram(context.Context, *ProgramCopyRequest) (*io.Id, error)
	// Deletes an existing program record by id. Deleting a program results in all tiers, and members underneath it being invalidated and removed. Needs to be used with care.
	DeleteProgram(context.Context, *io.Id) (*emptypb.Empty, error)
	// Lists all programs for the logged in user.
	ListProgramsDeprecated(*io.Pagination, Members_ListProgramsDeprecatedServer) error
	// Lists all programs for the logged in user.
	ListPrograms(*io.Filters, Members_ListProgramsServer) error
	// Create a new tier in an existing member program. Tiers allow a user to categorize their membership program; tiers allow for additional detail that is specific to that 'group' of members. A program needs at least one tier.
	CreateTier(context.Context, *Tier) (*io.Id, error)
	// Updates a tier by tier id
	UpdateTier(context.Context, *Tier) (*Tier, error)
	// Gets a tier by tier ID
	GetTier(context.Context, *TierRequestInput) (*Tier, error)
	// Deletes a tier. Deleting a tier will invalidate and delete all the passes that are in the tier.
	DeleteTier(context.Context, *TierRequestInput) (*emptypb.Empty, error)
	// Lists all the tiers.
	ListTiersDeprecated(*ListRequestDeprecated, Members_ListTiersDeprecatedServer) error
	// Lists all the tiers.
	ListTiers(*ListRequest, Members_ListTiersServer) error
	// Enrols a new member into a tier of a program. Returns the PassKit Member ID.
	EnrolMember(context.Context, *Member) (*io.Id, error)
	// Enrols a new member into the default tier (lowest tier index) of a program. Returns the PassKit Member ID.
	EnrolMemberPublic(context.Context, *Member) (*io.Id, error)
	GetMemberRecordById(context.Context, *io.Id) (*Member, error)
	GetMemberRecordByExternalId(context.Context, *MemberRecordByExternalIdRequest) (*Member, error)
	CheckInMember(context.Context, *MemberCheckInOutRequest) (*MemberEvent, error)
	CheckOutMember(context.Context, *MemberCheckInOutRequest) (*MemberEvent, error)
	ListMembersDeprecated(*ListRequestDeprecated, Members_ListMembersDeprecatedServer) error
	ListMembers(*ListRequest, Members_ListMembersServer) error
	UpdateMember(context.Context, *Member) (*io.Id, error)
	// @todo: define callback
	EarnPoints(context.Context, *EarnBurnPointsRequest) (*MemberPoints, error)
	// @todo: define callback
	BurnPoints(context.Context, *EarnBurnPointsRequest) (*MemberPoints, error)
	SetPoints(context.Context, *SetPointsRequest) (*MemberPoints, error)
	ChangeMemberTier(context.Context, *ChangeTierRequest) (*MemberEvent, error)
	UpdateMembersBySegment(context.Context, *MemberSegmentRequest) (*emptypb.Empty, error)
	DeleteMembersBySegment(context.Context, *MemberSegmentRequest) (*emptypb.Empty, error)
	DeleteMember(context.Context, *Member) (*emptypb.Empty, error)
	CountMembersDeprecated(context.Context, *ListRequestDeprecated) (*io.Count, error)
	CountMembers(context.Context, *ListRequest) (*io.Count, error)
	GetMessageHistoryForMember(*io.Pagination, Members_GetMessageHistoryForMemberServer) error
	GetMetaKeysForProgram(context.Context, *io.Id) (*io.Strings, error)
	RenewMembersExpiry(context.Context, *UpdateExpiryRequest) (*io.Count, error)
	UpdateMemberExpiry(context.Context, *MemberExpiry) (*io.Id, error)
	PatchPerson(context.Context, *io.PersonRequest) (*io.Id, error)
	CountMemberEvents(context.Context, *ListRequest) (*io.Count, error)
	ListMemberEvents(*ListRequest, Members_ListMemberEventsServer) error
	GetMemberEventMetaKeysForProgram(context.Context, *io.Id) (*io.Strings, error)
	ListEventsForMember(*io.Id, Members_ListEventsForMemberServer) error
	DeleteMemberEvents(context.Context, *ListRequest) (*emptypb.Empty, error)
	DeleteEventsForMember(context.Context, *io.Id) (*emptypb.Empty, error)
	DeleteMemberEvent(context.Context, *io.Id) (*emptypb.Empty, error)
	GetProgramEnrolment(context.Context, *io.Id) (*io.EnrolmentUrls, error)
}

MembersServer is the server API for Members service. All implementations should embed UnimplementedMembersServer for forward compatibility

type Members_GetMessageHistoryForMemberClient

type Members_GetMessageHistoryForMemberClient interface {
	Recv() (*io.Message, error)
	grpc.ClientStream
}

type Members_GetMessageHistoryForMemberServer

type Members_GetMessageHistoryForMemberServer interface {
	Send(*io.Message) error
	grpc.ServerStream
}

type Members_ListEventsForMemberClient

type Members_ListEventsForMemberClient interface {
	Recv() (*MemberEvent, error)
	grpc.ClientStream
}

type Members_ListEventsForMemberServer

type Members_ListEventsForMemberServer interface {
	Send(*MemberEvent) error
	grpc.ServerStream
}

type Members_ListMemberEventsClient

type Members_ListMemberEventsClient interface {
	Recv() (*MemberEvent, error)
	grpc.ClientStream
}

type Members_ListMemberEventsServer

type Members_ListMemberEventsServer interface {
	Send(*MemberEvent) error
	grpc.ServerStream
}

type Members_ListMembersClient

type Members_ListMembersClient interface {
	Recv() (*Member, error)
	grpc.ClientStream
}

type Members_ListMembersDeprecatedClient

type Members_ListMembersDeprecatedClient interface {
	Recv() (*Member, error)
	grpc.ClientStream
}

type Members_ListMembersDeprecatedServer

type Members_ListMembersDeprecatedServer interface {
	Send(*Member) error
	grpc.ServerStream
}

type Members_ListMembersServer

type Members_ListMembersServer interface {
	Send(*Member) error
	grpc.ServerStream
}

type Members_ListProgramsClient

type Members_ListProgramsClient interface {
	Recv() (*Program, error)
	grpc.ClientStream
}

type Members_ListProgramsDeprecatedClient

type Members_ListProgramsDeprecatedClient interface {
	Recv() (*Program, error)
	grpc.ClientStream
}

type Members_ListProgramsDeprecatedServer

type Members_ListProgramsDeprecatedServer interface {
	Send(*Program) error
	grpc.ServerStream
}

type Members_ListProgramsServer

type Members_ListProgramsServer interface {
	Send(*Program) error
	grpc.ServerStream
}

type Members_ListTiersClient

type Members_ListTiersClient interface {
	Recv() (*Tier, error)
	grpc.ClientStream
}

type Members_ListTiersDeprecatedClient

type Members_ListTiersDeprecatedClient interface {
	Recv() (*Tier, error)
	grpc.ClientStream
}

type Members_ListTiersDeprecatedServer

type Members_ListTiersDeprecatedServer interface {
	Send(*Tier) error
	grpc.ServerStream
}

type Members_ListTiersServer

type Members_ListTiersServer interface {
	Send(*Tier) error
	grpc.ServerStream
}

type PassRecoverySettings

type PassRecoverySettings struct {

	// Determines if users can recover passes.
	Enabled bool `protobuf:"varint,1,opt,name=enabled,proto3" json:"enabled,omitempty"`
	// Determines the medium that the pass is delivered to the user.
	Delivery RecoverPassDelivery `protobuf:"varint,2,opt,name=delivery,proto3,enum=members.RecoverPassDelivery" json:"delivery,omitempty"`
	// The header text for the error page.
	ErrorPageHeader string `protobuf:"bytes,3,opt,name=errorPageHeader,proto3" json:"errorPageHeader,omitempty"`
	// The body text for the error page.
	ErrorPageBody string `protobuf:"bytes,4,opt,name=errorPageBody,proto3" json:"errorPageBody,omitempty"`
	// Sets which person and meta fields to match for pass recovery. This gives you control over how strict you want the match to be. If this is left blank, all person and meta fields provided need to match with what is in the member record.
	FieldsToMatchUponRecovery []string `protobuf:"bytes,5,rep,name=fieldsToMatchUponRecovery,proto3" json:"fieldsToMatchUponRecovery,omitempty"`
	// contains filtered or unexported fields
}

PassRecoverySettings details the logic for recovering a pass.

func (*PassRecoverySettings) Descriptor deprecated

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

Deprecated: Use PassRecoverySettings.ProtoReflect.Descriptor instead.

func (*PassRecoverySettings) GetDelivery

func (x *PassRecoverySettings) GetDelivery() RecoverPassDelivery

func (*PassRecoverySettings) GetEnabled

func (x *PassRecoverySettings) GetEnabled() bool

func (*PassRecoverySettings) GetErrorPageBody

func (x *PassRecoverySettings) GetErrorPageBody() string

func (*PassRecoverySettings) GetErrorPageHeader

func (x *PassRecoverySettings) GetErrorPageHeader() string

func (*PassRecoverySettings) GetFieldsToMatchUponRecovery

func (x *PassRecoverySettings) GetFieldsToMatchUponRecovery() []string

func (*PassRecoverySettings) ProtoMessage

func (*PassRecoverySettings) ProtoMessage()

func (*PassRecoverySettings) ProtoReflect

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

func (*PassRecoverySettings) Reset

func (x *PassRecoverySettings) Reset()

func (*PassRecoverySettings) String

func (x *PassRecoverySettings) String() string

type PointsType

type PointsType struct {

	// The balance type.
	BalanceType BalanceType `protobuf:"varint,1,opt,name=balanceType,proto3,enum=members.BalanceType" json:"balanceType,omitempty"`
	// The currency code; only needs to be provided if balance type equals BALANCE_TYPE_MONEY.
	CurrencyCode string `protobuf:"bytes,2,opt,name=currencyCode,proto3" json:"currencyCode,omitempty"`
	// contains filtered or unexported fields
}

func (*PointsType) Descriptor deprecated

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

Deprecated: Use PointsType.ProtoReflect.Descriptor instead.

func (*PointsType) GetBalanceType

func (x *PointsType) GetBalanceType() BalanceType

func (*PointsType) GetCurrencyCode

func (x *PointsType) GetCurrencyCode() string

func (*PointsType) ProtoMessage

func (*PointsType) ProtoMessage()

func (*PointsType) ProtoReflect

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

func (*PointsType) Reset

func (x *PointsType) Reset()

func (*PointsType) String

func (x *PointsType) String() string

type ProfileImageSetting

type ProfileImageSetting int32
const (
	ProfileImageSetting_PROFILE_IMAGE_NONE     ProfileImageSetting = 0
	ProfileImageSetting_PROFILE_IMAGE_OPTIONAL ProfileImageSetting = 1
	ProfileImageSetting_PROFILE_IMAGE_REQUIRED ProfileImageSetting = 2
)

func (ProfileImageSetting) Descriptor

func (ProfileImageSetting) Enum

func (ProfileImageSetting) EnumDescriptor deprecated

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

Deprecated: Use ProfileImageSetting.Descriptor instead.

func (ProfileImageSetting) Number

func (ProfileImageSetting) String

func (x ProfileImageSetting) String() string

func (ProfileImageSetting) Type

type Program

type Program struct {

	// PassKit generated program id (22 characters).
	// @tag: validateGeneric:"required" validateCreate:"-" validateUpdate:"required"
	Id string `` /* 129-byte string literal not displayed */
	// Name of the membership programs; will be shown on the enrolment page (if set) and issuer name.
	// @tag: validateGeneric:"omitempty" validateCreate:"required" validateUpdate:"required"
	Name string `` /* 141-byte string literal not displayed */
	// Localized name of the membership program.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	LocalizedName *io.LocalizedString `` /* 161-byte string literal not displayed */
	// The program status (bitmask of ProjectStatus). Defaults to io.ProjectStatus.PROJECT_ACTIVE_FOR_OBJECT_CREATION + io.ProjectStatus.PROJECT_DRAFT.
	// @tag: validateGeneric:"-" validateCreate:"-" validateUpdate:"-"
	Status []io.ProjectStatus `` /* 153-byte string literal not displayed */
	// The project quota.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	Quota *io.Quota `` /* 145-byte string literal not displayed */
	// Leave empty for draft programs. Needs to be set for programs where status contains PROJECT_PUBLISHED.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"-"
	PassTypeIdentifier string `` /* 163-byte string literal not displayed */
	// Contains the email & sms distribution settings for the program.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	DistributionSettings *io.DistributionSettings `` /* 175-byte string literal not displayed */
	// Auto deletes the member after `autoDeleteDaysAfterExpiry` days.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	AutoDeleteDaysAfterExpiry uint32 `` /* 186-byte string literal not displayed */
	// Sets how many days before expiry to send a reminder lockscreen message to the member.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	AutoReminderDaysBeforeExpiry uint32 `` /* 192-byte string literal not displayed */
	// The message to send to the user `autoReminderDaysBeforeExpiry` days before expiry.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	ExpiryMessage string `` /* 162-byte string literal not displayed */
	// Localized expiry message.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	LocalizedExpiryMessage *io.LocalizedString `` /* 180-byte string literal not displayed */
	// Auto deletes the member `autoDeleteDaysAfterNotInstalling` days after the card has not been installed.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	AutoDeleteDaysAfterNotInstalling uint32 `` /* 201-byte string literal not displayed */
	// Points format for primary points.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	PointsType *PointsType `` /* 156-byte string literal not displayed */
	// Points format for secondary points.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	SecondaryPointsType *PointsType `` /* 174-byte string literal not displayed */
	// Issued, installed, uninstalled and invalidated counts. Metrics are not writable.
	// @tag: validateGeneric:"-" validateCreate:"-" validateUpdate:"-"
	Metrics *io.Metrics `` /* 126-byte string literal not displayed */
	// A list of dynamic fields which can be used to filter members.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	MetaFieldsList []string `` /* 164-byte string literal not displayed */
	// The date the program was created.
	// @tag: validateGeneric:"-" validateCreate:"-" validateUpdate:"-"
	Created *timestamppb.Timestamp `` /* 126-byte string literal not displayed */
	// The date the program was updated.
	// @tag: validateGeneric:"-" validateCreate:"-" validateUpdate:"-"
	Updated *timestamppb.Timestamp `` /* 126-byte string literal not displayed */
	// Indicates if the program requires member profile images on enrol.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	ProfileImageSettings ProfileImageSetting `` /* 210-byte string literal not displayed */
	// Auto generate the external id from member object field. e.g. if you set person.emailAddress, then member's email address will be used as a value of external id.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	ApplyFieldToExternalIdOnEnrol *CustomExternalId `` /* 194-byte string literal not displayed */
	// Event settings for the program. Can be used if the program captures member events.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	EventCaptureSettings *EventCaptureSettings `` /* 176-byte string literal not displayed */
	// Settings for how users can recover passes.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	PassRecoverySettings *PassRecoverySettings `` /* 176-byte string literal not displayed */
	// contains filtered or unexported fields
}

The Program Details

func (*Program) Descriptor deprecated

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

Deprecated: Use Program.ProtoReflect.Descriptor instead.

func (*Program) GetApplyFieldToExternalIdOnEnrol

func (x *Program) GetApplyFieldToExternalIdOnEnrol() *CustomExternalId

func (*Program) GetAutoDeleteDaysAfterExpiry

func (x *Program) GetAutoDeleteDaysAfterExpiry() uint32

func (*Program) GetAutoDeleteDaysAfterNotInstalling

func (x *Program) GetAutoDeleteDaysAfterNotInstalling() uint32

func (*Program) GetAutoReminderDaysBeforeExpiry

func (x *Program) GetAutoReminderDaysBeforeExpiry() uint32

func (*Program) GetCreated

func (x *Program) GetCreated() *timestamppb.Timestamp

func (*Program) GetDistributionSettings

func (x *Program) GetDistributionSettings() *io.DistributionSettings

func (*Program) GetEventCaptureSettings

func (x *Program) GetEventCaptureSettings() *EventCaptureSettings

func (*Program) GetExpiryMessage

func (x *Program) GetExpiryMessage() string

func (*Program) GetId

func (x *Program) GetId() string

func (*Program) GetLocalizedExpiryMessage

func (x *Program) GetLocalizedExpiryMessage() *io.LocalizedString

func (*Program) GetLocalizedName

func (x *Program) GetLocalizedName() *io.LocalizedString

func (*Program) GetMetaFieldsList

func (x *Program) GetMetaFieldsList() []string

func (*Program) GetMetrics

func (x *Program) GetMetrics() *io.Metrics

func (*Program) GetName

func (x *Program) GetName() string

func (*Program) GetPassRecoverySettings

func (x *Program) GetPassRecoverySettings() *PassRecoverySettings

func (*Program) GetPassTypeIdentifier

func (x *Program) GetPassTypeIdentifier() string

func (*Program) GetPointsType

func (x *Program) GetPointsType() *PointsType

func (*Program) GetProfileImageSettings

func (x *Program) GetProfileImageSettings() ProfileImageSetting

func (*Program) GetQuota

func (x *Program) GetQuota() *io.Quota

func (*Program) GetSecondaryPointsType

func (x *Program) GetSecondaryPointsType() *PointsType

func (*Program) GetStatus

func (x *Program) GetStatus() []io.ProjectStatus

func (*Program) GetUpdated

func (x *Program) GetUpdated() *timestamppb.Timestamp

func (*Program) ProtoMessage

func (*Program) ProtoMessage()

func (*Program) ProtoReflect

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

func (*Program) Reset

func (x *Program) Reset()

func (*Program) String

func (x *Program) String() string

type ProgramAutoUpDownGradeTierType

type ProgramAutoUpDownGradeTierType int32
const (
	// Auto up / down grades based on points.
	ProgramAutoUpDownGradeTierType_UPDOWNGRADE_POINTS ProgramAutoUpDownGradeTierType = 0
	// Auto up / down grades based on secondary points.
	ProgramAutoUpDownGradeTierType_UPDOWNGRADE_SECONDARY_POINTS ProgramAutoUpDownGradeTierType = 1
	// Auto up / down grades based on tier points.
	ProgramAutoUpDownGradeTierType_UPDOWNGRADE_TIER_POINTS ProgramAutoUpDownGradeTierType = 2
	// Auto up / down grades based on # of visits.
	ProgramAutoUpDownGradeTierType_UPDOWNGRADE_VISITS ProgramAutoUpDownGradeTierType = 3
)

func (ProgramAutoUpDownGradeTierType) Descriptor

func (ProgramAutoUpDownGradeTierType) Enum

func (ProgramAutoUpDownGradeTierType) EnumDescriptor deprecated

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

Deprecated: Use ProgramAutoUpDownGradeTierType.Descriptor instead.

func (ProgramAutoUpDownGradeTierType) Number

func (ProgramAutoUpDownGradeTierType) String

func (ProgramAutoUpDownGradeTierType) Type

type ProgramCopyRequest

type ProgramCopyRequest struct {

	// uuid of the program to copy.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// optional name for the new program.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Status to set the copied program to.
	Status []io.ProjectStatus `protobuf:"varint,3,rep,packed,name=status,proto3,enum=io.ProjectStatus" json:"status,omitempty"`
	// Can optionally be provided if setting status to published (requires a prod cert).
	PassTypeIdentifier string `protobuf:"bytes,4,opt,name=passTypeIdentifier,proto3" json:"passTypeIdentifier,omitempty"`
	// contains filtered or unexported fields
}

Contains payload for copying a program

func (*ProgramCopyRequest) Descriptor deprecated

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

Deprecated: Use ProgramCopyRequest.ProtoReflect.Descriptor instead.

func (*ProgramCopyRequest) GetId

func (x *ProgramCopyRequest) GetId() string

func (*ProgramCopyRequest) GetName

func (x *ProgramCopyRequest) GetName() string

func (*ProgramCopyRequest) GetPassTypeIdentifier

func (x *ProgramCopyRequest) GetPassTypeIdentifier() string

func (*ProgramCopyRequest) GetStatus

func (x *ProgramCopyRequest) GetStatus() []io.ProjectStatus

func (*ProgramCopyRequest) ProtoMessage

func (*ProgramCopyRequest) ProtoMessage()

func (*ProgramCopyRequest) ProtoReflect

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

func (*ProgramCopyRequest) Reset

func (x *ProgramCopyRequest) Reset()

func (*ProgramCopyRequest) String

func (x *ProgramCopyRequest) String() string

type RecoverPassDelivery

type RecoverPassDelivery int32

Defines what medium we deliver the recovered pass.

const (
	// redirect to pass url.
	RecoverPassDelivery_DELIVERY_REDIRECT RecoverPassDelivery = 0
	// email user (resend welcome email)
	RecoverPassDelivery_DELIVERY_EMAIL RecoverPassDelivery = 1
	// sms to users phone
	RecoverPassDelivery_DELIVERY_SMS RecoverPassDelivery = 2
)

func (RecoverPassDelivery) Descriptor

func (RecoverPassDelivery) Enum

func (RecoverPassDelivery) EnumDescriptor deprecated

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

Deprecated: Use RecoverPassDelivery.Descriptor instead.

func (RecoverPassDelivery) Number

func (RecoverPassDelivery) String

func (x RecoverPassDelivery) String() string

func (RecoverPassDelivery) Type

type SetPointsRequest

type SetPointsRequest struct {

	// Internal PassKit ID.
	// @tag: validateGeneric:"required_without=ExternalId"
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty" validateGeneric:"required_without=ExternalId"`
	// External member ID.
	// @tag: validateGeneric:"required_without=Id"
	ExternalId string `protobuf:"bytes,2,opt,name=externalId,proto3" json:"externalId,omitempty" validateGeneric:"required_without=Id"`
	// Required if externalId is set.
	// @tag: validateGeneric:"required_without=Id"
	ProgramId string `protobuf:"bytes,3,opt,name=programId,proto3" json:"programId,omitempty" validateGeneric:"required_without=Id"`
	// The latest point balance.
	// @tag: validateGeneric:"required_without_all=SecondaryPoints TierPoints ResetPoints ResetSecondaryPoints ResetTierPoints"
	Points float32 `` /* 182-byte string literal not displayed */
	// The latest secondary point balance.
	SecondaryPoints float32 `protobuf:"fixed32,5,opt,name=secondaryPoints,proto3" json:"secondaryPoints,omitempty"`
	// The latest tier point balance.
	TierPoints uint32 `protobuf:"varint,6,opt,name=tierPoints,proto3" json:"tierPoints,omitempty"`
	// Reset the point balance. If set true, the point balance will be 0. The default is false.
	ResetPoints bool `protobuf:"varint,7,opt,name=resetPoints,proto3" json:"resetPoints,omitempty"`
	// Reset the secondary points. If set true, the secondary point balance will be 0. The default is false.
	ResetSecondaryPoints bool `protobuf:"varint,8,opt,name=resetSecondaryPoints,proto3" json:"resetSecondaryPoints,omitempty"`
	// Reset the tier points. If set true, the tier point balance will be 0. The default is false.
	ResetTierPoints bool `protobuf:"varint,9,opt,name=resetTierPoints,proto3" json:"resetTierPoints,omitempty"`
	// @tag: validateGeneric:"omitempty"
	EventDetails *EventDetails `protobuf:"bytes,10,opt,name=eventDetails,proto3" json:"eventDetails,omitempty" validateGeneric:"omitempty"`
	// Optional field to change the tierIf of the member.
	// @tag: validateGeneric:"omitempty"
	TierId string `protobuf:"bytes,11,opt,name=tierId,proto3" json:"tierId,omitempty" validateGeneric:"omitempty"`
	// contains filtered or unexported fields
}

func (*SetPointsRequest) Descriptor deprecated

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

Deprecated: Use SetPointsRequest.ProtoReflect.Descriptor instead.

func (*SetPointsRequest) GetEventDetails

func (x *SetPointsRequest) GetEventDetails() *EventDetails

func (*SetPointsRequest) GetExternalId

func (x *SetPointsRequest) GetExternalId() string

func (*SetPointsRequest) GetId

func (x *SetPointsRequest) GetId() string

func (*SetPointsRequest) GetPoints

func (x *SetPointsRequest) GetPoints() float32

func (*SetPointsRequest) GetProgramId

func (x *SetPointsRequest) GetProgramId() string

func (*SetPointsRequest) GetResetPoints

func (x *SetPointsRequest) GetResetPoints() bool

func (*SetPointsRequest) GetResetSecondaryPoints

func (x *SetPointsRequest) GetResetSecondaryPoints() bool

func (*SetPointsRequest) GetResetTierPoints

func (x *SetPointsRequest) GetResetTierPoints() bool

func (*SetPointsRequest) GetSecondaryPoints

func (x *SetPointsRequest) GetSecondaryPoints() float32

func (*SetPointsRequest) GetTierId

func (x *SetPointsRequest) GetTierId() string

func (*SetPointsRequest) GetTierPoints

func (x *SetPointsRequest) GetTierPoints() uint32

func (*SetPointsRequest) ProtoMessage

func (*SetPointsRequest) ProtoMessage()

func (*SetPointsRequest) ProtoReflect

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

func (*SetPointsRequest) Reset

func (x *SetPointsRequest) Reset()

func (*SetPointsRequest) String

func (x *SetPointsRequest) String() string

type Tier

type Tier struct {

	// Tier identifier (could just be: blue, gold, etc); needs to be lower case. Tier ID needs to be uique within the program.
	// @tag: validateGeneric:"required" validateCreate:"-" validateUpdate:"required"
	Id string `` /* 129-byte string literal not displayed */
	// Index of the tier; can be used for managing downgrades / upgrade messaging; needs to be unique within the program.
	// @tag: validateGeneric:"omitempty" validateCreate:"required" validateUpdate:"required"
	TierIndex uint32 `` /* 152-byte string literal not displayed */
	// Name of tier.
	// @tag: validateGeneric:"omitempty" validateCreate:"required" validateUpdate:"required"
	Name string `` /* 141-byte string literal not displayed */
	// Localized name of tier.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	LocalizedName *io.LocalizedString `` /* 161-byte string literal not displayed */
	// Name of the secondary reward tier.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	SecondaryTierName string `` /* 169-byte string literal not displayed */
	// Localized name of the secondary reward tier.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	LocalizedSecondaryTierName *io.LocalizedString `` /* 187-byte string literal not displayed */
	// The program id that the tier belongs to.
	// @tag: validateGeneric:"omitempty" validateCreate:"required" validateUpdate:"required"
	ProgramId string `` /* 151-byte string literal not displayed */
	// Identifier of pass template which identifies design and data elements for this tier.
	// @tag: validateGeneric:"omitempty" validateCreate:"required" validateUpdate:"required"
	PassTemplateId string `` /* 161-byte string literal not displayed */
	// Notification to be shown when someone upgrades tier.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	TierUpgradeMessage string `` /* 171-byte string literal not displayed */
	// Localized notification to be shown when someone upgrades tier.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	LocalizedTierUpgradeMessage *io.LocalizedString `` /* 190-byte string literal not displayed */
	// Notification to be shown when someone downgrades tier.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	TierDowngradeMessage string `` /* 176-byte string literal not displayed */
	// Localized notification to be shown when someone upgrades tier.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	LocalizedTierDowngradeMessage *io.LocalizedString `` /* 194-byte string literal not displayed */
	// The date the tier was created.
	// @tag: validateGeneric:"-" validateCreate:"-" validateUpdate:"-"
	Created *timestamppb.Timestamp `` /* 126-byte string literal not displayed */
	// The date the tier was updated.
	// @tag: validateGeneric:"-" validateCreate:"-" validateUpdate:"-"
	Updated *timestamppb.Timestamp `` /* 126-byte string literal not displayed */
	// Set true to accept a negative point balance. Default is false.
	PointsOverdrawn bool `protobuf:"varint,15,opt,name=pointsOverdrawn,proto3" json:"pointsOverdrawn,omitempty"`
	// Set true to accept a negative secondary point balance. Default is false.
	SecondaryPointsOverdrawn bool `protobuf:"varint,16,opt,name=secondaryPointsOverdrawn,proto3" json:"secondaryPointsOverdrawn,omitempty"`
	// Expiry date setting. You can set expiry logic here. Default no expiry logic.
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	ExpirySettings *io.ExpirySettings `` /* 164-byte string literal not displayed */
	// Timezone string in IANA timezone format. If not provided defaults to Etc/UTC.
	// @tag: validateGeneric:"omitempty,ianaTimeZone" validateCreate:"required,ianaTimeZone" validateUpdate:"omitempty,ianaTimeZone"
	Timezone string `` /* 190-byte string literal not displayed */
	// Indicates if customers can enrol into this tier via a public web form (only for public programs).
	// @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty"
	AllowTierEnrolment *io.PkBool `` /* 172-byte string literal not displayed */
	// Tier shortcode is used in public enrolment URLs, that enrol members into the tier if the program is set to public and allowTierEnrolment = true for this tier. System generated.
	// @tag: validateGeneric:"-" validateCreate:"-" validateUpdate:"-"
	ShortCode string `` /* 130-byte string literal not displayed */
	// contains filtered or unexported fields
}

The Tier object; will override certain details of the pass (colours, logo's, dynamic back fields, and labels).

func (*Tier) Descriptor deprecated

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

Deprecated: Use Tier.ProtoReflect.Descriptor instead.

func (*Tier) GetAllowTierEnrolment

func (x *Tier) GetAllowTierEnrolment() *io.PkBool

func (*Tier) GetCreated

func (x *Tier) GetCreated() *timestamppb.Timestamp

func (*Tier) GetExpirySettings

func (x *Tier) GetExpirySettings() *io.ExpirySettings

func (*Tier) GetId

func (x *Tier) GetId() string

func (*Tier) GetLocalizedName

func (x *Tier) GetLocalizedName() *io.LocalizedString

func (*Tier) GetLocalizedSecondaryTierName

func (x *Tier) GetLocalizedSecondaryTierName() *io.LocalizedString

func (*Tier) GetLocalizedTierDowngradeMessage

func (x *Tier) GetLocalizedTierDowngradeMessage() *io.LocalizedString

func (*Tier) GetLocalizedTierUpgradeMessage

func (x *Tier) GetLocalizedTierUpgradeMessage() *io.LocalizedString

func (*Tier) GetName

func (x *Tier) GetName() string

func (*Tier) GetPassTemplateId

func (x *Tier) GetPassTemplateId() string

func (*Tier) GetPointsOverdrawn

func (x *Tier) GetPointsOverdrawn() bool

func (*Tier) GetProgramId

func (x *Tier) GetProgramId() string

func (*Tier) GetSecondaryPointsOverdrawn

func (x *Tier) GetSecondaryPointsOverdrawn() bool

func (*Tier) GetSecondaryTierName

func (x *Tier) GetSecondaryTierName() string

func (*Tier) GetShortCode

func (x *Tier) GetShortCode() string

func (*Tier) GetTierDowngradeMessage

func (x *Tier) GetTierDowngradeMessage() string

func (*Tier) GetTierIndex

func (x *Tier) GetTierIndex() uint32

func (*Tier) GetTierUpgradeMessage

func (x *Tier) GetTierUpgradeMessage() string

func (*Tier) GetTimezone

func (x *Tier) GetTimezone() string

func (*Tier) GetUpdated

func (x *Tier) GetUpdated() *timestamppb.Timestamp

func (*Tier) ProtoMessage

func (*Tier) ProtoMessage()

func (*Tier) ProtoReflect

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

func (*Tier) Reset

func (x *Tier) Reset()

func (*Tier) String

func (x *Tier) String() string

type TierRequestInput

type TierRequestInput struct {

	// Program ID.
	// @tag: validateGeneric:"required" validateCreate:"required" validateUpdate:"required"
	ProgramId string `` /* 150-byte string literal not displayed */
	// Tier ID.
	// @tag: validateGeneric:"required" validateCreate:"required" validateUpdate:"required"
	TierId string `` /* 144-byte string literal not displayed */
	// contains filtered or unexported fields
}

Used to request member tier record by tier id.

func (*TierRequestInput) Descriptor deprecated

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

Deprecated: Use TierRequestInput.ProtoReflect.Descriptor instead.

func (*TierRequestInput) GetProgramId

func (x *TierRequestInput) GetProgramId() string

func (*TierRequestInput) GetTierId

func (x *TierRequestInput) GetTierId() string

func (*TierRequestInput) ProtoMessage

func (*TierRequestInput) ProtoMessage()

func (*TierRequestInput) ProtoReflect

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

func (*TierRequestInput) Reset

func (x *TierRequestInput) Reset()

func (*TierRequestInput) String

func (x *TierRequestInput) String() string

type UnimplementedMembersServer

type UnimplementedMembersServer struct {
}

UnimplementedMembersServer should be embedded to have forward compatible implementations.

func (UnimplementedMembersServer) BurnPoints

func (UnimplementedMembersServer) ChangeMemberTier

func (UnimplementedMembersServer) CheckInMember

func (UnimplementedMembersServer) CheckOutMember

func (UnimplementedMembersServer) CopyProgram

func (UnimplementedMembersServer) CountMemberEvents

func (UnimplementedMembersServer) CountMembers

func (UnimplementedMembersServer) CountMembersDeprecated

func (UnimplementedMembersServer) CreateProgram

func (UnimplementedMembersServer) CreateTier

func (UnimplementedMembersServer) DeleteEventsForMember

func (UnimplementedMembersServer) DeleteEventsForMember(context.Context, *io.Id) (*emptypb.Empty, error)

func (UnimplementedMembersServer) DeleteMember

func (UnimplementedMembersServer) DeleteMemberEvent

func (UnimplementedMembersServer) DeleteMemberEvent(context.Context, *io.Id) (*emptypb.Empty, error)

func (UnimplementedMembersServer) DeleteMemberEvents

func (UnimplementedMembersServer) DeleteMembersBySegment

func (UnimplementedMembersServer) DeleteProgram

func (UnimplementedMembersServer) DeleteTier

func (UnimplementedMembersServer) EarnPoints

func (UnimplementedMembersServer) EnrolMember

func (UnimplementedMembersServer) EnrolMemberPublic

func (UnimplementedMembersServer) EnrolMemberPublic(context.Context, *Member) (*io.Id, error)

func (UnimplementedMembersServer) GetMemberEventMetaKeysForProgram

func (UnimplementedMembersServer) GetMemberEventMetaKeysForProgram(context.Context, *io.Id) (*io.Strings, error)

func (UnimplementedMembersServer) GetMemberRecordByExternalId

func (UnimplementedMembersServer) GetMemberRecordById

func (UnimplementedMembersServer) GetMemberRecordById(context.Context, *io.Id) (*Member, error)

func (UnimplementedMembersServer) GetMessageHistoryForMember

func (UnimplementedMembersServer) GetMetaKeysForProgram

func (UnimplementedMembersServer) GetMetaKeysForProgram(context.Context, *io.Id) (*io.Strings, error)

func (UnimplementedMembersServer) GetProgram

func (UnimplementedMembersServer) GetProgramEnrolment

func (UnimplementedMembersServer) GetProgramEnrolment(context.Context, *io.Id) (*io.EnrolmentUrls, error)

func (UnimplementedMembersServer) GetTier

func (UnimplementedMembersServer) ListEventsForMember

func (UnimplementedMembersServer) ListMemberEvents

func (UnimplementedMembersServer) ListMembers

func (UnimplementedMembersServer) ListPrograms

func (UnimplementedMembersServer) ListProgramsDeprecated

func (UnimplementedMembersServer) ListTiers

func (UnimplementedMembersServer) ListTiersDeprecated

func (UnimplementedMembersServer) PatchPerson

func (UnimplementedMembersServer) RenewMembersExpiry

func (UnimplementedMembersServer) SetPoints

func (UnimplementedMembersServer) UpdateMember

func (UnimplementedMembersServer) UpdateMemberExpiry

func (UnimplementedMembersServer) UpdateMemberExpiry(context.Context, *MemberExpiry) (*io.Id, error)

func (UnimplementedMembersServer) UpdateMembersBySegment

func (UnimplementedMembersServer) UpdateProgram

func (UnimplementedMembersServer) UpdateTier

type UnsafeMembersServer

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

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

type UpdateExpiryRequest

type UpdateExpiryRequest struct {

	// Indicates the ID of the program.
	// @tag: validateUpdate:"required"
	ProgramId string `protobuf:"bytes,1,opt,name=programId,proto3" json:"programId,omitempty" validateUpdate:"required"`
	// Indicates the ID of the tier.
	// @tag: validateUpdate:"required"
	TierId string `protobuf:"bytes,2,opt,name=tierId,proto3" json:"tierId,omitempty" validateUpdate:"required"`
	// Expiry date setting you want to apply for this update.
	// @tag: validateUpdate:"required"
	ExpirySettings *io.ExpirySettings `protobuf:"bytes,3,opt,name=expirySettings,proto3" json:"expirySettings,omitempty" validateUpdate:"required"`
	// Timezone string in IANA timezone format applied for EXPIRE_ON_FIXED_DATE. If not provided Tier timezone is applied.
	// @tag: validateUpdate:"omitempty,ianaTimeZone"
	Timezone string `protobuf:"bytes,4,opt,name=timezone,proto3" json:"timezone,omitempty" validateUpdate:"omitempty,ianaTimeZone"`
	// contains filtered or unexported fields
}

Used to set new expiry dates for all of active members in the tier.

func (*UpdateExpiryRequest) Descriptor deprecated

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

Deprecated: Use UpdateExpiryRequest.ProtoReflect.Descriptor instead.

func (*UpdateExpiryRequest) GetExpirySettings

func (x *UpdateExpiryRequest) GetExpirySettings() *io.ExpirySettings

func (*UpdateExpiryRequest) GetProgramId

func (x *UpdateExpiryRequest) GetProgramId() string

func (*UpdateExpiryRequest) GetTierId

func (x *UpdateExpiryRequest) GetTierId() string

func (*UpdateExpiryRequest) GetTimezone

func (x *UpdateExpiryRequest) GetTimezone() string

func (*UpdateExpiryRequest) ProtoMessage

func (*UpdateExpiryRequest) ProtoMessage()

func (*UpdateExpiryRequest) ProtoReflect

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

func (*UpdateExpiryRequest) Reset

func (x *UpdateExpiryRequest) Reset()

func (*UpdateExpiryRequest) String

func (x *UpdateExpiryRequest) String() string

Jump to

Keyboard shortcuts

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