Documentation ¶
Overview ¶
Package single_use_coupons is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Constants
- Variables
- func RegisterSingleUseCouponsHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterSingleUseCouponsHandlerClient(ctx context.Context, mux *runtime.ServeMux, client SingleUseCouponsClient) error
- func RegisterSingleUseCouponsHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterSingleUseCouponsHandlerServer(ctx context.Context, mux *runtime.ServeMux, server SingleUseCouponsServer) error
- func RegisterSingleUseCouponsServer(s grpc.ServiceRegistrar, srv SingleUseCouponsServer)
- type CallToActionButton
- func (*CallToActionButton) Descriptor() ([]byte, []int)deprecated
- func (x *CallToActionButton) GetButtonText() string
- func (x *CallToActionButton) GetHideCallToActionButton() bool
- func (x *CallToActionButton) GetLink() string
- func (x *CallToActionButton) GetLocalizedButtonText() *io.LocalizedString
- func (x *CallToActionButton) GetLocalizedLink() *io.LocalizedString
- func (*CallToActionButton) ProtoMessage()
- func (x *CallToActionButton) ProtoReflect() protoreflect.Message
- func (x *CallToActionButton) Reset()
- func (x *CallToActionButton) String() string
- type CampaignCopyRequest
- func (*CampaignCopyRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CampaignCopyRequest) GetId() string
- func (x *CampaignCopyRequest) GetName() string
- func (x *CampaignCopyRequest) GetPassTypeIdentifier() string
- func (x *CampaignCopyRequest) GetStatus() []io.ProjectStatus
- func (*CampaignCopyRequest) ProtoMessage()
- func (x *CampaignCopyRequest) ProtoReflect() protoreflect.Message
- func (x *CampaignCopyRequest) Reset()
- func (x *CampaignCopyRequest) String() string
- type Coupon
- func (*Coupon) Descriptor() ([]byte, []int)deprecated
- func (x *Coupon) GetCampaignId() string
- func (x *Coupon) GetCreated() *timestamppb.Timestamp
- func (x *Coupon) GetExpiryDate() *timestamppb.Timestamp
- func (x *Coupon) GetExternalId() string
- func (x *Coupon) GetId() string
- func (x *Coupon) GetMetaData() map[string]string
- func (x *Coupon) GetOfferId() string
- func (x *Coupon) GetOptOut() bool
- func (x *Coupon) GetPassMetaData() *io.Metadata
- func (x *Coupon) GetPassOverrides() *io.PassOverrides
- func (x *Coupon) GetPerson() *io.Person
- func (x *Coupon) GetRedemptionDetails() *RedemptionDetails
- func (x *Coupon) GetSku() string
- func (x *Coupon) GetStatus() CouponStatus
- func (x *Coupon) GetUpdated() *timestamppb.Timestamp
- func (*Coupon) ProtoMessage()
- func (x *Coupon) ProtoReflect() protoreflect.Message
- func (x *Coupon) Reset()
- func (x *Coupon) String() string
- type CouponCampaign
- func (*CouponCampaign) Descriptor() ([]byte, []int)deprecated
- func (x *CouponCampaign) GetCreated() *timestamppb.Timestamp
- func (x *CouponCampaign) GetIanaTimezone() string
- func (x *CouponCampaign) GetId() string
- func (x *CouponCampaign) GetLocalizedName() *io.LocalizedString
- func (x *CouponCampaign) GetName() string
- func (x *CouponCampaign) GetPassTypeIdentifier() string
- func (x *CouponCampaign) GetStatus() []io.ProjectStatus
- func (x *CouponCampaign) GetUpdated() *timestamppb.Timestamp
- func (*CouponCampaign) ProtoMessage()
- func (x *CouponCampaign) ProtoReflect() protoreflect.Message
- func (x *CouponCampaign) Reset()
- func (x *CouponCampaign) String() string
- type CouponCampaignAnalyticsResponse
- func (*CouponCampaignAnalyticsResponse) Descriptor() ([]byte, []int)deprecated
- func (x *CouponCampaignAnalyticsResponse) GetData() []*io.ChartDataPoints
- func (x *CouponCampaignAnalyticsResponse) GetDevices() *io.DeviceBreakdown
- func (x *CouponCampaignAnalyticsResponse) GetPeriod() io.Period
- func (x *CouponCampaignAnalyticsResponse) GetRedeemed() uint32
- func (x *CouponCampaignAnalyticsResponse) GetSources() map[string]uint32
- func (*CouponCampaignAnalyticsResponse) ProtoMessage()
- func (x *CouponCampaignAnalyticsResponse) ProtoReflect() protoreflect.Message
- func (x *CouponCampaignAnalyticsResponse) Reset()
- func (x *CouponCampaignAnalyticsResponse) String() string
- type CouponExpirySettings
- func (*CouponExpirySettings) Descriptor() ([]byte, []int)deprecated
- func (x *CouponExpirySettings) GetCouponExpiryType() CouponExpiryType
- func (x *CouponExpirySettings) GetExpireAfterXDays() uint32
- func (*CouponExpirySettings) ProtoMessage()
- func (x *CouponExpirySettings) ProtoReflect() protoreflect.Message
- func (x *CouponExpirySettings) Reset()
- func (x *CouponExpirySettings) String() string
- type CouponExpiryType
- func (CouponExpiryType) Descriptor() protoreflect.EnumDescriptor
- func (x CouponExpiryType) Enum() *CouponExpiryType
- func (CouponExpiryType) EnumDescriptor() ([]byte, []int)deprecated
- func (x CouponExpiryType) Number() protoreflect.EnumNumber
- func (x CouponExpiryType) String() string
- func (CouponExpiryType) Type() protoreflect.EnumType
- type CouponNewExternalIdRequest
- func (*CouponNewExternalIdRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CouponNewExternalIdRequest) GetCouponCampaignId() string
- func (x *CouponNewExternalIdRequest) GetExternalId() string
- func (x *CouponNewExternalIdRequest) GetId() string
- func (x *CouponNewExternalIdRequest) GetNewExternalId() string
- func (*CouponNewExternalIdRequest) ProtoMessage()
- func (x *CouponNewExternalIdRequest) ProtoReflect() protoreflect.Message
- func (x *CouponNewExternalIdRequest) Reset()
- func (x *CouponNewExternalIdRequest) String() string
- type CouponOffer
- func (*CouponOffer) Descriptor() ([]byte, []int)deprecated
- func (x *CouponOffer) GetAfterRedeemPassTemplateId() string
- func (x *CouponOffer) GetBeforeRedeemPassTemplateId() string
- func (x *CouponOffer) GetCampaignId() string
- func (x *CouponOffer) GetCouponExpirySettings() *CouponExpirySettings
- func (x *CouponOffer) GetCreated() *timestamppb.Timestamp
- func (x *CouponOffer) GetDisabled() bool
- func (x *CouponOffer) GetDistributionSettings() *io.DistributionSettings
- func (x *CouponOffer) GetIanaTimezone() string
- func (x *CouponOffer) GetId() string
- func (x *CouponOffer) GetIssueEndDate() *timestamppb.Timestamp
- func (x *CouponOffer) GetIssueStartDate() *timestamppb.Timestamp
- func (x *CouponOffer) GetLocalizedOfferDetails() *io.LocalizedString
- func (x *CouponOffer) GetLocalizedOfferFinePrint() *io.LocalizedString
- func (x *CouponOffer) GetLocalizedOfferShortTitle() *io.LocalizedString
- func (x *CouponOffer) GetLocalizedOfferTitle() *io.LocalizedString
- func (x *CouponOffer) GetOfferDetails() string
- func (x *CouponOffer) GetOfferFinePrint() string
- func (x *CouponOffer) GetOfferShortTitle() string
- func (x *CouponOffer) GetOfferTitle() string
- func (x *CouponOffer) GetOperation() io.Operation
- func (x *CouponOffer) GetQuota() *io.Quota
- func (x *CouponOffer) GetRedemptionSettings() *RedemptionSettings
- func (x *CouponOffer) GetShortCode() string
- func (x *CouponOffer) GetUpdated() *timestamppb.Timestamp
- func (*CouponOffer) ProtoMessage()
- func (x *CouponOffer) ProtoReflect() protoreflect.Message
- func (x *CouponOffer) Reset()
- func (x *CouponOffer) String() string
- type CouponOffersListRequest
- func (*CouponOffersListRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CouponOffersListRequest) GetCampaignId() string
- func (x *CouponOffersListRequest) GetFilters() *io.Filters
- func (*CouponOffersListRequest) ProtoMessage()
- func (x *CouponOffersListRequest) ProtoReflect() protoreflect.Message
- func (x *CouponOffersListRequest) Reset()
- func (x *CouponOffersListRequest) String() string
- type CouponOffersListRequestDeprecated
- func (*CouponOffersListRequestDeprecated) Descriptor() ([]byte, []int)deprecated
- func (x *CouponOffersListRequestDeprecated) GetCampaignId() string
- func (x *CouponOffersListRequestDeprecated) GetPagination() *io.Pagination
- func (*CouponOffersListRequestDeprecated) ProtoMessage()
- func (x *CouponOffersListRequestDeprecated) ProtoReflect() protoreflect.Message
- func (x *CouponOffersListRequestDeprecated) Reset()
- func (x *CouponOffersListRequestDeprecated) String() string
- type CouponStatus
- func (CouponStatus) Descriptor() protoreflect.EnumDescriptor
- func (x CouponStatus) Enum() *CouponStatus
- func (CouponStatus) EnumDescriptor() ([]byte, []int)deprecated
- func (x CouponStatus) Number() protoreflect.EnumNumber
- func (x CouponStatus) String() string
- func (CouponStatus) Type() protoreflect.EnumType
- type CustomerInitiatedCodeProvideOnRedeemSettings
- func (*CustomerInitiatedCodeProvideOnRedeemSettings) Descriptor() ([]byte, []int)deprecated
- func (x *CustomerInitiatedCodeProvideOnRedeemSettings) GetLocalizedSubmitButtonText() *io.LocalizedString
- func (x *CustomerInitiatedCodeProvideOnRedeemSettings) GetRedemptionCodeInput() *InputField
- func (x *CustomerInitiatedCodeProvideOnRedeemSettings) GetSubmitButtonText() string
- func (x *CustomerInitiatedCodeProvideOnRedeemSettings) GetValidCodes() []string
- func (*CustomerInitiatedCodeProvideOnRedeemSettings) ProtoMessage()
- func (x *CustomerInitiatedCodeProvideOnRedeemSettings) ProtoReflect() protoreflect.Message
- func (x *CustomerInitiatedCodeProvideOnRedeemSettings) Reset()
- func (x *CustomerInitiatedCodeProvideOnRedeemSettings) String() string
- type CustomerInitiatedFixedCodeSettings
- func (*CustomerInitiatedFixedCodeSettings) Descriptor() ([]byte, []int)deprecated
- func (x *CustomerInitiatedFixedCodeSettings) GetBarcode() io.BarcodeType
- func (x *CustomerInitiatedFixedCodeSettings) GetFixedCode() string
- func (x *CustomerInitiatedFixedCodeSettings) GetRedemptionTimer() *RedemptionTimerSettings
- func (x *CustomerInitiatedFixedCodeSettings) GetUseCouponSku() bool
- func (*CustomerInitiatedFixedCodeSettings) ProtoMessage()
- func (x *CustomerInitiatedFixedCodeSettings) ProtoReflect() protoreflect.Message
- func (x *CustomerInitiatedFixedCodeSettings) Reset()
- func (x *CustomerInitiatedFixedCodeSettings) String() string
- type ExternalIdRequest
- func (*ExternalIdRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ExternalIdRequest) GetCouponCampaignId() string
- func (x *ExternalIdRequest) GetExternalId() string
- func (*ExternalIdRequest) ProtoMessage()
- func (x *ExternalIdRequest) ProtoReflect() protoreflect.Message
- func (x *ExternalIdRequest) Reset()
- func (x *ExternalIdRequest) String() string
- type InputField
- func (*InputField) Descriptor() ([]byte, []int)deprecated
- func (x *InputField) GetDefaultValue() string
- func (x *InputField) GetErrorMessage() string
- func (x *InputField) GetHelperText() string
- func (x *InputField) GetLabel() string
- func (x *InputField) GetLocalizedDefaultValue() *io.LocalizedString
- func (x *InputField) GetLocalizedErrorMessage() *io.LocalizedString
- func (x *InputField) GetLocalizedHelperText() *io.LocalizedString
- func (x *InputField) GetLocalizedLabel() *io.LocalizedString
- func (x *InputField) GetLocalizedPlaceholder() *io.LocalizedString
- func (x *InputField) GetPlaceholder() string
- func (x *InputField) GetValidation() string
- func (*InputField) ProtoMessage()
- func (x *InputField) ProtoReflect() protoreflect.Message
- func (x *InputField) Reset()
- func (x *InputField) String() string
- type ListRequest
- func (*ListRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ListRequest) GetCouponCampaignId() string
- func (x *ListRequest) GetEmailAsCsv() bool
- func (x *ListRequest) GetFilters() *io.Filters
- func (*ListRequest) ProtoMessage()
- func (x *ListRequest) ProtoReflect() protoreflect.Message
- func (x *ListRequest) Reset()
- func (x *ListRequest) String() string
- type ListRequestDeprecated
- func (*ListRequestDeprecated) Descriptor() ([]byte, []int)deprecated
- func (x *ListRequestDeprecated) GetCouponCampaignId() string
- func (x *ListRequestDeprecated) GetPagination() *io.Pagination
- func (*ListRequestDeprecated) ProtoMessage()
- func (x *ListRequestDeprecated) ProtoReflect() protoreflect.Message
- func (x *ListRequestDeprecated) Reset()
- func (x *ListRequestDeprecated) String() string
- type RedemptionDetails
- func (*RedemptionDetails) Descriptor() ([]byte, []int)deprecated
- func (x *RedemptionDetails) GetAlt() int32
- func (x *RedemptionDetails) GetLat() float64
- func (x *RedemptionDetails) GetLon() float64
- func (x *RedemptionDetails) GetMetaData() map[string]string
- func (x *RedemptionDetails) GetRedemptionCode() string
- func (x *RedemptionDetails) GetRedemptionDate() *timestamppb.Timestamp
- func (x *RedemptionDetails) GetRedemptionReference() string
- func (x *RedemptionDetails) GetRedemptionSource() string
- func (x *RedemptionDetails) GetTransactionAmount() float64
- func (x *RedemptionDetails) GetTransactionReference() string
- func (*RedemptionDetails) ProtoMessage()
- func (x *RedemptionDetails) ProtoReflect() protoreflect.Message
- func (x *RedemptionDetails) Reset()
- func (x *RedemptionDetails) String() string
- type RedemptionSettings
- func (*RedemptionSettings) Descriptor() ([]byte, []int)deprecated
- func (x *RedemptionSettings) GetCodeProvidedOnRedeemSettings() *CustomerInitiatedCodeProvideOnRedeemSettings
- func (x *RedemptionSettings) GetFixedCodeSettings() *CustomerInitiatedFixedCodeSettings
- func (x *RedemptionSettings) GetRedemptionEndDate() *timestamppb.Timestamp
- func (x *RedemptionSettings) GetRedemptionStartDate() *timestamppb.Timestamp
- func (x *RedemptionSettings) GetRedemptionType() []RedemptionType
- func (x *RedemptionSettings) GetStandardSettings() *StandardPassKitHostedPage
- func (*RedemptionSettings) ProtoMessage()
- func (x *RedemptionSettings) ProtoReflect() protoreflect.Message
- func (x *RedemptionSettings) Reset()
- func (x *RedemptionSettings) String() string
- type RedemptionTimerSettings
- func (*RedemptionTimerSettings) Descriptor() ([]byte, []int)deprecated
- func (x *RedemptionTimerSettings) GetLocalizedTimeHelpText() *io.LocalizedString
- func (x *RedemptionTimerSettings) GetTimeoutSeconds() uint32
- func (x *RedemptionTimerSettings) GetTimerHelpText() string
- func (*RedemptionTimerSettings) ProtoMessage()
- func (x *RedemptionTimerSettings) ProtoReflect() protoreflect.Message
- func (x *RedemptionTimerSettings) Reset()
- func (x *RedemptionTimerSettings) String() string
- type RedemptionType
- func (RedemptionType) Descriptor() protoreflect.EnumDescriptor
- func (x RedemptionType) Enum() *RedemptionType
- func (RedemptionType) EnumDescriptor() ([]byte, []int)deprecated
- func (x RedemptionType) Number() protoreflect.EnumNumber
- func (x RedemptionType) String() string
- func (RedemptionType) Type() protoreflect.EnumType
- type ResponseTexts
- func (*ResponseTexts) Descriptor() ([]byte, []int)deprecated
- func (x *ResponseTexts) GetAfterRedeemText() string
- func (x *ResponseTexts) GetCancelRedeemText() string
- func (x *ResponseTexts) GetCouponAlreadyRedeemedText() string
- func (x *ResponseTexts) GetCouponExpiredText() string
- func (x *ResponseTexts) GetLocalizedAfterRedeemText() *io.LocalizedString
- func (x *ResponseTexts) GetLocalizedCancelRedeemText() *io.LocalizedString
- func (x *ResponseTexts) GetLocalizedCouponAlreadyRedeemedText() *io.LocalizedString
- func (x *ResponseTexts) GetLocalizedCouponExpiredText() *io.LocalizedString
- func (x *ResponseTexts) GetLocalizedOfferExpiredText() *io.LocalizedString
- func (x *ResponseTexts) GetLocalizedRedeemConfirmationDialogBoxText() *io.LocalizedString
- func (x *ResponseTexts) GetOfferExpiredText() string
- func (x *ResponseTexts) GetRedeemConfirmationDialogBoxText() string
- func (*ResponseTexts) ProtoMessage()
- func (x *ResponseTexts) ProtoReflect() protoreflect.Message
- func (x *ResponseTexts) Reset()
- func (x *ResponseTexts) String() string
- type SingleUseCouponsClient
- type SingleUseCouponsServer
- type SingleUseCoupons_ListCouponCampaignsClient
- type SingleUseCoupons_ListCouponCampaignsDeprecatedClient
- type SingleUseCoupons_ListCouponCampaignsDeprecatedServer
- type SingleUseCoupons_ListCouponCampaignsServer
- type SingleUseCoupons_ListCouponOffersClient
- type SingleUseCoupons_ListCouponOffersDeprecatedClient
- type SingleUseCoupons_ListCouponOffersDeprecatedServer
- type SingleUseCoupons_ListCouponOffersServer
- type SingleUseCoupons_ListCouponsByCouponCampaignClient
- type SingleUseCoupons_ListCouponsByCouponCampaignDeprecatedClient
- type SingleUseCoupons_ListCouponsByCouponCampaignDeprecatedServer
- type SingleUseCoupons_ListCouponsByCouponCampaignServer
- type SingleUseCoupons_StreamCouponRedemptionsClient
- type SingleUseCoupons_StreamCouponRedemptionsServer
- type SingleUseCoupons_StreamCouponUpdatesClient
- type SingleUseCoupons_StreamCouponUpdatesServer
- type StandardPassKitHostedPage
- func (*StandardPassKitHostedPage) Descriptor() ([]byte, []int)deprecated
- func (x *StandardPassKitHostedPage) GetCallToActionButton() *CallToActionButton
- func (x *StandardPassKitHostedPage) GetCssOverrides() string
- func (x *StandardPassKitHostedPage) GetFooterText() string
- func (x *StandardPassKitHostedPage) GetHideRedeemedDateTime() bool
- func (x *StandardPassKitHostedPage) GetImageIds() *io.ImageIds
- func (x *StandardPassKitHostedPage) GetImages() *io.ImageData
- func (x *StandardPassKitHostedPage) GetLocalizedFooterText() *io.LocalizedString
- func (x *StandardPassKitHostedPage) GetLocalizedRedemptionInstructions() *io.LocalizedString
- func (x *StandardPassKitHostedPage) GetLocalizedTitle() *io.LocalizedString
- func (m *StandardPassKitHostedPage) GetRedemptionImageAssets() isStandardPassKitHostedPage_RedemptionImageAssets
- func (x *StandardPassKitHostedPage) GetRedemptionInstructions() string
- func (x *StandardPassKitHostedPage) GetResponseTexts() *ResponseTexts
- func (x *StandardPassKitHostedPage) GetTitle() string
- func (*StandardPassKitHostedPage) ProtoMessage()
- func (x *StandardPassKitHostedPage) ProtoReflect() protoreflect.Message
- func (x *StandardPassKitHostedPage) Reset()
- func (x *StandardPassKitHostedPage) String() string
- type StandardPassKitHostedPage_ImageIds
- type StandardPassKitHostedPage_Images
- type UnimplementedSingleUseCouponsServer
- func (UnimplementedSingleUseCouponsServer) CopyCouponCampaign(context.Context, *CampaignCopyRequest) (*io.Id, error)
- func (UnimplementedSingleUseCouponsServer) CountCouponsByCouponCampaign(context.Context, *ListRequest) (*io.Count, error)
- func (UnimplementedSingleUseCouponsServer) CountCouponsByCouponCampaignDeprecated(context.Context, *ListRequestDeprecated) (*io.Count, error)
- func (UnimplementedSingleUseCouponsServer) CreateCoupon(context.Context, *Coupon) (*io.Id, error)
- func (UnimplementedSingleUseCouponsServer) CreateCouponCampaign(context.Context, *CouponCampaign) (*io.Id, error)
- func (UnimplementedSingleUseCouponsServer) CreateCouponOffer(context.Context, *CouponOffer) (*io.Id, error)
- func (UnimplementedSingleUseCouponsServer) DeleteCouponCampaign(context.Context, *io.Id) (*emptypb.Empty, error)
- func (UnimplementedSingleUseCouponsServer) DeleteCouponOffer(context.Context, *io.Id) (*emptypb.Empty, error)
- func (UnimplementedSingleUseCouponsServer) GetAnalytics(context.Context, *io.AnalyticsRequest) (*CouponCampaignAnalyticsResponse, error)
- func (UnimplementedSingleUseCouponsServer) GetCouponByExternalId(context.Context, *ExternalIdRequest) (*Coupon, error)
- func (UnimplementedSingleUseCouponsServer) GetCouponById(context.Context, *io.Id) (*Coupon, error)
- func (UnimplementedSingleUseCouponsServer) GetCouponCampaign(context.Context, *io.Id) (*CouponCampaign, error)
- func (UnimplementedSingleUseCouponsServer) GetCouponOffer(context.Context, *io.Id) (*CouponOffer, error)
- func (UnimplementedSingleUseCouponsServer) GetMetaKeysForCampaign(context.Context, *io.Id) (*io.Strings, error)
- func (UnimplementedSingleUseCouponsServer) ListCouponCampaigns(*io.Filters, SingleUseCoupons_ListCouponCampaignsServer) error
- func (UnimplementedSingleUseCouponsServer) ListCouponCampaignsDeprecated(*io.Pagination, SingleUseCoupons_ListCouponCampaignsDeprecatedServer) error
- func (UnimplementedSingleUseCouponsServer) ListCouponOffers(*CouponOffersListRequest, SingleUseCoupons_ListCouponOffersServer) error
- func (UnimplementedSingleUseCouponsServer) ListCouponOffersDeprecated(*CouponOffersListRequestDeprecated, ...) error
- func (UnimplementedSingleUseCouponsServer) ListCouponsByCouponCampaign(*ListRequest, SingleUseCoupons_ListCouponsByCouponCampaignServer) error
- func (UnimplementedSingleUseCouponsServer) ListCouponsByCouponCampaignDeprecated(*ListRequestDeprecated, ...) error
- func (UnimplementedSingleUseCouponsServer) PatchPerson(context.Context, *io.PersonRequest) (*io.Id, error)
- func (UnimplementedSingleUseCouponsServer) RedeemCoupon(context.Context, *Coupon) (*io.Id, error)
- func (UnimplementedSingleUseCouponsServer) StreamCouponRedemptions(SingleUseCoupons_StreamCouponRedemptionsServer) error
- func (UnimplementedSingleUseCouponsServer) StreamCouponUpdates(SingleUseCoupons_StreamCouponUpdatesServer) error
- func (UnimplementedSingleUseCouponsServer) UpdateCoupon(context.Context, *Coupon) (*io.Id, error)
- func (UnimplementedSingleUseCouponsServer) UpdateCouponCampaign(context.Context, *CouponCampaign) (*CouponCampaign, error)
- func (UnimplementedSingleUseCouponsServer) UpdateCouponExternalId(context.Context, *CouponNewExternalIdRequest) (*io.Id, error)
- func (UnimplementedSingleUseCouponsServer) UpdateCouponOffer(context.Context, *CouponOffer) (*CouponOffer, error)
- func (UnimplementedSingleUseCouponsServer) VoidCoupon(context.Context, *Coupon) (*emptypb.Empty, error)
- type UnsafeSingleUseCouponsServer
Constants ¶
const ( SingleUseCoupons_CreateCouponCampaign_FullMethodName = "/single_use_coupons.SingleUseCoupons/createCouponCampaign" SingleUseCoupons_UpdateCouponCampaign_FullMethodName = "/single_use_coupons.SingleUseCoupons/updateCouponCampaign" SingleUseCoupons_GetCouponCampaign_FullMethodName = "/single_use_coupons.SingleUseCoupons/getCouponCampaign" SingleUseCoupons_DeleteCouponCampaign_FullMethodName = "/single_use_coupons.SingleUseCoupons/deleteCouponCampaign" SingleUseCoupons_ListCouponCampaignsDeprecated_FullMethodName = "/single_use_coupons.SingleUseCoupons/listCouponCampaignsDeprecated" SingleUseCoupons_ListCouponCampaigns_FullMethodName = "/single_use_coupons.SingleUseCoupons/listCouponCampaigns" SingleUseCoupons_GetAnalytics_FullMethodName = "/single_use_coupons.SingleUseCoupons/getAnalytics" SingleUseCoupons_CreateCouponOffer_FullMethodName = "/single_use_coupons.SingleUseCoupons/createCouponOffer" SingleUseCoupons_UpdateCouponOffer_FullMethodName = "/single_use_coupons.SingleUseCoupons/updateCouponOffer" SingleUseCoupons_GetCouponOffer_FullMethodName = "/single_use_coupons.SingleUseCoupons/getCouponOffer" SingleUseCoupons_DeleteCouponOffer_FullMethodName = "/single_use_coupons.SingleUseCoupons/deleteCouponOffer" SingleUseCoupons_ListCouponOffersDeprecated_FullMethodName = "/single_use_coupons.SingleUseCoupons/listCouponOffersDeprecated" SingleUseCoupons_ListCouponOffers_FullMethodName = "/single_use_coupons.SingleUseCoupons/listCouponOffers" SingleUseCoupons_CreateCoupon_FullMethodName = "/single_use_coupons.SingleUseCoupons/createCoupon" SingleUseCoupons_UpdateCoupon_FullMethodName = "/single_use_coupons.SingleUseCoupons/updateCoupon" SingleUseCoupons_StreamCouponUpdates_FullMethodName = "/single_use_coupons.SingleUseCoupons/streamCouponUpdates" SingleUseCoupons_RedeemCoupon_FullMethodName = "/single_use_coupons.SingleUseCoupons/redeemCoupon" SingleUseCoupons_UpdateCouponExternalId_FullMethodName = "/single_use_coupons.SingleUseCoupons/updateCouponExternalId" SingleUseCoupons_StreamCouponRedemptions_FullMethodName = "/single_use_coupons.SingleUseCoupons/streamCouponRedemptions" SingleUseCoupons_GetCouponById_FullMethodName = "/single_use_coupons.SingleUseCoupons/getCouponById" SingleUseCoupons_GetCouponByExternalId_FullMethodName = "/single_use_coupons.SingleUseCoupons/getCouponByExternalId" SingleUseCoupons_VoidCoupon_FullMethodName = "/single_use_coupons.SingleUseCoupons/voidCoupon" SingleUseCoupons_ListCouponsByCouponCampaignDeprecated_FullMethodName = "/single_use_coupons.SingleUseCoupons/listCouponsByCouponCampaignDeprecated" SingleUseCoupons_ListCouponsByCouponCampaign_FullMethodName = "/single_use_coupons.SingleUseCoupons/listCouponsByCouponCampaign" SingleUseCoupons_CountCouponsByCouponCampaignDeprecated_FullMethodName = "/single_use_coupons.SingleUseCoupons/countCouponsByCouponCampaignDeprecated" SingleUseCoupons_CountCouponsByCouponCampaign_FullMethodName = "/single_use_coupons.SingleUseCoupons/countCouponsByCouponCampaign" SingleUseCoupons_PatchPerson_FullMethodName = "/single_use_coupons.SingleUseCoupons/patchPerson" SingleUseCoupons_CopyCouponCampaign_FullMethodName = "/single_use_coupons.SingleUseCoupons/copyCouponCampaign" SingleUseCoupons_GetMetaKeysForCampaign_FullMethodName = "/single_use_coupons.SingleUseCoupons/getMetaKeysForCampaign" )
Variables ¶
var ( CouponStatus_name = map[int32]string{ 0: "UNREDEEMED", 1: "REDEEMED", } CouponStatus_value = map[string]int32{ "UNREDEEMED": 0, "REDEEMED": 1, } )
Enum value maps for CouponStatus.
var ( CouponExpiryType_name = map[int32]string{ 0: "EXPIRY_DO_NOT_USE", 1: "AUTO_EXPIRE_OFFER_END_DATE", 2: "AUTO_EXPIRE_REDEMPTION_END_DATE", 3: "EXPIRE_AFTER_X_DAYS", 4: "EXPIRE_ON_VARIABLE_DATE_TIME", } CouponExpiryType_value = map[string]int32{ "EXPIRY_DO_NOT_USE": 0, "AUTO_EXPIRE_OFFER_END_DATE": 1, "AUTO_EXPIRE_REDEMPTION_END_DATE": 2, "EXPIRE_AFTER_X_DAYS": 3, "EXPIRE_ON_VARIABLE_DATE_TIME": 4, } )
Enum value maps for CouponExpiryType.
var ( RedemptionType_name = map[int32]string{ 0: "REDEMPTION_TYPE_DO_NOT_USE", 1: "REDEMPTION_TYPE_API", 2: "REDEMPTION_TYPE_CUSTOMER_INITIATED", 3: "REDEMPTION_TYPE_CUSTOMER_INITIATED_CODE_FIXED", 4: "REDEMPTION_TYPE_CUSTOMER_INITIATED_CODE_PROVIDED_ON_REDEEM", } RedemptionType_value = map[string]int32{ "REDEMPTION_TYPE_DO_NOT_USE": 0, "REDEMPTION_TYPE_API": 1, "REDEMPTION_TYPE_CUSTOMER_INITIATED": 2, "REDEMPTION_TYPE_CUSTOMER_INITIATED_CODE_FIXED": 3, "REDEMPTION_TYPE_CUSTOMER_INITIATED_CODE_PROVIDED_ON_REDEEM": 4, } )
Enum value maps for RedemptionType.
var File_io_single_use_coupons_a_rpc_proto protoreflect.FileDescriptor
var File_io_single_use_coupons_campaign_proto protoreflect.FileDescriptor
var File_io_single_use_coupons_coupon_proto protoreflect.FileDescriptor
var File_io_single_use_coupons_offer_proto protoreflect.FileDescriptor
var SingleUseCoupons_ServiceDesc = grpc.ServiceDesc{ ServiceName: "single_use_coupons.SingleUseCoupons", HandlerType: (*SingleUseCouponsServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "createCouponCampaign", Handler: _SingleUseCoupons_CreateCouponCampaign_Handler, }, { MethodName: "updateCouponCampaign", Handler: _SingleUseCoupons_UpdateCouponCampaign_Handler, }, { MethodName: "getCouponCampaign", Handler: _SingleUseCoupons_GetCouponCampaign_Handler, }, { MethodName: "deleteCouponCampaign", Handler: _SingleUseCoupons_DeleteCouponCampaign_Handler, }, { MethodName: "getAnalytics", Handler: _SingleUseCoupons_GetAnalytics_Handler, }, { MethodName: "createCouponOffer", Handler: _SingleUseCoupons_CreateCouponOffer_Handler, }, { MethodName: "updateCouponOffer", Handler: _SingleUseCoupons_UpdateCouponOffer_Handler, }, { MethodName: "getCouponOffer", Handler: _SingleUseCoupons_GetCouponOffer_Handler, }, { MethodName: "deleteCouponOffer", Handler: _SingleUseCoupons_DeleteCouponOffer_Handler, }, { MethodName: "createCoupon", Handler: _SingleUseCoupons_CreateCoupon_Handler, }, { MethodName: "updateCoupon", Handler: _SingleUseCoupons_UpdateCoupon_Handler, }, { MethodName: "redeemCoupon", Handler: _SingleUseCoupons_RedeemCoupon_Handler, }, { MethodName: "updateCouponExternalId", Handler: _SingleUseCoupons_UpdateCouponExternalId_Handler, }, { MethodName: "getCouponById", Handler: _SingleUseCoupons_GetCouponById_Handler, }, { MethodName: "getCouponByExternalId", Handler: _SingleUseCoupons_GetCouponByExternalId_Handler, }, { MethodName: "voidCoupon", Handler: _SingleUseCoupons_VoidCoupon_Handler, }, { MethodName: "countCouponsByCouponCampaignDeprecated", Handler: _SingleUseCoupons_CountCouponsByCouponCampaignDeprecated_Handler, }, { MethodName: "countCouponsByCouponCampaign", Handler: _SingleUseCoupons_CountCouponsByCouponCampaign_Handler, }, { MethodName: "patchPerson", Handler: _SingleUseCoupons_PatchPerson_Handler, }, { MethodName: "copyCouponCampaign", Handler: _SingleUseCoupons_CopyCouponCampaign_Handler, }, { MethodName: "getMetaKeysForCampaign", Handler: _SingleUseCoupons_GetMetaKeysForCampaign_Handler, }, }, Streams: []grpc.StreamDesc{ { StreamName: "listCouponCampaignsDeprecated", Handler: _SingleUseCoupons_ListCouponCampaignsDeprecated_Handler, ServerStreams: true, }, { StreamName: "listCouponCampaigns", Handler: _SingleUseCoupons_ListCouponCampaigns_Handler, ServerStreams: true, }, { StreamName: "listCouponOffersDeprecated", Handler: _SingleUseCoupons_ListCouponOffersDeprecated_Handler, ServerStreams: true, }, { StreamName: "listCouponOffers", Handler: _SingleUseCoupons_ListCouponOffers_Handler, ServerStreams: true, }, { StreamName: "streamCouponUpdates", Handler: _SingleUseCoupons_StreamCouponUpdates_Handler, ServerStreams: true, ClientStreams: true, }, { StreamName: "streamCouponRedemptions", Handler: _SingleUseCoupons_StreamCouponRedemptions_Handler, ServerStreams: true, ClientStreams: true, }, { StreamName: "listCouponsByCouponCampaignDeprecated", Handler: _SingleUseCoupons_ListCouponsByCouponCampaignDeprecated_Handler, ServerStreams: true, }, { StreamName: "listCouponsByCouponCampaign", Handler: _SingleUseCoupons_ListCouponsByCouponCampaign_Handler, ServerStreams: true, }, }, Metadata: "io/single_use_coupons/a_rpc.proto", }
SingleUseCoupons_ServiceDesc is the grpc.ServiceDesc for SingleUseCoupons service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterSingleUseCouponsHandler ¶
func RegisterSingleUseCouponsHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterSingleUseCouponsHandler registers the http handlers for service SingleUseCoupons to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterSingleUseCouponsHandlerClient ¶
func RegisterSingleUseCouponsHandlerClient(ctx context.Context, mux *runtime.ServeMux, client SingleUseCouponsClient) error
RegisterSingleUseCouponsHandlerClient registers the http handlers for service SingleUseCoupons to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "SingleUseCouponsClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "SingleUseCouponsClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "SingleUseCouponsClient" to call the correct interceptors.
func RegisterSingleUseCouponsHandlerFromEndpoint ¶
func RegisterSingleUseCouponsHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterSingleUseCouponsHandlerFromEndpoint is same as RegisterSingleUseCouponsHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterSingleUseCouponsHandlerServer ¶
func RegisterSingleUseCouponsHandlerServer(ctx context.Context, mux *runtime.ServeMux, server SingleUseCouponsServer) error
RegisterSingleUseCouponsHandlerServer registers the http handlers for service SingleUseCoupons to "mux". UnaryRPC :call SingleUseCouponsServer 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 RegisterSingleUseCouponsHandlerFromEndpoint instead.
func RegisterSingleUseCouponsServer ¶
func RegisterSingleUseCouponsServer(s grpc.ServiceRegistrar, srv SingleUseCouponsServer)
Types ¶
type CallToActionButton ¶
type CallToActionButton struct { // Set true to hide button. HideCallToActionButton bool `protobuf:"varint,1,opt,name=hideCallToActionButton,proto3" json:"hideCallToActionButton,omitempty"` // Call-to-action text shown on the button. ButtonText string `protobuf:"bytes,2,opt,name=buttonText,proto3" json:"buttonText,omitempty"` // Localized button text. LocalizedButtonText *io.LocalizedString `protobuf:"bytes,3,opt,name=localizedButtonText,proto3" json:"localizedButtonText,omitempty"` // Link that the button will open. Link string `protobuf:"bytes,4,opt,name=link,proto3" json:"link,omitempty"` // Localized link that the button will open. LocalizedLink *io.LocalizedString `protobuf:"bytes,5,opt,name=localizedLink,proto3" json:"localizedLink,omitempty"` // contains filtered or unexported fields }
func (*CallToActionButton) Descriptor
deprecated
func (*CallToActionButton) Descriptor() ([]byte, []int)
Deprecated: Use CallToActionButton.ProtoReflect.Descriptor instead.
func (*CallToActionButton) GetButtonText ¶
func (x *CallToActionButton) GetButtonText() string
func (*CallToActionButton) GetHideCallToActionButton ¶
func (x *CallToActionButton) GetHideCallToActionButton() bool
func (*CallToActionButton) GetLink ¶
func (x *CallToActionButton) GetLink() string
func (*CallToActionButton) GetLocalizedButtonText ¶
func (x *CallToActionButton) GetLocalizedButtonText() *io.LocalizedString
func (*CallToActionButton) GetLocalizedLink ¶
func (x *CallToActionButton) GetLocalizedLink() *io.LocalizedString
func (*CallToActionButton) ProtoMessage ¶
func (*CallToActionButton) ProtoMessage()
func (*CallToActionButton) ProtoReflect ¶
func (x *CallToActionButton) ProtoReflect() protoreflect.Message
func (*CallToActionButton) Reset ¶
func (x *CallToActionButton) Reset()
func (*CallToActionButton) String ¶
func (x *CallToActionButton) String() string
type CampaignCopyRequest ¶
type CampaignCopyRequest struct { // uuid of the campaign to copy. // @tag: validateCreate:"required" Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty" validateCreate:"required"` // Optional name for the new campaign. // @tag: validateCreate:"omitempty" Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty" validateCreate:"omitempty"` // Status to set the copied campaign to. // @tag: validateCreate:"omitempty" Status []io.ProjectStatus `protobuf:"varint,3,rep,packed,name=status,proto3,enum=io.ProjectStatus" json:"status,omitempty" validateCreate:"omitempty"` // Can optionally be provided if setting status to published (requires a prod cert). // @tag: validateCreate:"omitempty" PassTypeIdentifier string `protobuf:"bytes,4,opt,name=passTypeIdentifier,proto3" json:"passTypeIdentifier,omitempty" validateCreate:"omitempty"` // contains filtered or unexported fields }
Contains payload for copying a campaign.
func (*CampaignCopyRequest) Descriptor
deprecated
func (*CampaignCopyRequest) Descriptor() ([]byte, []int)
Deprecated: Use CampaignCopyRequest.ProtoReflect.Descriptor instead.
func (*CampaignCopyRequest) GetId ¶
func (x *CampaignCopyRequest) GetId() string
func (*CampaignCopyRequest) GetName ¶
func (x *CampaignCopyRequest) GetName() string
func (*CampaignCopyRequest) GetPassTypeIdentifier ¶
func (x *CampaignCopyRequest) GetPassTypeIdentifier() string
func (*CampaignCopyRequest) GetStatus ¶
func (x *CampaignCopyRequest) GetStatus() []io.ProjectStatus
func (*CampaignCopyRequest) ProtoMessage ¶
func (*CampaignCopyRequest) ProtoMessage()
func (*CampaignCopyRequest) ProtoReflect ¶
func (x *CampaignCopyRequest) ProtoReflect() protoreflect.Message
func (*CampaignCopyRequest) Reset ¶
func (x *CampaignCopyRequest) Reset()
func (*CampaignCopyRequest) String ¶
func (x *CampaignCopyRequest) String() string
type Coupon ¶
type Coupon struct { // PassKit generated coupon id (22 characters). // @tag: validateGeneric:"required" validateCreate:"-" validateUpdate:"required_without=ExternalId" Id string `` /* 148-byte string literal not displayed */ // This can be used to set the 'external' ID of the coupon (i.e. the unique coupon code as it's being used in your system). If provided then this can be used to query & update coupon. This field will be treated as unique within the campaign, and cannot be updated at a later stage. // @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"required_without=Id" ExternalId string `` /* 165-byte string literal not displayed */ // The coupon offer id that the coupon belongs to. // @tag: validateGeneric:"omitempty" validateCreate:"required" validateUpdate:"omitempty" OfferId string `` /* 148-byte string literal not displayed */ // The coupon campaign id the the coupon belongs to. // @tag: validateGeneric:"omitempty" validateCreate:"required" validateUpdate:"required_without=Id" CampaignId string `` /* 164-byte string literal not displayed */ // Optional field if you would like to add PII to the individual coupon. Person is stored encrypted. // @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty" Person *io.Person `` /* 147-byte string literal not displayed */ // Any other meta fields for the coupon that are not covered in the protocol (i.e. you might want to captures sign-up location, or favourite perfume, for segmenting later on). // @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty" MetaData map[string]string `` /* 239-byte string literal not displayed */ // Optional SKU. Can be used in the barcode by setting ${coupon.sku} in the template barcode settings. Sku string `protobuf:"bytes,7,opt,name=sku,proto3" json:"sku,omitempty"` // Indicates if the user of the coupon opted out to receive marketing promotions (defaults to false). // @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty" OptOut bool `` /* 148-byte string literal not displayed */ // Holds the coupon status. Status CouponStatus `protobuf:"varint,10,opt,name=status,proto3,enum=single_use_coupons.CouponStatus" json:"status,omitempty"` // Optional field to set when the coupon expires. When the expiry date hits, it will automatically gray out the barcode. Only applicable if the template for the offer is set to EXPIRE_ON_VARIABLE_DATE_TIME. // @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty" ExpiryDate *timestamppb.Timestamp `` /* 156-byte string literal not displayed */ // Contains details about the redemption (if the coupon is in a redeemed state). RedemptionDetails *RedemptionDetails `protobuf:"bytes,12,opt,name=redemptionDetails,proto3" json:"redemptionDetails,omitempty"` // Optional Pass level overrides for proximity & images. PassOverrides *io.PassOverrides `protobuf:"bytes,13,opt,name=passOverrides,proto3" json:"passOverrides,omitempty"` // Pass Metadata hold meta data about the pass like status, lifecycle, utm details and installation data. PassMetaData *io.Metadata `protobuf:"bytes,14,opt,name=passMetaData,proto3" json:"passMetaData,omitempty"` // The date the coupon was created. // @tag: validateGeneric:"-" validateCreate:"-" validateUpdate:"-" Created *timestamppb.Timestamp `` /* 126-byte string literal not displayed */ // The date the coupon was last updated. // @tag: validateGeneric:"-" validateCreate:"-" validateUpdate:"-" Updated *timestamppb.Timestamp `` /* 126-byte string literal not displayed */ // contains filtered or unexported fields }
The Coupon Details
func (*Coupon) Descriptor
deprecated
func (*Coupon) GetCampaignId ¶
func (*Coupon) GetCreated ¶
func (x *Coupon) GetCreated() *timestamppb.Timestamp
func (*Coupon) GetExpiryDate ¶
func (x *Coupon) GetExpiryDate() *timestamppb.Timestamp
func (*Coupon) GetExternalId ¶
func (*Coupon) GetMetaData ¶
func (*Coupon) GetOfferId ¶
func (*Coupon) GetPassMetaData ¶
func (*Coupon) GetPassOverrides ¶
func (x *Coupon) GetPassOverrides() *io.PassOverrides
func (*Coupon) GetRedemptionDetails ¶
func (x *Coupon) GetRedemptionDetails() *RedemptionDetails
func (*Coupon) GetStatus ¶
func (x *Coupon) GetStatus() CouponStatus
func (*Coupon) GetUpdated ¶
func (x *Coupon) GetUpdated() *timestamppb.Timestamp
func (*Coupon) ProtoMessage ¶
func (*Coupon) ProtoMessage()
func (*Coupon) ProtoReflect ¶
func (x *Coupon) ProtoReflect() protoreflect.Message
type CouponCampaign ¶
type CouponCampaign struct { // PassKit generated program id (22 characters). // @tag: validateGeneric:"required" validateCreate:"-" validateUpdate:"required" Id string `` /* 129-byte string literal not displayed */ // Name of the coupon campaign; used in the portal / API. Not shown to the end-customer. // @tag: validateGeneric:"omitempty" validateCreate:"required" validateUpdate:"required" Name string `` /* 141-byte string literal not displayed */ // Localized name of the coupon campaign. // @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:"required" validateUpdate:"-" Status []io.ProjectStatus `` /* 160-byte string literal not displayed */ // Leave empty for draft campaigns. Needs to be set for campaigns where status contains PROJECT_PUBLISHED. // @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"-" PassTypeIdentifier string `` /* 163-byte string literal not displayed */ // The campaign timezone. IanaTimezone string `protobuf:"bytes,7,opt,name=ianaTimezone,proto3" json:"ianaTimezone,omitempty"` // The date the campaign was created. // @tag: validateGeneric:"-" validateCreate:"-" validateUpdate:"-" Created *timestamppb.Timestamp `` /* 126-byte string literal not displayed */ // The date the campaign updated. // @tag: validateGeneric:"-" validateCreate:"-" validateUpdate:"-" Updated *timestamppb.Timestamp `` /* 126-byte string literal not displayed */ // contains filtered or unexported fields }
The Coupon Campaign Details.
func (*CouponCampaign) Descriptor
deprecated
func (*CouponCampaign) Descriptor() ([]byte, []int)
Deprecated: Use CouponCampaign.ProtoReflect.Descriptor instead.
func (*CouponCampaign) GetCreated ¶
func (x *CouponCampaign) GetCreated() *timestamppb.Timestamp
func (*CouponCampaign) GetIanaTimezone ¶
func (x *CouponCampaign) GetIanaTimezone() string
func (*CouponCampaign) GetId ¶
func (x *CouponCampaign) GetId() string
func (*CouponCampaign) GetLocalizedName ¶
func (x *CouponCampaign) GetLocalizedName() *io.LocalizedString
func (*CouponCampaign) GetName ¶
func (x *CouponCampaign) GetName() string
func (*CouponCampaign) GetPassTypeIdentifier ¶
func (x *CouponCampaign) GetPassTypeIdentifier() string
func (*CouponCampaign) GetStatus ¶
func (x *CouponCampaign) GetStatus() []io.ProjectStatus
func (*CouponCampaign) GetUpdated ¶
func (x *CouponCampaign) GetUpdated() *timestamppb.Timestamp
func (*CouponCampaign) ProtoMessage ¶
func (*CouponCampaign) ProtoMessage()
func (*CouponCampaign) ProtoReflect ¶
func (x *CouponCampaign) ProtoReflect() protoreflect.Message
func (*CouponCampaign) Reset ¶
func (x *CouponCampaign) Reset()
func (*CouponCampaign) String ¶
func (x *CouponCampaign) String() string
type CouponCampaignAnalyticsResponse ¶
type CouponCampaignAnalyticsResponse struct { // Period unit of data returned (day, month or year). Period io.Period `protobuf:"varint,1,opt,name=period,proto3,enum=io.Period" json:"period,omitempty"` // Passes redeemed in this period. Redeemed uint32 `protobuf:"varint,2,opt,name=redeemed,proto3" json:"redeemed,omitempty"` // Total number of pass redeemed for each device type. Devices *io.DeviceBreakdown `protobuf:"bytes,3,opt,name=devices,proto3" json:"devices,omitempty"` // Total number of pass redeemed for each distribution source. Sources map[string]uint32 `` /* 156-byte string literal not displayed */ // Breakdown of data by day, month or year. Data []*io.ChartDataPoints `protobuf:"bytes,5,rep,name=data,proto3" json:"data,omitempty"` // contains filtered or unexported fields }
CouponCampaignAnalyticsResponse contains redemption stats for the campaign. Other campaign analytics can be taken from the generic analytics endpoint.
func (*CouponCampaignAnalyticsResponse) Descriptor
deprecated
func (*CouponCampaignAnalyticsResponse) Descriptor() ([]byte, []int)
Deprecated: Use CouponCampaignAnalyticsResponse.ProtoReflect.Descriptor instead.
func (*CouponCampaignAnalyticsResponse) GetData ¶
func (x *CouponCampaignAnalyticsResponse) GetData() []*io.ChartDataPoints
func (*CouponCampaignAnalyticsResponse) GetDevices ¶
func (x *CouponCampaignAnalyticsResponse) GetDevices() *io.DeviceBreakdown
func (*CouponCampaignAnalyticsResponse) GetPeriod ¶
func (x *CouponCampaignAnalyticsResponse) GetPeriod() io.Period
func (*CouponCampaignAnalyticsResponse) GetRedeemed ¶
func (x *CouponCampaignAnalyticsResponse) GetRedeemed() uint32
func (*CouponCampaignAnalyticsResponse) GetSources ¶
func (x *CouponCampaignAnalyticsResponse) GetSources() map[string]uint32
func (*CouponCampaignAnalyticsResponse) ProtoMessage ¶
func (*CouponCampaignAnalyticsResponse) ProtoMessage()
func (*CouponCampaignAnalyticsResponse) ProtoReflect ¶
func (x *CouponCampaignAnalyticsResponse) ProtoReflect() protoreflect.Message
func (*CouponCampaignAnalyticsResponse) Reset ¶
func (x *CouponCampaignAnalyticsResponse) Reset()
func (*CouponCampaignAnalyticsResponse) String ¶
func (x *CouponCampaignAnalyticsResponse) String() string
type CouponExpirySettings ¶
type CouponExpirySettings struct { // @tag: validateGeneric:"omitempty,min=1" validateCreate:"required,min=1" validateUpdate:"omitempty,min=1" CouponExpiryType CouponExpiryType `` /* 226-byte string literal not displayed */ // Number of days the coupon card is expired after the issue date. // The expiry time is 23:59:59 of expiry day. Please set couponExpiryType as EXPIRE_AFTER_X_DAYS. // Field can be omitted if using any of the other coupon expiry types. // @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty" ExpireAfterXDays uint32 `` /* 168-byte string literal not displayed */ // contains filtered or unexported fields }
func (*CouponExpirySettings) Descriptor
deprecated
func (*CouponExpirySettings) Descriptor() ([]byte, []int)
Deprecated: Use CouponExpirySettings.ProtoReflect.Descriptor instead.
func (*CouponExpirySettings) GetCouponExpiryType ¶
func (x *CouponExpirySettings) GetCouponExpiryType() CouponExpiryType
func (*CouponExpirySettings) GetExpireAfterXDays ¶
func (x *CouponExpirySettings) GetExpireAfterXDays() uint32
func (*CouponExpirySettings) ProtoMessage ¶
func (*CouponExpirySettings) ProtoMessage()
func (*CouponExpirySettings) ProtoReflect ¶
func (x *CouponExpirySettings) ProtoReflect() protoreflect.Message
func (*CouponExpirySettings) Reset ¶
func (x *CouponExpirySettings) Reset()
func (*CouponExpirySettings) String ¶
func (x *CouponExpirySettings) String() string
type CouponExpiryType ¶
type CouponExpiryType int32
const ( CouponExpiryType_EXPIRY_DO_NOT_USE CouponExpiryType = 0 // The system will set the coupon expiry based to the campaign end date (default). CouponExpiryType_AUTO_EXPIRE_OFFER_END_DATE CouponExpiryType = 1 // The system will set the coupon expiry based to the redemption end date. CouponExpiryType_AUTO_EXPIRE_REDEMPTION_END_DATE CouponExpiryType = 2 // The system will calculate the expiry date based the number of days after the digital coupon is issued. // The calculated date needs to be within range of the campaign date rules. For example, if issue date + EXPIRE_AFTER_X_DAYS is greater than the campaign end date, it will default to the campaign end date. // The expiry date will be based on your timezone. The digital card will expire at 23:59:59 of set date in fixed timezone. CouponExpiryType_EXPIRE_AFTER_X_DAYS CouponExpiryType = 3 // If you want to set the expiry date for each individual coupon when the coupon is issued, you can use this expiry type. // You can set expiry date and time in fixed timezone on the coupon record. // The date needs to be within range of the campaign date rules, otherwise the system will return an error. CouponExpiryType_EXPIRE_ON_VARIABLE_DATE_TIME CouponExpiryType = 4 )
func (CouponExpiryType) Descriptor ¶
func (CouponExpiryType) Descriptor() protoreflect.EnumDescriptor
func (CouponExpiryType) Enum ¶
func (x CouponExpiryType) Enum() *CouponExpiryType
func (CouponExpiryType) EnumDescriptor
deprecated
func (CouponExpiryType) EnumDescriptor() ([]byte, []int)
Deprecated: Use CouponExpiryType.Descriptor instead.
func (CouponExpiryType) Number ¶
func (x CouponExpiryType) Number() protoreflect.EnumNumber
func (CouponExpiryType) String ¶
func (x CouponExpiryType) String() string
func (CouponExpiryType) Type ¶
func (CouponExpiryType) Type() protoreflect.EnumType
type CouponNewExternalIdRequest ¶
type CouponNewExternalIdRequest struct { // PassKit generated coupon ID (22 characters). Required if couponCampaignId and externalId are not provided. // @tag: validateGeneric:"required_without=ExternalId" Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty" validateGeneric:"required_without=ExternalId"` // Coupon Campaign ID. Required if external id is used. // @tag: validateGeneric:"required_with=ExternalId" CouponCampaignId string `` /* 128-byte string literal not displayed */ // Current external ID. Required if coupon id is not provided. // @tag: validateGeneric:"omitempty" ExternalId string `protobuf:"bytes,3,opt,name=externalId,proto3" json:"externalId,omitempty" validateGeneric:"omitempty"` // New external ID. // @tag: validateGeneric:"required" NewExternalId string `protobuf:"bytes,4,opt,name=newExternalId,proto3" json:"newExternalId,omitempty" validateGeneric:"required"` // contains filtered or unexported fields }
func (*CouponNewExternalIdRequest) Descriptor
deprecated
func (*CouponNewExternalIdRequest) Descriptor() ([]byte, []int)
Deprecated: Use CouponNewExternalIdRequest.ProtoReflect.Descriptor instead.
func (*CouponNewExternalIdRequest) GetCouponCampaignId ¶
func (x *CouponNewExternalIdRequest) GetCouponCampaignId() string
func (*CouponNewExternalIdRequest) GetExternalId ¶
func (x *CouponNewExternalIdRequest) GetExternalId() string
func (*CouponNewExternalIdRequest) GetId ¶
func (x *CouponNewExternalIdRequest) GetId() string
func (*CouponNewExternalIdRequest) GetNewExternalId ¶
func (x *CouponNewExternalIdRequest) GetNewExternalId() string
func (*CouponNewExternalIdRequest) ProtoMessage ¶
func (*CouponNewExternalIdRequest) ProtoMessage()
func (*CouponNewExternalIdRequest) ProtoReflect ¶
func (x *CouponNewExternalIdRequest) ProtoReflect() protoreflect.Message
func (*CouponNewExternalIdRequest) Reset ¶
func (x *CouponNewExternalIdRequest) Reset()
func (*CouponNewExternalIdRequest) String ¶
func (x *CouponNewExternalIdRequest) String() string
type CouponOffer ¶
type CouponOffer struct { // PassKit generated offer id (22 characters). // @tag: validateGeneric:"required" validateCreate:"-" validateUpdate:"required" Id string `` /* 129-byte string literal not displayed */ // The offer title; will be shown on the enrolment page. // @tag: validateGeneric:"omitempty,max=60" validateCreate:"required,max=60" validateUpdate:"required,max=60" OfferTitle string `` /* 174-byte string literal not displayed */ // Localized offer title. // @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty" LocalizedOfferTitle *io.LocalizedString `` /* 173-byte string literal not displayed */ // The offer short title. // @tag: validateGeneric:"omitempty,max=20" validateCreate:"required,max=20" validateUpdate:"required,max=20" OfferShortTitle string `` /* 184-byte string literal not displayed */ // Localized offer short title. // @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty" LocalizedOfferShortTitle *io.LocalizedString `` /* 183-byte string literal not displayed */ // The offer details; will be shown on the enrolment page. // @tag: validateGeneric:"omitempty" validateCreate:"required" validateUpdate:"required" OfferDetails string `` /* 157-byte string literal not displayed */ // Localized offer details. // @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty" LocalizedOfferDetails *io.LocalizedString `` /* 177-byte string literal not displayed */ // The offer fine print. // @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty" OfferFinePrint string `` /* 163-byte string literal not displayed */ // Localized offer fine print. // @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty" LocalizedOfferFinePrint *io.LocalizedString `` /* 181-byte string literal not displayed */ // The pass template ID that coupons will use when in unredeemed state. All coupons for the offer are issued in unredeemed state. // @tag: validateGeneric:"omitempty" validateCreate:"required" validateUpdate:"omitempty" BeforeRedeemPassTemplateId string `` /* 187-byte string literal not displayed */ // Optional pass template ID that coupons will use when switched to redeemed state. // @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty" AfterRedeemPassTemplateId string `` /* 186-byte string literal not displayed */ // The quota for the campaign. If set to 0, then it is unlimited. If the quota is reached no new coupons can be issued. // @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty" Quota *io.Quota `` /* 146-byte string literal not displayed */ // Coupon expiry settings // @tag: validateGeneric:"omitempty" validateCreate:"-" validateUpdate:"required" CouponExpirySettings *CouponExpirySettings `` /* 167-byte string literal not displayed */ // Optional redemption settings to give more control over redemption. // @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty" RedemptionSettings *RedemptionSettings `` /* 172-byte string literal not displayed */ // Optional date when coupons can start to be issued. Defaults to the campaign start date. Needs to be greater than / equal to the campaign start date. Needs to be less than / equal to the campaign end date. // @tag: validateGeneric:"omitempty" validateCreate:"required" validateUpdate:"required" IssueStartDate *timestamppb.Timestamp `` /* 162-byte string literal not displayed */ // Optional date when coupons can no longer be issued. Defaults to the campaign end date. Needs to be less than / equal to the campaign end date. // @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty" IssueEndDate *timestamppb.Timestamp `` /* 160-byte string literal not displayed */ // The date when the offer was created. // @tag: validateGeneric:"-" validateCreate:"-" validateUpdate:"-" Created *timestamppb.Timestamp `` /* 126-byte string literal not displayed */ // The date the offer was last updated. // @tag: validateGeneric:"-" validateCreate:"-" validateUpdate:"-" Updated *timestamppb.Timestamp `` /* 126-byte string literal not displayed */ // The campaign id that the offer belongs to (1 campaign can have multiple offers). This field cannot be changed once an offer is linked to a campaign. // @tag: validateGeneric:"omitempty" validateCreate:"required" validateUpdate:"required" CampaignId string `` /* 154-byte string literal not displayed */ // Contains the email & sms distribution settings for the offer. // @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty" DistributionSettings *io.DistributionSettings `` /* 176-byte string literal not displayed */ // The offer shortcode generated by the system. If the campaign is public, then this shortcode can be used to generate the coupon-create URL. // @tag: validateGeneric:"-" validateCreate:"-" validateUpdate:"-" ShortCode string `` /* 130-byte string literal not displayed */ // The offer timezone. // @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty" IanaTimezone string `` /* 160-byte string literal not displayed */ // Can be used to temporarily disable the coupon (i.e. if you ran out of your promotion item, you can temporarily disable all live coupons, and activate them again later on when your item is in stock again). // @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty" Disabled bool `` /* 153-byte string literal not displayed */ // Optional field to provide the operation that you want to perform when sending an offer in an update request. PUT will replace all values provided in the CouponOffer, 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 Coupon Offer Details.
func (*CouponOffer) Descriptor
deprecated
func (*CouponOffer) Descriptor() ([]byte, []int)
Deprecated: Use CouponOffer.ProtoReflect.Descriptor instead.
func (*CouponOffer) GetAfterRedeemPassTemplateId ¶
func (x *CouponOffer) GetAfterRedeemPassTemplateId() string
func (*CouponOffer) GetBeforeRedeemPassTemplateId ¶
func (x *CouponOffer) GetBeforeRedeemPassTemplateId() string
func (*CouponOffer) GetCampaignId ¶
func (x *CouponOffer) GetCampaignId() string
func (*CouponOffer) GetCouponExpirySettings ¶
func (x *CouponOffer) GetCouponExpirySettings() *CouponExpirySettings
func (*CouponOffer) GetCreated ¶
func (x *CouponOffer) GetCreated() *timestamppb.Timestamp
func (*CouponOffer) GetDisabled ¶
func (x *CouponOffer) GetDisabled() bool
func (*CouponOffer) GetDistributionSettings ¶
func (x *CouponOffer) GetDistributionSettings() *io.DistributionSettings
func (*CouponOffer) GetIanaTimezone ¶
func (x *CouponOffer) GetIanaTimezone() string
func (*CouponOffer) GetId ¶
func (x *CouponOffer) GetId() string
func (*CouponOffer) GetIssueEndDate ¶
func (x *CouponOffer) GetIssueEndDate() *timestamppb.Timestamp
func (*CouponOffer) GetIssueStartDate ¶
func (x *CouponOffer) GetIssueStartDate() *timestamppb.Timestamp
func (*CouponOffer) GetLocalizedOfferDetails ¶
func (x *CouponOffer) GetLocalizedOfferDetails() *io.LocalizedString
func (*CouponOffer) GetLocalizedOfferFinePrint ¶
func (x *CouponOffer) GetLocalizedOfferFinePrint() *io.LocalizedString
func (*CouponOffer) GetLocalizedOfferShortTitle ¶
func (x *CouponOffer) GetLocalizedOfferShortTitle() *io.LocalizedString
func (*CouponOffer) GetLocalizedOfferTitle ¶
func (x *CouponOffer) GetLocalizedOfferTitle() *io.LocalizedString
func (*CouponOffer) GetOfferDetails ¶
func (x *CouponOffer) GetOfferDetails() string
func (*CouponOffer) GetOfferFinePrint ¶
func (x *CouponOffer) GetOfferFinePrint() string
func (*CouponOffer) GetOfferShortTitle ¶
func (x *CouponOffer) GetOfferShortTitle() string
func (*CouponOffer) GetOfferTitle ¶
func (x *CouponOffer) GetOfferTitle() string
func (*CouponOffer) GetOperation ¶ added in v1.1.97
func (x *CouponOffer) GetOperation() io.Operation
func (*CouponOffer) GetQuota ¶
func (x *CouponOffer) GetQuota() *io.Quota
func (*CouponOffer) GetRedemptionSettings ¶
func (x *CouponOffer) GetRedemptionSettings() *RedemptionSettings
func (*CouponOffer) GetShortCode ¶
func (x *CouponOffer) GetShortCode() string
func (*CouponOffer) GetUpdated ¶
func (x *CouponOffer) GetUpdated() *timestamppb.Timestamp
func (*CouponOffer) ProtoMessage ¶
func (*CouponOffer) ProtoMessage()
func (*CouponOffer) ProtoReflect ¶
func (x *CouponOffer) ProtoReflect() protoreflect.Message
func (*CouponOffer) Reset ¶
func (x *CouponOffer) Reset()
func (*CouponOffer) String ¶
func (x *CouponOffer) String() string
type CouponOffersListRequest ¶
type CouponOffersListRequest struct { // @tag: validateGeneric:"required" validateCreate:"required" validateUpdate:"required" CampaignId string `` /* 152-byte string literal not displayed */ // @tag: validateGeneric:"omitempty" validateCreate:"omitempty" validateUpdate:"omitempty" Filters *io.Filters `` /* 149-byte string literal not displayed */ // contains filtered or unexported fields }
func (*CouponOffersListRequest) Descriptor
deprecated
func (*CouponOffersListRequest) Descriptor() ([]byte, []int)
Deprecated: Use CouponOffersListRequest.ProtoReflect.Descriptor instead.
func (*CouponOffersListRequest) GetCampaignId ¶
func (x *CouponOffersListRequest) GetCampaignId() string
func (*CouponOffersListRequest) GetFilters ¶
func (x *CouponOffersListRequest) GetFilters() *io.Filters
func (*CouponOffersListRequest) ProtoMessage ¶
func (*CouponOffersListRequest) ProtoMessage()
func (*CouponOffersListRequest) ProtoReflect ¶
func (x *CouponOffersListRequest) ProtoReflect() protoreflect.Message
func (*CouponOffersListRequest) Reset ¶
func (x *CouponOffersListRequest) Reset()
func (*CouponOffersListRequest) String ¶
func (x *CouponOffersListRequest) String() string
type CouponOffersListRequestDeprecated ¶
type CouponOffersListRequestDeprecated struct { // @tag: validateGeneric:"required" validateCreate:"required" validateUpdate:"required" CampaignId string `` /* 152-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 }
[DEPRECATED: OR operator not supported] Filter and list records.
func (*CouponOffersListRequestDeprecated) Descriptor
deprecated
func (*CouponOffersListRequestDeprecated) Descriptor() ([]byte, []int)
Deprecated: Use CouponOffersListRequestDeprecated.ProtoReflect.Descriptor instead.
func (*CouponOffersListRequestDeprecated) GetCampaignId ¶
func (x *CouponOffersListRequestDeprecated) GetCampaignId() string
func (*CouponOffersListRequestDeprecated) GetPagination ¶
func (x *CouponOffersListRequestDeprecated) GetPagination() *io.Pagination
func (*CouponOffersListRequestDeprecated) ProtoMessage ¶
func (*CouponOffersListRequestDeprecated) ProtoMessage()
func (*CouponOffersListRequestDeprecated) ProtoReflect ¶
func (x *CouponOffersListRequestDeprecated) ProtoReflect() protoreflect.Message
func (*CouponOffersListRequestDeprecated) Reset ¶
func (x *CouponOffersListRequestDeprecated) Reset()
func (*CouponOffersListRequestDeprecated) String ¶
func (x *CouponOffersListRequestDeprecated) String() string
type CouponStatus ¶
type CouponStatus int32
const ( // Default status when a coupon is issued. CouponStatus_UNREDEEMED CouponStatus = 0 // Set after a coupon is redeemed (the redeem endpoint is called). CouponStatus_REDEEMED CouponStatus = 1 )
func (CouponStatus) Descriptor ¶
func (CouponStatus) Descriptor() protoreflect.EnumDescriptor
func (CouponStatus) Enum ¶
func (x CouponStatus) Enum() *CouponStatus
func (CouponStatus) EnumDescriptor
deprecated
func (CouponStatus) EnumDescriptor() ([]byte, []int)
Deprecated: Use CouponStatus.Descriptor instead.
func (CouponStatus) Number ¶
func (x CouponStatus) Number() protoreflect.EnumNumber
func (CouponStatus) String ¶
func (x CouponStatus) String() string
func (CouponStatus) Type ¶
func (CouponStatus) Type() protoreflect.EnumType
type CustomerInitiatedCodeProvideOnRedeemSettings ¶
type CustomerInitiatedCodeProvideOnRedeemSettings struct { // Optional array of valid codes that can be input on redemption. ValidCodes []string `protobuf:"bytes,1,rep,name=validCodes,proto3" json:"validCodes,omitempty"` // Input field box for entering the redemption code. RedemptionCodeInput *InputField `protobuf:"bytes,2,opt,name=redemptionCodeInput,proto3" json:"redemptionCodeInput,omitempty"` // Submit button to confirm the validation code. SubmitButtonText string `protobuf:"bytes,3,opt,name=submitButtonText,proto3" json:"submitButtonText,omitempty"` // Localized submit button text. LocalizedSubmitButtonText *io.LocalizedString `protobuf:"bytes,4,opt,name=localizedSubmitButtonText,proto3" json:"localizedSubmitButtonText,omitempty"` // contains filtered or unexported fields }
func (*CustomerInitiatedCodeProvideOnRedeemSettings) Descriptor
deprecated
func (*CustomerInitiatedCodeProvideOnRedeemSettings) Descriptor() ([]byte, []int)
Deprecated: Use CustomerInitiatedCodeProvideOnRedeemSettings.ProtoReflect.Descriptor instead.
func (*CustomerInitiatedCodeProvideOnRedeemSettings) GetLocalizedSubmitButtonText ¶
func (x *CustomerInitiatedCodeProvideOnRedeemSettings) GetLocalizedSubmitButtonText() *io.LocalizedString
func (*CustomerInitiatedCodeProvideOnRedeemSettings) GetRedemptionCodeInput ¶
func (x *CustomerInitiatedCodeProvideOnRedeemSettings) GetRedemptionCodeInput() *InputField
func (*CustomerInitiatedCodeProvideOnRedeemSettings) GetSubmitButtonText ¶
func (x *CustomerInitiatedCodeProvideOnRedeemSettings) GetSubmitButtonText() string
func (*CustomerInitiatedCodeProvideOnRedeemSettings) GetValidCodes ¶
func (x *CustomerInitiatedCodeProvideOnRedeemSettings) GetValidCodes() []string
func (*CustomerInitiatedCodeProvideOnRedeemSettings) ProtoMessage ¶
func (*CustomerInitiatedCodeProvideOnRedeemSettings) ProtoMessage()
func (*CustomerInitiatedCodeProvideOnRedeemSettings) ProtoReflect ¶
func (x *CustomerInitiatedCodeProvideOnRedeemSettings) ProtoReflect() protoreflect.Message
func (*CustomerInitiatedCodeProvideOnRedeemSettings) Reset ¶
func (x *CustomerInitiatedCodeProvideOnRedeemSettings) Reset()
func (*CustomerInitiatedCodeProvideOnRedeemSettings) String ¶
func (x *CustomerInitiatedCodeProvideOnRedeemSettings) String() string
type CustomerInitiatedFixedCodeSettings ¶
type CustomerInitiatedFixedCodeSettings struct { // For fixed code customer initiated redemption; the fixed code to display needs to be set. FixedCode string `protobuf:"bytes,1,opt,name=fixedCode,proto3" json:"fixedCode,omitempty"` // If set to true will use coupon.sku as the fixed code. UseCouponSku bool `protobuf:"varint,2,opt,name=useCouponSku,proto3" json:"useCouponSku,omitempty"` // If set will render a barcode underneath the fixed code with as contents the fixed code. Barcode io.BarcodeType `protobuf:"varint,3,opt,name=barcode,proto3,enum=io.BarcodeType" json:"barcode,omitempty"` // Count down timer for redemption. RedemptionTimer *RedemptionTimerSettings `protobuf:"bytes,4,opt,name=redemptionTimer,proto3" json:"redemptionTimer,omitempty"` // contains filtered or unexported fields }
func (*CustomerInitiatedFixedCodeSettings) Descriptor
deprecated
func (*CustomerInitiatedFixedCodeSettings) Descriptor() ([]byte, []int)
Deprecated: Use CustomerInitiatedFixedCodeSettings.ProtoReflect.Descriptor instead.
func (*CustomerInitiatedFixedCodeSettings) GetBarcode ¶
func (x *CustomerInitiatedFixedCodeSettings) GetBarcode() io.BarcodeType
func (*CustomerInitiatedFixedCodeSettings) GetFixedCode ¶
func (x *CustomerInitiatedFixedCodeSettings) GetFixedCode() string
func (*CustomerInitiatedFixedCodeSettings) GetRedemptionTimer ¶
func (x *CustomerInitiatedFixedCodeSettings) GetRedemptionTimer() *RedemptionTimerSettings
func (*CustomerInitiatedFixedCodeSettings) GetUseCouponSku ¶
func (x *CustomerInitiatedFixedCodeSettings) GetUseCouponSku() bool
func (*CustomerInitiatedFixedCodeSettings) ProtoMessage ¶
func (*CustomerInitiatedFixedCodeSettings) ProtoMessage()
func (*CustomerInitiatedFixedCodeSettings) ProtoReflect ¶
func (x *CustomerInitiatedFixedCodeSettings) ProtoReflect() protoreflect.Message
func (*CustomerInitiatedFixedCodeSettings) Reset ¶
func (x *CustomerInitiatedFixedCodeSettings) Reset()
func (*CustomerInitiatedFixedCodeSettings) String ¶
func (x *CustomerInitiatedFixedCodeSettings) String() string
type ExternalIdRequest ¶
type ExternalIdRequest struct { // Coupon Campaign ID // @tag: validateGeneric:"required" CouponCampaignId string `protobuf:"bytes,1,opt,name=couponCampaignId,proto3" json:"couponCampaignId,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 }
func (*ExternalIdRequest) Descriptor
deprecated
func (*ExternalIdRequest) Descriptor() ([]byte, []int)
Deprecated: Use ExternalIdRequest.ProtoReflect.Descriptor instead.
func (*ExternalIdRequest) GetCouponCampaignId ¶
func (x *ExternalIdRequest) GetCouponCampaignId() string
func (*ExternalIdRequest) GetExternalId ¶
func (x *ExternalIdRequest) GetExternalId() string
func (*ExternalIdRequest) ProtoMessage ¶
func (*ExternalIdRequest) ProtoMessage()
func (*ExternalIdRequest) ProtoReflect ¶
func (x *ExternalIdRequest) ProtoReflect() protoreflect.Message
func (*ExternalIdRequest) Reset ¶
func (x *ExternalIdRequest) Reset()
func (*ExternalIdRequest) String ¶
func (x *ExternalIdRequest) String() string
type InputField ¶
type InputField struct { // The label of input field. Label string `protobuf:"bytes,1,opt,name=label,proto3" json:"label,omitempty"` // Localized label of input field. LocalizedLabel *io.LocalizedString `protobuf:"bytes,2,opt,name=localizedLabel,proto3" json:"localizedLabel,omitempty"` // Help text shown below the input field. HelperText string `protobuf:"bytes,3,opt,name=helperText,proto3" json:"helperText,omitempty"` // Localized help text shown below the input field. LocalizedHelperText *io.LocalizedString `protobuf:"bytes,4,opt,name=localizedHelperText,proto3" json:"localizedHelperText,omitempty"` // Optional message that is displayed if the user provides an invalid input value. ErrorMessage string `protobuf:"bytes,5,opt,name=errorMessage,proto3" json:"errorMessage,omitempty"` // Localized invalid code error message. LocalizedErrorMessage *io.LocalizedString `protobuf:"bytes,6,opt,name=localizedErrorMessage,proto3" json:"localizedErrorMessage,omitempty"` // Default input value. DefaultValue string `protobuf:"bytes,7,opt,name=defaultValue,proto3" json:"defaultValue,omitempty"` // Localized default value. LocalizedDefaultValue *io.LocalizedString `protobuf:"bytes,8,opt,name=localizedDefaultValue,proto3" json:"localizedDefaultValue,omitempty"` // Placeholder text for the input field. Placeholder string `protobuf:"bytes,9,opt,name=placeholder,proto3" json:"placeholder,omitempty"` // Localized placeholder text. LocalizedPlaceholder *io.LocalizedString `protobuf:"bytes,10,opt,name=localizedPlaceholder,proto3" json:"localizedPlaceholder,omitempty"` // A regex which allows you to set custom validation rules for the input value. Validation string `protobuf:"bytes,11,opt,name=validation,proto3" json:"validation,omitempty"` // contains filtered or unexported fields }
func (*InputField) Descriptor
deprecated
func (*InputField) Descriptor() ([]byte, []int)
Deprecated: Use InputField.ProtoReflect.Descriptor instead.
func (*InputField) GetDefaultValue ¶
func (x *InputField) GetDefaultValue() string
func (*InputField) GetErrorMessage ¶
func (x *InputField) GetErrorMessage() string
func (*InputField) GetHelperText ¶
func (x *InputField) GetHelperText() string
func (*InputField) GetLabel ¶
func (x *InputField) GetLabel() string
func (*InputField) GetLocalizedDefaultValue ¶
func (x *InputField) GetLocalizedDefaultValue() *io.LocalizedString
func (*InputField) GetLocalizedErrorMessage ¶
func (x *InputField) GetLocalizedErrorMessage() *io.LocalizedString
func (*InputField) GetLocalizedHelperText ¶
func (x *InputField) GetLocalizedHelperText() *io.LocalizedString
func (*InputField) GetLocalizedLabel ¶
func (x *InputField) GetLocalizedLabel() *io.LocalizedString
func (*InputField) GetLocalizedPlaceholder ¶
func (x *InputField) GetLocalizedPlaceholder() *io.LocalizedString
func (*InputField) GetPlaceholder ¶
func (x *InputField) GetPlaceholder() string
func (*InputField) GetValidation ¶
func (x *InputField) GetValidation() string
func (*InputField) ProtoMessage ¶
func (*InputField) ProtoMessage()
func (*InputField) ProtoReflect ¶
func (x *InputField) ProtoReflect() protoreflect.Message
func (*InputField) Reset ¶
func (x *InputField) Reset()
func (*InputField) String ¶
func (x *InputField) String() string
type ListRequest ¶
type ListRequest struct { // Coupon Campaign ID // @tag: validateGeneric:"required" validateCreate:"required" validateUpdate:"required" CouponCampaignId string `` /* 164-byte string literal not displayed */ // External ID // @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) GetCouponCampaignId ¶
func (x *ListRequest) GetCouponCampaignId() string
func (*ListRequest) GetEmailAsCsv ¶
func (x *ListRequest) GetEmailAsCsv() bool
func (*ListRequest) GetFilters ¶
func (x *ListRequest) GetFilters() *io.Filters
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 { // Coupon Campaign ID // @tag: validateGeneric:"required" validateCreate:"required" validateUpdate:"required" CouponCampaignId string `` /* 164-byte string literal not displayed */ // External ID // @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) GetCouponCampaignId ¶
func (x *ListRequestDeprecated) GetCouponCampaignId() string
func (*ListRequestDeprecated) GetPagination ¶
func (x *ListRequestDeprecated) GetPagination() *io.Pagination
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 RedemptionDetails ¶
type RedemptionDetails struct { // The date the coupon was redeemed (set by the system when the redeem endpoint is called). RedemptionDate *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=redemptionDate,proto3" json:"redemptionDate,omitempty"` // Optional field that contains the redemption code provided on redeem (either the fixed one if set, or user provided). RedemptionCode string `protobuf:"bytes,2,opt,name=redemptionCode,proto3" json:"redemptionCode,omitempty"` // Option redemption GPS lat, lon & alt. Lat float64 `protobuf:"fixed64,3,opt,name=lat,proto3" json:"lat,omitempty"` // Longitude. Lon float64 `protobuf:"fixed64,4,opt,name=lon,proto3" json:"lon,omitempty"` // Altitude in metres. Alt int32 `protobuf:"varint,5,opt,name=alt,proto3" json:"alt,omitempty"` // Optional redemption user agent, can be used in case where a Merchant uses the PassKit scanning solution combined with their own POS redemption and wants to differentiate the source of redemption. RedemptionSource string `protobuf:"bytes,6,opt,name=redemptionSource,proto3" json:"redemptionSource,omitempty"` // Optional redemption reference, can be used for staff name, username, POS ID, location ID, etc. RedemptionReference string `protobuf:"bytes,7,opt,name=redemptionReference,proto3" json:"redemptionReference,omitempty"` // Optional transaction reference, can be used to consolidate baskets at a later stage via a manual process. TransactionReference string `protobuf:"bytes,8,opt,name=transactionReference,proto3" json:"transactionReference,omitempty"` // Optional total transaction amount. TransactionAmount float64 `protobuf:"fixed64,9,opt,name=transactionAmount,proto3" json:"transactionAmount,omitempty"` // Any other meta data re. the redemption MetaData map[string]string `` /* 158-byte string literal not displayed */ // contains filtered or unexported fields }
func (*RedemptionDetails) Descriptor
deprecated
func (*RedemptionDetails) Descriptor() ([]byte, []int)
Deprecated: Use RedemptionDetails.ProtoReflect.Descriptor instead.
func (*RedemptionDetails) GetAlt ¶
func (x *RedemptionDetails) GetAlt() int32
func (*RedemptionDetails) GetLat ¶
func (x *RedemptionDetails) GetLat() float64
func (*RedemptionDetails) GetLon ¶
func (x *RedemptionDetails) GetLon() float64
func (*RedemptionDetails) GetMetaData ¶
func (x *RedemptionDetails) GetMetaData() map[string]string
func (*RedemptionDetails) GetRedemptionCode ¶
func (x *RedemptionDetails) GetRedemptionCode() string
func (*RedemptionDetails) GetRedemptionDate ¶
func (x *RedemptionDetails) GetRedemptionDate() *timestamppb.Timestamp
func (*RedemptionDetails) GetRedemptionReference ¶
func (x *RedemptionDetails) GetRedemptionReference() string
func (*RedemptionDetails) GetRedemptionSource ¶
func (x *RedemptionDetails) GetRedemptionSource() string
func (*RedemptionDetails) GetTransactionAmount ¶
func (x *RedemptionDetails) GetTransactionAmount() float64
func (*RedemptionDetails) GetTransactionReference ¶
func (x *RedemptionDetails) GetTransactionReference() string
func (*RedemptionDetails) ProtoMessage ¶
func (*RedemptionDetails) ProtoMessage()
func (*RedemptionDetails) ProtoReflect ¶
func (x *RedemptionDetails) ProtoReflect() protoreflect.Message
func (*RedemptionDetails) Reset ¶
func (x *RedemptionDetails) Reset()
func (*RedemptionDetails) String ¶
func (x *RedemptionDetails) String() string
type RedemptionSettings ¶
type RedemptionSettings struct { // Optional field that can be set if offers can only be redeemed after a certain date. Defaults to the offer issue start date. Needs to be greater than / equal to the offer issue start date, and less than / equal to offer issue end date. // @tag: validateGeneric:"-" validateCreate:"-" validateUpdate:"-" RedemptionStartDate *timestamppb.Timestamp `` /* 149-byte string literal not displayed */ // Optional field that can be set if offers can only be redeemed until a certain date. Defaults to the offer issue end date. Needs to be less than / equal to the offer issue end date. // @tag: validateGeneric:"-" validateCreate:"-" validateUpdate:"-" RedemptionEndDate *timestamppb.Timestamp `` /* 145-byte string literal not displayed */ // Dictates redemption type; defaults to API. RedemptionType []RedemptionType `` /* 128-byte string literal not displayed */ // Settings for code provided on redemption; a list of valid codes and possible invalid-code error message needs to be provided. CodeProvidedOnRedeemSettings *CustomerInitiatedCodeProvideOnRedeemSettings `protobuf:"bytes,5,opt,name=codeProvidedOnRedeemSettings,proto3" json:"codeProvidedOnRedeemSettings,omitempty"` // Settings for fixed code redemption. FixedCodeSettings *CustomerInitiatedFixedCodeSettings `protobuf:"bytes,6,opt,name=fixedCodeSettings,proto3" json:"fixedCodeSettings,omitempty"` // Standard redemption page design, hosted by PassKit. Mandatory field if the type is any of the customer initiated redemptions. StandardSettings *StandardPassKitHostedPage `protobuf:"bytes,7,opt,name=standardSettings,proto3" json:"standardSettings,omitempty"` // contains filtered or unexported fields }
func (*RedemptionSettings) Descriptor
deprecated
func (*RedemptionSettings) Descriptor() ([]byte, []int)
Deprecated: Use RedemptionSettings.ProtoReflect.Descriptor instead.
func (*RedemptionSettings) GetCodeProvidedOnRedeemSettings ¶
func (x *RedemptionSettings) GetCodeProvidedOnRedeemSettings() *CustomerInitiatedCodeProvideOnRedeemSettings
func (*RedemptionSettings) GetFixedCodeSettings ¶
func (x *RedemptionSettings) GetFixedCodeSettings() *CustomerInitiatedFixedCodeSettings
func (*RedemptionSettings) GetRedemptionEndDate ¶
func (x *RedemptionSettings) GetRedemptionEndDate() *timestamppb.Timestamp
func (*RedemptionSettings) GetRedemptionStartDate ¶
func (x *RedemptionSettings) GetRedemptionStartDate() *timestamppb.Timestamp
func (*RedemptionSettings) GetRedemptionType ¶
func (x *RedemptionSettings) GetRedemptionType() []RedemptionType
func (*RedemptionSettings) GetStandardSettings ¶
func (x *RedemptionSettings) GetStandardSettings() *StandardPassKitHostedPage
func (*RedemptionSettings) ProtoMessage ¶
func (*RedemptionSettings) ProtoMessage()
func (*RedemptionSettings) ProtoReflect ¶
func (x *RedemptionSettings) ProtoReflect() protoreflect.Message
func (*RedemptionSettings) Reset ¶
func (x *RedemptionSettings) Reset()
func (*RedemptionSettings) String ¶
func (x *RedemptionSettings) String() string
type RedemptionTimerSettings ¶
type RedemptionTimerSettings struct { // The number of seconds the redemption page displays the redemption code. When the times runs out, the redemption page will show the 'redemption period expired' message. TimeoutSeconds uint32 `protobuf:"varint,1,opt,name=timeoutSeconds,proto3" json:"timeoutSeconds,omitempty"` // Help text rendered above redemption timer. TimerHelpText string `protobuf:"bytes,2,opt,name=timerHelpText,proto3" json:"timerHelpText,omitempty"` // Localized help text for redemption timer. LocalizedTimeHelpText *io.LocalizedString `protobuf:"bytes,3,opt,name=localizedTimeHelpText,proto3" json:"localizedTimeHelpText,omitempty"` // contains filtered or unexported fields }
func (*RedemptionTimerSettings) Descriptor
deprecated
func (*RedemptionTimerSettings) Descriptor() ([]byte, []int)
Deprecated: Use RedemptionTimerSettings.ProtoReflect.Descriptor instead.
func (*RedemptionTimerSettings) GetLocalizedTimeHelpText ¶
func (x *RedemptionTimerSettings) GetLocalizedTimeHelpText() *io.LocalizedString
func (*RedemptionTimerSettings) GetTimeoutSeconds ¶
func (x *RedemptionTimerSettings) GetTimeoutSeconds() uint32
func (*RedemptionTimerSettings) GetTimerHelpText ¶
func (x *RedemptionTimerSettings) GetTimerHelpText() string
func (*RedemptionTimerSettings) ProtoMessage ¶
func (*RedemptionTimerSettings) ProtoMessage()
func (*RedemptionTimerSettings) ProtoReflect ¶
func (x *RedemptionTimerSettings) ProtoReflect() protoreflect.Message
func (*RedemptionTimerSettings) Reset ¶
func (x *RedemptionTimerSettings) Reset()
func (*RedemptionTimerSettings) String ¶
func (x *RedemptionTimerSettings) String() string
type RedemptionType ¶
type RedemptionType int32
const ( // Zero index should not be used RedemptionType_REDEMPTION_TYPE_DO_NOT_USE RedemptionType = 0 // Coupons are always redeemed via API (default). This method is used by POS integrations, but is also be used by the PassKit scanning app. RedemptionType_REDEMPTION_TYPE_API RedemptionType = 1 // Coupons can be redeemed by the coupon holder (i.e. the customer) by visiting a redemption URL rendered on the coupon. // The coupon will redeem upon the link being visited. RedemptionType_REDEMPTION_TYPE_CUSTOMER_INITIATED RedemptionType = 2 // This will present a fixed code to the customer after they visit the redemption URL, and then auto redeem the coupon. The customer can then present this fixed-code to a member of staff. RedemptionType_REDEMPTION_TYPE_CUSTOMER_INITIATED_CODE_FIXED RedemptionType = 3 // After visiting the redemption URL, a member of staff provides the customer with a redemption-code they need to enter. After entering the code, the coupon with redeem. RedemptionType_REDEMPTION_TYPE_CUSTOMER_INITIATED_CODE_PROVIDED_ON_REDEEM RedemptionType = 4 )
func (RedemptionType) Descriptor ¶
func (RedemptionType) Descriptor() protoreflect.EnumDescriptor
func (RedemptionType) Enum ¶
func (x RedemptionType) Enum() *RedemptionType
func (RedemptionType) EnumDescriptor
deprecated
func (RedemptionType) EnumDescriptor() ([]byte, []int)
Deprecated: Use RedemptionType.Descriptor instead.
func (RedemptionType) Number ¶
func (x RedemptionType) Number() protoreflect.EnumNumber
func (RedemptionType) String ¶
func (x RedemptionType) String() string
func (RedemptionType) Type ¶
func (RedemptionType) Type() protoreflect.EnumType
type ResponseTexts ¶
type ResponseTexts struct { // To be shown before redemption page is rendered. The dialogue box will have "Ok" and "Cancel" bottons. // If visitor clicks "Ok", coupon will be redeemed and the redemption page will render fixed code. // This only applies to the redemption type REDEMPTION_TYPE_CUSTOMER_INITIATED_CODE_FIXED. RedeemConfirmationDialogBoxText string `protobuf:"bytes,1,opt,name=redeemConfirmationDialogBoxText,proto3" json:"redeemConfirmationDialogBoxText,omitempty"` // Localized redemption confirm dialog box text. LocalizedRedeemConfirmationDialogBoxText *io.LocalizedString `` /* 133-byte string literal not displayed */ // To be shown when visitor clicks "Cancel" and reject to redeem now. // This only applies to the redemption type REDEMPTION_TYPE_CUSTOMER_INITIATED_CODE_FIXED. CancelRedeemText string `protobuf:"bytes,3,opt,name=cancelRedeemText,proto3" json:"cancelRedeemText,omitempty"` // Localized cancel redemption text. LocalizedCancelRedeemText *io.LocalizedString `protobuf:"bytes,4,opt,name=localizedCancelRedeemText,proto3" json:"localizedCancelRedeemText,omitempty"` // To be shown when coupon has been redeemed. AfterRedeemText string `protobuf:"bytes,5,opt,name=afterRedeemText,proto3" json:"afterRedeemText,omitempty"` // Localized after redemption text. LocalizedAfterRedeemText *io.LocalizedString `protobuf:"bytes,6,opt,name=localizedAfterRedeemText,proto3" json:"localizedAfterRedeemText,omitempty"` // To be shown when the coupon was already redeemed. CouponAlreadyRedeemedText string `protobuf:"bytes,7,opt,name=couponAlreadyRedeemedText,proto3" json:"couponAlreadyRedeemedText,omitempty"` // Localized text shown when the coupon was already redeemed. LocalizedCouponAlreadyRedeemedText *io.LocalizedString `protobuf:"bytes,8,opt,name=localizedCouponAlreadyRedeemedText,proto3" json:"localizedCouponAlreadyRedeemedText,omitempty"` // To be shown when the offer period has ended. OfferExpiredText string `protobuf:"bytes,9,opt,name=offerExpiredText,proto3" json:"offerExpiredText,omitempty"` // Localized text shown when offer has ended. LocalizedOfferExpiredText *io.LocalizedString `protobuf:"bytes,10,opt,name=localizedOfferExpiredText,proto3" json:"localizedOfferExpiredText,omitempty"` // To be shown when the coupon expiry date / redemption end date has passed. CouponExpiredText string `protobuf:"bytes,11,opt,name=couponExpiredText,proto3" json:"couponExpiredText,omitempty"` // Localized text shown when the coupon expiry date / redemption end date has passed. LocalizedCouponExpiredText *io.LocalizedString `protobuf:"bytes,12,opt,name=localizedCouponExpiredText,proto3" json:"localizedCouponExpiredText,omitempty"` // contains filtered or unexported fields }
func (*ResponseTexts) Descriptor
deprecated
func (*ResponseTexts) Descriptor() ([]byte, []int)
Deprecated: Use ResponseTexts.ProtoReflect.Descriptor instead.
func (*ResponseTexts) GetAfterRedeemText ¶
func (x *ResponseTexts) GetAfterRedeemText() string
func (*ResponseTexts) GetCancelRedeemText ¶
func (x *ResponseTexts) GetCancelRedeemText() string
func (*ResponseTexts) GetCouponAlreadyRedeemedText ¶
func (x *ResponseTexts) GetCouponAlreadyRedeemedText() string
func (*ResponseTexts) GetCouponExpiredText ¶
func (x *ResponseTexts) GetCouponExpiredText() string
func (*ResponseTexts) GetLocalizedAfterRedeemText ¶
func (x *ResponseTexts) GetLocalizedAfterRedeemText() *io.LocalizedString
func (*ResponseTexts) GetLocalizedCancelRedeemText ¶
func (x *ResponseTexts) GetLocalizedCancelRedeemText() *io.LocalizedString
func (*ResponseTexts) GetLocalizedCouponAlreadyRedeemedText ¶
func (x *ResponseTexts) GetLocalizedCouponAlreadyRedeemedText() *io.LocalizedString
func (*ResponseTexts) GetLocalizedCouponExpiredText ¶
func (x *ResponseTexts) GetLocalizedCouponExpiredText() *io.LocalizedString
func (*ResponseTexts) GetLocalizedOfferExpiredText ¶
func (x *ResponseTexts) GetLocalizedOfferExpiredText() *io.LocalizedString
func (*ResponseTexts) GetLocalizedRedeemConfirmationDialogBoxText ¶
func (x *ResponseTexts) GetLocalizedRedeemConfirmationDialogBoxText() *io.LocalizedString
func (*ResponseTexts) GetOfferExpiredText ¶
func (x *ResponseTexts) GetOfferExpiredText() string
func (*ResponseTexts) GetRedeemConfirmationDialogBoxText ¶
func (x *ResponseTexts) GetRedeemConfirmationDialogBoxText() string
func (*ResponseTexts) ProtoMessage ¶
func (*ResponseTexts) ProtoMessage()
func (*ResponseTexts) ProtoReflect ¶
func (x *ResponseTexts) ProtoReflect() protoreflect.Message
func (*ResponseTexts) Reset ¶
func (x *ResponseTexts) Reset()
func (*ResponseTexts) String ¶
func (x *ResponseTexts) String() string
type SingleUseCouponsClient ¶
type SingleUseCouponsClient interface { CreateCouponCampaign(ctx context.Context, in *CouponCampaign, opts ...grpc.CallOption) (*io.Id, error) UpdateCouponCampaign(ctx context.Context, in *CouponCampaign, opts ...grpc.CallOption) (*CouponCampaign, error) GetCouponCampaign(ctx context.Context, in *io.Id, opts ...grpc.CallOption) (*CouponCampaign, error) DeleteCouponCampaign(ctx context.Context, in *io.Id, opts ...grpc.CallOption) (*emptypb.Empty, error) ListCouponCampaignsDeprecated(ctx context.Context, in *io.Pagination, opts ...grpc.CallOption) (SingleUseCoupons_ListCouponCampaignsDeprecatedClient, error) ListCouponCampaigns(ctx context.Context, in *io.Filters, opts ...grpc.CallOption) (SingleUseCoupons_ListCouponCampaignsClient, error) GetAnalytics(ctx context.Context, in *io.AnalyticsRequest, opts ...grpc.CallOption) (*CouponCampaignAnalyticsResponse, error) CreateCouponOffer(ctx context.Context, in *CouponOffer, opts ...grpc.CallOption) (*io.Id, error) UpdateCouponOffer(ctx context.Context, in *CouponOffer, opts ...grpc.CallOption) (*CouponOffer, error) GetCouponOffer(ctx context.Context, in *io.Id, opts ...grpc.CallOption) (*CouponOffer, error) DeleteCouponOffer(ctx context.Context, in *io.Id, opts ...grpc.CallOption) (*emptypb.Empty, error) ListCouponOffersDeprecated(ctx context.Context, in *CouponOffersListRequestDeprecated, opts ...grpc.CallOption) (SingleUseCoupons_ListCouponOffersDeprecatedClient, error) ListCouponOffers(ctx context.Context, in *CouponOffersListRequest, opts ...grpc.CallOption) (SingleUseCoupons_ListCouponOffersClient, error) CreateCoupon(ctx context.Context, in *Coupon, opts ...grpc.CallOption) (*io.Id, error) UpdateCoupon(ctx context.Context, in *Coupon, opts ...grpc.CallOption) (*io.Id, error) StreamCouponUpdates(ctx context.Context, opts ...grpc.CallOption) (SingleUseCoupons_StreamCouponUpdatesClient, error) RedeemCoupon(ctx context.Context, in *Coupon, opts ...grpc.CallOption) (*io.Id, error) UpdateCouponExternalId(ctx context.Context, in *CouponNewExternalIdRequest, opts ...grpc.CallOption) (*io.Id, error) StreamCouponRedemptions(ctx context.Context, opts ...grpc.CallOption) (SingleUseCoupons_StreamCouponRedemptionsClient, error) GetCouponById(ctx context.Context, in *io.Id, opts ...grpc.CallOption) (*Coupon, error) GetCouponByExternalId(ctx context.Context, in *ExternalIdRequest, opts ...grpc.CallOption) (*Coupon, error) VoidCoupon(ctx context.Context, in *Coupon, opts ...grpc.CallOption) (*emptypb.Empty, error) ListCouponsByCouponCampaignDeprecated(ctx context.Context, in *ListRequestDeprecated, opts ...grpc.CallOption) (SingleUseCoupons_ListCouponsByCouponCampaignDeprecatedClient, error) ListCouponsByCouponCampaign(ctx context.Context, in *ListRequest, opts ...grpc.CallOption) (SingleUseCoupons_ListCouponsByCouponCampaignClient, error) CountCouponsByCouponCampaignDeprecated(ctx context.Context, in *ListRequestDeprecated, opts ...grpc.CallOption) (*io.Count, error) CountCouponsByCouponCampaign(ctx context.Context, in *ListRequest, opts ...grpc.CallOption) (*io.Count, error) PatchPerson(ctx context.Context, in *io.PersonRequest, opts ...grpc.CallOption) (*io.Id, error) CopyCouponCampaign(ctx context.Context, in *CampaignCopyRequest, opts ...grpc.CallOption) (*io.Id, error) GetMetaKeysForCampaign(ctx context.Context, in *io.Id, opts ...grpc.CallOption) (*io.Strings, error) }
SingleUseCouponsClient is the client API for SingleUseCoupons 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 NewSingleUseCouponsClient ¶
func NewSingleUseCouponsClient(cc grpc.ClientConnInterface) SingleUseCouponsClient
type SingleUseCouponsServer ¶
type SingleUseCouponsServer interface { CreateCouponCampaign(context.Context, *CouponCampaign) (*io.Id, error) UpdateCouponCampaign(context.Context, *CouponCampaign) (*CouponCampaign, error) GetCouponCampaign(context.Context, *io.Id) (*CouponCampaign, error) DeleteCouponCampaign(context.Context, *io.Id) (*emptypb.Empty, error) ListCouponCampaignsDeprecated(*io.Pagination, SingleUseCoupons_ListCouponCampaignsDeprecatedServer) error ListCouponCampaigns(*io.Filters, SingleUseCoupons_ListCouponCampaignsServer) error GetAnalytics(context.Context, *io.AnalyticsRequest) (*CouponCampaignAnalyticsResponse, error) CreateCouponOffer(context.Context, *CouponOffer) (*io.Id, error) UpdateCouponOffer(context.Context, *CouponOffer) (*CouponOffer, error) GetCouponOffer(context.Context, *io.Id) (*CouponOffer, error) DeleteCouponOffer(context.Context, *io.Id) (*emptypb.Empty, error) ListCouponOffersDeprecated(*CouponOffersListRequestDeprecated, SingleUseCoupons_ListCouponOffersDeprecatedServer) error ListCouponOffers(*CouponOffersListRequest, SingleUseCoupons_ListCouponOffersServer) error CreateCoupon(context.Context, *Coupon) (*io.Id, error) UpdateCoupon(context.Context, *Coupon) (*io.Id, error) StreamCouponUpdates(SingleUseCoupons_StreamCouponUpdatesServer) error RedeemCoupon(context.Context, *Coupon) (*io.Id, error) UpdateCouponExternalId(context.Context, *CouponNewExternalIdRequest) (*io.Id, error) StreamCouponRedemptions(SingleUseCoupons_StreamCouponRedemptionsServer) error GetCouponById(context.Context, *io.Id) (*Coupon, error) GetCouponByExternalId(context.Context, *ExternalIdRequest) (*Coupon, error) VoidCoupon(context.Context, *Coupon) (*emptypb.Empty, error) ListCouponsByCouponCampaignDeprecated(*ListRequestDeprecated, SingleUseCoupons_ListCouponsByCouponCampaignDeprecatedServer) error ListCouponsByCouponCampaign(*ListRequest, SingleUseCoupons_ListCouponsByCouponCampaignServer) error CountCouponsByCouponCampaignDeprecated(context.Context, *ListRequestDeprecated) (*io.Count, error) CountCouponsByCouponCampaign(context.Context, *ListRequest) (*io.Count, error) PatchPerson(context.Context, *io.PersonRequest) (*io.Id, error) CopyCouponCampaign(context.Context, *CampaignCopyRequest) (*io.Id, error) GetMetaKeysForCampaign(context.Context, *io.Id) (*io.Strings, error) }
SingleUseCouponsServer is the server API for SingleUseCoupons service. All implementations should embed UnimplementedSingleUseCouponsServer for forward compatibility
type SingleUseCoupons_ListCouponCampaignsClient ¶
type SingleUseCoupons_ListCouponCampaignsClient interface { Recv() (*CouponCampaign, error) grpc.ClientStream }
type SingleUseCoupons_ListCouponCampaignsDeprecatedClient ¶
type SingleUseCoupons_ListCouponCampaignsDeprecatedClient interface { Recv() (*CouponCampaign, error) grpc.ClientStream }
type SingleUseCoupons_ListCouponCampaignsDeprecatedServer ¶
type SingleUseCoupons_ListCouponCampaignsDeprecatedServer interface { Send(*CouponCampaign) error grpc.ServerStream }
type SingleUseCoupons_ListCouponCampaignsServer ¶
type SingleUseCoupons_ListCouponCampaignsServer interface { Send(*CouponCampaign) error grpc.ServerStream }
type SingleUseCoupons_ListCouponOffersClient ¶
type SingleUseCoupons_ListCouponOffersClient interface { Recv() (*CouponOffer, error) grpc.ClientStream }
type SingleUseCoupons_ListCouponOffersDeprecatedClient ¶
type SingleUseCoupons_ListCouponOffersDeprecatedClient interface { Recv() (*CouponOffer, error) grpc.ClientStream }
type SingleUseCoupons_ListCouponOffersDeprecatedServer ¶
type SingleUseCoupons_ListCouponOffersDeprecatedServer interface { Send(*CouponOffer) error grpc.ServerStream }
type SingleUseCoupons_ListCouponOffersServer ¶
type SingleUseCoupons_ListCouponOffersServer interface { Send(*CouponOffer) error grpc.ServerStream }
type SingleUseCoupons_ListCouponsByCouponCampaignClient ¶
type SingleUseCoupons_ListCouponsByCouponCampaignClient interface { Recv() (*Coupon, error) grpc.ClientStream }
type SingleUseCoupons_ListCouponsByCouponCampaignDeprecatedClient ¶
type SingleUseCoupons_ListCouponsByCouponCampaignDeprecatedClient interface { Recv() (*Coupon, error) grpc.ClientStream }
type SingleUseCoupons_ListCouponsByCouponCampaignDeprecatedServer ¶
type SingleUseCoupons_ListCouponsByCouponCampaignDeprecatedServer interface { Send(*Coupon) error grpc.ServerStream }
type SingleUseCoupons_ListCouponsByCouponCampaignServer ¶
type SingleUseCoupons_ListCouponsByCouponCampaignServer interface { Send(*Coupon) error grpc.ServerStream }
type StandardPassKitHostedPage ¶
type StandardPassKitHostedPage struct { // Title shown on the redemption page browser tab. If not set, offer title will be shown. Title string `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"` // Localized title. LocalizedTitle *io.LocalizedString `protobuf:"bytes,2,opt,name=localizedTitle,proto3" json:"localizedTitle,omitempty"` // Redemption instructions, show underneath the redemption banner image. RedemptionInstructions string `protobuf:"bytes,3,opt,name=redemptionInstructions,proto3" json:"redemptionInstructions,omitempty"` // Localized redemption instructions. LocalizedRedemptionInstructions *io.LocalizedString `protobuf:"bytes,4,opt,name=localizedRedemptionInstructions,proto3" json:"localizedRedemptionInstructions,omitempty"` // Image assets for the redemption banner image. // // Types that are assignable to RedemptionImageAssets: // // *StandardPassKitHostedPage_ImageIds // *StandardPassKitHostedPage_Images RedemptionImageAssets isStandardPassKitHostedPage_RedemptionImageAssets `protobuf_oneof:"RedemptionImageAssets"` FooterText string `protobuf:"bytes,7,opt,name=footerText,proto3" json:"footerText,omitempty"` LocalizedFooterText *io.LocalizedString `protobuf:"bytes,8,opt,name=localizedFooterText,proto3" json:"localizedFooterText,omitempty"` // Customize success or error messages shown on the page or error dialog box. ResponseTexts *ResponseTexts `protobuf:"bytes,9,opt,name=responseTexts,proto3" json:"responseTexts,omitempty"` // Date time showed with couponAlreadyRedeemedText. Date time is localized to browser preferred language. HideRedeemedDateTime bool `protobuf:"varint,10,opt,name=hideRedeemedDateTime,proto3" json:"hideRedeemedDateTime,omitempty"` // Call to action button rendered on error page of coupon already redeemed to provide better customer experience. CallToActionButton *CallToActionButton `protobuf:"bytes,11,opt,name=callToActionButton,proto3" json:"callToActionButton,omitempty"` // Optional CSS overrides to ensure the page aligns with your brand guidelines. CssOverrides string `protobuf:"bytes,12,opt,name=cssOverrides,proto3" json:"cssOverrides,omitempty"` // contains filtered or unexported fields }
func (*StandardPassKitHostedPage) Descriptor
deprecated
func (*StandardPassKitHostedPage) Descriptor() ([]byte, []int)
Deprecated: Use StandardPassKitHostedPage.ProtoReflect.Descriptor instead.
func (*StandardPassKitHostedPage) GetCallToActionButton ¶
func (x *StandardPassKitHostedPage) GetCallToActionButton() *CallToActionButton
func (*StandardPassKitHostedPage) GetCssOverrides ¶
func (x *StandardPassKitHostedPage) GetCssOverrides() string
func (*StandardPassKitHostedPage) GetFooterText ¶
func (x *StandardPassKitHostedPage) GetFooterText() string
func (*StandardPassKitHostedPage) GetHideRedeemedDateTime ¶
func (x *StandardPassKitHostedPage) GetHideRedeemedDateTime() bool
func (*StandardPassKitHostedPage) GetImageIds ¶
func (x *StandardPassKitHostedPage) GetImageIds() *io.ImageIds
func (*StandardPassKitHostedPage) GetImages ¶
func (x *StandardPassKitHostedPage) GetImages() *io.ImageData
func (*StandardPassKitHostedPage) GetLocalizedFooterText ¶
func (x *StandardPassKitHostedPage) GetLocalizedFooterText() *io.LocalizedString
func (*StandardPassKitHostedPage) GetLocalizedRedemptionInstructions ¶
func (x *StandardPassKitHostedPage) GetLocalizedRedemptionInstructions() *io.LocalizedString
func (*StandardPassKitHostedPage) GetLocalizedTitle ¶
func (x *StandardPassKitHostedPage) GetLocalizedTitle() *io.LocalizedString
func (*StandardPassKitHostedPage) GetRedemptionImageAssets ¶
func (m *StandardPassKitHostedPage) GetRedemptionImageAssets() isStandardPassKitHostedPage_RedemptionImageAssets
func (*StandardPassKitHostedPage) GetRedemptionInstructions ¶
func (x *StandardPassKitHostedPage) GetRedemptionInstructions() string
func (*StandardPassKitHostedPage) GetResponseTexts ¶
func (x *StandardPassKitHostedPage) GetResponseTexts() *ResponseTexts
func (*StandardPassKitHostedPage) GetTitle ¶
func (x *StandardPassKitHostedPage) GetTitle() string
func (*StandardPassKitHostedPage) ProtoMessage ¶
func (*StandardPassKitHostedPage) ProtoMessage()
func (*StandardPassKitHostedPage) ProtoReflect ¶
func (x *StandardPassKitHostedPage) ProtoReflect() protoreflect.Message
func (*StandardPassKitHostedPage) Reset ¶
func (x *StandardPassKitHostedPage) Reset()
func (*StandardPassKitHostedPage) String ¶
func (x *StandardPassKitHostedPage) String() string
type UnimplementedSingleUseCouponsServer ¶
type UnimplementedSingleUseCouponsServer struct { }
UnimplementedSingleUseCouponsServer should be embedded to have forward compatible implementations.
func (UnimplementedSingleUseCouponsServer) CopyCouponCampaign ¶
func (UnimplementedSingleUseCouponsServer) CopyCouponCampaign(context.Context, *CampaignCopyRequest) (*io.Id, error)
func (UnimplementedSingleUseCouponsServer) CountCouponsByCouponCampaign ¶
func (UnimplementedSingleUseCouponsServer) CountCouponsByCouponCampaign(context.Context, *ListRequest) (*io.Count, error)
func (UnimplementedSingleUseCouponsServer) CountCouponsByCouponCampaignDeprecated ¶
func (UnimplementedSingleUseCouponsServer) CountCouponsByCouponCampaignDeprecated(context.Context, *ListRequestDeprecated) (*io.Count, error)
func (UnimplementedSingleUseCouponsServer) CreateCoupon ¶
func (UnimplementedSingleUseCouponsServer) CreateCouponCampaign ¶
func (UnimplementedSingleUseCouponsServer) CreateCouponCampaign(context.Context, *CouponCampaign) (*io.Id, error)
func (UnimplementedSingleUseCouponsServer) CreateCouponOffer ¶
func (UnimplementedSingleUseCouponsServer) CreateCouponOffer(context.Context, *CouponOffer) (*io.Id, error)
func (UnimplementedSingleUseCouponsServer) DeleteCouponCampaign ¶
func (UnimplementedSingleUseCouponsServer) DeleteCouponOffer ¶
func (UnimplementedSingleUseCouponsServer) GetAnalytics ¶
func (UnimplementedSingleUseCouponsServer) GetAnalytics(context.Context, *io.AnalyticsRequest) (*CouponCampaignAnalyticsResponse, error)
func (UnimplementedSingleUseCouponsServer) GetCouponByExternalId ¶
func (UnimplementedSingleUseCouponsServer) GetCouponByExternalId(context.Context, *ExternalIdRequest) (*Coupon, error)
func (UnimplementedSingleUseCouponsServer) GetCouponById ¶
func (UnimplementedSingleUseCouponsServer) GetCouponCampaign ¶
func (UnimplementedSingleUseCouponsServer) GetCouponCampaign(context.Context, *io.Id) (*CouponCampaign, error)
func (UnimplementedSingleUseCouponsServer) GetCouponOffer ¶
func (UnimplementedSingleUseCouponsServer) GetCouponOffer(context.Context, *io.Id) (*CouponOffer, error)
func (UnimplementedSingleUseCouponsServer) GetMetaKeysForCampaign ¶
func (UnimplementedSingleUseCouponsServer) ListCouponCampaigns ¶
func (UnimplementedSingleUseCouponsServer) ListCouponCampaigns(*io.Filters, SingleUseCoupons_ListCouponCampaignsServer) error
func (UnimplementedSingleUseCouponsServer) ListCouponCampaignsDeprecated ¶
func (UnimplementedSingleUseCouponsServer) ListCouponCampaignsDeprecated(*io.Pagination, SingleUseCoupons_ListCouponCampaignsDeprecatedServer) error
func (UnimplementedSingleUseCouponsServer) ListCouponOffers ¶
func (UnimplementedSingleUseCouponsServer) ListCouponOffers(*CouponOffersListRequest, SingleUseCoupons_ListCouponOffersServer) error
func (UnimplementedSingleUseCouponsServer) ListCouponOffersDeprecated ¶
func (UnimplementedSingleUseCouponsServer) ListCouponOffersDeprecated(*CouponOffersListRequestDeprecated, SingleUseCoupons_ListCouponOffersDeprecatedServer) error
func (UnimplementedSingleUseCouponsServer) ListCouponsByCouponCampaign ¶
func (UnimplementedSingleUseCouponsServer) ListCouponsByCouponCampaign(*ListRequest, SingleUseCoupons_ListCouponsByCouponCampaignServer) error
func (UnimplementedSingleUseCouponsServer) ListCouponsByCouponCampaignDeprecated ¶
func (UnimplementedSingleUseCouponsServer) ListCouponsByCouponCampaignDeprecated(*ListRequestDeprecated, SingleUseCoupons_ListCouponsByCouponCampaignDeprecatedServer) error
func (UnimplementedSingleUseCouponsServer) PatchPerson ¶
func (UnimplementedSingleUseCouponsServer) PatchPerson(context.Context, *io.PersonRequest) (*io.Id, error)
func (UnimplementedSingleUseCouponsServer) RedeemCoupon ¶
func (UnimplementedSingleUseCouponsServer) StreamCouponRedemptions ¶
func (UnimplementedSingleUseCouponsServer) StreamCouponRedemptions(SingleUseCoupons_StreamCouponRedemptionsServer) error
func (UnimplementedSingleUseCouponsServer) StreamCouponUpdates ¶
func (UnimplementedSingleUseCouponsServer) StreamCouponUpdates(SingleUseCoupons_StreamCouponUpdatesServer) error
func (UnimplementedSingleUseCouponsServer) UpdateCoupon ¶
func (UnimplementedSingleUseCouponsServer) UpdateCouponCampaign ¶
func (UnimplementedSingleUseCouponsServer) UpdateCouponCampaign(context.Context, *CouponCampaign) (*CouponCampaign, error)
func (UnimplementedSingleUseCouponsServer) UpdateCouponExternalId ¶
func (UnimplementedSingleUseCouponsServer) UpdateCouponExternalId(context.Context, *CouponNewExternalIdRequest) (*io.Id, error)
func (UnimplementedSingleUseCouponsServer) UpdateCouponOffer ¶
func (UnimplementedSingleUseCouponsServer) UpdateCouponOffer(context.Context, *CouponOffer) (*CouponOffer, error)
func (UnimplementedSingleUseCouponsServer) VoidCoupon ¶
type UnsafeSingleUseCouponsServer ¶
type UnsafeSingleUseCouponsServer interface {
// contains filtered or unexported methods
}
UnsafeSingleUseCouponsServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SingleUseCouponsServer will result in compilation errors.