Skip to content

Commit 1df0546

Browse files
yoshi-automationsofisl
yoshi-automation
authored and
sofisl
committed
feat(walletobjects): update the API
#### walletobjects:v1 The following keys were added: - schemas.EventTicketClass.properties.locations.deprecated - schemas.EventTicketClass.properties.valueAddedModuleData.description - schemas.EventTicketClass.properties.valueAddedModuleData.items.$ref - schemas.EventTicketClass.properties.valueAddedModuleData.type - schemas.EventTicketObject.properties.locations.deprecated - schemas.EventTicketObject.properties.valueAddedModuleData.description - schemas.EventTicketObject.properties.valueAddedModuleData.items.$ref - schemas.EventTicketObject.properties.valueAddedModuleData.type - schemas.FlightClass.properties.locations.deprecated - schemas.FlightClass.properties.valueAddedModuleData.description - schemas.FlightClass.properties.valueAddedModuleData.items.$ref - schemas.FlightClass.properties.valueAddedModuleData.type - schemas.FlightObject.properties.locations.deprecated - schemas.FlightObject.properties.valueAddedModuleData.description - schemas.FlightObject.properties.valueAddedModuleData.items.$ref - schemas.FlightObject.properties.valueAddedModuleData.type - schemas.GenericClass.properties.valueAddedModuleData.description - schemas.GenericClass.properties.valueAddedModuleData.items.$ref - schemas.GenericClass.properties.valueAddedModuleData.type - schemas.GenericObject.properties.valueAddedModuleData.description - schemas.GenericObject.properties.valueAddedModuleData.items.$ref - schemas.GenericObject.properties.valueAddedModuleData.type - schemas.GiftCardClass.properties.locations.deprecated - schemas.GiftCardClass.properties.valueAddedModuleData.description - schemas.GiftCardClass.properties.valueAddedModuleData.items.$ref - schemas.GiftCardClass.properties.valueAddedModuleData.type - schemas.GiftCardObject.properties.locations.deprecated - schemas.GiftCardObject.properties.valueAddedModuleData.description - schemas.GiftCardObject.properties.valueAddedModuleData.items.$ref - schemas.GiftCardObject.properties.valueAddedModuleData.type - schemas.LoyaltyClass.properties.locations.deprecated - schemas.LoyaltyClass.properties.valueAddedModuleData.description - schemas.LoyaltyClass.properties.valueAddedModuleData.items.$ref - schemas.LoyaltyClass.properties.valueAddedModuleData.type - schemas.LoyaltyObject.properties.locations.deprecated - schemas.LoyaltyObject.properties.valueAddedModuleData.description - schemas.LoyaltyObject.properties.valueAddedModuleData.items.$ref - schemas.LoyaltyObject.properties.valueAddedModuleData.type - schemas.ModuleViewConstraints.description - schemas.ModuleViewConstraints.id - schemas.ModuleViewConstraints.properties.displayInterval.$ref - schemas.ModuleViewConstraints.properties.displayInterval.description - schemas.ModuleViewConstraints.type - schemas.OfferClass.properties.locations.deprecated - schemas.OfferClass.properties.valueAddedModuleData.description - schemas.OfferClass.properties.valueAddedModuleData.items.$ref - schemas.OfferClass.properties.valueAddedModuleData.type - schemas.OfferObject.properties.valueAddedModuleData.description - schemas.OfferObject.properties.valueAddedModuleData.items.$ref - schemas.OfferObject.properties.valueAddedModuleData.type - schemas.TransitClass.properties.locations.deprecated - schemas.TransitClass.properties.valueAddedModuleData.description - schemas.TransitClass.properties.valueAddedModuleData.items.$ref - schemas.TransitClass.properties.valueAddedModuleData.type - schemas.TransitObject.properties.locations.deprecated - schemas.TransitObject.properties.valueAddedModuleData.description - schemas.TransitObject.properties.valueAddedModuleData.items.$ref - schemas.TransitObject.properties.valueAddedModuleData.type - schemas.ValueAddedModuleData.description - schemas.ValueAddedModuleData.id - schemas.ValueAddedModuleData.properties.body.$ref - schemas.ValueAddedModuleData.properties.body.description - schemas.ValueAddedModuleData.properties.header.$ref - schemas.ValueAddedModuleData.properties.header.description - schemas.ValueAddedModuleData.properties.image.$ref - schemas.ValueAddedModuleData.properties.image.description - schemas.ValueAddedModuleData.properties.sortIndex.description - schemas.ValueAddedModuleData.properties.sortIndex.format - schemas.ValueAddedModuleData.properties.sortIndex.type - schemas.ValueAddedModuleData.properties.uri.description - schemas.ValueAddedModuleData.properties.uri.type - schemas.ValueAddedModuleData.properties.viewConstraints.$ref - schemas.ValueAddedModuleData.properties.viewConstraints.description - schemas.ValueAddedModuleData.type
1 parent 460b5b6 commit 1df0546

