single_use_coupons

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
}

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
}

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
}

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
}

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
}

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
}

type CouponExpiryType int32

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
}

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
}

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
}

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
}

type CouponStatus int32

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

type RedemptionType int32

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
}

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

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

type SingleUseCoupons_ListCouponCampaignsClient interface {
	Recv() (*CouponCampaign, error)
	grpc.ClientStream
}

type SingleUseCoupons_ListCouponCampaignsDeprecatedClient interface {
	Recv() (*CouponCampaign, error)
	grpc.ClientStream
}

type SingleUseCoupons_ListCouponCampaignsDeprecatedServer interface {
	Send(*CouponCampaign) error
	grpc.ServerStream
}

type SingleUseCoupons_ListCouponCampaignsServer interface {
	Send(*CouponCampaign) error
	grpc.ServerStream
}

type SingleUseCoupons_ListCouponOffersClient interface {
	Recv() (*CouponOffer, error)
	grpc.ClientStream
}

type SingleUseCoupons_ListCouponOffersDeprecatedClient interface {
	Recv() (*CouponOffer, error)
	grpc.ClientStream
}

type SingleUseCoupons_ListCouponOffersDeprecatedServer interface {
	Send(*CouponOffer) error
	grpc.ServerStream
}

type SingleUseCoupons_ListCouponOffersServer interface {
	Send(*CouponOffer) error
	grpc.ServerStream
}

type SingleUseCoupons_ListCouponsByCouponCampaignClient interface {
	Recv() (*Coupon, error)
	grpc.ClientStream
}

type SingleUseCoupons_ListCouponsByCouponCampaignDeprecatedClient interface {
	Recv() (*Coupon, error)
	grpc.ClientStream
}

type SingleUseCoupons_ListCouponsByCouponCampaignDeprecatedServer interface {
	Send(*Coupon) error
	grpc.ServerStream
}

type SingleUseCoupons_ListCouponsByCouponCampaignServer interface {
	Send(*Coupon) error
	grpc.ServerStream
}

type SingleUseCoupons_StreamCouponRedemptionsClient interface {
	Send(*Coupon) error
	Recv() (*io.Id, error)
	grpc.ClientStream
}

type SingleUseCoupons_StreamCouponRedemptionsServer interface {
	Send(*io.Id) error
	Recv() (*Coupon, error)
	grpc.ServerStream
}

type SingleUseCoupons_StreamCouponUpdatesClient interface {
	Send(*Coupon) error
	Recv() (*io.Id, error)
	grpc.ClientStream
}

type SingleUseCoupons_StreamCouponUpdatesServer interface {
	Send(*io.Id) error
	Recv() (*Coupon, error)
	grpc.ServerStream
}

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"`
	// Text shown at the footer of the page, underneath the redemption code / redemption code input.
	FooterText string `protobuf:"bytes,7,opt,name=footerText,proto3" json:"footerText,omitempty"`
	// Localized text shown at the footer of the page.
	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
}

type StandardPassKitHostedPage_ImageIds struct {
	// Image data defined by image ids.
	ImageIds *io.ImageIds `protobuf:"bytes,5,opt,name=imageIds,proto3,oneof"`
}

type StandardPassKitHostedPage_Images struct {
	// Image data defined as image object.
	Images *io.ImageData `protobuf:"bytes,6,opt,name=images,proto3,oneof"`
}

type UnimplementedSingleUseCouponsServer struct {
}

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