> For the complete documentation index, see [llms.txt](https://kbase.whitelabel-loyalty.com/developer/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://kbase.whitelabel-loyalty.com/developer/resources/campaigns-api-reference/models.md). # Models ## The ListQueryParams object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"ListQueryParams":{"properties":{"limit":{"type":"number","maximum":1000,"minimum":1},"skip":{"type":"number","maximum":9007199254740991,"minimum":0},"order":{"type":"string","enum":["ASC","DESC"]},"filter":{}},"type":"object","required":["order"]}}}} ``` ## The TenantConfiguration object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"TenantConfiguration":{"properties":{"allowDuplicateEmailAddress":{"type":"boolean"},"allowDuplicateTelephoneNumber":{"type":"boolean"},"allowedTeamInvitationTypes":{"items":{"enum":["REGISTER_ACCOUNT"],"type":"string"},"type":"array"},"enableUserGenderGuessing":{"type":"boolean"},"deleteAuthIdentifiers":{"type":"boolean"}},"type":"object"}}}} ``` ## The XoxoOrderEvents object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"XoxoOrderEvents":{"properties":{"DELIVERED":{"type":"string"},"CANCELLED":{"type":"string"}},"type":"object","required":["DELIVERED","CANCELLED"]}}}} ``` ## The XoxoIntegrationConfig object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"XoxoIntegrationConfig":{"properties":{"clientId":{"type":"string"},"clientSecret":{"type":"string"},"refreshToken":{"type":"string"},"tokenExpiryInDays":{"type":"number"},"accessToken":{"type":"string"},"environment":{"type":"string","enum":["staging","production"]},"onlyRealtime":{"type":"boolean"},"useXoxoEmailDelivery":{"type":"boolean"},"synchronizeXoxoRewards":{"type":"boolean"},"eventTypes":{"$ref":"#/components/schemas/XoxoOrderEvents"}},"type":"object","required":["clientId","clientSecret","refreshToken","tokenExpiryInDays","environment"]},"XoxoOrderEvents":{"properties":{"DELIVERED":{"type":"string"},"CANCELLED":{"type":"string"}},"type":"object","required":["DELIVERED","CANCELLED"]}}}} ``` ## The MagnatiIntegrationConfig object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"MagnatiIntegrationConfig":{"properties":{"channelId":{"type":"string"},"countryOfOrigin":{"enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"type":"string"},"productType":{"type":"number"},"topUpAmount":{"type":"number"},"webViewUrl":{"format":"url","type":"string"},"secretKey":{"type":"string"},"certThumbprint":{"type":"string"},"clientId":{"type":"string"},"jwtAudienceTenantUrl":{"type":"string"},"baseURL":{"format":"url","type":"string"},"proxySecretKey":{"type":"string"}},"type":"object","required":["channelId","countryOfOrigin","productType","topUpAmount","webViewUrl","secretKey","certThumbprint","clientId","jwtAudienceTenantUrl","baseURL","proxySecretKey"]}}}} ``` ## The NotificationConfig object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"NotificationConfig":{"properties":{"quantity":{"type":"number"},"emails":{"items":{},"type":"array"},"triggered":{"type":"boolean"}},"type":"object","required":["quantity","emails","triggered"]}}}} ``` ## The RoundUpLimit object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"RoundUpLimit":{"properties":{"period":{"type":"string","enum":["monthly","weekly","bi_weekly"]},"lower":{"minimum":0,"type":"number"},"default":{"minimum":0,"type":"number"},"upper":{"minimum":0,"type":"number"},"validateLimits":{"type":"object"}},"type":"object","required":["period","lower","default","validateLimits"]}}}} ``` ## The RoundUpTransferDestination object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"RoundUpTransferDestination":{"properties":{"id":{"format":"uuid","type":"string"},"title":{"type":"string"},"description":{"type":"string"},"pictureUrl":{"format":"url","type":"string"}},"type":"object","required":["id","title","description","pictureUrl"]}}}} ``` ## The ProgramMetadata object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"ProgramMetadata":{"properties":{"title":{"type":"string"},"description":{"type":"string"},"infoTitle":{"type":"string"}},"type":"object","required":["title","description","infoTitle"]}}}} ``` ## The RoundupPreferences object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"RoundupPreferences":{"properties":{"roundUpAmounts":{"items":{"type":"number"},"type":"array","minItems":1},"limit":{"$ref":"#/components/schemas/RoundUpLimit"},"roundUpTransferDestinations":{"items":{"$ref":"#/components/schemas/RoundUpTransferDestination"},"type":"array"}},"type":"object","required":["roundUpAmounts","limit"]},"RoundUpLimit":{"properties":{"period":{"type":"string","enum":["monthly","weekly","bi_weekly"]},"lower":{"minimum":0,"type":"number"},"default":{"minimum":0,"type":"number"},"upper":{"minimum":0,"type":"number"},"validateLimits":{"type":"object"}},"type":"object","required":["period","lower","default","validateLimits"]},"RoundUpTransferDestination":{"properties":{"id":{"format":"uuid","type":"string"},"title":{"type":"string"},"description":{"type":"string"},"pictureUrl":{"format":"url","type":"string"}},"type":"object","required":["id","title","description","pictureUrl"]}}}} ``` ## The Program object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"Program":{"properties":{"programType":{"enum":["CASHBACK","CASHBACK_AND_ROUNDUP"],"type":"string"},"enabled":{"type":"boolean"},"preferences":{"$ref":"#/components/schemas/RoundupPreferences"}},"type":"object","required":["programType"]},"RoundupPreferences":{"properties":{"roundUpAmounts":{"items":{"type":"number"},"type":"array","minItems":1},"limit":{"$ref":"#/components/schemas/RoundUpLimit"},"roundUpTransferDestinations":{"items":{"$ref":"#/components/schemas/RoundUpTransferDestination"},"type":"array"}},"type":"object","required":["roundUpAmounts","limit"]},"RoundUpLimit":{"properties":{"period":{"type":"string","enum":["monthly","weekly","bi_weekly"]},"lower":{"minimum":0,"type":"number"},"default":{"minimum":0,"type":"number"},"upper":{"minimum":0,"type":"number"},"validateLimits":{"type":"object"}},"type":"object","required":["period","lower","default","validateLimits"]},"RoundUpTransferDestination":{"properties":{"id":{"format":"uuid","type":"string"},"title":{"type":"string"},"description":{"type":"string"},"pictureUrl":{"format":"url","type":"string"}},"type":"object","required":["id","title","description","pictureUrl"]}}}} ``` ## The OliveProgramConfig object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"OliveProgramConfig":{"properties":{"programs":{"items":{"$ref":"#/components/schemas/Program"},"type":"array","minItems":1},"metadata":{"$ref":"#/components/schemas/ProgramMetadata"}},"type":"object","required":["programs","metadata"]},"Program":{"properties":{"programType":{"enum":["CASHBACK","CASHBACK_AND_ROUNDUP"],"type":"string"},"enabled":{"type":"boolean"},"preferences":{"$ref":"#/components/schemas/RoundupPreferences"}},"type":"object","required":["programType"]},"RoundupPreferences":{"properties":{"roundUpAmounts":{"items":{"type":"number"},"type":"array","minItems":1},"limit":{"$ref":"#/components/schemas/RoundUpLimit"},"roundUpTransferDestinations":{"items":{"$ref":"#/components/schemas/RoundUpTransferDestination"},"type":"array"}},"type":"object","required":["roundUpAmounts","limit"]},"RoundUpLimit":{"properties":{"period":{"type":"string","enum":["monthly","weekly","bi_weekly"]},"lower":{"minimum":0,"type":"number"},"default":{"minimum":0,"type":"number"},"upper":{"minimum":0,"type":"number"},"validateLimits":{"type":"object"}},"type":"object","required":["period","lower","default","validateLimits"]},"RoundUpTransferDestination":{"properties":{"id":{"format":"uuid","type":"string"},"title":{"type":"string"},"description":{"type":"string"},"pictureUrl":{"format":"url","type":"string"}},"type":"object","required":["id","title","description","pictureUrl"]},"ProgramMetadata":{"properties":{"title":{"type":"string"},"description":{"type":"string"},"infoTitle":{"type":"string"}},"type":"object","required":["title","description","infoTitle"]}}}} ``` ## The OliveEventTypes object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"OliveEventTypes":{"properties":{"LINKED_CARD":{"type":"string"},"UNLINKED_CARD":{"type":"string"},"PERIODIC_ROUNDUP_CHARGED":{"type":"string"},"PERIODIC_ROUNDUP_CHARGE_SUCCESSFUL":{"type":"string"},"PERIODIC_ROUNDUP_CHARGE_FAILED":{"type":"string"},"CASHBACK_REGISTERED":{"type":"string"},"CASHBACK_REJECTED":{"type":"string"},"CASHBACK_EARNED":{"type":"string"},"ROUNDUP_REGISTERED":{"type":"string"}},"type":"object","required":["LINKED_CARD","UNLINKED_CARD","PERIODIC_ROUNDUP_CHARGED","PERIODIC_ROUNDUP_CHARGE_SUCCESSFUL","PERIODIC_ROUNDUP_CHARGE_FAILED","CASHBACK_REGISTERED","CASHBACK_REJECTED","CASHBACK_EARNED","ROUNDUP_REGISTERED"]}}}} ``` ## The OliveIntegrationConfig object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"OliveIntegrationConfig":{"properties":{"publicKey":{"type":"string"},"privateKey":{"type":"string"},"environment":{"type":"string","enum":["staging","production"]},"eventTypes":{"$ref":"#/components/schemas/OliveEventTypes"},"programConfig":{"$ref":"#/components/schemas/OliveProgramConfig"},"dailyOfferSync":{"type":"boolean"}},"type":"object","required":["publicKey","privateKey","environment"]},"OliveEventTypes":{"properties":{"LINKED_CARD":{"type":"string"},"UNLINKED_CARD":{"type":"string"},"PERIODIC_ROUNDUP_CHARGED":{"type":"string"},"PERIODIC_ROUNDUP_CHARGE_SUCCESSFUL":{"type":"string"},"PERIODIC_ROUNDUP_CHARGE_FAILED":{"type":"string"},"CASHBACK_REGISTERED":{"type":"string"},"CASHBACK_REJECTED":{"type":"string"},"CASHBACK_EARNED":{"type":"string"},"ROUNDUP_REGISTERED":{"type":"string"}},"type":"object","required":["LINKED_CARD","UNLINKED_CARD","PERIODIC_ROUNDUP_CHARGED","PERIODIC_ROUNDUP_CHARGE_SUCCESSFUL","PERIODIC_ROUNDUP_CHARGE_FAILED","CASHBACK_REGISTERED","CASHBACK_REJECTED","CASHBACK_EARNED","ROUNDUP_REGISTERED"]},"OliveProgramConfig":{"properties":{"programs":{"items":{"$ref":"#/components/schemas/Program"},"type":"array","minItems":1},"metadata":{"$ref":"#/components/schemas/ProgramMetadata"}},"type":"object","required":["programs","metadata"]},"Program":{"properties":{"programType":{"enum":["CASHBACK","CASHBACK_AND_ROUNDUP"],"type":"string"},"enabled":{"type":"boolean"},"preferences":{"$ref":"#/components/schemas/RoundupPreferences"}},"type":"object","required":["programType"]},"RoundupPreferences":{"properties":{"roundUpAmounts":{"items":{"type":"number"},"type":"array","minItems":1},"limit":{"$ref":"#/components/schemas/RoundUpLimit"},"roundUpTransferDestinations":{"items":{"$ref":"#/components/schemas/RoundUpTransferDestination"},"type":"array"}},"type":"object","required":["roundUpAmounts","limit"]},"RoundUpLimit":{"properties":{"period":{"type":"string","enum":["monthly","weekly","bi_weekly"]},"lower":{"minimum":0,"type":"number"},"default":{"minimum":0,"type":"number"},"upper":{"minimum":0,"type":"number"},"validateLimits":{"type":"object"}},"type":"object","required":["period","lower","default","validateLimits"]},"RoundUpTransferDestination":{"properties":{"id":{"format":"uuid","type":"string"},"title":{"type":"string"},"description":{"type":"string"},"pictureUrl":{"format":"url","type":"string"}},"type":"object","required":["id","title","description","pictureUrl"]},"ProgramMetadata":{"properties":{"title":{"type":"string"},"description":{"type":"string"},"infoTitle":{"type":"string"}},"type":"object","required":["title","description","infoTitle"]}}}} ``` ## The Auth0IntegrationConfig object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"Auth0IntegrationConfig":{"properties":{"tenantDomain":{"type":"string"},"clientId":{"type":"string"},"clientSecret":{"type":"string"}},"type":"object","required":["tenantDomain","clientId","clientSecret"]}}}} ``` ## The Effectivity object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"Effectivity":{"properties":{"start":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"end":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]}},"type":"object","required":["start"]}}}} ``` ## The TransactionMetaPayloadConfig object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"TransactionMetaPayloadConfig":{"properties":{"__type":{"enum":["TRANSACTION"],"type":"string"},"metaEventIdPath":{"type":"string"},"valuePath":{"type":"string"},"currency":{"type":"string"},"valueFactor":{"type":"number"},"operationType":{"enum":["UPSERT"],"type":"string"}},"type":"object","required":["__type","metaEventIdPath","valuePath","currency","valueFactor"]}}}} ``` ## The MetaTypeMapping object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"MetaTypeMapping":{"properties":{"metaType":{"enum":["TRANSACTION"],"type":"string"},"metaPayloadConfig":{"type":"object"},"metaConstraint":{"type":"object"}},"type":"object","required":["metaType"]}}}} ``` ## The KeyValuePair object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"KeyValuePair":{"properties":{"key":{"minLength":1,"maxLength":255,"type":"string"},"value":{}},"type":"object","required":["key","value"]}}}} ``` ## The FilterResultParams object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"FilterResultParams":{"properties":{"success":{"items":{"$ref":"#/components/schemas/KeyValuePair"},"type":"array"},"failure":{"items":{"$ref":"#/components/schemas/KeyValuePair"},"type":"array"}},"type":"object","required":["success","failure"]},"KeyValuePair":{"properties":{"key":{"minLength":1,"maxLength":255,"type":"string"},"value":{}},"type":"object","required":["key","value"]}}}} ``` ## The AudienceCriteria object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"AudienceCriteria":{"properties":{"id":{"format":"uuid","type":"string"},"criteriaFormat":{"enum":["QUERY_TREE","JSONATA"],"type":"string"},"criteriaTree":{},"criteriaJsonata":{"type":"string"}},"type":"object","required":["id"]}}}} ``` ## The Hydratable object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"Hydratable":{"properties":{"id":{"format":"uuid","type":"string"}},"type":"object","required":["id"]}}}} ``` ## The GeoPoint object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"GeoPoint":{"properties":{"longitude":{"minimum":-180,"type":"number","maximum":180},"latitude":{"minimum":-90,"type":"number","maximum":90}},"type":"object","required":["longitude","latitude"]}}}} ``` ## The VenueAttributes object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"VenueAttributes":{"properties":{"bookingUrl":{"format":"url","type":"string"},"telephoneNumber":{"type":"string"},"openingTimes":{"type":"object"}},"type":"object"}}}} ``` ## The Venue object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"Venue":{"properties":{"id":{"type":"string"}},"type":"object","required":["id"]}}}} ``` ## The BaseRewardDetails object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"BaseRewardDetails":{"properties":{"locale":{"enum":["en","fr","de","it","es","nl","ar","bn","gu","hi","id","ja","ko","ml","mr","mt","pl","pt","ru","sv","ta","te","th","tl","tr","uk","ur","vi"],"type":"string"},"name":{"type":"string","minLength":2,"maxLength":200},"description":{"type":"string","minLength":2,"maxLength":10000},"pictureUrl":{"format":"url","type":"string"},"terms":{"type":"string","maxLength":25000},"summary":{"type":"string"},"logoUrl":{"format":"url","type":"string"},"redemptionMessage":{"type":"string"}},"type":"object","required":["locale"]}}}} ``` ## The AwinRewardDetails object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"AwinRewardDetails":{"properties":{"displayUrl":{"format":"url","type":"string"},"locale":{"enum":["en","fr","de","it","es","nl","ar","bn","gu","hi","id","ja","ko","ml","mr","mt","pl","pt","ru","sv","ta","te","th","tl","tr","uk","ur","vi"],"type":"string"},"name":{"type":"string","minLength":2,"maxLength":200},"description":{"type":"string","minLength":2,"maxLength":10000},"pictureUrl":{"format":"url","type":"string"},"terms":{"type":"string","maxLength":25000},"summary":{"type":"string"},"logoUrl":{"format":"url","type":"string"},"redemptionMessage":{"type":"string"}},"type":"object","required":["locale"]}}}} ``` ## The RewardCategoryDetails object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"RewardCategoryDetails":{"properties":{"locale":{"enum":["en","fr","de","it","es","nl","ar","bn","gu","hi","id","ja","ko","ml","mr","mt","pl","pt","ru","sv","ta","te","th","tl","tr","uk","ur","vi"],"type":"string"},"name":{"type":"string","minLength":2,"maxLength":64},"pictureUrl":{"format":"url","type":"string"},"description":{"minLength":2,"maxLength":5000,"type":"string"}},"type":"object","required":["locale"]}}}} ``` ## The NumberDerivationArgument object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"NumberDerivationArgument":{"properties":{"type":{"enum":["JSON_VALUE","NUMBER","PAYLOAD_QUERY"],"type":"string"},"value":{"pattern":"^[+-]?[0-9]+(\\.[0-9]+)?$","type":"string"}},"type":"object","required":["type","value"]}}}} ``` ## The JsonValueDerivationArgument object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"JsonValueDerivationArgument":{"properties":{"type":{"enum":["JSON_VALUE","NUMBER","PAYLOAD_QUERY"],"type":"string"},"value":{"type":"string"}},"type":"object","required":["type","value"]}}}} ``` ## The QueryDerivationArgument object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"QueryDerivationArgument":{"properties":{"type":{"enum":["JSON_VALUE","NUMBER","PAYLOAD_QUERY"],"type":"string"},"value":{"type":"string"}},"type":"object","required":["type","value"]}}}} ``` ## The Derivation object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"Derivation":{"properties":{"operation":{"enum":["SUM","PRODUCT"],"type":"string"},"arguments":{"items":{"type":"object"},"type":"array"},"max":{"type":"number"},"roundingDirection":{"enum":["UP","DOWN"],"type":"string"},"roundingUnit":{"minimum":1,"type":"integer"}},"type":"object","required":["operation","arguments"]}}}} ``` ## The LinkConfig object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"LinkConfig":{"properties":{"title":{"type":"string","minLength":2,"maxLength":1024},"description":{"type":"string","minLength":2,"maxLength":1024},"imageUrl":{"format":"url","type":"string"},"desktopUrl":{"format":"url","type":"string"},"androidUrl":{"format":"url","type":"string"},"iosUrl":{"format":"url","type":"string"},"androidUriScheme":{"type":"string","minLength":2,"maxLength":256},"channel":{"type":"string","minLength":1,"maxLength":256},"feature":{"type":"string","minLength":1,"maxLength":256},"tags":{"items":{"type":"string"},"type":"array"}},"type":"object","required":["title","description","desktopUrl"]}}}} ``` ## The OAuth2ClientCredentialsConfig object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"OAuth2ClientCredentialsConfig":{"properties":{"tokenUrl":{"format":"url","type":"string"},"clientId":{"type":"string"},"scope":{"type":"string"}},"type":"object","required":["tokenUrl","clientId"]}}}} ``` ## The AwinIntegrationConfig object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"AwinIntegrationConfig":{"properties":{"apiToken":{"type":"string"},"publisherId":{"type":"integer"}},"type":"object","required":["apiToken","publisherId"]}}}} ``` ## The FidelIntegrationConfig object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"FidelIntegrationConfig":{"properties":{"apiKey":{"type":"string"},"programId":{"type":"string"},"accountId":{"type":"string"},"defaultOfferPictureUrl":{"format":"url","type":"string"},"transactionAuthSecret":{"type":"string"},"transactionQualifiedSecret":{"type":"string"},"refundQualifiedSecret":{"type":"string"},"transactionClearedSecret":{"type":"string"},"cardLinkedSecret":{"type":"string"},"qualificationStatus":{"enum":["CLEARED","AUTHORIZED"],"type":"string"},"qualificationRefunds":{"type":"boolean"},"retainExistingRewardName":{"type":"boolean"}},"type":"object","required":["apiKey","programId","accountId"]}}}} ``` ## The QueryTreeFilterConfiguration object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"QueryTreeFilterConfiguration":{"properties":{"queryTree":{},"queryJsonLogic":{}},"type":"object","required":["queryTree","queryJsonLogic"]}}}} ``` ## The MParticleIntegrationConfig object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"MParticleIntegrationConfig":{"properties":{"eventTypeMappings":{"items":{"$ref":"#/components/schemas/MParticleEventTypeMapping"},"type":"array"}},"type":"object","required":["eventTypeMappings"]},"MParticleEventTypeMapping":{"properties":{"mparticleEventType":{"minLength":1,"maxLength":255,"type":"string"},"mparticleEventSubType":{"minLength":1,"maxLength":255,"type":"string"},"wllEventType":{"minLength":1,"maxLength":255,"type":"string"}},"type":"object","required":["mparticleEventType","wllEventType"]}}}} ``` ## The MParticleEventTypeMapping object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"MParticleEventTypeMapping":{"properties":{"mparticleEventType":{"minLength":1,"maxLength":255,"type":"string"},"mparticleEventSubType":{"minLength":1,"maxLength":255,"type":"string"},"wllEventType":{"minLength":1,"maxLength":255,"type":"string"}},"type":"object","required":["mparticleEventType","wllEventType"]}}}} ``` ## The WeGiftIntegrationConfig object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"WeGiftIntegrationConfig":{"properties":{"userId":{"type":"string"},"playground":{"type":"boolean"},"notificationEmail":{"format":"email","type":"string"},"urlExpiryPeriod":{"type":"integer"},"emailTemplate":{"type":"string"},"enableBreakage":{"type":"boolean"},"deliveryMethod":{"enum":["direct","email"],"type":"string"},"apiKey":{"type":"string"},"apiV2Key":{"type":"string"}},"type":"object","required":["playground"]}}}} ``` ## The BranchIntegrationConfig object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"BranchIntegrationConfig":{"properties":{"key":{"type":"string"},"linkDomain":{"type":"string"}},"type":"object","required":["key","linkDomain"]}}}} ``` ## The FinconectaIntegrationConfig object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"FinconectaIntegrationConfig":{"properties":{"providerName":{"minLength":2,"maxLength":64,"type":"string"},"accountSelectionType":{"enum":["ALL","MULTIPLE","SINGLE"],"type":"string"},"authFlowType":{"enum":["TWO_LEGGED_PASSWORD","THREE_LEGGED_AUTHORIZATION"],"type":"string"},"clientTokenBasic":{"type":"string"},"eventTypeMappings":{"items":{"$ref":"#/components/schemas/FinconectaEventTypeMapping"},"type":"array"}},"type":"object","required":["providerName","accountSelectionType","authFlowType","clientTokenBasic","eventTypeMappings"]},"FinconectaEventTypeMapping":{"properties":{"finconectaEventType":{"minLength":1,"maxLength":255,"type":"string"},"wllEventType":{"minLength":1,"maxLength":255,"type":"string"}},"type":"object","required":["finconectaEventType","wllEventType"]}}}} ``` ## The FinconectaEventTypeMapping object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"FinconectaEventTypeMapping":{"properties":{"finconectaEventType":{"minLength":1,"maxLength":255,"type":"string"},"wllEventType":{"minLength":1,"maxLength":255,"type":"string"}},"type":"object","required":["finconectaEventType","wllEventType"]}}}} ``` ## The SimplifiTransactionEvents object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"SimplifiTransactionEvents":{"properties":{"ACCEPTED":{"type":"string"},"CLEARED":{"type":"string"},"DECLINED":{"type":"string"},"SETTLED":{"type":"string"},"REVERSED":{"type":"string"}},"type":"object"}}}} ``` ## The SimplifiIntegrationConfig object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"SimplifiIntegrationConfig":{"properties":{"username":{"type":"string"},"password":{"type":"string"},"restrictedUsername":{"type":"string"},"restrictedPassword":{"type":"string"},"simplifiUrl":{"format":"url","type":"string"},"companyName":{"type":"string"},"cardProgramId":{"format":"uuid","type":"string"},"currency":{"type":"string"},"pointToCurrencyMultiplier":{"type":"number"},"maximumLoad":{"type":"number"},"minimumLoad":{"type":"number"},"maximumBalance":{"type":"number"},"loadCardFlowRequestTimeout":{"type":"number"},"loadStartedEvent":{"type":"string"},"loadFailedEvent":{"type":"string"},"loadSuccessEvent":{"type":"string"},"eventTypes":{"$ref":"#/components/schemas/SimplifiTransactionEvents"}},"type":"object","required":["username","password","restrictedUsername","restrictedPassword","simplifiUrl","companyName","cardProgramId","currency","pointToCurrencyMultiplier","maximumLoad","minimumLoad","maximumBalance","loadCardFlowRequestTimeout","loadStartedEvent","loadFailedEvent","loadSuccessEvent"]},"SimplifiTransactionEvents":{"properties":{"ACCEPTED":{"type":"string"},"CLEARED":{"type":"string"},"DECLINED":{"type":"string"},"SETTLED":{"type":"string"},"REVERSED":{"type":"string"}},"type":"object"}}}} ``` ## The KindredEvents object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"KindredEvents":{"properties":{"PENDING":{"type":"string"},"APPROVED":{"type":"string"}},"type":"object","required":["PENDING","APPROVED"]}}}} ``` ## The KindredIntegrationConfig object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"KindredIntegrationConfig":{"properties":{"clientId":{"type":"string"},"clientSecret":{"type":"string"},"partnerId":{"type":"string"},"countryCode":{"type":"string"},"eventTypes":{"$ref":"#/components/schemas/KindredEvents"},"importDaily":{"type":"boolean"},"importType":{"enum":["FULL","CASHBACK_ONLY","COUPONS_ONLY"],"type":"string"}},"type":"object","required":["clientId","clientSecret","partnerId","countryCode","importDaily"]},"KindredEvents":{"properties":{"PENDING":{"type":"string"},"APPROVED":{"type":"string"}},"type":"object","required":["PENDING","APPROVED"]}}}} ``` ## The KindredRewardMetadata object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"KindredRewardMetadata":{"properties":{"dealId":{"type":"string"},"domains":{"items":{"type":"string"},"type":"array"}},"type":"object","required":["dealId","domains"]}}}} ``` ## The KindredReward object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"KindredReward":{"properties":{"externalId":{"type":"string"}},"type":"object","required":["externalId"]}}}} ``` ## The SimpleConfig object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"SimpleConfig":{"properties":{"expiryBasedOn":{},"dateModifier":{}},"type":"object","required":["expiryBasedOn","dateModifier"]}}}} ``` ## The ExpiryPrediction object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"ExpiryPrediction":{"properties":{"fullExpiryPeriod":{"type":"number"},"remainingPeriod":{"type":"number"}},"type":"object","required":["fullExpiryPeriod","remainingPeriod"]}}}} ``` ## The SegmentIntegrationConfig object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"SegmentIntegrationConfig":{"properties":{"writeKey":{"type":"string"},"overrideIdPath":{"type":"string"},"backupOverrideIdPath":{"type":"string"},"usDataCenter":{"type":"boolean"}},"type":"object","required":["writeKey"]}}}} ``` ## The CalendarWeekRestrictionArg object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"CalendarWeekRestrictionArg":{"properties":{"startOfWeek":{"type":"string","enum":["SUN","MON","TUE","WED","THUR","FRI","SAT"]}},"type":"object","required":["startOfWeek"]}}}} ``` ## The CalendarNumericRestrictionArg object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"CalendarNumericRestrictionArg":{"properties":{"n":{"exclusiveMinimum":true,"minimum":0,"type":"number"}},"type":"object","required":["n"]}}}} ``` ## The BaseRestriction object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"BaseRestriction":{"properties":{"maximumPoints":{"type":"number"}},"type":"object","required":["maximumPoints"]}}}} ``` ## The CalendarWeekRestriction object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"CalendarWeekRestriction":{"properties":{"intervalType":{"type":"string","enum":["CALENDAR_WEEK"]},"arg":{"$ref":"#/components/schemas/CalendarWeekRestrictionArg","type":"object","minProperties":1},"maximumPoints":{"type":"number"}},"type":"object","required":["intervalType","arg","maximumPoints"]},"CalendarWeekRestrictionArg":{"properties":{"startOfWeek":{"type":"string","enum":["SUN","MON","TUE","WED","THUR","FRI","SAT"]}},"type":"object","required":["startOfWeek"]}}}} ``` ## The CalendarNumericRestriction object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"CalendarNumericRestriction":{"properties":{"intervalType":{"type":"string","enum":["RUNNING_HOURS","RUNNING_DAYS"]},"arg":{"$ref":"#/components/schemas/CalendarNumericRestrictionArg","type":"object","minProperties":1},"maximumPoints":{"type":"number"}},"type":"object","required":["intervalType","arg","maximumPoints"]},"CalendarNumericRestrictionArg":{"properties":{"n":{"exclusiveMinimum":true,"minimum":0,"type":"number"}},"type":"object","required":["n"]}}}} ``` ## The MaxPointsConfig object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"MaxPointsConfig":{"properties":{"liabilityEntity":{"enum":["ACTOR","TENANT"],"type":"string"}},"type":"object","required":["liabilityEntity"]}}}} ``` ## The MaxPointsTransactionConfig object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"MaxPointsTransactionConfig":{"properties":{"restriction":{"type":"object"},"liabilityEntity":{"enum":["ACTOR","TENANT"],"type":"string"}},"type":"object","required":["restriction","liabilityEntity"]}}}} ``` ## The MaxPointsBalanceConfig object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"MaxPointsBalanceConfig":{"properties":{"maxPointsInCirculation":{"type":"number"},"liabilityEntity":{"enum":["ACTOR","TENANT"],"type":"string"}},"type":"object","required":["maxPointsInCirculation","liabilityEntity"]}}}} ``` ## The MaxPointsPrediction object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"MaxPointsPrediction":{"properties":{"pointsCap":{"type":"number"},"remainingPoints":{"type":"number"}},"type":"object","required":["pointsCap","remainingPoints"]}}}} ``` ## The StripePayoutIntegrationConfig object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"StripePayoutIntegrationConfig":{"properties":{"apiKey":{"type":"string"},"conversionRate":{"type":"number"},"minimumPayoutAmount":{"type":"number"},"currencyCode":{"type":"string"},"returnUrl":{"type":"string"}},"type":"object","required":["apiKey","conversionRate","minimumPayoutAmount","currencyCode"]}}}} ``` ## The CheckoutIntegrationConfig object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"CheckoutIntegrationConfig":{"properties":{"channelId":{"type":"string"},"secretKey":{"type":"string"},"publicKey":{"type":"string"},"currencyAccountId":{"type":"string"},"conversionRate":{"type":"number"},"minimumPayoutAmount":{"type":"number"},"currencyCode":{"enum":["AED","AFN","ALL","AMD","ANG","AOA","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GIP","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RWF","SAR","SBD","SCR","SEK","SGD","SHP","SLE","SLL","SOS","SRD","STN","SVC","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VES","VND","VUV","WST","XAF","XCD","XDR","XOF","XPF","YER","ZAR","ZMW"],"type":"string"},"name":{"type":"string"},"verifyFidelCards":{"type":"boolean"},"domesticCountryCode":{"type":"string"},"fundsTransferTypeMap":{"type":"object"},"sender":{"type":"object"}},"type":"object","required":["channelId","secretKey","publicKey","currencyAccountId","conversionRate","minimumPayoutAmount","currencyCode","domesticCountryCode","fundsTransferTypeMap","sender"]}}}} ``` ## The WalletTheme object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"WalletTheme":{"properties":{"backgroundColor":{"type":"string"},"foregroundColor":{"type":"string"},"labelColor":{"type":"string"},"icon":{"type":"string"},"icon2x":{"type":"string"},"logo":{"type":"string"},"logo2x":{"type":"string"},"strip":{"type":"string"}},"type":"object"}}}} ``` ## The WalletIntegrationConfig object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"WalletIntegrationConfig":{"properties":{"appleSignerCert":{"type":"string"},"appleSignerKey":{"type":"string"},"appleWWDRCert":{"type":"string"},"applePassphrase":{"type":"string"},"appIdentifier":{"type":"string"},"appleTeamId":{"type":"string"},"googleIssuerId":{"type":"string"},"googlePrivateKey":{"type":"string"},"googleClientEmail":{"type":"string"},"applePassModel":{"type":"string"},"googlePassClassId":{"type":"string"},"theme":{"$ref":"#/components/schemas/WalletTheme"},"organizationName":{"type":"string"},"description":{"type":"string"}},"type":"object","required":["appleSignerCert","appleSignerKey","appleWWDRCert","applePassphrase","appIdentifier","appleTeamId","googleIssuerId","googlePrivateKey","googleClientEmail","applePassModel","googlePassClassId","theme","organizationName","description"]},"WalletTheme":{"properties":{"backgroundColor":{"type":"string"},"foregroundColor":{"type":"string"},"labelColor":{"type":"string"},"icon":{"type":"string"},"icon2x":{"type":"string"},"logo":{"type":"string"},"logo2x":{"type":"string"},"strip":{"type":"string"}},"type":"object"}}}} ``` ## The PurchaseRewardsConfig object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"PurchaseRewardsConfig":{"properties":{"rewardIds":{"items":{"format":"uuid","type":"string"},"type":"array"},"autoRedeem":{"type":"boolean"}},"type":"object","required":["rewardIds"]}}}} ``` ## The JsonataFilterConfiguration object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"JsonataFilterConfiguration":{"properties":{"expression":{"type":"string"}},"type":"object","required":["expression"]}}}} ``` ## The KlaviyoIntegrationConfig object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"KlaviyoIntegrationConfig":{"properties":{"codeVerifier":{"type":"string"},"authorizationCode":{"type":"string"},"redirectUrl":{"type":"string"},"audienceMap":{},"consentConfig":{}},"type":"object"}}}} ``` ## The CarltonOneIntegrationConfig object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"CarltonOneIntegrationConfig":{"properties":{"galleryId":{"type":"string"},"environment":{"type":"string","enum":["staging","production"]},"country":{"enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"type":"string"},"language":{"type":"string"}},"type":"object","required":["galleryId","environment","country","language"]}}}} ``` ## The CarltonOneRewardMetadata object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"CarltonOneRewardMetadata":{"properties":{"rewardId":{"type":"string"},"catalogId":{"type":"string"}},"type":"object","required":["rewardId","catalogId"]}}}} ``` ## The MerchandiseReward object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"MerchandiseReward":{"properties":{"stockCapacity":{"minimum":0,"type":"integer"},"requiresDeliveryAddress":{"type":"boolean"},"allowedCountries":{"items":{"type":"string"},"type":"array"}},"type":"object","required":["stockCapacity","requiresDeliveryAddress"]}}}} ``` ## The ShippingAddress object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"ShippingAddress":{"properties":{"recipientName":{"type":"string"},"streetAddress":{"type":"string"},"city":{"type":"string"},"region":{"type":"string"},"postcode":{"type":"string"},"country":{"type":"string"},"telephoneNumber":{"type":"string"}},"type":"object","required":["recipientName","streetAddress","city","postcode","country"]}}}} ``` ## The EarningCampaignDetails object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"EarningCampaignDetails":{"properties":{"locale":{"enum":["en","fr","de","it","es","nl","ar","bn","gu","hi","id","ja","ko","ml","mr","mt","pl","pt","ru","sv","ta","te","th","tl","tr","uk","ur","vi"],"type":"string"},"name":{"minLength":2,"maxLength":128,"type":"string"},"description":{"minLength":2,"maxLength":5000,"type":"string"},"pictureUrl":{"format":"url","type":"string"}},"type":"object","required":["locale"]}}}} ``` ## The MissionDetails object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"MissionDetails":{"properties":{"locale":{"enum":["en","fr","de","it","es","nl","ar","bn","gu","hi","id","ja","ko","ml","mr","mt","pl","pt","ru","sv","ta","te","th","tl","tr","uk","ur","vi"],"type":"string"},"name":{"minLength":2,"maxLength":128,"type":"string"},"description":{"minLength":2,"maxLength":5000,"type":"string"},"pictureUrl":{"format":"url","type":"string"}},"type":"object","required":["locale"]}}}} ``` ## The ProfileDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"ProfileDefinition":{"properties":{"attributes":{"type":"object"}},"type":"object"}}}} ``` ## The UserProfileDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"UserProfileDefinition":{"properties":{"familyName":{"type":"string","minLength":1,"maxLength":64},"givenName":{"type":"string","minLength":1,"maxLength":64},"emailAddress":{"format":"email","type":"string"},"gender":{"enum":["FEMALE","MALE","OTHER","UNKNOWN"],"type":"string"},"birthdate":{"pattern":"^(19[0-9][0-9]|20[0-3][0-9])-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","type":"string"},"country":{"enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"type":"string"},"city":{"type":"string","minLength":1,"maxLength":256},"postcode":{"type":"string","minLength":1,"maxLength":128},"pictureUrl":{"format":"url","type":"string"},"streetAddress":{"minLength":1,"maxLength":64,"type":"string"},"telephoneNumber":{"type":"string"},"region":{"type":"string"},"attributionData":{"type":"object"},"attributes":{"type":"object"}},"type":"object","required":["familyName","givenName"]}}}} ``` ## The AttributeKeyValuePair object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"AttributeKeyValuePair":{"properties":{"isEnabled":{"type":"boolean"},"key":{"minLength":1,"maxLength":255,"type":"string"},"value":{}},"type":"object","required":["isEnabled","key","value"]}}}} ``` ## The ReactionDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"ReactionDefinition":{"properties":{"type":{"enum":["HANDLER","REWARD","POINTS","POINTS_CAP","WEBHOOK","ATTRIBUTE","BADGE"],"type":"string"},"handler":{"enum":["EXAMPLE","REFERRAL_TRANCHE_STATUS","MISSION_PROGRESS"],"type":"string"},"points":{"$ref":"#/components/schemas/Derivation"},"attributes":{"items":{"$ref":"#/components/schemas/AttributeKeyValuePair"},"type":"array"},"reward":{},"autoRedeem":{"type":"boolean"},"url":{"format":"url","type":"string"},"forFailure":{"type":"boolean"},"headers":{"type":"object"},"authType":{"enum":["NONE","OAUTH2_CLIENT_CREDENTIALS"],"type":"string"},"authConfig":{"type":"object"},"includeFullSubject":{"type":"boolean"},"badge":{}},"type":"object","required":["type"]},"Derivation":{"properties":{"operation":{"enum":["SUM","PRODUCT"],"type":"string"},"arguments":{"items":{"type":"object"},"type":"array"},"max":{"type":"number"},"roundingDirection":{"enum":["UP","DOWN"],"type":"string"},"roundingUnit":{"minimum":1,"type":"integer"}},"type":"object","required":["operation","arguments"]},"AttributeKeyValuePair":{"properties":{"isEnabled":{"type":"boolean"},"key":{"minLength":1,"maxLength":255,"type":"string"},"value":{}},"type":"object","required":["isEnabled","key","value"]}}}} ``` ## The EventReactorDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"EventReactorDefinition":{"properties":{"name":{"type":"string","minLength":2,"maxLength":64,"pattern":"^[\\x00-\\x7F]+$"},"description":{"type":"string","minLength":2,"maxLength":1024,"pattern":"^[\\x00-\\x7F]+$"},"eventType":{},"reactions":{"items":{"$ref":"#/components/schemas/ReactionDefinition"},"type":"array"},"constraint":{"type":"object"},"maxActivations":{"minimum":1,"type":"integer"},"activationContext":{"enum":["GLOBAL","TENANT","SUBJECT"],"type":"string"},"activationCalculationType":{"type":"object"},"activationPeriod":{"type":"object"},"effectivity":{"$ref":"#/components/schemas/Effectivity"},"isLocked":{},"ownerId":{},"ownerType":{}},"type":"object","required":["name","eventType"]},"ReactionDefinition":{"properties":{"type":{"enum":["HANDLER","REWARD","POINTS","POINTS_CAP","WEBHOOK","ATTRIBUTE","BADGE"],"type":"string"},"handler":{"enum":["EXAMPLE","REFERRAL_TRANCHE_STATUS","MISSION_PROGRESS"],"type":"string"},"points":{"$ref":"#/components/schemas/Derivation"},"attributes":{"items":{"$ref":"#/components/schemas/AttributeKeyValuePair"},"type":"array"},"reward":{},"autoRedeem":{"type":"boolean"},"url":{"format":"url","type":"string"},"forFailure":{"type":"boolean"},"headers":{"type":"object"},"authType":{"enum":["NONE","OAUTH2_CLIENT_CREDENTIALS"],"type":"string"},"authConfig":{"type":"object"},"includeFullSubject":{"type":"boolean"},"badge":{}},"type":"object","required":["type"]},"Derivation":{"properties":{"operation":{"enum":["SUM","PRODUCT"],"type":"string"},"arguments":{"items":{"type":"object"},"type":"array"},"max":{"type":"number"},"roundingDirection":{"enum":["UP","DOWN"],"type":"string"},"roundingUnit":{"minimum":1,"type":"integer"}},"type":"object","required":["operation","arguments"]},"AttributeKeyValuePair":{"properties":{"isEnabled":{"type":"boolean"},"key":{"minLength":1,"maxLength":255,"type":"string"},"value":{}},"type":"object","required":["isEnabled","key","value"]},"Effectivity":{"properties":{"start":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"end":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]}},"type":"object","required":["start"]}}}} ``` ## The FilterDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"FilterDefinition":{"properties":{"type":{"enum":["QUERY_TREE","CUSTOM_RULE","JSONATA"],"type":"string"},"ruleProperties":{"type":"object"},"resultParams":{"$ref":"#/components/schemas/FilterResultParams","items":{"$ref":"#/components/schemas/FilterResultParams"},"type":"array"},"configuration":{},"name":{"minLength":1,"maxLength":255,"type":"string"},"priority":{"type":"number"}},"type":"object","required":["type","resultParams","name","priority"]},"FilterResultParams":{"properties":{"success":{"items":{"$ref":"#/components/schemas/KeyValuePair"},"type":"array"},"failure":{"items":{"$ref":"#/components/schemas/KeyValuePair"},"type":"array"}},"type":"object","required":["success","failure"]},"KeyValuePair":{"properties":{"key":{"minLength":1,"maxLength":255,"type":"string"},"value":{}},"type":"object","required":["key","value"]}}}} ``` ## The TriggerDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"TriggerDefinition":{"properties":{"type":{"enum":["DAILY_SCHEDULED_JOB","HOURLY_SCHEDULED_JOB","EVENT_REACTOR","MANUAL_FOR_ONE","MANUAL_FOR_ALL","DAILY_POST_POINTS_LIABILITY"],"type":"string"},"name":{"type":"string","minLength":2,"maxLength":64,"pattern":"^[\\x00-\\x7F]+$"},"eventReactorDefinition":{"$ref":"#/components/schemas/EventReactorDefinition"}},"type":"object","required":["type","name"]},"EventReactorDefinition":{"properties":{"name":{"type":"string","minLength":2,"maxLength":64,"pattern":"^[\\x00-\\x7F]+$"},"description":{"type":"string","minLength":2,"maxLength":1024,"pattern":"^[\\x00-\\x7F]+$"},"eventType":{},"reactions":{"items":{"$ref":"#/components/schemas/ReactionDefinition"},"type":"array"},"constraint":{"type":"object"},"maxActivations":{"minimum":1,"type":"integer"},"activationContext":{"enum":["GLOBAL","TENANT","SUBJECT"],"type":"string"},"activationCalculationType":{"type":"object"},"activationPeriod":{"type":"object"},"effectivity":{"$ref":"#/components/schemas/Effectivity"},"isLocked":{},"ownerId":{},"ownerType":{}},"type":"object","required":["name","eventType"]},"ReactionDefinition":{"properties":{"type":{"enum":["HANDLER","REWARD","POINTS","POINTS_CAP","WEBHOOK","ATTRIBUTE","BADGE"],"type":"string"},"handler":{"enum":["EXAMPLE","REFERRAL_TRANCHE_STATUS","MISSION_PROGRESS"],"type":"string"},"points":{"$ref":"#/components/schemas/Derivation"},"attributes":{"items":{"$ref":"#/components/schemas/AttributeKeyValuePair"},"type":"array"},"reward":{},"autoRedeem":{"type":"boolean"},"url":{"format":"url","type":"string"},"forFailure":{"type":"boolean"},"headers":{"type":"object"},"authType":{"enum":["NONE","OAUTH2_CLIENT_CREDENTIALS"],"type":"string"},"authConfig":{"type":"object"},"includeFullSubject":{"type":"boolean"},"badge":{}},"type":"object","required":["type"]},"Derivation":{"properties":{"operation":{"enum":["SUM","PRODUCT"],"type":"string"},"arguments":{"items":{"type":"object"},"type":"array"},"max":{"type":"number"},"roundingDirection":{"enum":["UP","DOWN"],"type":"string"},"roundingUnit":{"minimum":1,"type":"integer"}},"type":"object","required":["operation","arguments"]},"AttributeKeyValuePair":{"properties":{"isEnabled":{"type":"boolean"},"key":{"minLength":1,"maxLength":255,"type":"string"},"value":{}},"type":"object","required":["isEnabled","key","value"]},"Effectivity":{"properties":{"start":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"end":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]}},"type":"object","required":["start"]}}}} ``` ## The LogicDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"LogicDefinition":{"properties":{"name":{"type":"string","minLength":2,"maxLength":200},"isActive":{"type":"boolean"},"triggers":{"items":{"$ref":"#/components/schemas/TriggerDefinition"},"type":"array"},"filters":{"items":{"$ref":"#/components/schemas/FilterDefinition"},"type":"array"},"reactions":{"items":{"$ref":"#/components/schemas/ReactionDefinition"},"type":"array"},"ownerId":{"format":"uuid","type":"string"},"ownerDomain":{"enum":["CAMPAIGN_TRANCHE","AUDIENCE","REWARD_AVAILABILITY","USER_BASED_VISIBILITY"],"type":"string"}},"type":"object","required":["name","isActive","triggers","filters","reactions","ownerDomain"]},"TriggerDefinition":{"properties":{"type":{"enum":["DAILY_SCHEDULED_JOB","HOURLY_SCHEDULED_JOB","EVENT_REACTOR","MANUAL_FOR_ONE","MANUAL_FOR_ALL","DAILY_POST_POINTS_LIABILITY"],"type":"string"},"name":{"type":"string","minLength":2,"maxLength":64,"pattern":"^[\\x00-\\x7F]+$"},"eventReactorDefinition":{"$ref":"#/components/schemas/EventReactorDefinition"}},"type":"object","required":["type","name"]},"EventReactorDefinition":{"properties":{"name":{"type":"string","minLength":2,"maxLength":64,"pattern":"^[\\x00-\\x7F]+$"},"description":{"type":"string","minLength":2,"maxLength":1024,"pattern":"^[\\x00-\\x7F]+$"},"eventType":{},"reactions":{"items":{"$ref":"#/components/schemas/ReactionDefinition"},"type":"array"},"constraint":{"type":"object"},"maxActivations":{"minimum":1,"type":"integer"},"activationContext":{"enum":["GLOBAL","TENANT","SUBJECT"],"type":"string"},"activationCalculationType":{"type":"object"},"activationPeriod":{"type":"object"},"effectivity":{"$ref":"#/components/schemas/Effectivity"},"isLocked":{},"ownerId":{},"ownerType":{}},"type":"object","required":["name","eventType"]},"ReactionDefinition":{"properties":{"type":{"enum":["HANDLER","REWARD","POINTS","POINTS_CAP","WEBHOOK","ATTRIBUTE","BADGE"],"type":"string"},"handler":{"enum":["EXAMPLE","REFERRAL_TRANCHE_STATUS","MISSION_PROGRESS"],"type":"string"},"points":{"$ref":"#/components/schemas/Derivation"},"attributes":{"items":{"$ref":"#/components/schemas/AttributeKeyValuePair"},"type":"array"},"reward":{},"autoRedeem":{"type":"boolean"},"url":{"format":"url","type":"string"},"forFailure":{"type":"boolean"},"headers":{"type":"object"},"authType":{"enum":["NONE","OAUTH2_CLIENT_CREDENTIALS"],"type":"string"},"authConfig":{"type":"object"},"includeFullSubject":{"type":"boolean"},"badge":{}},"type":"object","required":["type"]},"Derivation":{"properties":{"operation":{"enum":["SUM","PRODUCT"],"type":"string"},"arguments":{"items":{"type":"object"},"type":"array"},"max":{"type":"number"},"roundingDirection":{"enum":["UP","DOWN"],"type":"string"},"roundingUnit":{"minimum":1,"type":"integer"}},"type":"object","required":["operation","arguments"]},"AttributeKeyValuePair":{"properties":{"isEnabled":{"type":"boolean"},"key":{"minLength":1,"maxLength":255,"type":"string"},"value":{}},"type":"object","required":["isEnabled","key","value"]},"Effectivity":{"properties":{"start":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"end":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]}},"type":"object","required":["start"]},"FilterDefinition":{"properties":{"type":{"enum":["QUERY_TREE","CUSTOM_RULE","JSONATA"],"type":"string"},"ruleProperties":{"type":"object"},"resultParams":{"$ref":"#/components/schemas/FilterResultParams","items":{"$ref":"#/components/schemas/FilterResultParams"},"type":"array"},"configuration":{},"name":{"minLength":1,"maxLength":255,"type":"string"},"priority":{"type":"number"}},"type":"object","required":["type","resultParams","name","priority"]},"FilterResultParams":{"properties":{"success":{"items":{"$ref":"#/components/schemas/KeyValuePair"},"type":"array"},"failure":{"items":{"$ref":"#/components/schemas/KeyValuePair"},"type":"array"}},"type":"object","required":["success","failure"]},"KeyValuePair":{"properties":{"key":{"minLength":1,"maxLength":255,"type":"string"},"value":{}},"type":"object","required":["key","value"]}}}} ``` ## The LogicPatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"LogicPatch":{"properties":{"name":{"type":"string","minLength":2,"maxLength":200},"isActive":{"type":"boolean"},"triggers":{"items":{"$ref":"#/components/schemas/TriggerDefinition"},"type":"array"},"filters":{"items":{"$ref":"#/components/schemas/FilterDefinition"},"type":"array"},"reactions":{"items":{"$ref":"#/components/schemas/ReactionDefinition"},"type":"array"}},"type":"object"},"TriggerDefinition":{"properties":{"type":{"enum":["DAILY_SCHEDULED_JOB","HOURLY_SCHEDULED_JOB","EVENT_REACTOR","MANUAL_FOR_ONE","MANUAL_FOR_ALL","DAILY_POST_POINTS_LIABILITY"],"type":"string"},"name":{"type":"string","minLength":2,"maxLength":64,"pattern":"^[\\x00-\\x7F]+$"},"eventReactorDefinition":{"$ref":"#/components/schemas/EventReactorDefinition"}},"type":"object","required":["type","name"]},"EventReactorDefinition":{"properties":{"name":{"type":"string","minLength":2,"maxLength":64,"pattern":"^[\\x00-\\x7F]+$"},"description":{"type":"string","minLength":2,"maxLength":1024,"pattern":"^[\\x00-\\x7F]+$"},"eventType":{},"reactions":{"items":{"$ref":"#/components/schemas/ReactionDefinition"},"type":"array"},"constraint":{"type":"object"},"maxActivations":{"minimum":1,"type":"integer"},"activationContext":{"enum":["GLOBAL","TENANT","SUBJECT"],"type":"string"},"activationCalculationType":{"type":"object"},"activationPeriod":{"type":"object"},"effectivity":{"$ref":"#/components/schemas/Effectivity"},"isLocked":{},"ownerId":{},"ownerType":{}},"type":"object","required":["name","eventType"]},"ReactionDefinition":{"properties":{"type":{"enum":["HANDLER","REWARD","POINTS","POINTS_CAP","WEBHOOK","ATTRIBUTE","BADGE"],"type":"string"},"handler":{"enum":["EXAMPLE","REFERRAL_TRANCHE_STATUS","MISSION_PROGRESS"],"type":"string"},"points":{"$ref":"#/components/schemas/Derivation"},"attributes":{"items":{"$ref":"#/components/schemas/AttributeKeyValuePair"},"type":"array"},"reward":{},"autoRedeem":{"type":"boolean"},"url":{"format":"url","type":"string"},"forFailure":{"type":"boolean"},"headers":{"type":"object"},"authType":{"enum":["NONE","OAUTH2_CLIENT_CREDENTIALS"],"type":"string"},"authConfig":{"type":"object"},"includeFullSubject":{"type":"boolean"},"badge":{}},"type":"object","required":["type"]},"Derivation":{"properties":{"operation":{"enum":["SUM","PRODUCT"],"type":"string"},"arguments":{"items":{"type":"object"},"type":"array"},"max":{"type":"number"},"roundingDirection":{"enum":["UP","DOWN"],"type":"string"},"roundingUnit":{"minimum":1,"type":"integer"}},"type":"object","required":["operation","arguments"]},"AttributeKeyValuePair":{"properties":{"isEnabled":{"type":"boolean"},"key":{"minLength":1,"maxLength":255,"type":"string"},"value":{}},"type":"object","required":["isEnabled","key","value"]},"Effectivity":{"properties":{"start":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"end":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]}},"type":"object","required":["start"]},"FilterDefinition":{"properties":{"type":{"enum":["QUERY_TREE","CUSTOM_RULE","JSONATA"],"type":"string"},"ruleProperties":{"type":"object"},"resultParams":{"$ref":"#/components/schemas/FilterResultParams","items":{"$ref":"#/components/schemas/FilterResultParams"},"type":"array"},"configuration":{},"name":{"minLength":1,"maxLength":255,"type":"string"},"priority":{"type":"number"}},"type":"object","required":["type","resultParams","name","priority"]},"FilterResultParams":{"properties":{"success":{"items":{"$ref":"#/components/schemas/KeyValuePair"},"type":"array"},"failure":{"items":{"$ref":"#/components/schemas/KeyValuePair"},"type":"array"}},"type":"object","required":["success","failure"]},"KeyValuePair":{"properties":{"key":{"minLength":1,"maxLength":255,"type":"string"},"value":{}},"type":"object","required":["key","value"]}}}} ``` ## The ReferralActivityDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"ReferralActivityDefinition":{"properties":{"source":{"enum":["EMAIL","FACEBOOK","TWITTER","LINKEDIN","OTHER"],"type":"string"},"sourceUserId":{"type":"string"},"userAgent":{"enum":["IOS","ANDROID","WEB","UNKNOWN"],"type":"string"},"ipAddress":{"type":"string"},"activityType":{"enum":["CLICK","REGISTER"],"type":"string"},"registeredUserAuthIdentifier":{"type":"string"}},"type":"object","required":["source","sourceUserId","activityType"]}}}} ``` ## The ReferralDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"ReferralDefinition":{"properties":{"clickCount":{"type":"integer"},"source":{"enum":["EMAIL","FACEBOOK","TWITTER","LINKEDIN","OTHER"],"type":"string"},"sourceUserId":{"type":"string"},"userAgent":{"enum":["IOS","ANDROID","WEB","UNKNOWN"],"type":"string"},"ipAddress":{"type":"string"}},"type":"object","required":["clickCount","source","sourceUserId"]}}}} ``` ## The ReferralPatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"ReferralPatch":{"properties":{"clickCount":{"type":"integer"},"source":{"enum":["EMAIL","FACEBOOK","TWITTER","LINKEDIN","OTHER"],"type":"string"},"userAgent":{"enum":["IOS","ANDROID","WEB","UNKNOWN"],"type":"string"},"ipAddress":{"type":"string"}},"type":"object"}}}} ``` ## The TrancheStatusUpdateDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"TrancheStatusUpdateDefinition":{"properties":{"type":{"pattern":"^[A-Z]+(_[A-Z]+)*$","type":"string","minLength":2,"maxLength":64},"subject":{"minLength":1,"maxLength":128,"type":"string"},"payload":{"type":"object"}},"type":"object","required":["type","subject","payload"]}}}} ``` ## The EventReactorPatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"EventReactorPatch":{"properties":{"name":{"type":"string","minLength":2,"maxLength":64,"pattern":"^[\\x00-\\x7F]+$"},"description":{"type":"string","minLength":2,"maxLength":1024,"pattern":"^[\\x00-\\x7F]+$"},"constraint":{"type":"object"},"maxActivations":{"minimum":1,"type":"integer"},"activationContext":{"enum":["GLOBAL","TENANT","SUBJECT"],"type":"string"},"activationCalculationType":{"type":"object"},"activationPeriod":{"type":"object"},"reactions":{"items":{"$ref":"#/components/schemas/ReactionDefinition"},"type":"array"},"effectivity":{"$ref":"#/components/schemas/Effectivity"}},"type":"object"},"ReactionDefinition":{"properties":{"type":{"enum":["HANDLER","REWARD","POINTS","POINTS_CAP","WEBHOOK","ATTRIBUTE","BADGE"],"type":"string"},"handler":{"enum":["EXAMPLE","REFERRAL_TRANCHE_STATUS","MISSION_PROGRESS"],"type":"string"},"points":{"$ref":"#/components/schemas/Derivation"},"attributes":{"items":{"$ref":"#/components/schemas/AttributeKeyValuePair"},"type":"array"},"reward":{},"autoRedeem":{"type":"boolean"},"url":{"format":"url","type":"string"},"forFailure":{"type":"boolean"},"headers":{"type":"object"},"authType":{"enum":["NONE","OAUTH2_CLIENT_CREDENTIALS"],"type":"string"},"authConfig":{"type":"object"},"includeFullSubject":{"type":"boolean"},"badge":{}},"type":"object","required":["type"]},"Derivation":{"properties":{"operation":{"enum":["SUM","PRODUCT"],"type":"string"},"arguments":{"items":{"type":"object"},"type":"array"},"max":{"type":"number"},"roundingDirection":{"enum":["UP","DOWN"],"type":"string"},"roundingUnit":{"minimum":1,"type":"integer"}},"type":"object","required":["operation","arguments"]},"AttributeKeyValuePair":{"properties":{"isEnabled":{"type":"boolean"},"key":{"minLength":1,"maxLength":255,"type":"string"},"value":{}},"type":"object","required":["isEnabled","key","value"]},"Effectivity":{"properties":{"start":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"end":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]}},"type":"object","required":["start"]}}}} ``` ## The EventTypePatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"EventTypePatch":{"properties":{"name":{"type":"string","pattern":"^[A-Z]+(_[A-Z]+)*$","minLength":2,"maxLength":64},"description":{"type":"string","minLength":2,"maxLength":1024,"pattern":"^[\\x00-\\x7F]+$"},"schema":{"type":"object"},"metaTypeMappings":{"items":{"$ref":"#/components/schemas/MetaTypeMapping"},"type":"array"},"enhancers":{"items":{"enum":["AUDIENCE_ENHANCER","POINTS_ENHANCER","REFERRAL_DETAILS","CODE_POOL","RANDOM_NUMBER","TEST"],"type":"string"},"type":"array"},"isActive":{"type":"boolean"},"omitFromUserActivity":{"type":"boolean"},"isPrivate":{"type":"boolean"}},"type":"object"},"MetaTypeMapping":{"properties":{"metaType":{"enum":["TRANSACTION"],"type":"string"},"metaPayloadConfig":{"type":"object"},"metaConstraint":{"type":"object"}},"type":"object","required":["metaType"]}}}} ``` ## The RewardFacade object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"RewardFacade":{"properties":{"externalId":{"type":"string"},"stockCapacity":{"minimum":0,"type":"integer"},"requiresDeliveryAddress":{"type":"boolean"},"allowedCountries":{"items":{"type":"string"},"type":"array"},"locale":{"enum":["en","fr","de","it","es","nl","ar","bn","gu","hi","id","ja","ko","ml","mr","mt","pl","pt","ru","sv","ta","te","th","tl","tr","uk","ur","vi"],"type":"string"},"name":{"type":"string","minLength":2,"maxLength":200},"description":{"type":"string","minLength":2,"maxLength":10000},"pictureUrl":{"format":"url","type":"string"},"terms":{"type":"string","maxLength":25000},"summary":{"type":"string"},"logoUrl":{"format":"url","type":"string"},"redemptionMessage":{"type":"string"}},"type":"object","required":["externalId","stockCapacity","requiresDeliveryAddress","locale"]}}}} ``` ## The Gallery object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"Gallery":{"properties":{"id":{"minLength":1,"type":"string"},"name":{"minLength":1,"type":"string"},"status":{"type":"string","enum":["Active","Inactive"]},"partner_id":{"minLength":1,"type":"string"}},"type":"object","required":["id","name","status","partner_id"]}}}} ``` ## The Catalog object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"Catalog":{"properties":{"id":{"minLength":1,"type":"string"},"type":{"minLength":1,"type":"string"}},"type":"object","required":["id","type"]}}}} ``` ## The ValidateOrderResponse object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"ValidateOrderResponse":{"properties":{"valid_status":{"type":"boolean"}},"type":"object"}}}} ``` ## The OrderItemStatus object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"OrderItemStatus":{"properties":{"validation_errors":{},"line_item_id":{"minLength":1,"type":"string"},"status":{"minLength":1,"type":"string"},"extra":{"type":"string"},"partner_order_number":{"minLength":1,"type":"string"},"order_item_history":{"items":{},"type":"array"},"details":{"items":{},"type":"array"},"categories":{"items":{},"type":"array"},"user_defined_fields":{"items":{},"type":"array"}},"type":"object","required":["line_item_id","status","partner_order_number"]}}}} ``` ## The OrderResponse object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"OrderResponse":{"properties":{"validation_errors":{},"order_item_statuses":{"minLength":1,"type":"array","items":{}},"order_id":{"minLength":1,"type":"string"},"status":{"minLength":1,"type":"string"}},"type":"object","required":["order_item_statuses","order_id","status"]}}}} ``` ## The CarltonOneCredentials object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"CarltonOneCredentials":{"properties":{"clientId":{"minLength":1,"type":"string"},"clientSecret":{"minLength":1,"type":"string"},"username":{"minLength":1,"type":"string"},"password":{"minLength":1,"type":"string"}},"type":"object","required":["clientId","clientSecret","username","password"]}}}} ``` ## The ExpiryData object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"ExpiryData":{"properties":{"isExpired":{"type":"boolean"},"pointsBalance":{"type":"number"},"prediction":{"$ref":"#/components/schemas/ExpiryPrediction","type":"object"}},"type":"object","required":["isExpired"]},"ExpiryPrediction":{"properties":{"fullExpiryPeriod":{"type":"number"},"remainingPeriod":{"type":"number"}},"type":"object","required":["fullExpiryPeriod","remainingPeriod"]}}}} ``` ## The MaxPointsLiabilityData object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"MaxPointsLiabilityData":{"properties":{"isLiable":{"type":"boolean"},"prediction":{"$ref":"#/components/schemas/MaxPointsPrediction","type":"object"}},"type":"object","required":["isLiable"]},"MaxPointsPrediction":{"properties":{"pointsCap":{"type":"number"},"remainingPoints":{"type":"number"}},"type":"object","required":["pointsCap","remainingPoints"]}}}} ``` ## The ExpiryPredictionSummaryPeriodEntry object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"ExpiryPredictionSummaryPeriodEntry":{"properties":{"pointsDueToExpire":{"type":"number"},"timePeriod":{"type":"number"}},"type":"object","required":["pointsDueToExpire","timePeriod"]}}}} ``` ## The MaxPointsPredictionSummaryEntry object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"MaxPointsPredictionSummaryEntry":{"properties":{"percentageUsed":{"type":"number"},"pointsCap":{"type":"number"},"remainingPoints":{"type":"number"}},"type":"object","required":["percentageUsed","pointsCap","remainingPoints"]}}}} ``` ## The ExpiryResultDetails object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"ExpiryResultDetails":{"properties":{"expiryDetails":{"additionalProperties":{"$ref":"#/components/schemas/ExpiryData"},"type":"object"}},"type":"object","required":["expiryDetails"]},"ExpiryData":{"properties":{"isExpired":{"type":"boolean"},"pointsBalance":{"type":"number"},"prediction":{"$ref":"#/components/schemas/ExpiryPrediction","type":"object"}},"type":"object","required":["isExpired"]},"ExpiryPrediction":{"properties":{"fullExpiryPeriod":{"type":"number"},"remainingPeriod":{"type":"number"}},"type":"object","required":["fullExpiryPeriod","remainingPeriod"]}}}} ``` ## The MaxPointsLiabilityResultDetails object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"MaxPointsLiabilityResultDetails":{"properties":{"maxPointsLiabilityDetails":{"$ref":"#/components/schemas/MaxPointsLiabilityData","type":"object"}},"type":"object","required":["maxPointsLiabilityDetails"]},"MaxPointsLiabilityData":{"properties":{"isLiable":{"type":"boolean"},"prediction":{"$ref":"#/components/schemas/MaxPointsPrediction","type":"object"}},"type":"object","required":["isLiable"]},"MaxPointsPrediction":{"properties":{"pointsCap":{"type":"number"},"remainingPoints":{"type":"number"}},"type":"object","required":["pointsCap","remainingPoints"]}}}} ``` ## The MaxPointsPredictionSummary object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"MaxPointsPredictionSummary":{"properties":{"summary":{"$ref":"#/components/schemas/MaxPointsPredictionSummaryEntry"},"type":{"enum":["MAX_POINTS","EXPIRY"],"type":"string"}},"type":"object","required":["type"]},"MaxPointsPredictionSummaryEntry":{"properties":{"percentageUsed":{"type":"number"},"pointsCap":{"type":"number"},"remainingPoints":{"type":"number"}},"type":"object","required":["percentageUsed","pointsCap","remainingPoints"]}}}} ``` ## The ExpiryPredictionSummary object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"ExpiryPredictionSummary":{"properties":{"summary":{"items":{"$ref":"#/components/schemas/ExpiryPredictionSummaryPeriodEntry"},"type":"array"},"type":{"enum":["MAX_POINTS","EXPIRY"],"type":"string"}},"type":"object","required":["summary","type"]},"ExpiryPredictionSummaryPeriodEntry":{"properties":{"pointsDueToExpire":{"type":"number"},"timePeriod":{"type":"number"}},"type":"object","required":["pointsDueToExpire","timePeriod"]}}}} ``` ## The CumulatedPrediction object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"CumulatedPrediction":{"properties":{"overallSummary":{"type":"object"}},"type":"object","required":["overallSummary"]}}}} ``` ## The RewardAvailabilityCriteriaDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"RewardAvailabilityCriteriaDefinition":{"properties":{"criteriaTree":{"type":"object"},"criteriaJsonLogic":{"type":"object"}},"type":"object","required":["criteriaTree","criteriaJsonLogic"]}}}} ``` ## The RewardAvailabilityCriteria object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"RewardAvailabilityCriteria":{"properties":{"id":{"format":"uuid","type":"string"}},"type":"object","required":["id"]}}}} ``` ## The RewardDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"RewardDefinition":{"properties":{"type":{"enum":["AWIN_PROGRAMME","FIDEL_OFFER","GENERIC_OFFER","KINDRED","MERCHANDISE","OLIVE_OFFER","VOUCHER","WEGIFT_PRODUCT","XOXO_PRODUCT","CARLTON_ONE"],"type":"string"},"name":{"type":"string","minLength":2,"maxLength":200},"price":{"maximum":10000000,"type":"integer","minimum":0},"availability":{"$ref":"#/components/schemas/Effectivity"},"purchasable":{"type":"boolean"},"description":{"type":"string","minLength":2,"maxLength":10000},"pictureUrl":{"format":"url","type":"string"},"value":{"maximum":10000000,"type":"integer","minimum":0},"priority":{"minimum":0,"type":"integer"},"terms":{"type":"string","maxLength":25000},"tier":{"$ref":"#/components/schemas/Hydratable"},"venues":{"items":{"$ref":"#/components/schemas/Hydratable"},"type":"array"},"category":{"$ref":"#/components/schemas/Hydratable"},"categories":{"items":{"$ref":"#/components/schemas/Hydratable"},"type":"array"},"summary":{"type":"string"},"redemptionChannels":{"items":{"enum":["IN_STORE","ONLINE"],"type":"string"},"type":"array"},"purchasableForAudiences":{"items":{"$ref":"#/components/schemas/Hydratable"},"type":"array"},"visibilityCriteriaDefinition":{"$ref":"#/components/schemas/RewardAvailabilityCriteriaDefinition"},"clickThroughUrl":{"format":"url","type":"string"},"logoUrl":{"format":"url","type":"string"},"currency":{"pattern":"^[A-Z]{3}$","type":"string"},"country":{"enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"type":"string"},"redemptionMessage":{"type":"string"},"displayUrl":{"format":"url","type":"string"},"brandName":{"type":"string"},"fidelBrandId":{"type":"string"},"fidelOfferId":{"type":"string"},"schemes":{"items":{"type":"string"},"type":"array"},"minTransactionAmount":{"minimum":0,"type":"integer"},"maxTransactionAmount":{"type":"integer"},"returnPeriod":{"minimum":7,"type":"integer"},"qualifiedTransactionsLimit":{"minimum":0,"type":"integer"},"purchaseExpiration":{"type":"integer"},"codeType":{"enum":["HUMAN","OTP","POOL","STATIC"],"type":"string"},"code":{"type":"object"},"codes":{"items":{},"type":"array"},"hideCode":{"type":"boolean"},"notificationConfig":{"$ref":"#/components/schemas/NotificationConfig"},"dynamicUrl":{"type":"boolean"},"productCode":{"type":"string"},"productCodes":{"items":{"type":"string"},"type":"array"},"denomination":{"type":"string"},"margin":{"type":"number"},"payoutType":{"enum":["SINGLE","MULTIPLE","PAY_TO_CARD"],"type":"string"},"productId":{"type":"number"},"details":{"type":"object"},"defaultLocale":{"enum":["en","fr","de","it","es","nl","ar","bn","gu","hi","id","ja","ko","ml","mr","mt","pl","pt","ru","sv","ta","te","th","tl","tr","uk","ur","vi"],"type":"string"},"metadata":{"$ref":"#/components/schemas/CarltonOneRewardMetadata"},"stockCapacity":{"minimum":0,"type":"integer"},"requiresDeliveryAddress":{"type":"boolean"},"allowedCountries":{"items":{"type":"string"},"type":"array"}},"type":"object","required":["type","name","price","availability","purchasable","details"]},"Effectivity":{"properties":{"start":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"end":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]}},"type":"object","required":["start"]},"Hydratable":{"properties":{"id":{"format":"uuid","type":"string"}},"type":"object","required":["id"]},"RewardAvailabilityCriteriaDefinition":{"properties":{"criteriaTree":{"type":"object"},"criteriaJsonLogic":{"type":"object"}},"type":"object","required":["criteriaTree","criteriaJsonLogic"]},"NotificationConfig":{"properties":{"quantity":{"type":"number"},"emails":{"items":{},"type":"array"},"triggered":{"type":"boolean"}},"type":"object","required":["quantity","emails","triggered"]},"CarltonOneRewardMetadata":{"properties":{"rewardId":{"type":"string"},"catalogId":{"type":"string"}},"type":"object","required":["rewardId","catalogId"]}}}} ``` ## The RewardAvailabilityCriteriaPatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"RewardAvailabilityCriteriaPatch":{"properties":{"criteriaTree":{"type":"object"},"criteriaJsonLogic":{"type":"object"}},"type":"object"}}}} ``` ## The RewardPatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"RewardPatch":{"properties":{"name":{"type":"string","minLength":2,"maxLength":200},"description":{"type":"string","minLength":2,"maxLength":10000},"pictureUrl":{"format":"url","type":"string"},"value":{"maximum":10000000,"type":"integer","minimum":0},"price":{"maximum":10000000,"type":"integer","minimum":0},"priority":{"minimum":0,"type":"integer"},"availability":{"$ref":"#/components/schemas/Effectivity"},"purchasable":{"type":"boolean"},"terms":{"type":"string","maxLength":25000},"tier":{},"venues":{},"purchaseExpiration":{"type":"integer"},"hideCode":{"type":"boolean"},"notificationConfig":{"$ref":"#/components/schemas/NotificationConfig"},"redemptionMessage":{"type":"string"},"codes":{"items":{},"type":"array"},"code":{"type":"object"},"category":{"$ref":"#/components/schemas/Hydratable"},"categories":{"items":{"$ref":"#/components/schemas/Hydratable"},"type":"array"},"summary":{"type":"string"},"redemptionChannels":{"items":{"enum":["IN_STORE","ONLINE"],"type":"string"},"type":"array"},"clickThroughUrl":{"format":"url","type":"string"},"displayUrl":{"format":"url","type":"string"},"logoUrl":{"format":"url","type":"string"},"metadata":{"$ref":"#/components/schemas/CarltonOneRewardMetadata"},"currency":{"pattern":"^[A-Z]{3}$","type":"string"},"country":{"enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"type":"string"},"brandName":{"type":"string"},"fidelBrandId":{"type":"string"},"minTransactionAmount":{"minimum":0,"type":"integer"},"maxTransactionAmount":{"type":"integer"},"returnPeriod":{"minimum":7,"type":"integer"},"qualifiedTransactionsLimit":{"minimum":0,"type":"integer"},"schemes":{"items":{"type":"string"},"type":"array"},"productCode":{"type":"string"},"productCodes":{"items":{"type":"string"},"type":"array"},"productId":{"type":"number"},"denomination":{"pattern":"^[0-9]+\\.[0-9]{2}$","type":"string"},"margin":{"type":"number"},"payoutType":{"enum":["SINGLE","MULTIPLE","PAY_TO_CARD"],"type":"string"},"purchasableForAudiences":{"items":{"$ref":"#/components/schemas/Hydratable"},"type":"array"},"visibilityCriteriaPatch":{"$ref":"#/components/schemas/RewardAvailabilityCriteriaPatch"},"details":{"type":"object"},"defaultLocale":{"enum":["en","fr","de","it","es","nl","ar","bn","gu","hi","id","ja","ko","ml","mr","mt","pl","pt","ru","sv","ta","te","th","tl","tr","uk","ur","vi"],"type":"string"},"stockCapacity":{"minimum":0,"type":"integer"},"requiresDeliveryAddress":{"type":"boolean"},"allowedCountries":{"items":{"type":"string"},"type":"array"}},"type":"object","required":["availability"]},"Effectivity":{"properties":{"start":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"end":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]}},"type":"object","required":["start"]},"NotificationConfig":{"properties":{"quantity":{"type":"number"},"emails":{"items":{},"type":"array"},"triggered":{"type":"boolean"}},"type":"object","required":["quantity","emails","triggered"]},"Hydratable":{"properties":{"id":{"format":"uuid","type":"string"}},"type":"object","required":["id"]},"CarltonOneRewardMetadata":{"properties":{"rewardId":{"type":"string"},"catalogId":{"type":"string"}},"type":"object","required":["rewardId","catalogId"]},"RewardAvailabilityCriteriaPatch":{"properties":{"criteriaTree":{"type":"object"},"criteriaJsonLogic":{"type":"object"}},"type":"object"}}}} ``` ## The AwardBadgeCommand object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"AwardBadgeCommand":{"properties":{"badgeId":{"format":"uuid","type":"string"},"beneficiaryId":{"format":"uuid","type":"string"},"comment":{"type":"string"}},"type":"object","required":["badgeId","beneficiaryId"]}}}} ``` ## The HandleEventReactionCommand object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"HandleEventReactionCommand":{"properties":{"eventId":{"type":"number"}},"type":"object","required":["eventId"]}}}} ``` ## The GiveVoucherCommand object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"GiveVoucherCommand":{"properties":{"reward":{"$ref":"#/components/schemas/Hydratable"},"comment":{"type":"string"}},"type":"object","required":["reward"]},"Hydratable":{"properties":{"id":{"format":"uuid","type":"string"}},"type":"object","required":["id"]}}}} ``` ## The VenueContactDetails object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"VenueContactDetails":{"properties":{"type":{"enum":["email","phone","sms","link"],"type":"string"},"name":{"type":"string"},"value":{"type":"string"},"imageUri":{"format":"url","type":"string"}},"type":"object","required":["type","name","value"]}}}} ``` ## The VenueDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"VenueDefinition":{"properties":{"name":{"type":"string","minLength":1,"maxLength":64},"address":{"type":"string","minLength":1,"maxLength":512},"description":{"type":"string","minLength":1,"maxLength":1024},"availability":{"$ref":"#/components/schemas/Effectivity"},"coordinates":{"$ref":"#/components/schemas/GeoPoint"},"attributes":{"$ref":"#/components/schemas/VenueAttributes"},"externalIdentifier":{"maxLength":512,"type":"string"},"isUserModifiable":{"type":"boolean"},"postcode":{"minLength":1,"maxLength":128,"type":"string"},"type":{"enum":["TENANT","USER","MERCHANT"],"type":"string"},"contactDetails":{"items":{"$ref":"#/components/schemas/VenueContactDetails"},"type":"array"}},"type":"object","required":["name","address","availability","coordinates"]},"Effectivity":{"properties":{"start":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"end":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]}},"type":"object","required":["start"]},"GeoPoint":{"properties":{"longitude":{"minimum":-180,"type":"number","maximum":180},"latitude":{"minimum":-90,"type":"number","maximum":90}},"type":"object","required":["longitude","latitude"]},"VenueAttributes":{"properties":{"bookingUrl":{"format":"url","type":"string"},"telephoneNumber":{"type":"string"},"openingTimes":{"type":"object"}},"type":"object"},"VenueContactDetails":{"properties":{"type":{"enum":["email","phone","sms","link"],"type":"string"},"name":{"type":"string"},"value":{"type":"string"},"imageUri":{"format":"url","type":"string"}},"type":"object","required":["type","name","value"]}}}} ``` ## The UserConsentDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"UserConsentDefinition":{"properties":{"type":{"$ref":"#/components/schemas/Hydratable"},"checked":{"type":"boolean"},"user":{"$ref":"#/components/schemas/Hydratable"},"id":{"format":"uuid","type":"string"}},"type":"object","required":["type","checked"]},"Hydratable":{"properties":{"id":{"format":"uuid","type":"string"}},"type":"object","required":["id"]}}}} ``` ## The ActorDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"ActorDefinition":{"properties":{"externalIdentifier":{"maxLength":512,"type":"string"},"isRestricted":{"type":"boolean"},"linkedVenuesDefinitions":{"items":{"$ref":"#/components/schemas/VenueDefinition"},"type":"array"},"linkedVenues":{"items":{"$ref":"#/components/schemas/Hydratable"},"type":"array"},"consentsDefinition":{"items":{"$ref":"#/components/schemas/UserConsentDefinition"},"type":"array"}},"type":"object"},"VenueDefinition":{"properties":{"name":{"type":"string","minLength":1,"maxLength":64},"address":{"type":"string","minLength":1,"maxLength":512},"description":{"type":"string","minLength":1,"maxLength":1024},"availability":{"$ref":"#/components/schemas/Effectivity"},"coordinates":{"$ref":"#/components/schemas/GeoPoint"},"attributes":{"$ref":"#/components/schemas/VenueAttributes"},"externalIdentifier":{"maxLength":512,"type":"string"},"isUserModifiable":{"type":"boolean"},"postcode":{"minLength":1,"maxLength":128,"type":"string"},"type":{"enum":["TENANT","USER","MERCHANT"],"type":"string"},"contactDetails":{"items":{"$ref":"#/components/schemas/VenueContactDetails"},"type":"array"}},"type":"object","required":["name","address","availability","coordinates"]},"Effectivity":{"properties":{"start":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"end":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]}},"type":"object","required":["start"]},"GeoPoint":{"properties":{"longitude":{"minimum":-180,"type":"number","maximum":180},"latitude":{"minimum":-90,"type":"number","maximum":90}},"type":"object","required":["longitude","latitude"]},"VenueAttributes":{"properties":{"bookingUrl":{"format":"url","type":"string"},"telephoneNumber":{"type":"string"},"openingTimes":{"type":"object"}},"type":"object"},"VenueContactDetails":{"properties":{"type":{"enum":["email","phone","sms","link"],"type":"string"},"name":{"type":"string"},"value":{"type":"string"},"imageUri":{"format":"url","type":"string"}},"type":"object","required":["type","name","value"]},"Hydratable":{"properties":{"id":{"format":"uuid","type":"string"}},"type":"object","required":["id"]},"UserConsentDefinition":{"properties":{"type":{"$ref":"#/components/schemas/Hydratable"},"checked":{"type":"boolean"},"user":{"$ref":"#/components/schemas/Hydratable"},"id":{"format":"uuid","type":"string"}},"type":"object","required":["type","checked"]}}}} ``` ## The UserDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"UserDefinition":{"properties":{"profile":{"$ref":"#/components/schemas/UserProfileDefinition"},"authIdentifier":{"maxLength":512,"type":"string"},"referralInviteCode":{"minLength":1,"maxLength":1024,"type":"string"},"userToken":{"minLength":1,"maxLength":1024,"type":"string"},"referralActivity":{"$ref":"#/components/schemas/ReferralActivityDefinition"},"flags":{},"externalIdentifier":{"maxLength":512,"type":"string"},"isRestricted":{"type":"boolean"},"linkedVenuesDefinitions":{"items":{"$ref":"#/components/schemas/VenueDefinition"},"type":"array"},"linkedVenues":{"items":{"$ref":"#/components/schemas/Hydratable"},"type":"array"},"consentsDefinition":{"items":{"$ref":"#/components/schemas/UserConsentDefinition"},"type":"array"}},"type":"object","required":["profile"]},"UserProfileDefinition":{"properties":{"familyName":{"type":"string","minLength":1,"maxLength":64},"givenName":{"type":"string","minLength":1,"maxLength":64},"emailAddress":{"format":"email","type":"string"},"gender":{"enum":["FEMALE","MALE","OTHER","UNKNOWN"],"type":"string"},"birthdate":{"pattern":"^(19[0-9][0-9]|20[0-3][0-9])-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","type":"string"},"country":{"enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"type":"string"},"city":{"type":"string","minLength":1,"maxLength":256},"postcode":{"type":"string","minLength":1,"maxLength":128},"pictureUrl":{"format":"url","type":"string"},"streetAddress":{"minLength":1,"maxLength":64,"type":"string"},"telephoneNumber":{"type":"string"},"region":{"type":"string"},"attributionData":{"type":"object"},"attributes":{"type":"object"}},"type":"object","required":["familyName","givenName"]},"ReferralActivityDefinition":{"properties":{"source":{"enum":["EMAIL","FACEBOOK","TWITTER","LINKEDIN","OTHER"],"type":"string"},"sourceUserId":{"type":"string"},"userAgent":{"enum":["IOS","ANDROID","WEB","UNKNOWN"],"type":"string"},"ipAddress":{"type":"string"},"activityType":{"enum":["CLICK","REGISTER"],"type":"string"},"registeredUserAuthIdentifier":{"type":"string"}},"type":"object","required":["source","sourceUserId","activityType"]},"VenueDefinition":{"properties":{"name":{"type":"string","minLength":1,"maxLength":64},"address":{"type":"string","minLength":1,"maxLength":512},"description":{"type":"string","minLength":1,"maxLength":1024},"availability":{"$ref":"#/components/schemas/Effectivity"},"coordinates":{"$ref":"#/components/schemas/GeoPoint"},"attributes":{"$ref":"#/components/schemas/VenueAttributes"},"externalIdentifier":{"maxLength":512,"type":"string"},"isUserModifiable":{"type":"boolean"},"postcode":{"minLength":1,"maxLength":128,"type":"string"},"type":{"enum":["TENANT","USER","MERCHANT"],"type":"string"},"contactDetails":{"items":{"$ref":"#/components/schemas/VenueContactDetails"},"type":"array"}},"type":"object","required":["name","address","availability","coordinates"]},"Effectivity":{"properties":{"start":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"end":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]}},"type":"object","required":["start"]},"GeoPoint":{"properties":{"longitude":{"minimum":-180,"type":"number","maximum":180},"latitude":{"minimum":-90,"type":"number","maximum":90}},"type":"object","required":["longitude","latitude"]},"VenueAttributes":{"properties":{"bookingUrl":{"format":"url","type":"string"},"telephoneNumber":{"type":"string"},"openingTimes":{"type":"object"}},"type":"object"},"VenueContactDetails":{"properties":{"type":{"enum":["email","phone","sms","link"],"type":"string"},"name":{"type":"string"},"value":{"type":"string"},"imageUri":{"format":"url","type":"string"}},"type":"object","required":["type","name","value"]},"Hydratable":{"properties":{"id":{"format":"uuid","type":"string"}},"type":"object","required":["id"]},"UserConsentDefinition":{"properties":{"type":{"$ref":"#/components/schemas/Hydratable"},"checked":{"type":"boolean"},"user":{"$ref":"#/components/schemas/Hydratable"},"id":{"format":"uuid","type":"string"}},"type":"object","required":["type","checked"]}}}} ``` ## The DeleteUserInAuthProvider object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"DeleteUserInAuthProvider":{"properties":{"userId":{"format":"uuid","type":"string"},"authIdentifier":{"type":"string"}},"type":"object","required":["userId","authIdentifier"]}}}} ``` ## The DeleteUserFidelCardsCommand object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"DeleteUserFidelCardsCommand":{"properties":{"userId":{"format":"uuid","type":"string"},"authIdentifier":{"type":"string"}},"type":"object","required":["userId","authIdentifier"]}}}} ``` ## The BaseEventDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"BaseEventDefinition":{"properties":{"type":{"pattern":"^[A-Z]+(_[A-Z]+)*$","type":"string","minLength":2,"maxLength":64},"payload":{"type":"object"},"occurredAt":{"pattern":"\\d{4}-[01]\\d-[0-3]\\dT[0-2]\\d:[0-5]\\d:[0-5]\\d.\\d+Z?","type":"string"}},"type":"object","required":["type"]}}}} ``` ## The EventDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"EventDefinition":{"properties":{"subject":{"minLength":1,"maxLength":128,"type":"string"},"executor":{"minLength":1,"maxLength":128,"type":"string"},"type":{"pattern":"^[A-Z]+(_[A-Z]+)*$","type":"string","minLength":2,"maxLength":64},"payload":{"type":"object"},"occurredAt":{"pattern":"\\d{4}-[01]\\d-[0-3]\\dT[0-2]\\d:[0-5]\\d:[0-5]\\d.\\d+Z?","type":"string"}},"type":"object","required":["type"]}}}} ``` ## The SqsEventDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"SqsEventDefinition":{"properties":{"subject":{},"retryIfUserNotFound":{},"type":{"pattern":"^[A-Z]+(_[A-Z]+)*$","type":"string","minLength":2,"maxLength":64},"payload":{"type":"object"},"occurredAt":{"pattern":"\\d{4}-[01]\\d-[0-3]\\dT[0-2]\\d:[0-5]\\d:[0-5]\\d.\\d+Z?","type":"string"}},"type":"object","required":["type"]}}}} ``` ## The SqsCreateEventCommand object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"SqsCreateEventCommand":{"properties":{"apiKey":{"type":"string"},"command":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x00-\\x7F]+$"},"payload":{"$ref":"#/components/schemas/SqsEventDefinition"}},"type":"object","required":["apiKey","command","payload"]},"SqsEventDefinition":{"properties":{"subject":{},"retryIfUserNotFound":{},"type":{"pattern":"^[A-Z]+(_[A-Z]+)*$","type":"string","minLength":2,"maxLength":64},"payload":{"type":"object"},"occurredAt":{"pattern":"\\d{4}-[01]\\d-[0-3]\\dT[0-2]\\d:[0-5]\\d:[0-5]\\d.\\d+Z?","type":"string"}},"type":"object","required":["type"]}}}} ``` ## The AudienceCriteriaPatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"AudienceCriteriaPatch":{"properties":{"criteriaFormat":{"enum":["QUERY_TREE","JSONATA"],"type":"string"},"criteriaTree":{"type":"object"},"criteriaJsonLogic":{"type":"object"},"criteriaJsonata":{"type":"string"},"triggerFrequency":{"enum":["DAILY","HOURLY","REACTIVE","MANUAL","DAILY_REACTIVE","DAILY_POST_POINTS_LIABILITY"],"type":"string"}},"type":"object"}}}} ``` ## The CalculateUserAudienceCommand object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"CalculateUserAudienceCommand":{"properties":{"audienceId":{"type":"string"},"audienceIds":{"items":{"type":"string"},"type":"array"},"tenantId":{"type":"string"},"userId":{"type":"string"}},"type":"object","required":["audienceIds","tenantId","userId"]}}}} ``` ## The TriggerAudienceSearchCommand object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"TriggerAudienceSearchCommand":{"properties":{"audienceId":{"type":"string"},"tenantId":{"type":"string"}},"type":"object","required":["audienceId","tenantId"]}}}} ``` ## The EventTypeDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"EventTypeDefinition":{"properties":{"name":{"type":"string","pattern":"^[A-Z]+(_[A-Z]+)*$","minLength":2,"maxLength":64},"description":{"type":"string","minLength":2,"maxLength":1024,"pattern":"^[\\x00-\\x7F]+$"},"schema":{"type":"object"},"isPrivate":{"type":"boolean"},"isActive":{"type":"boolean"},"metaTypeMappings":{"items":{"$ref":"#/components/schemas/MetaTypeMapping"},"type":"array"},"enhancers":{"items":{"enum":["AUDIENCE_ENHANCER","POINTS_ENHANCER","REFERRAL_DETAILS","CODE_POOL","RANDOM_NUMBER","TEST"],"type":"string"},"type":"array"},"omitFromUserActivity":{"type":"boolean"}},"type":"object","required":["name","description","isPrivate"]},"MetaTypeMapping":{"properties":{"metaType":{"enum":["TRANSACTION"],"type":"string"},"metaPayloadConfig":{"type":"object"},"metaConstraint":{"type":"object"}},"type":"object","required":["metaType"]}}}} ``` ## The AudienceCriteriaDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"AudienceCriteriaDefinition":{"properties":{"criteriaFormat":{"enum":["QUERY_TREE","JSONATA"],"type":"string"},"criteriaTree":{"type":"object"},"criteriaJsonLogic":{"type":"object"},"criteriaJsonata":{"type":"string"},"triggerFrequency":{"enum":["DAILY","HOURLY","REACTIVE","MANUAL","DAILY_REACTIVE","DAILY_POST_POINTS_LIABILITY"],"type":"string"}},"type":"object","required":["triggerFrequency"]}}}} ``` ## The AudienceDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"AudienceDefinition":{"properties":{"name":{"type":"string","minLength":2,"maxLength":200},"description":{"type":"string","minLength":2,"maxLength":10000},"isActive":{"type":"boolean"},"criteriaDefinition":{"$ref":"#/components/schemas/AudienceCriteriaDefinition"},"sendAudienceJoinedEvent":{"type":"boolean"},"sendAudienceLeftEvent":{"type":"boolean"},"calculateOnSubjectRegistration":{"type":"boolean"},"aiCriteriaMetadata":{"type":"object"}},"type":"object","required":["name","description","isActive","criteriaDefinition"]},"AudienceCriteriaDefinition":{"properties":{"criteriaFormat":{"enum":["QUERY_TREE","JSONATA"],"type":"string"},"criteriaTree":{"type":"object"},"criteriaJsonLogic":{"type":"object"},"criteriaJsonata":{"type":"string"},"triggerFrequency":{"enum":["DAILY","HOURLY","REACTIVE","MANUAL","DAILY_REACTIVE","DAILY_POST_POINTS_LIABILITY"],"type":"string"}},"type":"object","required":["triggerFrequency"]}}}} ``` ## The AudienceEstimatePayload object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"AudienceEstimatePayload":{"properties":{"criteriaJsonata":{"type":"string"},"maxSample":{"maximum":5000,"type":"integer","minimum":100},"sampleSeed":{"type":"integer"}},"type":"object","required":["criteriaJsonata"]}}}} ``` ## The AudiencePatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"AudiencePatch":{"properties":{"name":{"type":"string","minLength":2,"maxLength":200},"description":{"type":"string","minLength":2,"maxLength":10000},"isActive":{"type":"boolean"},"criteriaPatch":{"$ref":"#/components/schemas/AudienceCriteriaPatch"},"sendAudienceJoinedEvent":{"type":"boolean"},"sendAudienceLeftEvent":{"type":"boolean"},"calculateOnSubjectRegistration":{"type":"boolean"},"aiCriteriaMetadata":{"type":"object"}},"type":"object"},"AudienceCriteriaPatch":{"properties":{"criteriaFormat":{"enum":["QUERY_TREE","JSONATA"],"type":"string"},"criteriaTree":{"type":"object"},"criteriaJsonLogic":{"type":"object"},"criteriaJsonata":{"type":"string"},"triggerFrequency":{"enum":["DAILY","HOURLY","REACTIVE","MANUAL","DAILY_REACTIVE","DAILY_POST_POINTS_LIABILITY"],"type":"string"}},"type":"object"}}}} ``` ## The AudienceResultsPayload object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"AudienceResultsPayload":{"properties":{"audienceIds":{"items":{"format":"uuid","type":"string"},"type":"array"}},"type":"object","required":["audienceIds"]}}}} ``` ## The ImportAwinRewardsCommand object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"ImportAwinRewardsCommand":{"properties":{"tenantId":{"format":"uuid","type":"string"}},"type":"object","required":["tenantId"]}}}} ``` ## The BranchAttributionPayload object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"BranchAttributionPayload":{"properties":{"isAttributed":{"type":"boolean"},"lastAttributedTouchData":{"type":"object","minProperties":1},"hasExistingUserOnSameDevice":{"type":"boolean"}},"type":"object","required":["isAttributed","lastAttributedTouchData"]}}}} ``` ## The BulkCodeDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"BulkCodeDefinition":{"properties":{"codes":{"items":{"type":"string"},"maxItems":5000,"type":"array"}},"type":"object","required":["codes"]}}}} ``` ## The CodeDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"CodeDefinition":{"properties":{"value":{"type":"string","minLength":1,"maxLength":5000}},"type":"object","required":["value"]}}}} ``` ## The CodePoolDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"CodePoolDefinition":{"properties":{"name":{"type":"string","minLength":1,"maxLength":128},"description":{"type":"string","minLength":0,"maxLength":10000},"active":{"type":"boolean"}},"type":"object","required":["name"]}}}} ``` ## The CodePoolPatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"CodePoolPatch":{"properties":{"name":{"type":"string","minLength":1,"maxLength":128},"description":{"type":"string","minLength":0,"maxLength":10000},"active":{"type":"boolean"}},"type":"object"}}}} ``` ## The ActorAdjustPointsCommand object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"ActorAdjustPointsCommand":{"properties":{"points":{"type":"number"},"actorId":{"type":"string"},"comment":{"type":"string"},"impactType":{"enum":["EARN","SPEND","NONE"],"type":"string"},"liabilityHandlingPolicy":{"enum":["BYPASS","REJECT_EVENT"],"type":"string"}},"type":"object","required":["points","actorId"]}}}} ``` ## The PurchaseRewardCommand object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"PurchaseRewardCommand":{"properties":{"beneficiaryId":{"format":"uuid","type":"string"},"rewardId":{"format":"uuid","type":"string"},"comment":{"type":"string"},"deliveryAddress":{"$ref":"#/components/schemas/ShippingAddress"}},"type":"object","required":["rewardId"]},"ShippingAddress":{"properties":{"recipientName":{"type":"string"},"streetAddress":{"type":"string"},"city":{"type":"string"},"region":{"type":"string"},"postcode":{"type":"string"},"country":{"type":"string"},"telephoneNumber":{"type":"string"}},"type":"object","required":["recipientName","streetAddress","city","postcode","country"]}}}} ``` ## The RedeemBenefitCommand object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"RedeemBenefitCommand":{"properties":{"benefitId":{"format":"uuid","type":"string"},"position":{"$ref":"#/components/schemas/GeoPoint"}},"type":"object","required":["benefitId"]},"GeoPoint":{"properties":{"longitude":{"minimum":-180,"type":"number","maximum":180},"latitude":{"minimum":-90,"type":"number","maximum":90}},"type":"object","required":["longitude","latitude"]}}}} ``` ## The ValidateVoucherCommand object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"ValidateVoucherCommand":{"properties":{"code":{"minLength":1,"type":"string"},"allowFutureValidation":{"type":"boolean"},"userIdentifier":{"minLength":1,"type":"string"},"venueIdentifier":{"minLength":1,"type":"string"},"position":{"$ref":"#/components/schemas/GeoPoint"}},"type":"object","required":["code"]},"GeoPoint":{"properties":{"longitude":{"minimum":-180,"type":"number","maximum":180},"latitude":{"minimum":-90,"type":"number","maximum":90}},"type":"object","required":["longitude","latitude"]}}}} ``` ## The VoidBenefitCommand object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"VoidBenefitCommand":{"properties":{"benefitId":{"format":"uuid","type":"string"}},"type":"object","required":["benefitId"]}}}} ``` ## The ConsentDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"ConsentDefinition":{"properties":{"type":{"$ref":"#/components/schemas/Hydratable"},"user":{"$ref":"#/components/schemas/Hydratable"}},"type":"object","required":["type","user"]},"Hydratable":{"properties":{"id":{"format":"uuid","type":"string"}},"type":"object","required":["id"]}}}} ``` ## The ConsentTypeDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"ConsentTypeDefinition":{"properties":{"name":{"type":"string","minLength":1,"maxLength":128},"required":{"type":"boolean"},"priority":{"minimum":0,"type":"integer"}},"type":"object","required":["name","required"]}}}} ``` ## The ConsentTypePatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"ConsentTypePatch":{"properties":{"name":{"type":"string","minLength":1,"maxLength":128},"required":{"type":"boolean"},"priority":{"minimum":0,"type":"integer"}},"type":"object"}}}} ``` ## The DiscountDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"DiscountDefinition":{"properties":{"type":{"enum":["ABSOLUTE","FIXED","PERCENTAGE"],"type":"string"},"value":{"type":"number"},"sku":{"type":"string"},"productSku":{"type":"string"},"venues":{"items":{"$ref":"#/components/schemas/Hydratable"},"type":"array"}},"type":"object","required":["type","value"]},"Hydratable":{"properties":{"id":{"format":"uuid","type":"string"}},"type":"object","required":["id"]}}}} ``` ## The DiscountPatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"DiscountPatch":{"properties":{"type":{"enum":["ABSOLUTE","FIXED","PERCENTAGE"],"type":"string"},"value":{"type":"number"},"sku":{"type":"string"},"productSku":{"type":"string"},"reward":{},"venues":{}},"type":"object"}}}} ``` ## The OliveCardDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"OliveCardDefinition":{"properties":{"cardToken":{"type":"string"},"programType":{}},"type":"object","required":["cardToken","programType"]}}}} ``` ## The OliveCardUpdateDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"OliveCardUpdateDefinition":{"properties":{"programType":{"enum":["CASHBACK","CASHBACK_AND_ROUNDUP"],"type":"string"}},"type":"object","required":["programType"]}}}} ``` ## The OliveRoundUpConfig object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"OliveRoundUpConfig":{"properties":{"limit":{"type":"number"},"chargeableCardId":{"type":"string"},"destinationId":{"type":"string"}},"type":"object"}}}} ``` ## The UpdateOliveConfigDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"UpdateOliveConfigDefinition":{"properties":{"roundUp":{"$ref":"#/components/schemas/OliveRoundUpConfig"}},"type":"object"},"OliveRoundUpConfig":{"properties":{"limit":{"type":"number"},"chargeableCardId":{"type":"string"},"destinationId":{"type":"string"}},"type":"object"}}}} ``` ## The PayoutRegistrationAttributeValue object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"PayoutRegistrationAttributeValue":{"properties":{"accountId":{"type":"string"},"status":{"enum":["UNREGISTERED","INPROGRESS","REGISTERED","FAILED"],"type":"string"}},"type":"object","required":["accountId","status"]}}}} ``` ## The StripeRegistrationRequest object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"StripeRegistrationRequest":{"properties":{"refreshUrl":{"type":"string"},"returnUrl":{"type":"string"}},"type":"object"}}}} ``` ## The StripePayoutRequest object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"StripePayoutRequest":{"properties":{"pointsToTransfer":{"type":"number"}},"type":"object"}}}} ``` ## The StripeInitiatePaymentRequest object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"StripeInitiatePaymentRequest":{"properties":{"pointsToTransfer":{"type":"number"},"refreshUrl":{"type":"string"},"returnUrl":{"type":"string"}},"type":"object","required":["pointsToTransfer","refreshUrl","returnUrl"]}}}} ``` ## The CheckoutPaymentBody object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"CheckoutPaymentBody":{"properties":{"cardToken":{"pattern":"^tok_.*$","type":"string"},"instrumentId":{"pattern":"^src_.*$","type":"string"},"points":{"type":"number"}},"type":"object","required":["points"]}}}} ``` ## The CheckoutPaymentRequestPayload object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"CheckoutPaymentRequestPayload":{"properties":{"instrumentId":{"type":"string"},"processingChannelId":{"type":"string"},"points":{"type":"number"},"amount":{"type":"number"},"currency":{"enum":["AED","AFN","ALL","AMD","ANG","AOA","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GIP","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RWF","SAR","SBD","SCR","SEK","SGD","SHP","SLE","SLL","SOS","SRD","STN","SVC","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VES","VND","VUV","WST","XAF","XCD","XDR","XOF","XPF","YER","ZAR","ZMW"],"type":"string"},"fundsTransferType":{"type":"string"},"reference":{"type":"string"}},"type":"object","required":["instrumentId","processingChannelId","points","amount","currency","fundsTransferType","reference"]}}}} ``` ## The CheckoutRegistrationInfoParams object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"CheckoutRegistrationInfoParams":{"properties":{"type":{"enum":["cards","audiences"],"type":"string"}},"type":"object","required":["type"]}}}} ``` ## The CheckoutRevokeRegistrationBody object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"CheckoutRevokeRegistrationBody":{"properties":{"type":{"pattern":"^(cards)$","type":"string"},"id":{"type":"string"}},"type":"object","required":["type","id"]}}}} ``` ## The CheckoutRegistrationRequestBody object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"CheckoutRegistrationRequestBody":{"properties":{"type":{"pattern":"^(cards)$","type":"string"},"cardToken":{"pattern":"^tok_.*$","type":"string"}},"type":"object","required":["type","cardToken"]}}}} ``` ## The ProfileData object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"ProfileData":{"properties":{"type":{"type":"string"},"id":{"type":"string"}},"type":"object","required":["type","id"]}}}} ``` ## The MetricAttributes object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"MetricAttributes":{"properties":{"name":{"type":"string"},"service":{"type":"string"}},"type":"object","required":["name","service"]}}}} ``` ## The MetricData object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"MetricData":{"properties":{"type":{"type":"string"},"attributes":{"$ref":"#/components/schemas/MetricAttributes"}},"type":"object","required":["type","attributes"]},"MetricAttributes":{"properties":{"name":{"type":"string"},"service":{"type":"string"}},"type":"object","required":["name","service"]}}}} ``` ## The EventAttributes object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"EventAttributes":{"properties":{"profile":{"$ref":"#/components/schemas/ProfileData"},"metric":{"$ref":"#/components/schemas/MetricData"},"properties":{"type":"object"},"time":{"type":"string"},"unique_id":{"type":"string"}},"type":"object","required":["profile","metric","properties","time","unique_id"]},"ProfileData":{"properties":{"type":{"type":"string"},"id":{"type":"string"}},"type":"object","required":["type","id"]},"MetricData":{"properties":{"type":{"type":"string"},"attributes":{"$ref":"#/components/schemas/MetricAttributes"}},"type":"object","required":["type","attributes"]},"MetricAttributes":{"properties":{"name":{"type":"string"},"service":{"type":"string"}},"type":"object","required":["name","service"]}}}} ``` ## The KlaviyoEventPayload object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"KlaviyoEventPayload":{"properties":{"type":{"type":"string"},"attributes":{"$ref":"#/components/schemas/EventAttributes"}},"type":"object","required":["type","attributes"]},"EventAttributes":{"properties":{"profile":{"$ref":"#/components/schemas/ProfileData"},"metric":{"$ref":"#/components/schemas/MetricData"},"properties":{"type":"object"},"time":{"type":"string"},"unique_id":{"type":"string"}},"type":"object","required":["profile","metric","properties","time","unique_id"]},"ProfileData":{"properties":{"type":{"type":"string"},"id":{"type":"string"}},"type":"object","required":["type","id"]},"MetricData":{"properties":{"type":{"type":"string"},"attributes":{"$ref":"#/components/schemas/MetricAttributes"}},"type":"object","required":["type","attributes"]},"MetricAttributes":{"properties":{"name":{"type":"string"},"service":{"type":"string"}},"type":"object","required":["name","service"]}}}} ``` ## The Attributes object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"Attributes":{"properties":{"name":{"type":"string"},"created":{"type":"string","pattern":"\\d{4}-[01]\\d-[0-3]\\dT[0-2]\\d:[0-5]\\d:[0-5]\\d.\\d+Z?"},"updated":{"type":"string","pattern":"\\d{4}-[01]\\d-[0-3]\\dT[0-2]\\d:[0-5]\\d:[0-5]\\d.\\d+Z?"},"opt_in_process":{"type":"string"},"email":{"type":"string"},"phone_number":{"type":"string"},"external_id":{"type":"string"},"anonymous_id":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"organization":{"type":"string"},"locale":{"type":"string"},"title":{"type":"string"},"image":{"type":"string"},"last_event_date":{"pattern":"\\d{4}-[01]\\d-[0-3]\\dT[0-2]\\d:[0-5]\\d:[0-5]\\d.\\d+Z?","type":"string"},"location":{"$ref":"#/components/schemas/Location"},"properties":{"type":"object"}},"type":"object","required":["name","opt_in_process"]},"Location":{"properties":{"zip":{"type":"string"},"country":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"region":{"type":"string"},"longitude":{"type":"number"},"latitude":{"type":"number"},"city":{"type":"string"},"timezone":{"type":"string"},"ip":{"type":"string"}},"type":"object"}}}} ``` ## The Data object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"Data":{"properties":{"type":{"type":"string"},"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/Attributes"}},"type":"object","required":["type","attributes"]},"Attributes":{"properties":{"name":{"type":"string"},"created":{"type":"string","pattern":"\\d{4}-[01]\\d-[0-3]\\dT[0-2]\\d:[0-5]\\d:[0-5]\\d.\\d+Z?"},"updated":{"type":"string","pattern":"\\d{4}-[01]\\d-[0-3]\\dT[0-2]\\d:[0-5]\\d:[0-5]\\d.\\d+Z?"},"opt_in_process":{"type":"string"},"email":{"type":"string"},"phone_number":{"type":"string"},"external_id":{"type":"string"},"anonymous_id":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"organization":{"type":"string"},"locale":{"type":"string"},"title":{"type":"string"},"image":{"type":"string"},"last_event_date":{"pattern":"\\d{4}-[01]\\d-[0-3]\\dT[0-2]\\d:[0-5]\\d:[0-5]\\d.\\d+Z?","type":"string"},"location":{"$ref":"#/components/schemas/Location"},"properties":{"type":"object"}},"type":"object","required":["name","opt_in_process"]},"Location":{"properties":{"zip":{"type":"string"},"country":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"region":{"type":"string"},"longitude":{"type":"number"},"latitude":{"type":"number"},"city":{"type":"string"},"timezone":{"type":"string"},"ip":{"type":"string"}},"type":"object"}}}} ``` ## The Links object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"Links":{"properties":{"self":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}},"type":"object"}}}} ``` ## The KlaviyoLists object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"KlaviyoLists":{"properties":{"data":{"$ref":"#/components/schemas/Data"},"links":{"$ref":"#/components/schemas/Links"}},"type":"object","required":["data","links"]},"Data":{"properties":{"type":{"type":"string"},"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/Attributes"}},"type":"object","required":["type","attributes"]},"Attributes":{"properties":{"name":{"type":"string"},"created":{"type":"string","pattern":"\\d{4}-[01]\\d-[0-3]\\dT[0-2]\\d:[0-5]\\d:[0-5]\\d.\\d+Z?"},"updated":{"type":"string","pattern":"\\d{4}-[01]\\d-[0-3]\\dT[0-2]\\d:[0-5]\\d:[0-5]\\d.\\d+Z?"},"opt_in_process":{"type":"string"},"email":{"type":"string"},"phone_number":{"type":"string"},"external_id":{"type":"string"},"anonymous_id":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"organization":{"type":"string"},"locale":{"type":"string"},"title":{"type":"string"},"image":{"type":"string"},"last_event_date":{"pattern":"\\d{4}-[01]\\d-[0-3]\\dT[0-2]\\d:[0-5]\\d:[0-5]\\d.\\d+Z?","type":"string"},"location":{"$ref":"#/components/schemas/Location"},"properties":{"type":"object"}},"type":"object","required":["name","opt_in_process"]},"Location":{"properties":{"zip":{"type":"string"},"country":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"region":{"type":"string"},"longitude":{"type":"number"},"latitude":{"type":"number"},"city":{"type":"string"},"timezone":{"type":"string"},"ip":{"type":"string"}},"type":"object"},"Links":{"properties":{"self":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}},"type":"object"}}}} ``` ## The Location object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"Location":{"properties":{"zip":{"type":"string"},"country":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"region":{"type":"string"},"longitude":{"type":"number"},"latitude":{"type":"number"},"city":{"type":"string"},"timezone":{"type":"string"},"ip":{"type":"string"}},"type":"object"}}}} ``` ## The KlaviyoProfile object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"KlaviyoProfile":{"properties":{"data":{"$ref":"#/components/schemas/Data"}},"type":"object","required":["data"]},"Data":{"properties":{"type":{"type":"string"},"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/Attributes"}},"type":"object","required":["type","attributes"]},"Attributes":{"properties":{"name":{"type":"string"},"created":{"type":"string","pattern":"\\d{4}-[01]\\d-[0-3]\\dT[0-2]\\d:[0-5]\\d:[0-5]\\d.\\d+Z?"},"updated":{"type":"string","pattern":"\\d{4}-[01]\\d-[0-3]\\dT[0-2]\\d:[0-5]\\d:[0-5]\\d.\\d+Z?"},"opt_in_process":{"type":"string"},"email":{"type":"string"},"phone_number":{"type":"string"},"external_id":{"type":"string"},"anonymous_id":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"organization":{"type":"string"},"locale":{"type":"string"},"title":{"type":"string"},"image":{"type":"string"},"last_event_date":{"pattern":"\\d{4}-[01]\\d-[0-3]\\dT[0-2]\\d:[0-5]\\d:[0-5]\\d.\\d+Z?","type":"string"},"location":{"$ref":"#/components/schemas/Location"},"properties":{"type":"object"}},"type":"object","required":["name","opt_in_process"]},"Location":{"properties":{"zip":{"type":"string"},"country":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"region":{"type":"string"},"longitude":{"type":"number"},"latitude":{"type":"number"},"city":{"type":"string"},"timezone":{"type":"string"},"ip":{"type":"string"}},"type":"object"}}}} ``` ## The MetadataDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"MetadataDefinition":{"properties":{"id":{"type":"string"}},"type":"object","required":["id"]}}}} ``` ## The CardDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"CardDefinition":{"properties":{"id":{"type":"string"},"accountId":{"type":"string"},"programId":{"type":"string"},"type":{"type":"string"},"scheme":{"type":"string"},"expYear":{"type":"number"},"expMonth":{"type":"number"},"expDate":{"type":"string"},"created":{"type":"string"},"updated":{"type":"string"},"live":{"type":"boolean"},"countryCode":{"type":"string"},"metadata":{"$ref":"#/components/schemas/MetadataDefinition"},"lastNumbers":{"type":"string"},"firstNumbers":{"type":"string"}},"type":"object","required":["id","accountId","programId","type","scheme","expYear","expMonth","expDate","created","updated","live","countryCode","metadata"]},"MetadataDefinition":{"properties":{"id":{"type":"string"}},"type":"object","required":["id"]}}}} ``` ## The ProcessFidelCardLinkWebhookCommand object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"ProcessFidelCardLinkWebhookCommand":{"properties":{"integrationId":{"format":"uuid","type":"string"}},"type":"object","required":["integrationId"]}}}} ``` ## The BrandPayloadDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"BrandPayloadDefinition":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"logoURL":{"format":"url","type":"string"}},"type":"object","required":["id","name"]}}}} ``` ## The CardPayloadDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"CardPayloadDefinition":{"properties":{"id":{"type":"string"},"scheme":{"type":"string"},"metadata":{"$ref":"#/components/schemas/MetadataDefinition"},"firstNumbers":{"type":"string"},"lastNumbers":{"type":"string"}},"type":"object","required":["id","scheme","metadata"]},"MetadataDefinition":{"properties":{"id":{"type":"string"}},"type":"object","required":["id"]}}}} ``` ## The IdentifiersPayloadDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"IdentifiersPayloadDefinition":{"properties":{"MID":{"type":"string"},"amexApprovalCode":{"type":"string"},"visaAuthCode":{"type":"string"},"mastercardAuthCode":{"type":"string"},"mastercardRefNumber":{"type":"string"},"mastercardTransactionSequenceNumber":{"type":"string"}},"type":"object","required":["MID"]}}}} ``` ## The LocationPayloadDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"LocationPayloadDefinition":{"properties":{"id":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"timezone":{"type":"string"},"countryCode":{"type":"string"}},"type":"object"}}}} ``` ## The ProgramInfo object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"ProgramInfo":{"properties":{"programId":{"type":"string"},"programName":{"type":"string"}},"type":"object","required":["programId","programName"]}}}} ``` ## The OfferPayloadDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"OfferPayloadDefinition":{"properties":{"qualified":{"type":"boolean"},"supplier":{"type":"string"},"name":{"type":"string"},"automatedReimbursement":{"type":"boolean"},"id":{"type":"string"},"message":{"items":{"type":"string"},"type":"array"},"qualificationDate":{"type":"string"},"cashback":{"type":"number"},"performanceFee":{"type":"number"},"metadata":{}},"type":"object","required":["qualified","id","cashback"]}}}} ``` ## The TransactionDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"TransactionDefinition":{"properties":{"id":{"type":"string"},"accountId":{"type":"string"},"programId":{"type":"string"},"datetime":{"type":"string"},"created":{"type":"string"},"updated":{"type":"string"},"auth":{"type":"boolean"},"cleared":{"type":"boolean"},"currency":{"type":"string"},"amount":{"type":"number"},"authCode":{"type":"string"},"card":{"$ref":"#/components/schemas/CardPayloadDefinition"},"location":{"$ref":"#/components/schemas/LocationPayloadDefinition"},"brand":{"$ref":"#/components/schemas/BrandPayloadDefinition"},"identifiers":{"$ref":"#/components/schemas/IdentifiersPayloadDefinition"},"refundTransactionId":{"type":"string"},"wallet":{"type":"string"},"offer":{},"originalTransactionId":{"type":"string"},"originalTransaction":{}},"type":"object","required":["id","accountId","programId","datetime","created","updated","auth","cleared","currency","amount","card","location","brand","identifiers"]},"CardPayloadDefinition":{"properties":{"id":{"type":"string"},"scheme":{"type":"string"},"metadata":{"$ref":"#/components/schemas/MetadataDefinition"},"firstNumbers":{"type":"string"},"lastNumbers":{"type":"string"}},"type":"object","required":["id","scheme","metadata"]},"MetadataDefinition":{"properties":{"id":{"type":"string"}},"type":"object","required":["id"]},"LocationPayloadDefinition":{"properties":{"id":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"timezone":{"type":"string"},"countryCode":{"type":"string"}},"type":"object"},"BrandPayloadDefinition":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"logoURL":{"format":"url","type":"string"}},"type":"object","required":["id","name"]},"IdentifiersPayloadDefinition":{"properties":{"MID":{"type":"string"},"amexApprovalCode":{"type":"string"},"visaAuthCode":{"type":"string"},"mastercardAuthCode":{"type":"string"},"mastercardRefNumber":{"type":"string"},"mastercardTransactionSequenceNumber":{"type":"string"}},"type":"object","required":["MID"]}}}} ``` ## The ProcessFidelClearanceWebhookCommand object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"ProcessFidelClearanceWebhookCommand":{"properties":{"integrationId":{"format":"uuid","type":"string"}},"type":"object","required":["integrationId"]}}}} ``` ## The ProcessFidelQualifiedWebhookCommand object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"ProcessFidelQualifiedWebhookCommand":{"properties":{"integrationId":{"format":"uuid","type":"string"}},"type":"object","required":["integrationId"]}}}} ``` ## The ProcessFidelRefundWebhookCommand object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"ProcessFidelRefundWebhookCommand":{"properties":{"integrationId":{"format":"uuid","type":"string"}},"type":"object","required":["integrationId"]}}}} ``` ## The ProcessFidelAuthWebhookCommand object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"ProcessFidelAuthWebhookCommand":{"properties":{"integrationId":{"format":"uuid","type":"string"}},"type":"object","required":["integrationId"]}}}} ``` ## The ImportFidelOffersCommand object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"ImportFidelOffersCommand":{"properties":{"tenantId":{"type":"string"}},"type":"object","required":["tenantId"]}}}} ``` ## The IntegrationDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"IntegrationDefinition":{"properties":{"type":{"enum":["AUTH0","AWIN","BRANCH","FIDEL","FINCONECTA","KINDRED","MAGNATI","MPARTICLE","OLIVE","SIMPLIFI","WEGIFT","XOXO","SEGMENT","STRIPE_PAYOUT","CHECKOUT","WALLET","KLAVIYO","CARLTON_ONE"],"type":"string"},"active":{"type":"boolean"},"configuration":{}},"type":"object","required":["type","active","configuration"]}}}} ``` ## The IntegrationPatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"IntegrationPatch":{"properties":{"configuration":{},"active":{"type":"boolean"}},"type":"object"}}}} ``` ## The ImportKindredRewardsCommand object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"ImportKindredRewardsCommand":{"properties":{"tenantId":{"format":"uuid","type":"string"}},"type":"object","required":["tenantId"]}}}} ``` ## The CardIssuancePayload object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"CardIssuancePayload":{"properties":{"fullName":{"type":"string"},"dob":{"description":"Before 2026-08-20T16:00:42.686Z","oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"mobile":{"type":"string"},"email":{"format":"email","type":"string"},"idNumber":{"pattern":"\\d{3}-\\d{4}-\\d{7}-\\d","type":"string"},"idExpiryDate":{"description":"After 2026-08-20T16:00:42.686Z","oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"city":{"type":"string","enum":["Abu Dhabi","Dubai","Sharjah","Ajman","Umm Al Quwain","Ras Al Khaimah","Fujairah"]},"nationality":{"enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"type":"string"}},"type":"object","required":["fullName","dob","mobile","email","idNumber","idExpiryDate","city","nationality"]}}}} ``` ## The IssueCardPayload object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"IssueCardPayload":{"properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"middleName":{"type":"string"},"customerType":{"type":"string"},"prefixTitle":{"type":"number"},"embossedName":{"type":"string"},"countryOfResidence":{"enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"type":"string"},"addressLine1":{"type":"string"},"countryCode":{"enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"type":"string"},"occupation":{"type":"string"},"idType":{"type":"number"},"idIssueCountryId":{"enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"type":"string"},"gender":{"type":"string"},"cardType":{"type":"string"},"productType":{"type":"number"},"birthPlace":{"enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"type":"string"},"emirates":{"type":"number"},"documentsVerified":{"type":"number"},"addressLine2":{"type":"string"},"addressLine3":{"type":"string"},"addressLine4":{"type":"string"},"postalCode":{"type":"string"},"walletId":{"type":"string"},"pcif":{"type":"string"},"companyName":{"type":"string"},"visaExpiryDate":{"type":"string"},"fullName":{"type":"string"},"dob":{"description":"Before 2026-08-20T16:00:42.686Z","oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"mobile":{"type":"string"},"email":{"format":"email","type":"string"},"idNumber":{"pattern":"\\d{3}-\\d{4}-\\d{7}-\\d","type":"string"},"idExpiryDate":{"description":"After 2026-08-20T16:00:42.686Z","oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"city":{"type":"string","enum":["Abu Dhabi","Dubai","Sharjah","Ajman","Umm Al Quwain","Ras Al Khaimah","Fujairah"]},"nationality":{"enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"type":"string"}},"type":"object","required":["firstName","lastName","middleName","customerType","prefixTitle","embossedName","countryOfResidence","addressLine1","countryCode","occupation","idType","idIssueCountryId","gender","cardType","productType","birthPlace","emirates","documentsVerified","addressLine2","addressLine3","addressLine4","postalCode","walletId","pcif","companyName","visaExpiryDate","fullName","dob","mobile","email","idNumber","idExpiryDate","city","nationality"]}}}} ``` ## The MagnatiTopUpPayload object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"MagnatiTopUpPayload":{"properties":{"transactionType":{"type":"number"},"cardId":{"type":"string"},"terminalId":{"type":"string"},"merchantId":{"type":"string"},"rrn":{"type":"string"},"transactionAmount":{"type":"number"},"transactionCurrency":{"type":"string"},"equivalentAmount":{"type":"number"},"equivalentCurrency":{"type":"string"},"authorizationCode":{"type":"string"},"feeAmount":{"type":"string"},"transactionRate":{"type":"number"},"remarks":{"type":"string"},"merchantName":{"type":"string"},"merchantLocation":{"type":"string"},"transactionDateTime":{"type":"string"},"feeDescription":{"type":"string"},"sourceTxnReferenceNo":{"type":"string"},"mcc":{"type":"string"}},"type":"object","required":["transactionType","cardId","terminalId","merchantId","rrn","transactionAmount","transactionCurrency","equivalentAmount","equivalentCurrency","authorizationCode","feeAmount","transactionRate","remarks","merchantName","merchantLocation","transactionDateTime","feeDescription","sourceTxnReferenceNo","mcc"]}}}} ``` ## The MediaItemDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"MediaItemDefinition":{"properties":{"url":{"format":"url","type":"string"},"description":{"type":"string","minLength":2,"maxLength":1024},"type":{"enum":["PICTURE","VIDEO"],"type":"string"},"priority":{"type":"number"},"locale":{"pattern":"[a-z]{2,3}(-[A-Za-z]+)*","type":"string"}},"type":"object","required":["url","type","priority","locale"]}}}} ``` ## The MediaItemPatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"MediaItemPatch":{"properties":{"url":{"format":"url","type":"string"},"description":{"type":"string","minLength":2,"maxLength":1024},"type":{"enum":["PICTURE","VIDEO"],"type":"string"},"priority":{"type":"number"},"locale":{"pattern":"[a-z]{2,3}(-[A-Za-z]+)*","type":"string"},"venue":{}},"type":"object"}}}} ``` ## The ProcessTransactionMetaEventCommand object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"ProcessTransactionMetaEventCommand":{"properties":{"payload":{"type":"object"}},"type":"object","required":["payload"]}}}} ``` ## The RecalculateMetaEventsForUserCommand object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"RecalculateMetaEventsForUserCommand":{"properties":{"userId":{"type":"string"},"tenantId":{"type":"string"}},"type":"object","required":["userId","tenantId"]}}}} ``` ## The GoogleWalletPassBody object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"GoogleWalletPassBody":{"properties":{"backgroundColor":{"pattern":"^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$","type":"string"},"organizationName":{"type":"string"},"icon":{"format":"url","type":"string"},"memberIdHeader":{"type":"string"},"memberIdPath":{"enum":["accountNumber","authIdentifier","id","externalIdentifier"],"type":"string"},"showMemberIdAsLabel":{"type":"boolean"}},"type":"object"}}}} ``` ## The AppleWalletPassBody object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"AppleWalletPassBody":{"properties":{"backgroundColor":{"pattern":"^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$","type":"string"},"organizationName":{"type":"string"},"description":{"type":"string"},"foregroundColor":{"pattern":"^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$","type":"string"},"labelColor":{"pattern":"^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$","type":"string"},"memberIdPath":{"enum":["accountNumber","authIdentifier","id","externalIdentifier"],"type":"string"},"showMemberIdAsLabel":{"type":"boolean"},"icon":{"type":"string"},"icon2x":{"type":"string"},"logo":{"type":"string"},"logo2x":{"type":"string"},"strip":{"type":"string"}},"type":"object"}}}} ``` ## The BadgeDetailsDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"BadgeDetailsDefinition":{"properties":{"name":{"type":"string","minLength":2,"maxLength":200},"description":{"minLength":2,"maxLength":1000,"type":"string"},"artworkUrl":{"format":"url","type":"string"},"locale":{"enum":["en","fr","de","it","es","nl","ar","bn","gu","hi","id","ja","ko","ml","mr","mt","pl","pt","ru","sv","ta","te","th","tl","tr","uk","ur","vi"],"type":"string"}},"type":"object","required":["name","locale"]}}}} ``` ## The BadgeDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"BadgeDefinition":{"properties":{"internalName":{"type":"string","minLength":2,"maxLength":200},"internalDescription":{"minLength":2,"maxLength":1000,"type":"string"},"details":{"items":{"$ref":"#/components/schemas/BadgeDetailsDefinition"},"type":"array"},"priority":{"minimum":0,"type":"integer"}},"type":"object","required":["internalName"]},"BadgeDetailsDefinition":{"properties":{"name":{"type":"string","minLength":2,"maxLength":200},"description":{"minLength":2,"maxLength":1000,"type":"string"},"artworkUrl":{"format":"url","type":"string"},"locale":{"enum":["en","fr","de","it","es","nl","ar","bn","gu","hi","id","ja","ko","ml","mr","mt","pl","pt","ru","sv","ta","te","th","tl","tr","uk","ur","vi"],"type":"string"}},"type":"object","required":["name","locale"]}}}} ``` ## The BadgePatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"BadgePatch":{"properties":{"internalName":{"type":"string","minLength":1,"maxLength":200},"internalDescription":{"type":"string","minLength":2,"maxLength":1000},"priority":{"minimum":0,"type":"integer"},"status":{"enum":["ACTIVE","INACTIVE","ARCHIVED"],"type":"string"},"details":{"items":{"$ref":"#/components/schemas/BadgeDetailsDefinition"},"type":"array"}},"type":"object"},"BadgeDetailsDefinition":{"properties":{"name":{"type":"string","minLength":2,"maxLength":200},"description":{"minLength":2,"maxLength":1000,"type":"string"},"artworkUrl":{"format":"url","type":"string"},"locale":{"enum":["en","fr","de","it","es","nl","ar","bn","gu","hi","id","ja","ko","ml","mr","mt","pl","pt","ru","sv","ta","te","th","tl","tr","uk","ur","vi"],"type":"string"}},"type":"object","required":["name","locale"]}}}} ``` ## The SeedTenantDataCommand object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"SeedTenantDataCommand":{"properties":{"tenantId":{"type":"string"},"type":{"enum":["DATA_GENERATION","DATA_DESTRUCTION"],"type":"string"}},"type":"object","required":["tenantId","type"]}}}} ``` ## The MissionReactorDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"MissionReactorDefinition":{"properties":{"eventType":{},"constraint":{"type":"object"},"reactions":{"items":{"$ref":"#/components/schemas/ReactionDefinition"},"type":"array"},"maxActivations":{"minimum":1,"type":"integer"},"activationContext":{"enum":["GLOBAL","TENANT","SUBJECT"],"type":"string"},"activationCalculationType":{"enum":["LIFETIME","CALENDAR_PERIOD","ROLLING_WINDOW"],"type":"string"},"activationPeriod":{"type":"string"}},"type":"object"},"ReactionDefinition":{"properties":{"type":{"enum":["HANDLER","REWARD","POINTS","POINTS_CAP","WEBHOOK","ATTRIBUTE","BADGE"],"type":"string"},"handler":{"enum":["EXAMPLE","REFERRAL_TRANCHE_STATUS","MISSION_PROGRESS"],"type":"string"},"points":{"$ref":"#/components/schemas/Derivation"},"attributes":{"items":{"$ref":"#/components/schemas/AttributeKeyValuePair"},"type":"array"},"reward":{},"autoRedeem":{"type":"boolean"},"url":{"format":"url","type":"string"},"forFailure":{"type":"boolean"},"headers":{"type":"object"},"authType":{"enum":["NONE","OAUTH2_CLIENT_CREDENTIALS"],"type":"string"},"authConfig":{"type":"object"},"includeFullSubject":{"type":"boolean"},"badge":{}},"type":"object","required":["type"]},"Derivation":{"properties":{"operation":{"enum":["SUM","PRODUCT"],"type":"string"},"arguments":{"items":{"type":"object"},"type":"array"},"max":{"type":"number"},"roundingDirection":{"enum":["UP","DOWN"],"type":"string"},"roundingUnit":{"minimum":1,"type":"integer"}},"type":"object","required":["operation","arguments"]},"AttributeKeyValuePair":{"properties":{"isEnabled":{"type":"boolean"},"key":{"minLength":1,"maxLength":255,"type":"string"},"value":{}},"type":"object","required":["isEnabled","key","value"]}}}} ``` ## The MissionDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"MissionDefinition":{"properties":{"details":{"items":{"$ref":"#/components/schemas/MissionDetails"},"type":"array","minItems":1},"defaultLocale":{"enum":["en","fr","de","it","es","nl","ar","bn","gu","hi","id","ja","ko","ml","mr","mt","pl","pt","ru","sv","ta","te","th","tl","tr","uk","ur","vi"],"type":"string"},"completionType":{"enum":["COUNT","VALUE","BOOLEAN"],"type":"string"},"targetValue":{"type":"object"},"valueExpression":{"type":"string"},"duration":{"type":"string","pattern":"^P\\d+D$"},"cooldownDuration":{"type":"string","pattern":"^P\\d+D$"},"requiresOptIn":{"type":"boolean"},"displayStyle":{"enum":["PROGRESS_BAR","STAMP_CARD","COUNTER","CHECKBOX"],"type":"string"},"parentMissionId":{"type":"string"},"reactor":{"$ref":"#/components/schemas/MissionReactorDefinition"},"order":{"minimum":0,"type":"number"}},"type":"object","required":["details","reactor"]},"MissionDetails":{"properties":{"locale":{"enum":["en","fr","de","it","es","nl","ar","bn","gu","hi","id","ja","ko","ml","mr","mt","pl","pt","ru","sv","ta","te","th","tl","tr","uk","ur","vi"],"type":"string"},"name":{"minLength":2,"maxLength":128,"type":"string"},"description":{"minLength":2,"maxLength":5000,"type":"string"},"pictureUrl":{"format":"url","type":"string"}},"type":"object","required":["locale"]},"MissionReactorDefinition":{"properties":{"eventType":{},"constraint":{"type":"object"},"reactions":{"items":{"$ref":"#/components/schemas/ReactionDefinition"},"type":"array"},"maxActivations":{"minimum":1,"type":"integer"},"activationContext":{"enum":["GLOBAL","TENANT","SUBJECT"],"type":"string"},"activationCalculationType":{"enum":["LIFETIME","CALENDAR_PERIOD","ROLLING_WINDOW"],"type":"string"},"activationPeriod":{"type":"string"}},"type":"object"},"ReactionDefinition":{"properties":{"type":{"enum":["HANDLER","REWARD","POINTS","POINTS_CAP","WEBHOOK","ATTRIBUTE","BADGE"],"type":"string"},"handler":{"enum":["EXAMPLE","REFERRAL_TRANCHE_STATUS","MISSION_PROGRESS"],"type":"string"},"points":{"$ref":"#/components/schemas/Derivation"},"attributes":{"items":{"$ref":"#/components/schemas/AttributeKeyValuePair"},"type":"array"},"reward":{},"autoRedeem":{"type":"boolean"},"url":{"format":"url","type":"string"},"forFailure":{"type":"boolean"},"headers":{"type":"object"},"authType":{"enum":["NONE","OAUTH2_CLIENT_CREDENTIALS"],"type":"string"},"authConfig":{"type":"object"},"includeFullSubject":{"type":"boolean"},"badge":{}},"type":"object","required":["type"]},"Derivation":{"properties":{"operation":{"enum":["SUM","PRODUCT"],"type":"string"},"arguments":{"items":{"type":"object"},"type":"array"},"max":{"type":"number"},"roundingDirection":{"enum":["UP","DOWN"],"type":"string"},"roundingUnit":{"minimum":1,"type":"integer"}},"type":"object","required":["operation","arguments"]},"AttributeKeyValuePair":{"properties":{"isEnabled":{"type":"boolean"},"key":{"minLength":1,"maxLength":255,"type":"string"},"value":{}},"type":"object","required":["isEnabled","key","value"]}}}} ``` ## The EarningCampaignEffectivityDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"EarningCampaignEffectivityDefinition":{"properties":{"start":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"end":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"availableImmediately":{"type":"boolean"}},"type":"object"}}}} ``` ## The EarningCampaignDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"EarningCampaignDefinition":{"properties":{"details":{"items":{"$ref":"#/components/schemas/EarningCampaignDetails"},"type":"array","minItems":1},"defaultLocale":{"enum":["en","fr","de","it","es","nl","ar","bn","gu","hi","id","ja","ko","ml","mr","mt","pl","pt","ru","sv","ta","te","th","tl","tr","uk","ur","vi"],"type":"string"},"effectivity":{"$ref":"#/components/schemas/EarningCampaignEffectivityDefinition"},"type":{"enum":["GOAL_BASED","RULE_BASED"],"type":"string"},"status":{"enum":["DRAFT","ACTIVE","PAUSED","ENDED","ARCHIVED"],"type":"string"},"visibilityCriteria":{},"missions":{"items":{"$ref":"#/components/schemas/MissionDefinition"},"type":"array"},"reactions":{"items":{"$ref":"#/components/schemas/ReactionDefinition"},"type":"array"}},"type":"object","required":["details","effectivity","type"]},"EarningCampaignDetails":{"properties":{"locale":{"enum":["en","fr","de","it","es","nl","ar","bn","gu","hi","id","ja","ko","ml","mr","mt","pl","pt","ru","sv","ta","te","th","tl","tr","uk","ur","vi"],"type":"string"},"name":{"minLength":2,"maxLength":128,"type":"string"},"description":{"minLength":2,"maxLength":5000,"type":"string"},"pictureUrl":{"format":"url","type":"string"}},"type":"object","required":["locale"]},"EarningCampaignEffectivityDefinition":{"properties":{"start":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"end":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"availableImmediately":{"type":"boolean"}},"type":"object"},"MissionDefinition":{"properties":{"details":{"items":{"$ref":"#/components/schemas/MissionDetails"},"type":"array","minItems":1},"defaultLocale":{"enum":["en","fr","de","it","es","nl","ar","bn","gu","hi","id","ja","ko","ml","mr","mt","pl","pt","ru","sv","ta","te","th","tl","tr","uk","ur","vi"],"type":"string"},"completionType":{"enum":["COUNT","VALUE","BOOLEAN"],"type":"string"},"targetValue":{"type":"object"},"valueExpression":{"type":"string"},"duration":{"type":"string","pattern":"^P\\d+D$"},"cooldownDuration":{"type":"string","pattern":"^P\\d+D$"},"requiresOptIn":{"type":"boolean"},"displayStyle":{"enum":["PROGRESS_BAR","STAMP_CARD","COUNTER","CHECKBOX"],"type":"string"},"parentMissionId":{"type":"string"},"reactor":{"$ref":"#/components/schemas/MissionReactorDefinition"},"order":{"minimum":0,"type":"number"}},"type":"object","required":["details","reactor"]},"MissionDetails":{"properties":{"locale":{"enum":["en","fr","de","it","es","nl","ar","bn","gu","hi","id","ja","ko","ml","mr","mt","pl","pt","ru","sv","ta","te","th","tl","tr","uk","ur","vi"],"type":"string"},"name":{"minLength":2,"maxLength":128,"type":"string"},"description":{"minLength":2,"maxLength":5000,"type":"string"},"pictureUrl":{"format":"url","type":"string"}},"type":"object","required":["locale"]},"MissionReactorDefinition":{"properties":{"eventType":{},"constraint":{"type":"object"},"reactions":{"items":{"$ref":"#/components/schemas/ReactionDefinition"},"type":"array"},"maxActivations":{"minimum":1,"type":"integer"},"activationContext":{"enum":["GLOBAL","TENANT","SUBJECT"],"type":"string"},"activationCalculationType":{"enum":["LIFETIME","CALENDAR_PERIOD","ROLLING_WINDOW"],"type":"string"},"activationPeriod":{"type":"string"}},"type":"object"},"ReactionDefinition":{"properties":{"type":{"enum":["HANDLER","REWARD","POINTS","POINTS_CAP","WEBHOOK","ATTRIBUTE","BADGE"],"type":"string"},"handler":{"enum":["EXAMPLE","REFERRAL_TRANCHE_STATUS","MISSION_PROGRESS"],"type":"string"},"points":{"$ref":"#/components/schemas/Derivation"},"attributes":{"items":{"$ref":"#/components/schemas/AttributeKeyValuePair"},"type":"array"},"reward":{},"autoRedeem":{"type":"boolean"},"url":{"format":"url","type":"string"},"forFailure":{"type":"boolean"},"headers":{"type":"object"},"authType":{"enum":["NONE","OAUTH2_CLIENT_CREDENTIALS"],"type":"string"},"authConfig":{"type":"object"},"includeFullSubject":{"type":"boolean"},"badge":{}},"type":"object","required":["type"]},"Derivation":{"properties":{"operation":{"enum":["SUM","PRODUCT"],"type":"string"},"arguments":{"items":{"type":"object"},"type":"array"},"max":{"type":"number"},"roundingDirection":{"enum":["UP","DOWN"],"type":"string"},"roundingUnit":{"minimum":1,"type":"integer"}},"type":"object","required":["operation","arguments"]},"AttributeKeyValuePair":{"properties":{"isEnabled":{"type":"boolean"},"key":{"minLength":1,"maxLength":255,"type":"string"},"value":{}},"type":"object","required":["isEnabled","key","value"]}}}} ``` ## The EarningCampaignEffectivityPatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"EarningCampaignEffectivityPatch":{"properties":{"start":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"end":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"availableImmediately":{"type":"boolean"}},"type":"object"}}}} ``` ## The EarningCampaignPatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"EarningCampaignPatch":{"properties":{"details":{"items":{"$ref":"#/components/schemas/EarningCampaignDetails"},"type":"array","minItems":1},"defaultLocale":{"enum":["en","fr","de","it","es","nl","ar","bn","gu","hi","id","ja","ko","ml","mr","mt","pl","pt","ru","sv","ta","te","th","tl","tr","uk","ur","vi"],"type":"string"},"effectivity":{"$ref":"#/components/schemas/EarningCampaignEffectivityPatch"},"visibilityCriteria":{},"type":{"enum":["GOAL_BASED","RULE_BASED"],"type":"string"},"reactions":{"items":{"$ref":"#/components/schemas/ReactionDefinition"},"type":"array"}},"type":"object"},"EarningCampaignDetails":{"properties":{"locale":{"enum":["en","fr","de","it","es","nl","ar","bn","gu","hi","id","ja","ko","ml","mr","mt","pl","pt","ru","sv","ta","te","th","tl","tr","uk","ur","vi"],"type":"string"},"name":{"minLength":2,"maxLength":128,"type":"string"},"description":{"minLength":2,"maxLength":5000,"type":"string"},"pictureUrl":{"format":"url","type":"string"}},"type":"object","required":["locale"]},"EarningCampaignEffectivityPatch":{"properties":{"start":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"end":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"availableImmediately":{"type":"boolean"}},"type":"object"},"ReactionDefinition":{"properties":{"type":{"enum":["HANDLER","REWARD","POINTS","POINTS_CAP","WEBHOOK","ATTRIBUTE","BADGE"],"type":"string"},"handler":{"enum":["EXAMPLE","REFERRAL_TRANCHE_STATUS","MISSION_PROGRESS"],"type":"string"},"points":{"$ref":"#/components/schemas/Derivation"},"attributes":{"items":{"$ref":"#/components/schemas/AttributeKeyValuePair"},"type":"array"},"reward":{},"autoRedeem":{"type":"boolean"},"url":{"format":"url","type":"string"},"forFailure":{"type":"boolean"},"headers":{"type":"object"},"authType":{"enum":["NONE","OAUTH2_CLIENT_CREDENTIALS"],"type":"string"},"authConfig":{"type":"object"},"includeFullSubject":{"type":"boolean"},"badge":{}},"type":"object","required":["type"]},"Derivation":{"properties":{"operation":{"enum":["SUM","PRODUCT"],"type":"string"},"arguments":{"items":{"type":"object"},"type":"array"},"max":{"type":"number"},"roundingDirection":{"enum":["UP","DOWN"],"type":"string"},"roundingUnit":{"minimum":1,"type":"integer"}},"type":"object","required":["operation","arguments"]},"AttributeKeyValuePair":{"properties":{"isEnabled":{"type":"boolean"},"key":{"minLength":1,"maxLength":255,"type":"string"},"value":{}},"type":"object","required":["isEnabled","key","value"]}}}} ``` ## The EarningCampaignStatusTransition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"EarningCampaignStatusTransition":{"properties":{"status":{"enum":["DRAFT","ACTIVE","PAUSED","ENDED","ARCHIVED"],"type":"string"}},"type":"object","required":["status"]}}}} ``` ## The LeaderboardDetailsDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"LeaderboardDetailsDefinition":{"properties":{"name":{"type":"string","minLength":2,"maxLength":200},"description":{"minLength":2,"maxLength":1000,"type":"string"},"locale":{"enum":["en","fr","de","it","es","nl","ar","bn","gu","hi","id","ja","ko","ml","mr","mt","pl","pt","ru","sv","ta","te","th","tl","tr","uk","ur","vi"],"type":"string"}},"type":"object","required":["name","locale"]}}}} ``` ## The LeaderboardDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"LeaderboardDefinition":{"properties":{"internalName":{"type":"string","minLength":2,"maxLength":200},"rankingMetric":{"enum":["POINTS"],"type":"string"},"status":{"enum":["ACTIVE","INACTIVE","ARCHIVED"],"type":"string"},"timeWindowType":{"type":"string","enum":["LIFETIME","FIXED","RECURRING"]},"recurrenceSchedule":{"enum":["WEEKLY","MONTHLY","QUARTERLY","YEARLY"],"type":"string"},"startDate":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"availableImmediately":{"type":"boolean"},"endDate":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"audienceIds":{"items":{"format":"uuid","type":"string"},"type":"array"},"boardSize":{"minimum":1,"type":"integer"},"priority":{"minimum":0,"type":"integer"},"details":{"type":"object"},"defaultLocale":{"enum":["en","fr","de","it","es","nl","ar","bn","gu","hi","id","ja","ko","ml","mr","mt","pl","pt","ru","sv","ta","te","th","tl","tr","uk","ur","vi"],"type":"string"}},"type":"object","required":["internalName","timeWindowType","details","defaultLocale"]}}}} ``` ## The LeaderboardPatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"LeaderboardPatch":{"properties":{"internalName":{"type":"string","minLength":2,"maxLength":200},"rankingMetric":{"enum":["POINTS"],"type":"string"},"timeWindowType":{"enum":["LIFETIME","FIXED","RECURRING"],"type":"string"},"recurrenceSchedule":{"enum":["WEEKLY","MONTHLY","QUARTERLY","YEARLY"],"type":"string"},"startDate":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"endDate":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"audienceIds":{"items":{"format":"uuid","type":"string"},"type":"array"},"boardSize":{"minimum":1,"type":"integer"},"priority":{"minimum":0,"type":"integer"},"defaultLocale":{"enum":["en","fr","de","it","es","nl","ar","bn","gu","hi","id","ja","ko","ml","mr","mt","pl","pt","ru","sv","ta","te","th","tl","tr","uk","ur","vi"],"type":"string"},"details":{"items":{"$ref":"#/components/schemas/LeaderboardDetailsDefinition"},"type":"array"}},"type":"object"},"LeaderboardDetailsDefinition":{"properties":{"name":{"type":"string","minLength":2,"maxLength":200},"description":{"minLength":2,"maxLength":1000,"type":"string"},"locale":{"enum":["en","fr","de","it","es","nl","ar","bn","gu","hi","id","ja","ko","ml","mr","mt","pl","pt","ru","sv","ta","te","th","tl","tr","uk","ur","vi"],"type":"string"}},"type":"object","required":["name","locale"]}}}} ``` ## The LeaderboardStatusTransition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"LeaderboardStatusTransition":{"properties":{"status":{"enum":["ACTIVE","INACTIVE","ARCHIVED"],"type":"string"}},"type":"object","required":["status"]}}}} ``` ## The RefreshLeaderboardCommand object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"RefreshLeaderboardCommand":{"properties":{"leaderboardId":{"type":"string"},"tenantId":{"type":"string"}},"type":"object","required":["leaderboardId","tenantId"]}}}} ``` ## The MissionReactorPatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"MissionReactorPatch":{"properties":{"constraint":{"type":"object"},"reactions":{"items":{"$ref":"#/components/schemas/ReactionDefinition"},"type":"array"},"maxActivations":{"minimum":1,"type":"integer"},"activationContext":{"enum":["GLOBAL","TENANT","SUBJECT"],"type":"string"},"activationCalculationType":{"enum":["LIFETIME","CALENDAR_PERIOD","ROLLING_WINDOW"],"type":"string"},"activationPeriod":{"type":"string"}},"type":"object"},"ReactionDefinition":{"properties":{"type":{"enum":["HANDLER","REWARD","POINTS","POINTS_CAP","WEBHOOK","ATTRIBUTE","BADGE"],"type":"string"},"handler":{"enum":["EXAMPLE","REFERRAL_TRANCHE_STATUS","MISSION_PROGRESS"],"type":"string"},"points":{"$ref":"#/components/schemas/Derivation"},"attributes":{"items":{"$ref":"#/components/schemas/AttributeKeyValuePair"},"type":"array"},"reward":{},"autoRedeem":{"type":"boolean"},"url":{"format":"url","type":"string"},"forFailure":{"type":"boolean"},"headers":{"type":"object"},"authType":{"enum":["NONE","OAUTH2_CLIENT_CREDENTIALS"],"type":"string"},"authConfig":{"type":"object"},"includeFullSubject":{"type":"boolean"},"badge":{}},"type":"object","required":["type"]},"Derivation":{"properties":{"operation":{"enum":["SUM","PRODUCT"],"type":"string"},"arguments":{"items":{"type":"object"},"type":"array"},"max":{"type":"number"},"roundingDirection":{"enum":["UP","DOWN"],"type":"string"},"roundingUnit":{"minimum":1,"type":"integer"}},"type":"object","required":["operation","arguments"]},"AttributeKeyValuePair":{"properties":{"isEnabled":{"type":"boolean"},"key":{"minLength":1,"maxLength":255,"type":"string"},"value":{}},"type":"object","required":["isEnabled","key","value"]}}}} ``` ## The MissionPatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"MissionPatch":{"properties":{"details":{"items":{"$ref":"#/components/schemas/MissionDetails"},"type":"array","minItems":1},"defaultLocale":{"enum":["en","fr","de","it","es","nl","ar","bn","gu","hi","id","ja","ko","ml","mr","mt","pl","pt","ru","sv","ta","te","th","tl","tr","uk","ur","vi"],"type":"string"},"completionType":{"enum":["COUNT","VALUE","BOOLEAN"],"type":"string"},"targetValue":{"type":"object"},"valueExpression":{"type":"string"},"duration":{"type":"string","pattern":"^P\\d+D$"},"cooldownDuration":{"type":"string","pattern":"^P\\d+D$"},"requiresOptIn":{"type":"boolean"},"displayStyle":{"enum":["PROGRESS_BAR","STAMP_CARD","COUNTER","CHECKBOX"],"type":"string"},"reactor":{"$ref":"#/components/schemas/MissionReactorPatch"},"order":{"minimum":0,"type":"number"}},"type":"object"},"MissionDetails":{"properties":{"locale":{"enum":["en","fr","de","it","es","nl","ar","bn","gu","hi","id","ja","ko","ml","mr","mt","pl","pt","ru","sv","ta","te","th","tl","tr","uk","ur","vi"],"type":"string"},"name":{"minLength":2,"maxLength":128,"type":"string"},"description":{"minLength":2,"maxLength":5000,"type":"string"},"pictureUrl":{"format":"url","type":"string"}},"type":"object","required":["locale"]},"MissionReactorPatch":{"properties":{"constraint":{"type":"object"},"reactions":{"items":{"$ref":"#/components/schemas/ReactionDefinition"},"type":"array"},"maxActivations":{"minimum":1,"type":"integer"},"activationContext":{"enum":["GLOBAL","TENANT","SUBJECT"],"type":"string"},"activationCalculationType":{"enum":["LIFETIME","CALENDAR_PERIOD","ROLLING_WINDOW"],"type":"string"},"activationPeriod":{"type":"string"}},"type":"object"},"ReactionDefinition":{"properties":{"type":{"enum":["HANDLER","REWARD","POINTS","POINTS_CAP","WEBHOOK","ATTRIBUTE","BADGE"],"type":"string"},"handler":{"enum":["EXAMPLE","REFERRAL_TRANCHE_STATUS","MISSION_PROGRESS"],"type":"string"},"points":{"$ref":"#/components/schemas/Derivation"},"attributes":{"items":{"$ref":"#/components/schemas/AttributeKeyValuePair"},"type":"array"},"reward":{},"autoRedeem":{"type":"boolean"},"url":{"format":"url","type":"string"},"forFailure":{"type":"boolean"},"headers":{"type":"object"},"authType":{"enum":["NONE","OAUTH2_CLIENT_CREDENTIALS"],"type":"string"},"authConfig":{"type":"object"},"includeFullSubject":{"type":"boolean"},"badge":{}},"type":"object","required":["type"]},"Derivation":{"properties":{"operation":{"enum":["SUM","PRODUCT"],"type":"string"},"arguments":{"items":{"type":"object"},"type":"array"},"max":{"type":"number"},"roundingDirection":{"enum":["UP","DOWN"],"type":"string"},"roundingUnit":{"minimum":1,"type":"integer"}},"type":"object","required":["operation","arguments"]},"AttributeKeyValuePair":{"properties":{"isEnabled":{"type":"boolean"},"key":{"minLength":1,"maxLength":255,"type":"string"},"value":{}},"type":"object","required":["isEnabled","key","value"]}}}} ``` ## The MissionOrderItem object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"MissionOrderItem":{"properties":{"missionId":{"format":"uuid","type":"string"},"order":{"minimum":0,"type":"number"}},"type":"object","required":["missionId"]}}}} ``` ## The MissionReorder object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"MissionReorder":{"properties":{"missions":{"items":{"$ref":"#/components/schemas/MissionOrderItem"},"type":"array","minItems":1}},"type":"object","required":["missions"]},"MissionOrderItem":{"properties":{"missionId":{"format":"uuid","type":"string"},"order":{"minimum":0,"type":"number"}},"type":"object","required":["missionId"]}}}} ``` ## The PointsLiabilityCriteriaDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"PointsLiabilityCriteriaDefinition":{"properties":{"type":{"enum":["SIMPLE_EXPIRY","MAXIMUM_POINTS_SPEND_CAP","MAXIMUM_POINTS_EARN_CAP","MAXIMUM_POINTS_BALANCE_CAP","PURCHASE_REWARDS"],"type":"string"},"liabilityType":{"enum":["EXPIRY","SPENDING_CAP","EARNING_CAP","PURCHASE_REWARDS"],"type":"string"},"config":{},"name":{"minLength":1,"maxLength":255,"type":"string"}},"type":"object","required":["type","liabilityType","config","name"]}}}} ``` ## The PointsLiabilityCriteriaPatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"PointsLiabilityCriteriaPatch":{"properties":{"type":{"enum":["SIMPLE_EXPIRY","MAXIMUM_POINTS_SPEND_CAP","MAXIMUM_POINTS_EARN_CAP","MAXIMUM_POINTS_BALANCE_CAP","PURCHASE_REWARDS"],"type":"string"},"liabilityType":{"enum":["EXPIRY","SPENDING_CAP","EARNING_CAP","PURCHASE_REWARDS"],"type":"string"},"isActive":{"type":"boolean"},"config":{},"name":{"minLength":1,"maxLength":255,"type":"string"}},"type":"object"}}}} ``` ## The CategoryDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"CategoryDefinition":{"properties":{"name":{"type":"string","minLength":2,"maxLength":64},"priority":{"type":"number"},"pictureUrl":{"format":"url","type":"string"},"description":{"minLength":2,"maxLength":5000,"type":"string"},"parent":{"$ref":"#/components/schemas/Hydratable"},"defaultLocale":{"enum":["en","fr","de","it","es","nl","ar","bn","gu","hi","id","ja","ko","ml","mr","mt","pl","pt","ru","sv","ta","te","th","tl","tr","uk","ur","vi"],"type":"string"},"details":{"items":{"$ref":"#/components/schemas/RewardCategoryDetails"},"type":"array"}},"type":"object","required":["name","priority"]},"Hydratable":{"properties":{"id":{"format":"uuid","type":"string"}},"type":"object","required":["id"]},"RewardCategoryDetails":{"properties":{"locale":{"enum":["en","fr","de","it","es","nl","ar","bn","gu","hi","id","ja","ko","ml","mr","mt","pl","pt","ru","sv","ta","te","th","tl","tr","uk","ur","vi"],"type":"string"},"name":{"type":"string","minLength":2,"maxLength":64},"pictureUrl":{"format":"url","type":"string"},"description":{"minLength":2,"maxLength":5000,"type":"string"}},"type":"object","required":["locale"]}}}} ``` ## The CategoryPatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"CategoryPatch":{"properties":{"name":{"type":"string","minLength":2,"maxLength":64},"priority":{"type":"number"},"pictureUrl":{"format":"url","type":"string"},"description":{"minLength":2,"maxLength":5000,"type":"string"},"parent":{"$ref":"#/components/schemas/Hydratable"},"defaultLocale":{"enum":["en","fr","de","it","es","nl","ar","bn","gu","hi","id","ja","ko","ml","mr","mt","pl","pt","ru","sv","ta","te","th","tl","tr","uk","ur","vi"],"type":"string"},"details":{"items":{"$ref":"#/components/schemas/RewardCategoryDetails"},"type":"array"}},"type":"object"},"Hydratable":{"properties":{"id":{"format":"uuid","type":"string"}},"type":"object","required":["id"]},"RewardCategoryDetails":{"properties":{"locale":{"enum":["en","fr","de","it","es","nl","ar","bn","gu","hi","id","ja","ko","ml","mr","mt","pl","pt","ru","sv","ta","te","th","tl","tr","uk","ur","vi"],"type":"string"},"name":{"type":"string","minLength":2,"maxLength":64},"pictureUrl":{"format":"url","type":"string"},"description":{"minLength":2,"maxLength":5000,"type":"string"}},"type":"object","required":["locale"]}}}} ``` ## The SettingDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"SettingDefinition":{"properties":{"name":{"type":"string","minLength":2,"maxLength":64,"pattern":"^[a-zA-Z./]+$"},"value":{"type":"string","minLength":1,"maxLength":8192,"pattern":"^[\\x00-\\x7F]+$"}},"type":"object","required":["name","value"]}}}} ``` ## The SettingPatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"SettingPatch":{"properties":{"name":{"type":"string","minLength":2,"maxLength":64,"pattern":"^[a-zA-Z./]+$"},"value":{"type":"string","minLength":1,"maxLength":8192,"pattern":"^[\\x00-\\x7F]+$"}},"type":"object","required":["name"]}}}} ``` ## The TeamMembershipDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"TeamMembershipDefinition":{"properties":{"user":{"$ref":"#/components/schemas/Hydratable"},"role":{"enum":["LEADER","MEMBER"],"type":"string"}},"type":"object","required":["user","role"]},"Hydratable":{"properties":{"id":{"format":"uuid","type":"string"}},"type":"object","required":["id"]}}}} ``` ## The TeamProfileDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"TeamProfileDefinition":{"properties":{"name":{"type":"string","minLength":1,"maxLength":128},"attributes":{"type":"object"}},"type":"object","required":["name"]}}}} ``` ## The TeamDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"TeamDefinition":{"properties":{"memberDefinitions":{"items":{"$ref":"#/components/schemas/TeamMembershipDefinition"},"type":"array"},"profile":{"$ref":"#/components/schemas/TeamProfileDefinition"},"externalIdentifier":{"maxLength":512,"type":"string"},"isRestricted":{"type":"boolean"},"linkedVenuesDefinitions":{"items":{"$ref":"#/components/schemas/VenueDefinition"},"type":"array"},"linkedVenues":{"items":{"$ref":"#/components/schemas/Hydratable"},"type":"array"},"consentsDefinition":{"items":{"$ref":"#/components/schemas/UserConsentDefinition"},"type":"array"}},"type":"object","required":["profile"]},"TeamMembershipDefinition":{"properties":{"user":{"$ref":"#/components/schemas/Hydratable"},"role":{"enum":["LEADER","MEMBER"],"type":"string"}},"type":"object","required":["user","role"]},"Hydratable":{"properties":{"id":{"format":"uuid","type":"string"}},"type":"object","required":["id"]},"TeamProfileDefinition":{"properties":{"name":{"type":"string","minLength":1,"maxLength":128},"attributes":{"type":"object"}},"type":"object","required":["name"]},"VenueDefinition":{"properties":{"name":{"type":"string","minLength":1,"maxLength":64},"address":{"type":"string","minLength":1,"maxLength":512},"description":{"type":"string","minLength":1,"maxLength":1024},"availability":{"$ref":"#/components/schemas/Effectivity"},"coordinates":{"$ref":"#/components/schemas/GeoPoint"},"attributes":{"$ref":"#/components/schemas/VenueAttributes"},"externalIdentifier":{"maxLength":512,"type":"string"},"isUserModifiable":{"type":"boolean"},"postcode":{"minLength":1,"maxLength":128,"type":"string"},"type":{"enum":["TENANT","USER","MERCHANT"],"type":"string"},"contactDetails":{"items":{"$ref":"#/components/schemas/VenueContactDetails"},"type":"array"}},"type":"object","required":["name","address","availability","coordinates"]},"Effectivity":{"properties":{"start":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"end":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]}},"type":"object","required":["start"]},"GeoPoint":{"properties":{"longitude":{"minimum":-180,"type":"number","maximum":180},"latitude":{"minimum":-90,"type":"number","maximum":90}},"type":"object","required":["longitude","latitude"]},"VenueAttributes":{"properties":{"bookingUrl":{"format":"url","type":"string"},"telephoneNumber":{"type":"string"},"openingTimes":{"type":"object"}},"type":"object"},"VenueContactDetails":{"properties":{"type":{"enum":["email","phone","sms","link"],"type":"string"},"name":{"type":"string"},"value":{"type":"string"},"imageUri":{"format":"url","type":"string"}},"type":"object","required":["type","name","value"]},"UserConsentDefinition":{"properties":{"type":{"$ref":"#/components/schemas/Hydratable"},"checked":{"type":"boolean"},"user":{"$ref":"#/components/schemas/Hydratable"},"id":{"format":"uuid","type":"string"}},"type":"object","required":["type","checked"]}}}} ``` ## The TeamInvitation object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"TeamInvitation":{"properties":{"type":{"enum":["REGISTER_ACCOUNT"],"type":"string"},"role":{"enum":["LEADER","MEMBER"],"type":"string"},"profile":{"$ref":"#/components/schemas/UserProfileDefinition"}},"type":"object","required":["type","role"]},"UserProfileDefinition":{"properties":{"familyName":{"type":"string","minLength":1,"maxLength":64},"givenName":{"type":"string","minLength":1,"maxLength":64},"emailAddress":{"format":"email","type":"string"},"gender":{"enum":["FEMALE","MALE","OTHER","UNKNOWN"],"type":"string"},"birthdate":{"pattern":"^(19[0-9][0-9]|20[0-3][0-9])-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","type":"string"},"country":{"enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"type":"string"},"city":{"type":"string","minLength":1,"maxLength":256},"postcode":{"type":"string","minLength":1,"maxLength":128},"pictureUrl":{"format":"url","type":"string"},"streetAddress":{"minLength":1,"maxLength":64,"type":"string"},"telephoneNumber":{"type":"string"},"region":{"type":"string"},"attributionData":{"type":"object"},"attributes":{"type":"object"}},"type":"object","required":["familyName","givenName"]}}}} ``` ## The TeamMembershipPatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"TeamMembershipPatch":{"properties":{"role":{"enum":["LEADER","MEMBER"],"type":"string"}},"type":"object","required":["role"]}}}} ``` ## The ActorPatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"ActorPatch":{"properties":{"externalIdentifier":{"maxLength":512,"type":"string"},"linkedVenuesDefinitions":{"items":{"$ref":"#/components/schemas/VenueDefinition"},"type":"array"},"linkedVenues":{"items":{"$ref":"#/components/schemas/Hydratable"},"type":"array"},"consentsDefinition":{"items":{"$ref":"#/components/schemas/UserConsentDefinition"},"type":"array"},"isRestricted":{"type":"boolean"}},"type":"object"},"VenueDefinition":{"properties":{"name":{"type":"string","minLength":1,"maxLength":64},"address":{"type":"string","minLength":1,"maxLength":512},"description":{"type":"string","minLength":1,"maxLength":1024},"availability":{"$ref":"#/components/schemas/Effectivity"},"coordinates":{"$ref":"#/components/schemas/GeoPoint"},"attributes":{"$ref":"#/components/schemas/VenueAttributes"},"externalIdentifier":{"maxLength":512,"type":"string"},"isUserModifiable":{"type":"boolean"},"postcode":{"minLength":1,"maxLength":128,"type":"string"},"type":{"enum":["TENANT","USER","MERCHANT"],"type":"string"},"contactDetails":{"items":{"$ref":"#/components/schemas/VenueContactDetails"},"type":"array"}},"type":"object","required":["name","address","availability","coordinates"]},"Effectivity":{"properties":{"start":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"end":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]}},"type":"object","required":["start"]},"GeoPoint":{"properties":{"longitude":{"minimum":-180,"type":"number","maximum":180},"latitude":{"minimum":-90,"type":"number","maximum":90}},"type":"object","required":["longitude","latitude"]},"VenueAttributes":{"properties":{"bookingUrl":{"format":"url","type":"string"},"telephoneNumber":{"type":"string"},"openingTimes":{"type":"object"}},"type":"object"},"VenueContactDetails":{"properties":{"type":{"enum":["email","phone","sms","link"],"type":"string"},"name":{"type":"string"},"value":{"type":"string"},"imageUri":{"format":"url","type":"string"}},"type":"object","required":["type","name","value"]},"Hydratable":{"properties":{"id":{"format":"uuid","type":"string"}},"type":"object","required":["id"]},"UserConsentDefinition":{"properties":{"type":{"$ref":"#/components/schemas/Hydratable"},"checked":{"type":"boolean"},"user":{"$ref":"#/components/schemas/Hydratable"},"id":{"format":"uuid","type":"string"}},"type":"object","required":["type","checked"]}}}} ``` ## The ProfilePatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"ProfilePatch":{"properties":{"attributes":{"type":"object"}},"type":"object"}}}} ``` ## The TeamProfilePatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"TeamProfilePatch":{"properties":{"name":{"type":"string","minLength":1,"maxLength":128},"attributes":{"type":"object"}},"type":"object"}}}} ``` ## The TeamPatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"TeamPatch":{"properties":{"profile":{"$ref":"#/components/schemas/TeamProfilePatch"},"externalIdentifier":{"maxLength":512,"type":"string"},"linkedVenuesDefinitions":{"items":{"$ref":"#/components/schemas/VenueDefinition"},"type":"array"},"linkedVenues":{"items":{"$ref":"#/components/schemas/Hydratable"},"type":"array"},"consentsDefinition":{"items":{"$ref":"#/components/schemas/UserConsentDefinition"},"type":"array"},"isRestricted":{"type":"boolean"}},"type":"object"},"TeamProfilePatch":{"properties":{"name":{"type":"string","minLength":1,"maxLength":128},"attributes":{"type":"object"}},"type":"object"},"VenueDefinition":{"properties":{"name":{"type":"string","minLength":1,"maxLength":64},"address":{"type":"string","minLength":1,"maxLength":512},"description":{"type":"string","minLength":1,"maxLength":1024},"availability":{"$ref":"#/components/schemas/Effectivity"},"coordinates":{"$ref":"#/components/schemas/GeoPoint"},"attributes":{"$ref":"#/components/schemas/VenueAttributes"},"externalIdentifier":{"maxLength":512,"type":"string"},"isUserModifiable":{"type":"boolean"},"postcode":{"minLength":1,"maxLength":128,"type":"string"},"type":{"enum":["TENANT","USER","MERCHANT"],"type":"string"},"contactDetails":{"items":{"$ref":"#/components/schemas/VenueContactDetails"},"type":"array"}},"type":"object","required":["name","address","availability","coordinates"]},"Effectivity":{"properties":{"start":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"end":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]}},"type":"object","required":["start"]},"GeoPoint":{"properties":{"longitude":{"minimum":-180,"type":"number","maximum":180},"latitude":{"minimum":-90,"type":"number","maximum":90}},"type":"object","required":["longitude","latitude"]},"VenueAttributes":{"properties":{"bookingUrl":{"format":"url","type":"string"},"telephoneNumber":{"type":"string"},"openingTimes":{"type":"object"}},"type":"object"},"VenueContactDetails":{"properties":{"type":{"enum":["email","phone","sms","link"],"type":"string"},"name":{"type":"string"},"value":{"type":"string"},"imageUri":{"format":"url","type":"string"}},"type":"object","required":["type","name","value"]},"Hydratable":{"properties":{"id":{"format":"uuid","type":"string"}},"type":"object","required":["id"]},"UserConsentDefinition":{"properties":{"type":{"$ref":"#/components/schemas/Hydratable"},"checked":{"type":"boolean"},"user":{"$ref":"#/components/schemas/Hydratable"},"id":{"format":"uuid","type":"string"}},"type":"object","required":["type","checked"]}}}} ``` ## The TenantDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"TenantDefinition":{"properties":{"name":{"minLength":1,"maxLength":64,"type":"string"},"slug":{"pattern":"^(test--)?[a-z][a-z0-9]+(-[a-z][a-z0-9]+)*$","type":"string"},"authentication":{"type":"object"},"key":{"type":"string"},"timezone":{"maxLength":64,"type":"string"},"mode":{"type":"string","enum":["live","test"]},"counterpartEnv":{"type":"string","enum":["self","external"]},"liveTenant":{"type":"string"}},"type":"object","required":["name","slug"]}}}} ``` ## The TenantPatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"TenantPatch":{"properties":{"configuration":{"$ref":"#/components/schemas/TenantConfiguration"},"profileSchema":{"type":"object"}},"type":"object","required":["configuration"]},"TenantConfiguration":{"properties":{"allowDuplicateEmailAddress":{"type":"boolean"},"allowDuplicateTelephoneNumber":{"type":"boolean"},"allowedTeamInvitationTypes":{"items":{"enum":["REGISTER_ACCOUNT"],"type":"string"},"type":"array"},"enableUserGenderGuessing":{"type":"boolean"},"deleteAuthIdentifiers":{"type":"boolean"}},"type":"object"}}}} ``` ## The TenantUpdatedPlatformEventPayload object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"TenantUpdatedPlatformEventPayload":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"authentication":{"type":"object"},"timezone":{"maxLength":64,"type":"string"},"mode":{"type":"string","enum":["live","test"]},"counterpartEnv":{"type":"string","enum":["self","external"]},"liveTenant":{"type":"string"}},"type":"object","required":["id"]}}}} ``` ## The TierDetailsDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"TierDetailsDefinition":{"properties":{"name":{"type":"string","minLength":2,"maxLength":200},"description":{"minLength":2,"maxLength":1000,"type":"string"},"artworkUrl":{"format":"url","type":"string"},"locale":{"enum":["en","fr","de","it","es","nl","ar","bn","gu","hi","id","ja","ko","ml","mr","mt","pl","pt","ru","sv","ta","te","th","tl","tr","uk","ur","vi"],"type":"string"}},"type":"object","required":["name","locale"]}}}} ``` ## The TierDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"TierDefinition":{"properties":{"pointsRequirement":{"minimum":0,"type":"integer"},"effectivity":{"$ref":"#/components/schemas/Effectivity"},"calculation":{"enum":["LIFETIME_EARN","CALENDAR_PERIOD","ROLLING_WINDOW"],"type":"string"},"accumulationPeriod":{"type":"object"},"priority":{"minimum":0,"type":"integer"},"details":{"type":"object"},"defaultLocale":{"enum":["en","fr","de","it","es","nl","ar","bn","gu","hi","id","ja","ko","ml","mr","mt","pl","pt","ru","sv","ta","te","th","tl","tr","uk","ur","vi"],"type":"string"}},"type":"object","required":["pointsRequirement","calculation","priority","details","defaultLocale"]},"Effectivity":{"properties":{"start":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"end":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]}},"type":"object","required":["start"]}}}} ``` ## The TierPatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"TierPatch":{"properties":{"pointsRequirement":{"minimum":0,"type":"integer"},"effectivity":{"$ref":"#/components/schemas/Effectivity"},"calculation":{"enum":["LIFETIME_EARN","CALENDAR_PERIOD","ROLLING_WINDOW"],"type":"string"},"priority":{"minimum":0,"type":"integer"},"accumulationPeriod":{"type":"object"},"details":{"type":"object"},"defaultLocale":{"enum":["en","fr","de","it","es","nl","ar","bn","gu","hi","id","ja","ko","ml","mr","mt","pl","pt","ru","sv","ta","te","th","tl","tr","uk","ur","vi"],"type":"string"}},"type":"object"},"Effectivity":{"properties":{"start":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"end":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]}},"type":"object","required":["start"]}}}} ``` ## The TranslationDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"TranslationDefinition":{"properties":{"content":{"type":"string","minLength":1,"maxLength":500},"locale":{"enum":["en","fr","de","it","es","nl","ar","bn","gu","hi","id","ja","ko","ml","mr","mt","pl","pt","ru","sv","ta","te","th","tl","tr","uk","ur","vi"],"type":"string"},"consentType":{"$ref":"#/components/schemas/Hydratable"}},"type":"object","required":["content","locale","consentType"]},"Hydratable":{"properties":{"id":{"format":"uuid","type":"string"}},"type":"object","required":["id"]}}}} ``` ## The TranslationPatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"TranslationPatch":{"properties":{"content":{"type":"string","minLength":1,"maxLength":500},"locale":{"enum":["en","fr","de","it","es","nl","ar","bn","gu","hi","id","ja","ko","ml","mr","mt","pl","pt","ru","sv","ta","te","th","tl","tr","uk","ur","vi"],"type":"string"},"consentType":{"$ref":"#/components/schemas/Hydratable"}},"type":"object"},"Hydratable":{"properties":{"id":{"format":"uuid","type":"string"}},"type":"object","required":["id"]}}}} ``` ## The ReferralCodeDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"ReferralCodeDefinition":{"properties":{"inviteCode":{"type":"string","minLength":1,"maxLength":1024},"inviteLink":{"type":"string","minLength":3,"maxLength":1024}},"type":"object","required":["inviteCode"]}}}} ``` ## The AdjustPointsCommand object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"AdjustPointsCommand":{"properties":{"points":{"type":"number"},"comment":{"type":"string"}},"type":"object","required":["points"]}}}} ``` ## The CommandDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"CommandDefinition":{"properties":{"type":{"enum":["PURCHASED_REWARD","REDEEMED_VOUCHER","BURNED_VOUCHER","REGISTERED_ACCOUNT","POINTS_ADJUSTED","VOUCHER_GIVEN","REFERRAL_TRANCHE_ACTIVATION","PROFILE_UPDATED","USER_METADATA_UPDATED","CONSENT_GIVEN","CONSENT_REVOKED","CLOSED_ACCOUNT","POINTS_EXPIRED","MISSION_COMPLETED","VOUCHER_VOIDED"],"type":"string"}},"type":"object","required":["type"]}}}} ``` ## The Resource object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"Resource":{"properties":{"type":{"enum":["VOUCHER","VOUCHER_REWARD","WEGIFT_PRODUCT","OLIVE_OFFER","XOXO_PRODUCT"],"type":"string"},"id":{"format":"uuid","type":"string"}},"type":"object","required":["type","id"]}}}} ``` ## The RedemptionDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"RedemptionDefinition":{"properties":{"resource":{"$ref":"#/components/schemas/Resource"},"position":{"$ref":"#/components/schemas/GeoPoint"}},"type":"object","required":["resource"]},"Resource":{"properties":{"type":{"enum":["VOUCHER","VOUCHER_REWARD","WEGIFT_PRODUCT","OLIVE_OFFER","XOXO_PRODUCT"],"type":"string"},"id":{"format":"uuid","type":"string"}},"type":"object","required":["type","id"]},"GeoPoint":{"properties":{"longitude":{"minimum":-180,"type":"number","maximum":180},"latitude":{"minimum":-90,"type":"number","maximum":90}},"type":"object","required":["longitude","latitude"]}}}} ``` ## The UserProfilePatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"UserProfilePatch":{"properties":{"familyName":{"type":"string","minLength":1,"maxLength":64},"givenName":{"type":"string","minLength":1,"maxLength":64},"gender":{"enum":["FEMALE","MALE","OTHER","UNKNOWN"],"type":"string"},"emailAddress":{"format":"email","type":"string"},"birthdate":{"pattern":"^(19[0-9][0-9]|20[0-3][0-9])-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","type":"string"},"country":{"enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"type":"string"},"city":{"type":"string","minLength":1,"maxLength":256},"postcode":{"type":"string","minLength":1,"maxLength":128},"pictureUrl":{"format":"url","type":"string"},"streetAddress":{"minLength":1,"maxLength":64,"type":"string"},"telephoneNumber":{"type":"string"},"region":{"type":"string"},"attributes":{"type":"object"}},"type":"object"}}}} ``` ## The UserPatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"UserPatch":{"properties":{"profile":{"$ref":"#/components/schemas/UserProfilePatch"},"flags":{},"externalIdentifier":{"maxLength":512,"type":"string"},"linkedVenuesDefinitions":{"items":{"$ref":"#/components/schemas/VenueDefinition"},"type":"array"},"linkedVenues":{"items":{"$ref":"#/components/schemas/Hydratable"},"type":"array"},"consentsDefinition":{"items":{"$ref":"#/components/schemas/UserConsentDefinition"},"type":"array"},"isRestricted":{"type":"boolean"}},"type":"object"},"UserProfilePatch":{"properties":{"familyName":{"type":"string","minLength":1,"maxLength":64},"givenName":{"type":"string","minLength":1,"maxLength":64},"gender":{"enum":["FEMALE","MALE","OTHER","UNKNOWN"],"type":"string"},"emailAddress":{"format":"email","type":"string"},"birthdate":{"pattern":"^(19[0-9][0-9]|20[0-3][0-9])-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","type":"string"},"country":{"enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"type":"string"},"city":{"type":"string","minLength":1,"maxLength":256},"postcode":{"type":"string","minLength":1,"maxLength":128},"pictureUrl":{"format":"url","type":"string"},"streetAddress":{"minLength":1,"maxLength":64,"type":"string"},"telephoneNumber":{"type":"string"},"region":{"type":"string"},"attributes":{"type":"object"}},"type":"object"},"VenueDefinition":{"properties":{"name":{"type":"string","minLength":1,"maxLength":64},"address":{"type":"string","minLength":1,"maxLength":512},"description":{"type":"string","minLength":1,"maxLength":1024},"availability":{"$ref":"#/components/schemas/Effectivity"},"coordinates":{"$ref":"#/components/schemas/GeoPoint"},"attributes":{"$ref":"#/components/schemas/VenueAttributes"},"externalIdentifier":{"maxLength":512,"type":"string"},"isUserModifiable":{"type":"boolean"},"postcode":{"minLength":1,"maxLength":128,"type":"string"},"type":{"enum":["TENANT","USER","MERCHANT"],"type":"string"},"contactDetails":{"items":{"$ref":"#/components/schemas/VenueContactDetails"},"type":"array"}},"type":"object","required":["name","address","availability","coordinates"]},"Effectivity":{"properties":{"start":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"end":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]}},"type":"object","required":["start"]},"GeoPoint":{"properties":{"longitude":{"minimum":-180,"type":"number","maximum":180},"latitude":{"minimum":-90,"type":"number","maximum":90}},"type":"object","required":["longitude","latitude"]},"VenueAttributes":{"properties":{"bookingUrl":{"format":"url","type":"string"},"telephoneNumber":{"type":"string"},"openingTimes":{"type":"object"}},"type":"object"},"VenueContactDetails":{"properties":{"type":{"enum":["email","phone","sms","link"],"type":"string"},"name":{"type":"string"},"value":{"type":"string"},"imageUri":{"format":"url","type":"string"}},"type":"object","required":["type","name","value"]},"Hydratable":{"properties":{"id":{"format":"uuid","type":"string"}},"type":"object","required":["id"]},"UserConsentDefinition":{"properties":{"type":{"$ref":"#/components/schemas/Hydratable"},"checked":{"type":"boolean"},"user":{"$ref":"#/components/schemas/Hydratable"},"id":{"format":"uuid","type":"string"}},"type":"object","required":["type","checked"]}}}} ``` ## The VoucherCodeDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"VoucherCodeDefinition":{"properties":{"value":{"type":"string","pattern":"^[\\x00-\\x7F]+$"},"voucher":{"type":"object"}},"type":"object","required":["value","voucher"]}}}} ``` ## The UpdateUserInAuthProvider object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"UpdateUserInAuthProvider":{"properties":{"userId":{"format":"uuid","type":"string"}},"type":"object","required":["userId"]}}}} ``` ## The TokenProfilePayload object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"TokenProfilePayload":{"properties":{"emailAddress":{"format":"email","type":"string"},"isRestricted":{},"familyName":{"type":"string","minLength":1,"maxLength":64},"givenName":{"type":"string","minLength":1,"maxLength":64},"gender":{"enum":["FEMALE","MALE","OTHER","UNKNOWN"],"type":"string"},"birthdate":{"pattern":"^(19[0-9][0-9]|20[0-3][0-9])-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","type":"string"},"country":{"enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"type":"string"},"city":{"minLength":1,"maxLength":256,"type":"string"},"postcode":{"minLength":1,"maxLength":128,"type":"string"},"pictureUrl":{"format":"url","type":"string"},"streetAddress":{"minLength":1,"maxLength":64,"type":"string"},"telephoneNumber":{"type":"string"},"region":{"type":"string"},"extraFields":{"type":"object"}},"type":"object","required":["emailAddress"]}}}} ``` ## The UserSessionDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"UserSessionDefinition":{"properties":{"source":{"enum":["CAMPAIGN","OTHER"],"type":"string"},"sourceId":{"type":"string","minLength":1,"maxLength":256},"deviceFingerprint":{},"locationAndIpInfo":{},"sessionDetails":{},"globalToken":{"type":"string","minLength":3,"maxLength":1024},"token":{"type":"string","minLength":1,"maxLength":1024}},"type":"object","required":["source","sourceId","token"]}}}} ``` ## The UserTokenDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"UserTokenDefinition":{"properties":{"token":{"type":"string","minLength":1,"maxLength":1024},"globalToken":{"type":"string","minLength":3,"maxLength":1024},"profile":{"$ref":"#/components/schemas/TokenProfilePayload"}},"type":"object","required":["token"]},"TokenProfilePayload":{"properties":{"emailAddress":{"format":"email","type":"string"},"isRestricted":{},"familyName":{"type":"string","minLength":1,"maxLength":64},"givenName":{"type":"string","minLength":1,"maxLength":64},"gender":{"enum":["FEMALE","MALE","OTHER","UNKNOWN"],"type":"string"},"birthdate":{"pattern":"^(19[0-9][0-9]|20[0-3][0-9])-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","type":"string"},"country":{"enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"type":"string"},"city":{"minLength":1,"maxLength":256,"type":"string"},"postcode":{"minLength":1,"maxLength":128,"type":"string"},"pictureUrl":{"format":"url","type":"string"},"streetAddress":{"minLength":1,"maxLength":64,"type":"string"},"telephoneNumber":{"type":"string"},"region":{"type":"string"},"extraFields":{"type":"object"}},"type":"object","required":["emailAddress"]}}}} ``` ## The UserTokenPatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"UserTokenPatch":{"properties":{"globalToken":{"type":"string","minLength":3,"maxLength":1024},"profile":{"$ref":"#/components/schemas/TokenProfilePayload"}},"type":"object"},"TokenProfilePayload":{"properties":{"emailAddress":{"format":"email","type":"string"},"isRestricted":{},"familyName":{"type":"string","minLength":1,"maxLength":64},"givenName":{"type":"string","minLength":1,"maxLength":64},"gender":{"enum":["FEMALE","MALE","OTHER","UNKNOWN"],"type":"string"},"birthdate":{"pattern":"^(19[0-9][0-9]|20[0-3][0-9])-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$","type":"string"},"country":{"enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","AN","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SK","SI","SB","SO","ZA","GS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"type":"string"},"city":{"minLength":1,"maxLength":256,"type":"string"},"postcode":{"minLength":1,"maxLength":128,"type":"string"},"pictureUrl":{"format":"url","type":"string"},"streetAddress":{"minLength":1,"maxLength":64,"type":"string"},"telephoneNumber":{"type":"string"},"region":{"type":"string"},"extraFields":{"type":"object"}},"type":"object","required":["emailAddress"]}}}} ``` ## The VenuePatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"VenuePatch":{"properties":{"name":{"type":"string","minLength":1,"maxLength":64},"address":{"type":"string","minLength":1,"maxLength":512},"description":{"type":"string","minLength":1,"maxLength":1024},"availability":{"$ref":"#/components/schemas/Effectivity"},"coordinates":{"$ref":"#/components/schemas/GeoPoint"},"attributes":{"$ref":"#/components/schemas/VenueAttributes"},"category":{},"externalIdentifier":{"maxLength":512,"type":"string"},"postcode":{"minLength":1,"maxLength":128,"type":"string"},"isUserModifiable":{"type":"boolean"},"shouldCalculateCoordinates":{"type":"boolean"},"type":{"enum":["TENANT","USER","MERCHANT"],"type":"string"},"contactDetails":{"items":{"$ref":"#/components/schemas/VenueContactDetails"},"type":"array"}},"type":"object"},"Effectivity":{"properties":{"start":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"end":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]}},"type":"object","required":["start"]},"GeoPoint":{"properties":{"longitude":{"minimum":-180,"type":"number","maximum":180},"latitude":{"minimum":-90,"type":"number","maximum":90}},"type":"object","required":["longitude","latitude"]},"VenueAttributes":{"properties":{"bookingUrl":{"format":"url","type":"string"},"telephoneNumber":{"type":"string"},"openingTimes":{"type":"object"}},"type":"object"},"VenueContactDetails":{"properties":{"type":{"enum":["email","phone","sms","link"],"type":"string"},"name":{"type":"string"},"value":{"type":"string"},"imageUri":{"format":"url","type":"string"}},"type":"object","required":["type","name","value"]}}}} ``` ## The AttributeDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"AttributeDefinition":{"properties":{"subjectId":{"type":"string","minLength":1,"maxLength":64},"subjectAuthId":{"maxLength":512,"type":"string"},"subjectType":{"enum":["USER","REWARD","TENANT"],"type":"string"},"key":{"maxLength":512,"type":"string"},"value":{},"isEnabled":{"type":"boolean"},"shouldReplaceOnlySameKeyValue":{"type":"boolean"}},"type":"object","required":["subjectType","key","value","isEnabled","shouldReplaceOnlySameKeyValue"]}}}} ``` ## The BatchAttributeDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"BatchAttributeDefinition":{"properties":{"definitions":{"items":{"$ref":"#/components/schemas/AttributeDefinition"},"type":"array"}},"type":"object","required":["definitions"]},"AttributeDefinition":{"properties":{"subjectId":{"type":"string","minLength":1,"maxLength":64},"subjectAuthId":{"maxLength":512,"type":"string"},"subjectType":{"enum":["USER","REWARD","TENANT"],"type":"string"},"key":{"maxLength":512,"type":"string"},"value":{},"isEnabled":{"type":"boolean"},"shouldReplaceOnlySameKeyValue":{"type":"boolean"}},"type":"object","required":["subjectType","key","value","isEnabled","shouldReplaceOnlySameKeyValue"]}}}} ``` ## The SqsSaveAttributesCommand object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"SqsSaveAttributesCommand":{"properties":{"apiKey":{"type":"string"},"command":{"type":"string","minLength":1,"maxLength":255},"definitions":{"items":{"$ref":"#/components/schemas/AttributeDefinition"},"type":"array"},"onChanged":{}},"type":"object","required":["apiKey","command","definitions"]},"AttributeDefinition":{"properties":{"subjectId":{"type":"string","minLength":1,"maxLength":64},"subjectAuthId":{"maxLength":512,"type":"string"},"subjectType":{"enum":["USER","REWARD","TENANT"],"type":"string"},"key":{"maxLength":512,"type":"string"},"value":{},"isEnabled":{"type":"boolean"},"shouldReplaceOnlySameKeyValue":{"type":"boolean"}},"type":"object","required":["subjectType","key","value","isEnabled","shouldReplaceOnlySameKeyValue"]}}}} ``` ## The OliveCardWebhookCommand object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"OliveCardWebhookCommand":{"properties":{"integrationId":{"format":"uuid","type":"string"},"command":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x00-\\x7F]+$"}},"type":"object","required":["integrationId","command"]}}}} ``` ## The UserBasedVisibilityCriteriaDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"UserBasedVisibilityCriteriaDefinition":{"properties":{"criteriaTree":{"type":"object"},"criteriaJsonLogic":{"type":"object"}},"type":"object","required":["criteriaTree","criteriaJsonLogic"]}}}} ``` ## The PartiallyTranslatedLogicDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"PartiallyTranslatedLogicDefinition":{"properties":{"name":{"type":"string","minLength":2,"maxLength":200},"isActive":{"type":"boolean"},"triggers":{"items":{"$ref":"#/components/schemas/TriggerDefinition"},"type":"array"},"criteriaDefinition":{"$ref":"#/components/schemas/UserBasedVisibilityCriteriaDefinition"},"reactions":{"items":{"$ref":"#/components/schemas/ReactionDefinition"},"type":"array"},"ownerId":{"type":"string"},"ownerDomain":{"enum":["CAMPAIGN_TRANCHE","AUDIENCE","REWARD_AVAILABILITY","USER_BASED_VISIBILITY"],"type":"string"}},"type":"object","required":["name","isActive","triggers","criteriaDefinition","reactions","ownerId","ownerDomain"]},"TriggerDefinition":{"properties":{"type":{"enum":["DAILY_SCHEDULED_JOB","HOURLY_SCHEDULED_JOB","EVENT_REACTOR","MANUAL_FOR_ONE","MANUAL_FOR_ALL","DAILY_POST_POINTS_LIABILITY"],"type":"string"},"name":{"type":"string","minLength":2,"maxLength":64,"pattern":"^[\\x00-\\x7F]+$"},"eventReactorDefinition":{"$ref":"#/components/schemas/EventReactorDefinition"}},"type":"object","required":["type","name"]},"EventReactorDefinition":{"properties":{"name":{"type":"string","minLength":2,"maxLength":64,"pattern":"^[\\x00-\\x7F]+$"},"description":{"type":"string","minLength":2,"maxLength":1024,"pattern":"^[\\x00-\\x7F]+$"},"eventType":{},"reactions":{"items":{"$ref":"#/components/schemas/ReactionDefinition"},"type":"array"},"constraint":{"type":"object"},"maxActivations":{"minimum":1,"type":"integer"},"activationContext":{"enum":["GLOBAL","TENANT","SUBJECT"],"type":"string"},"activationCalculationType":{"type":"object"},"activationPeriod":{"type":"object"},"effectivity":{"$ref":"#/components/schemas/Effectivity"},"isLocked":{},"ownerId":{},"ownerType":{}},"type":"object","required":["name","eventType"]},"ReactionDefinition":{"properties":{"type":{"enum":["HANDLER","REWARD","POINTS","POINTS_CAP","WEBHOOK","ATTRIBUTE","BADGE"],"type":"string"},"handler":{"enum":["EXAMPLE","REFERRAL_TRANCHE_STATUS","MISSION_PROGRESS"],"type":"string"},"points":{"$ref":"#/components/schemas/Derivation"},"attributes":{"items":{"$ref":"#/components/schemas/AttributeKeyValuePair"},"type":"array"},"reward":{},"autoRedeem":{"type":"boolean"},"url":{"format":"url","type":"string"},"forFailure":{"type":"boolean"},"headers":{"type":"object"},"authType":{"enum":["NONE","OAUTH2_CLIENT_CREDENTIALS"],"type":"string"},"authConfig":{"type":"object"},"includeFullSubject":{"type":"boolean"},"badge":{}},"type":"object","required":["type"]},"Derivation":{"properties":{"operation":{"enum":["SUM","PRODUCT"],"type":"string"},"arguments":{"items":{"type":"object"},"type":"array"},"max":{"type":"number"},"roundingDirection":{"enum":["UP","DOWN"],"type":"string"},"roundingUnit":{"minimum":1,"type":"integer"}},"type":"object","required":["operation","arguments"]},"AttributeKeyValuePair":{"properties":{"isEnabled":{"type":"boolean"},"key":{"minLength":1,"maxLength":255,"type":"string"},"value":{}},"type":"object","required":["isEnabled","key","value"]},"Effectivity":{"properties":{"start":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"end":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]}},"type":"object","required":["start"]},"UserBasedVisibilityCriteriaDefinition":{"properties":{"criteriaTree":{"type":"object"},"criteriaJsonLogic":{"type":"object"}},"type":"object","required":["criteriaTree","criteriaJsonLogic"]}}}} ``` ## The LogicCriteria object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"LogicCriteria":{"properties":{"id":{"format":"uuid","type":"string"}},"type":"object","required":["id"]}}}} ``` ## The PartiallyTranslatedLogicDefinitionPatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"PartiallyTranslatedLogicDefinitionPatch":{"properties":{"name":{"type":"string","minLength":2,"maxLength":200},"isActive":{"type":"boolean"},"triggers":{"items":{"$ref":"#/components/schemas/TriggerDefinition"},"type":"array"},"criteriaDefinition":{"$ref":"#/components/schemas/UserBasedVisibilityCriteriaDefinition"},"reactions":{"items":{"$ref":"#/components/schemas/ReactionDefinition"},"type":"array"}},"type":"object"},"TriggerDefinition":{"properties":{"type":{"enum":["DAILY_SCHEDULED_JOB","HOURLY_SCHEDULED_JOB","EVENT_REACTOR","MANUAL_FOR_ONE","MANUAL_FOR_ALL","DAILY_POST_POINTS_LIABILITY"],"type":"string"},"name":{"type":"string","minLength":2,"maxLength":64,"pattern":"^[\\x00-\\x7F]+$"},"eventReactorDefinition":{"$ref":"#/components/schemas/EventReactorDefinition"}},"type":"object","required":["type","name"]},"EventReactorDefinition":{"properties":{"name":{"type":"string","minLength":2,"maxLength":64,"pattern":"^[\\x00-\\x7F]+$"},"description":{"type":"string","minLength":2,"maxLength":1024,"pattern":"^[\\x00-\\x7F]+$"},"eventType":{},"reactions":{"items":{"$ref":"#/components/schemas/ReactionDefinition"},"type":"array"},"constraint":{"type":"object"},"maxActivations":{"minimum":1,"type":"integer"},"activationContext":{"enum":["GLOBAL","TENANT","SUBJECT"],"type":"string"},"activationCalculationType":{"type":"object"},"activationPeriod":{"type":"object"},"effectivity":{"$ref":"#/components/schemas/Effectivity"},"isLocked":{},"ownerId":{},"ownerType":{}},"type":"object","required":["name","eventType"]},"ReactionDefinition":{"properties":{"type":{"enum":["HANDLER","REWARD","POINTS","POINTS_CAP","WEBHOOK","ATTRIBUTE","BADGE"],"type":"string"},"handler":{"enum":["EXAMPLE","REFERRAL_TRANCHE_STATUS","MISSION_PROGRESS"],"type":"string"},"points":{"$ref":"#/components/schemas/Derivation"},"attributes":{"items":{"$ref":"#/components/schemas/AttributeKeyValuePair"},"type":"array"},"reward":{},"autoRedeem":{"type":"boolean"},"url":{"format":"url","type":"string"},"forFailure":{"type":"boolean"},"headers":{"type":"object"},"authType":{"enum":["NONE","OAUTH2_CLIENT_CREDENTIALS"],"type":"string"},"authConfig":{"type":"object"},"includeFullSubject":{"type":"boolean"},"badge":{}},"type":"object","required":["type"]},"Derivation":{"properties":{"operation":{"enum":["SUM","PRODUCT"],"type":"string"},"arguments":{"items":{"type":"object"},"type":"array"},"max":{"type":"number"},"roundingDirection":{"enum":["UP","DOWN"],"type":"string"},"roundingUnit":{"minimum":1,"type":"integer"}},"type":"object","required":["operation","arguments"]},"AttributeKeyValuePair":{"properties":{"isEnabled":{"type":"boolean"},"key":{"minLength":1,"maxLength":255,"type":"string"},"value":{}},"type":"object","required":["isEnabled","key","value"]},"Effectivity":{"properties":{"start":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]},"end":{"oneOf":[{"format":"date","type":"string"},{"format":"date-time","type":"string"}]}},"type":"object","required":["start"]},"UserBasedVisibilityCriteriaDefinition":{"properties":{"criteriaTree":{"type":"object"},"criteriaJsonLogic":{"type":"object"}},"type":"object","required":["criteriaTree","criteriaJsonLogic"]}}}} ``` ## The LogicExecutionPayload object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"LogicExecutionPayload":{"properties":{"ids":{"items":{"format":"uuid","type":"string"},"type":"array","minItems":1},"triggerPayload":{},"domainType":{"enum":["CAMPAIGN_TRANCHE","AUDIENCE","REWARD_AVAILABILITY","USER_BASED_VISIBILITY"],"type":"string"},"subjectId":{"type":"string"}},"type":"object","required":["ids","domainType","subjectId"]}}}} ``` ## The CampaignDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"CampaignDefinition":{"properties":{"name":{"type":"string","minLength":2,"maxLength":1024},"linkConfig":{"$ref":"#/components/schemas/LinkConfig"},"isActive":{"type":"boolean"},"eligibleAudiences":{"items":{"$ref":"#/components/schemas/Hydratable"},"type":"array","description":"Audience UUID references. A member is eligible when they belong to any listed audience. An empty or omitted list makes the campaign an untargeted fallback."},"referralCodeType":{"enum":["BRANCH","CODE","STATIC_USER_CODE","STATIC_USER_WORD_CODE"],"type":"string","description":"How referral identifiers are generated. BRANCH creates a Branch deep link; CODE creates a new eight-character hexadecimal code; the STATIC variants reuse a persistent code for each tenant, member, and campaign combination.","default":"BRANCH"}},"type":"object","required":["name","linkConfig"]},"LinkConfig":{"properties":{"title":{"type":"string","minLength":2,"maxLength":1024},"description":{"type":"string","minLength":2,"maxLength":1024},"imageUrl":{"format":"url","type":"string"},"desktopUrl":{"format":"url","type":"string"},"androidUrl":{"format":"url","type":"string"},"iosUrl":{"format":"url","type":"string"},"androidUriScheme":{"type":"string","minLength":2,"maxLength":256},"channel":{"type":"string","minLength":1,"maxLength":256},"feature":{"type":"string","minLength":1,"maxLength":256},"tags":{"items":{"type":"string"},"type":"array"}},"type":"object","required":["title","description","desktopUrl"]},"Hydratable":{"properties":{"id":{"format":"uuid","type":"string"}},"type":"object","required":["id"]}}}} ``` ## The CampaignPatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"CampaignPatch":{"properties":{"name":{"type":"string","minLength":2,"maxLength":1024},"linkConfig":{"$ref":"#/components/schemas/LinkConfig"},"isActive":{"type":"boolean"},"referralCodeType":{"enum":["BRANCH","CODE","STATIC_USER_CODE","STATIC_USER_WORD_CODE"],"type":"string","description":"How referral identifiers are generated. BRANCH creates a Branch deep link; CODE creates a new eight-character hexadecimal code; the STATIC variants reuse a persistent code for each tenant, member, and campaign combination."}},"type":"object"},"LinkConfig":{"properties":{"title":{"type":"string","minLength":2,"maxLength":1024},"description":{"type":"string","minLength":2,"maxLength":1024},"imageUrl":{"format":"url","type":"string"},"desktopUrl":{"format":"url","type":"string"},"androidUrl":{"format":"url","type":"string"},"iosUrl":{"format":"url","type":"string"},"androidUriScheme":{"type":"string","minLength":2,"maxLength":256},"channel":{"type":"string","minLength":1,"maxLength":256},"feature":{"type":"string","minLength":1,"maxLength":256},"tags":{"items":{"type":"string"},"type":"array"}},"type":"object","required":["title","description","desktopUrl"]}}}} ``` ## The ReferralCodePatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"ReferralCodePatch":{"properties":{"inviteCode":{"type":"string","minLength":1,"maxLength":1024},"inviteLink":{"type":"string","minLength":3,"maxLength":1024,"nullable":true,"description":"Replacement invitation URL. Send null to remove the link."}},"type":"object"}}}} ``` ## The TrancheDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"TrancheDefinition":{"properties":{"name":{"type":"string","minLength":2,"maxLength":1024},"eventType":{"$ref":"#/components/schemas/Hydratable"},"reactions":{"items":{"$ref":"#/components/schemas/ReactionDefinition"},"type":"array"},"constraint":{"type":"object"},"maxActivations":{"minimum":1,"type":"integer","nullable":true,"description":"Maximum activations for the referred-user reactor. Null means unlimited."},"effectivity":{"$ref":"#/components/schemas/TrancheEffectivity"},"referrerReactions":{"items":{"$ref":"#/components/schemas/ReactionDefinition"},"type":"array"}},"type":"object","required":["name","eventType","reactions"]},"Hydratable":{"properties":{"id":{"format":"uuid","type":"string"}},"type":"object","required":["id"]},"ReactionDefinition":{"properties":{"type":{"enum":["HANDLER","REWARD","POINTS","POINTS_CAP","WEBHOOK","ATTRIBUTE","BADGE"],"type":"string"},"handler":{"enum":["EXAMPLE","REFERRAL_TRANCHE_STATUS","MISSION_PROGRESS"],"type":"string"},"points":{"$ref":"#/components/schemas/Derivation"},"attributes":{"items":{"$ref":"#/components/schemas/AttributeKeyValuePair"},"type":"array"},"reward":{},"autoRedeem":{"type":"boolean"},"url":{"format":"url","type":"string"},"forFailure":{"type":"boolean"},"headers":{"type":"object"},"authType":{"enum":["NONE","OAUTH2_CLIENT_CREDENTIALS"],"type":"string"},"authConfig":{"type":"object"},"includeFullSubject":{"type":"boolean"},"badge":{}},"type":"object","required":["type"]},"Derivation":{"properties":{"operation":{"enum":["SUM","PRODUCT"],"type":"string"},"arguments":{"items":{"type":"object"},"type":"array"},"max":{"type":"number"},"roundingDirection":{"enum":["UP","DOWN"],"type":"string"},"roundingUnit":{"minimum":1,"type":"integer"}},"type":"object","required":["operation","arguments"]},"AttributeKeyValuePair":{"properties":{"isEnabled":{"type":"boolean"},"key":{"minLength":1,"maxLength":255,"type":"string"},"value":{}},"type":"object","required":["isEnabled","key","value"]},"TrancheEffectivity":{"type":"object","required":["start","end"],"description":"Effectivity range for a referral tranche. Use a null end for no expiry.","properties":{"start":{"type":"string","format":"date-time","description":"ISO 8601 start timestamp."},"end":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 end timestamp, or null for no expiry."}}}}}} ``` ## The TranchePatch object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"TranchePatch":{"properties":{"name":{"type":"string","minLength":2,"maxLength":64,"pattern":"^[\\x00-\\x7F]+$"},"constraint":{"type":"object"},"maxActivations":{"minimum":1,"type":"integer","nullable":true,"description":"Maximum activations for the referred-user reactor. Null means unlimited."},"reactions":{"items":{"$ref":"#/components/schemas/ReactionDefinition"},"type":"array"},"effectivity":{"$ref":"#/components/schemas/TrancheEffectivity"},"referrerReactions":{"items":{"$ref":"#/components/schemas/ReactionDefinition"},"type":"array"},"deleteReferrerReactions":{"type":"boolean"}},"type":"object"},"ReactionDefinition":{"properties":{"type":{"enum":["HANDLER","REWARD","POINTS","POINTS_CAP","WEBHOOK","ATTRIBUTE","BADGE"],"type":"string"},"handler":{"enum":["EXAMPLE","REFERRAL_TRANCHE_STATUS","MISSION_PROGRESS"],"type":"string"},"points":{"$ref":"#/components/schemas/Derivation"},"attributes":{"items":{"$ref":"#/components/schemas/AttributeKeyValuePair"},"type":"array"},"reward":{},"autoRedeem":{"type":"boolean"},"url":{"format":"url","type":"string"},"forFailure":{"type":"boolean"},"headers":{"type":"object"},"authType":{"enum":["NONE","OAUTH2_CLIENT_CREDENTIALS"],"type":"string"},"authConfig":{"type":"object"},"includeFullSubject":{"type":"boolean"},"badge":{}},"type":"object","required":["type"]},"Derivation":{"properties":{"operation":{"enum":["SUM","PRODUCT"],"type":"string"},"arguments":{"items":{"type":"object"},"type":"array"},"max":{"type":"number"},"roundingDirection":{"enum":["UP","DOWN"],"type":"string"},"roundingUnit":{"minimum":1,"type":"integer"}},"type":"object","required":["operation","arguments"]},"AttributeKeyValuePair":{"properties":{"isEnabled":{"type":"boolean"},"key":{"minLength":1,"maxLength":255,"type":"string"},"value":{}},"type":"object","required":["isEnabled","key","value"]},"TrancheEffectivity":{"type":"object","required":["start","end"],"description":"Effectivity range for a referral tranche. Use a null end for no expiry.","properties":{"start":{"type":"string","format":"date-time","description":"ISO 8601 start timestamp."},"end":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 end timestamp, or null for no expiry."}}}}}} ``` ## The SimplifiLoadDefinition object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"SimplifiLoadDefinition":{"properties":{"points":{"type":"number"}},"type":"object","required":["points"]}}}} ``` ## The TrancheEffectivity object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"TrancheEffectivity":{"type":"object","required":["start","end"],"description":"Effectivity range for a referral tranche. Use a null end for no expiry.","properties":{"start":{"type":"string","format":"date-time","description":"ISO 8601 start timestamp."},"end":{"type":"string","format":"date-time","nullable":true,"description":"ISO 8601 end timestamp, or null for no expiry."}}}}}} ``` ## The EventListParams object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"EventListParams":{"type":"object"}}}} ``` ## The BenefitListParams object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"BenefitListParams":{"type":"object"}}}} ``` ## The RewardCategoryListParams object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"RewardCategoryListParams":{"type":"object"}}}} ``` ## The TierListParams object ```json {"openapi":"3.0.0","info":{"title":"loyalty-rewards","version":"1.0.0"},"components":{"schemas":{"TierListParams":{"type":"object"}}}} ```