File tree

2 files changed

+247
-1
lines changed

2 files changed

+247
-1
lines changed

‎discovery/walletobjects-v1.json‎

Lines changed: 153 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2681,7 +2681,7 @@
26812681
}
26822682
}
26832683
},
2684-
"revision": "20240809",
2684+
"revision": "20240927",
26852685
"rootUrl": "https://walletobjects.googleapis.com/",
26862686
"schemas": {
26872687
"ActivationOptions": {
@@ -3906,6 +3906,7 @@
39063906
"description": "Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens."
39073907
},
39083908
"locations": {
3909+
"deprecated": true,
39093910
"description": "Note: This field is currently not supported to trigger geo notifications.",
39103911
"items": {
39113912
"$ref": "LatLongPoint"
@@ -4077,6 +4078,13 @@
40774078
},
40784079
"type": "array"
40794080
},
4081+
"valueAddedModuleData": {
4082+
"description": "Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.",
4083+
"items": {
4084+
"$ref": "ValueAddedModuleData"
4085+
},
4086+
"type": "array"
4087+
},
40804088
"venue": {
40814089
"$ref": "EventVenue",
40824090
"description": "Event venue details."
@@ -4226,6 +4234,7 @@
42264234
"description": "Links module data. If links module data is also defined on the class, both will be displayed."
42274235
},
42284236
"locations": {
4237+
"deprecated": true,
42294238
"description": "Note: This field is currently not supported to trigger geo notifications.",
42304239
"items": {
42314240
"$ref": "LatLongPoint"
@@ -4323,6 +4332,13 @@
43234332
"$ref": "TimeInterval",
43244333
"description": "The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed."
43254334
},
4335+
"valueAddedModuleData": {
4336+
"description": "Optional value added module data. Maximum of ten on the object.",
4337+
"items": {
4338+
"$ref": "ValueAddedModuleData"
4339+
},
4340+
"type": "array"
4341+
},
43264342
"version": {
43274343
"deprecated": true,
43284344
"description": "Deprecated",
@@ -4701,6 +4717,7 @@
47014717
"description": "Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens."
47024718
},
47034719
"locations": {
4720+
"deprecated": true,
47044721
"description": "Note: This field is currently not supported to trigger geo notifications.",
47054722
"items": {
47064723
"$ref": "LatLongPoint"
@@ -4809,6 +4826,13 @@
48094826
},
48104827
"type": "array"
48114828
},
4829+
"valueAddedModuleData": {
4830+
"description": "Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.",
4831+
"items": {
4832+
"$ref": "ValueAddedModuleData"
4833+
},
4834+
"type": "array"
4835+
},
48124836
"version": {
48134837
"deprecated": true,
48144838
"description": "Deprecated",
@@ -4974,6 +4998,7 @@
49744998
"description": "Links module data. If links module data is also defined on the class, both will be displayed."
49754999
},
49765000
"locations": {
5001+
"deprecated": true,
49775002
"description": "Note: This field is currently not supported to trigger geo notifications.",
49785003
"items": {
49795004
"$ref": "LatLongPoint"
@@ -5063,6 +5088,13 @@
50635088
"$ref": "TimeInterval",
50645089
"description": "The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed."
50655090
},
5091+
"valueAddedModuleData": {
5092+
"description": "Optional value added module data. Maximum of ten on the object.",
5093+
"items": {
5094+
"$ref": "ValueAddedModuleData"
5095+
},
5096+
"type": "array"
5097+
},
50665098
"version": {
50675099
"deprecated": true,
50685100
"description": "Deprecated",
@@ -5210,6 +5242,13 @@
52105242
},
52115243
"type": "array"
52125244
},
5245+
"valueAddedModuleData": {
5246+
"description": "Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.",
5247+
"items": {
5248+
"$ref": "ValueAddedModuleData"
5249+
},
5250+
"type": "array"
5251+
},
52135252
"viewUnlockRequirement": {
52145253
"description": "View Unlock Requirement options for the generic pass.",
52155254
"enum": [
@@ -5435,6 +5474,13 @@
54355474
"$ref": "TimeInterval",
54365475
"description": "The time period this object will be considered valid or usable. When the time period is passed, the object will be considered expired, which will affect the rendering on user's devices."
54375476
},
5477+
"valueAddedModuleData": {
5478+
"description": "Optional value added module data. Maximum of ten on the object.",
5479+
"items": {
5480+
"$ref": "ValueAddedModuleData"
5481+
},
5482+
"type": "array"
5483+
},
54385484
"wideLogo": {
54395485
"$ref": "Image",
54405486
"description": "The wide logo of the pass. When provided, this will be used in place of the logo in the top left of the card view."
@@ -5573,6 +5619,7 @@
55735619
"description": "Translated strings for the pin_label."
55745620
},
55755621
"locations": {
5622+
"deprecated": true,
55765623
"description": "Note: This field is currently not supported to trigger geo notifications.",
55775624
"items": {
55785625
"$ref": "LatLongPoint"
@@ -5689,6 +5736,13 @@
56895736
},
56905737
"type": "array"
56915738
},
5739+
"valueAddedModuleData": {
5740+
"description": "Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.",
5741+
"items": {
5742+
"$ref": "ValueAddedModuleData"
5743+
},
5744+
"type": "array"
5745+
},
56925746
"version": {
56935747
"deprecated": true,
56945748
"description": "Deprecated",
@@ -5835,6 +5889,7 @@
58355889
"description": "Links module data. If links module data is also defined on the class, both will be displayed."
58365890
},
58375891
"locations": {
5892+
"deprecated": true,
58385893
"description": "Note: This field is currently not supported to trigger geo notifications.",
58395894
"items": {
58405895
"$ref": "LatLongPoint"
@@ -5916,6 +5971,13 @@
59165971
"$ref": "TimeInterval",
59175972
"description": "The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed."
59185973
},
5974+
"valueAddedModuleData": {
5975+
"description": "Optional value added module data. Maximum of ten on the object.",
5976+
"items": {
5977+
"$ref": "ValueAddedModuleData"
5978+
},
5979+
"type": "array"
5980+
},
59195981
"version": {
59205982
"deprecated": true,
59215983
"description": "Deprecated",
@@ -6397,6 +6459,7 @@
63976459
"description": "Translated strings for the secondary_rewards_tier_label."
63986460
},
63996461
"locations": {
6462+
"deprecated": true,
64006463
"description": "Note: This field is currently not supported to trigger geo notifications.",
64016464
"items": {
64026465
"$ref": "LatLongPoint"
@@ -6525,6 +6588,13 @@
65256588
},
65266589
"type": "array"
65276590
},
6591+
"valueAddedModuleData": {
6592+
"description": "Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.",
6593+
"items": {
6594+
"$ref": "ValueAddedModuleData"
6595+
},
6596+
"type": "array"
6597+
},
65286598
"version": {
65296599
"deprecated": true,
65306600
"description": "Deprecated",
@@ -6670,6 +6740,7 @@
66706740
"description": "Links module data. If links module data is also defined on the class, both will be displayed."
66716741
},
66726742
"locations": {
6743+
"deprecated": true,
66736744
"description": "Note: This field is currently not supported to trigger geo notifications.",
66746745
"items": {
66756746
"$ref": "LatLongPoint"
@@ -6755,6 +6826,13 @@
67556826
"$ref": "TimeInterval",
67566827
"description": "The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed."
67576828
},
6829+
"valueAddedModuleData": {
6830+
"description": "Optional value added module data. Maximum of ten on the object.",
6831+
"items": {
6832+
"$ref": "ValueAddedModuleData"
6833+
},
6834+
"type": "array"
6835+
},
67586836
"version": {
67596837
"deprecated": true,
67606838
"description": "Deprecated",
@@ -7163,6 +7241,17 @@
71637241
},
71647242
"type": "object"
71657243
},
7244+
"ModuleViewConstraints": {
7245+
"description": "Constraints that all must be met for the module to be shown.",
7246+
"id": "ModuleViewConstraints",
7247+
"properties": {
7248+
"displayInterval": {
7249+
"$ref": "TimeInterval",
7250+
"description": "The period of time that the module will be displayed to users. Can define both a `startTime` and `endTime`. The module is displayed immediately after insertion unless a `startTime` is set. The module is displayed indefinitely if `endTime` is not set."
7251+
}
7252+
},
7253+
"type": "object"
7254+
},
71667255
"Money": {
71677256
"id": "Money",
71687257
"properties": {
@@ -7324,6 +7413,7 @@
73247413
"description": "Translated strings for the title. Recommended maximum length is 60 characters to ensure full string is displayed on smaller screens."
73257414
},
73267415
"locations": {
7416+
"deprecated": true,
73277417
"description": "Note: This field is currently not supported to trigger geo notifications.",
73287418
"items": {
73297419
"$ref": "LatLongPoint"
@@ -7481,6 +7571,13 @@
74817571
"$ref": "Image",
74827572
"description": "The title image of the offer. This image is displayed in both the details and list views of the app."
74837573
},
7574+
"valueAddedModuleData": {
7575+
"description": "Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.",
7576+
"items": {
7577+
"$ref": "ValueAddedModuleData"
7578+
},
7579+
"type": "array"
7580+
},
74847581
"version": {
74857582
"deprecated": true,
74867583
"description": "Deprecated",
@@ -7688,6 +7785,13 @@
76887785
"$ref": "TimeInterval",
76897786
"description": "The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed."
76907787
},
7788+
"valueAddedModuleData": {
7789+
"description": "Optional value added module data. Maximum of ten on the object.",
7790+
"items": {
7791+
"$ref": "ValueAddedModuleData"
7792+
},
7793+
"type": "array"
7794+
},
76917795
"version": {
76927796
"deprecated": true,
76937797
"description": "Deprecated",
@@ -8696,6 +8800,7 @@
86968800
"description": "Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens."
86978801
},
86988802
"locations": {
8803+
"deprecated": true,
86998804
"description": "Note: This field is currently not supported to trigger geo notifications.",
87008805
"items": {
87018806
"$ref": "LatLongPoint"
@@ -8851,6 +8956,13 @@
88518956
],
88528957
"type": "string"
88538958
},
8959+
"valueAddedModuleData": {
8960+
"description": "Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.",
8961+
"items": {
8962+
"$ref": "ValueAddedModuleData"
8963+
},
8964+
"type": "array"
8965+
},
88548966
"version": {
88558967
"deprecated": true,
88568968
"description": "Deprecated",
@@ -9031,6 +9143,7 @@
90319143
"description": "Links module data. If links module data is also defined on the class, both will be displayed."
90329144
},
90339145
"locations": {
9146+
"deprecated": true,
90349147
"description": "Note: This field is currently not supported to trigger geo notifications.",
90359148
"items": {
90369149
"$ref": "LatLongPoint"
@@ -9220,6 +9333,13 @@
92209333
"$ref": "TimeInterval",
92219334
"description": "The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed."
92229335
},
9336+
"valueAddedModuleData": {
9337+
"description": "Optional value added module data. Maximum of ten on the object.",
9338+
"items": {
9339+
"$ref": "ValueAddedModuleData"
9340+
},
9341+
"type": "array"
9342+
},
92239343
"version": {
92249344
"deprecated": true,
92259345
"description": "Deprecated",
@@ -9333,6 +9453,38 @@
93339453
}
93349454
},
93359455
"type": "object"
9456+
},
9457+
"ValueAddedModuleData": {
9458+
"description": "Data for Value Added module. Required fields are header and uri.",
9459+
"id": "ValueAddedModuleData",
9460+
"properties": {
9461+
"body": {
9462+
"$ref": "LocalizedString",
9463+
"description": "Body to be displayed on the module. Character limit is 50 and longer strings will be truncated."
9464+
},
9465+
"header": {
9466+
"$ref": "LocalizedString",
9467+
"description": "Header to be displayed on the module. Character limit is 60 and longer strings will be truncated."
9468+
},
9469+
"image": {
9470+
"$ref": "Image",
9471+
"description": "Image to be displayed on the module. Recommended image ratio is 1:1. Images will be resized to fit this ratio."
9472+
},
9473+
"sortIndex": {
9474+
"description": "The index for sorting the modules. Modules with a lower sort index are shown before modules with a higher sort index. If unspecified, the sort index is assumed to be INT_MAX. For two modules with the same index, the sorting behavior is undefined.",
9475+
"format": "int32",
9476+
"type": "integer"
9477+
},
9478+
"uri": {
9479+
"description": "URI that the module leads to on click. This can be a web link or a deep link as mentioned in https://developer.android.com/training/app-links/deep-linking.",
9480+
"type": "string"
9481+
},
9482+
"viewConstraints": {
9483+
"$ref": "ModuleViewConstraints",
9484+
"description": "Constraints that all must be met for the module to be shown."
9485+
}
9486+
},
9487+
"type": "object"
93369488
}
93379489
},
93389490
"servicePath": "",

0 commit comments

Comments
 (0)