@pushwoosh/rpc-gateway-apple-passkit 0.1.51 → 0.1.53

package/data.js

@@ -58,6 +58,18 @@ export const data = {
                 "response": "pushwoosh.googlewallet.v1.DeletePassResponse",
                 "method": "delete",
                 "path": "/api/google/pass/{application_code}/{serial_number}"
+            },
+            "ListTemplates": {
+                "request": "pushwoosh.googlewallet.v1.ListTemplatesRequest",
+                "response": "pushwoosh.googlewallet.v1.ListTemplatesResponse",
+                "method": "get",
+                "path": "/api/google/templates"
+            },
+            "GetTemplate": {
+                "request": "pushwoosh.googlewallet.v1.GetTemplateRequest",
+                "response": "pushwoosh.googlewallet.v1.GetTemplateResponse",
+                "method": "get",
+                "path": "/api/google/templates/{filename}"
             }
         }
     },
@@ -100,33 +112,105 @@ export const data = {
             }
         }
     },
-    "pushwoosh.googlewallet.v1.GoogleBarcode": {
+    "pushwoosh.googlewallet.v1.GoogleGeneric": {
         "type": "I",
         "fields": {
-            "format": {
+            "cardTitle": {
                 "type": "string"
             },
-            "value": {
+            "header": {
                 "type": "string"
             },
-            "altText": {
+            "subheader": {
                 "type": "string"
+            },
+            "cardFields": {
+                "type": "pushwoosh.googlewallet.v1.GoogleTextModule",
+                "array": true
             }
         }
     },
-    "pushwoosh.googlewallet.v1.GooglePass": {
+    "pushwoosh.googlewallet.v1.GoogleOffer": {
         "type": "I",
         "fields": {
-            "serialNumber": {
+            "title": {
                 "type": "string"
             },
-            "cardTitle": {
+            "provider": {
                 "type": "string"
             },
-            "header": {
+            "details": {
                 "type": "string"
             },
-            "subheader": {
+            "finePrint": {
+                "type": "string"
+            },
+            "redemptionChannel": {
+                "type": "string"
+            },
+            "issuerName": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.googlewallet.v1.GoogleLoyalty": {
+        "type": "I",
+        "fields": {
+            "programName": {
+                "type": "string"
+            },
+            "accountName": {
+                "type": "string"
+            },
+            "accountId": {
+                "type": "string"
+            },
+            "pointsLabel": {
+                "type": "string"
+            },
+            "pointsBalance": {
+                "type": "string"
+            },
+            "rewardsTier": {
+                "type": "string"
+            },
+            "rewardsTierLabel": {
+                "type": "string"
+            },
+            "issuerName": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.googlewallet.v1.GoogleLocation": {
+        "type": "I",
+        "fields": {
+            "latitude": {
+                "type": "number"
+            },
+            "longitude": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.googlewallet.v1.GoogleBarcode": {
+        "type": "I",
+        "fields": {
+            "format": {
+                "type": "string"
+            },
+            "value": {
+                "type": "string"
+            },
+            "altText": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.googlewallet.v1.GooglePass": {
+        "type": "I",
+        "fields": {
+            "serialNumber": {
                 "type": "string"
             },
             "hexBackgroundColor": {
@@ -149,15 +233,33 @@ export const data = {
                 "type": "pushwoosh.googlewallet.v1.GoogleLinkModule",
                 "array": true
             },
-            "cardFields": {
-                "type": "pushwoosh.googlewallet.v1.GoogleTextModule",
-                "array": true
-            },
             "expirationTime": {
                 "type": "string"
             },
             "appLink": {
                 "type": "pushwoosh.googlewallet.v1.GoogleAppLink"
+            },
+            "locations": {
+                "type": "pushwoosh.googlewallet.v1.GoogleLocation",
+                "array": true
+            },
+            "generic": {
+                "type": "pushwoosh.googlewallet.v1.GoogleGeneric"
+            },
+            "offer": {
+                "type": "pushwoosh.googlewallet.v1.GoogleOffer"
+            },
+            "loyalty": {
+                "type": "pushwoosh.googlewallet.v1.GoogleLoyalty"
+            }
+        },
+        "oneofs": {
+            "style": {
+                "oneof": [
+                    "generic",
+                    "offer",
+                    "loyalty"
+                ]
             }
         }
     },
@@ -330,6 +432,9 @@ export const data = {
             },
             "state": {
                 "type": "string"
+            },
+            "style": {
+                "type": "string"
             }
         }
     },
@@ -418,6 +523,52 @@ export const data = {
             }
         }
     },
+    "pushwoosh.googlewallet.v1.GoogleTemplateInfo": {
+        "type": "I",
+        "fields": {
+            "filename": {
+                "type": "string"
+            },
+            "name": {
+                "type": "string"
+            },
+            "description": {
+                "type": "string"
+            },
+            "style": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.googlewallet.v1.ListTemplatesRequest": {
+        "type": "I",
+        "fields": {}
+    },
+    "pushwoosh.googlewallet.v1.ListTemplatesResponse": {
+        "type": "I",
+        "fields": {
+            "templates": {
+                "type": "pushwoosh.googlewallet.v1.GoogleTemplateInfo",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.googlewallet.v1.GetTemplateRequest": {
+        "type": "I",
+        "fields": {
+            "filename": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.googlewallet.v1.GetTemplateResponse": {
+        "type": "I",
+        "fields": {
+            "template": {
+                "type": "pushwoosh.googlewallet.v1.GooglePass"
+            }
+        }
+    },
     "pushwoosh.passkit.v1.PassKitService": {
         "type": "S",
         "key": "passKit",

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@pushwoosh/rpc-gateway-apple-passkit",
-    "version": "0.1.51",
+    "version": "0.1.53",
     "description": "Apple PassKit Service api gateway HTTP API Types and Data",
     "main": "index.js",
     "module": "index.js",

package/pushwoosh_googlewallet_v1.d.ts

@@ -8,6 +8,8 @@ export type GoogleWalletService_GetPass = RpcMethod<GetPassRequest, GetPassRespo
 export type GoogleWalletService_ListPasses = RpcMethod<ListPassesRequest, ListPassesResponse>;
 export type GoogleWalletService_SetPassState = RpcMethod<SetPassStateRequest, SetPassStateResponse>;
 export type GoogleWalletService_DeletePass = RpcMethod<DeletePassRequest, DeletePassResponse>;
+export type GoogleWalletService_ListTemplates = RpcMethod<ListTemplatesRequest, ListTemplatesResponse>;
+export type GoogleWalletService_GetTemplate = RpcMethod<GetTemplateRequest, GetTemplateResponse>;
 /**
  * Google Wallet Service - issues Generic passes via the Google Wallet API.
  *
@@ -47,6 +49,10 @@ export interface GoogleWalletService {
      * user's device) and drop our stored record.
      */
     DeletePass: GoogleWalletService_DeletePass;
+    /** List example pass templates. */
+    ListTemplates: GoogleWalletService_ListTemplates;
+    /** Get an example pass template by filename. */
+    GetTemplate: GoogleWalletService_GetTemplate;
 }
 /** Text module - a labeled block of text on the pass details view */
 export type GoogleTextModule = {
@@ -77,6 +83,75 @@ export type GoogleAppLink = {
      */
     description: string;
 };
+/**
+ * Generic pass data (maps to GenericClass/GenericObject;
+ * https://developers.google.com/wallet/generic). The free-form style: the
+ * card layout is composed from these fields via the class card template.
+ */
+export type GoogleGeneric = {
+    /** required; the issuer/program name at the top */
+    cardTitle: string;
+    /** required; the main title of the card */
+    header: string;
+    subheader: string;
+    /**
+     * Fields pinned to the front of the card via the class
+     * cardTemplateOverride: up to 6, rendered as up to 3 rows of 2.
+     */
+    cardFields: GoogleTextModule[];
+};
+/**
+ * Offer pass data (maps to OfferClass/OfferObject;
+ * https://developers.google.com/wallet/retail/offers). Google renders its
+ * native offer layout: title and provider on the card, details and fine print
+ * in the details view.
+ */
+export type GoogleOffer = {
+    /** required; e.g. "20% off everything" */
+    title: string;
+    /** required; the merchant name */
+    provider: string;
+    details: string;
+    finePrint: string;
+    /** ONLINE | INSTORE | BOTH | TEMPORARY_PRICE_REDUCTION; empty defaults to BOTH. */
+    redemptionChannel: string;
+    /** Shown on Google's "issued by" surfaces; defaults to provider when empty. */
+    issuerName: string;
+};
+/**
+ * Loyalty pass data (maps to LoyaltyClass/LoyaltyObject;
+ * https://developers.google.com/wallet/retail/loyalty-cards). Google renders
+ * its native loyalty layout: program name, member fields, points and tier.
+ * Note: Google requires a program logo, so logo_url is mandatory for loyalty.
+ */
+export type GoogleLoyalty = {
+    /** required */
+    programName: string;
+    /** member name shown on the card */
+    accountName: string;
+    /** member id shown on the card */
+    accountId: string;
+    /** e.g. "Points"; shown only with a balance */
+    pointsLabel: string;
+    pointsBalance: string;
+    /** e.g. "Gold" */
+    rewardsTier: string;
+    /** shown next to the tier; defaults to "Tier" */
+    rewardsTierLabel: string;
+    /** Shown on Google's "issued by" surfaces; defaults to program_name when empty. */
+    issuerName: string;
+};
+/**
+ * Location of interest (object.merchantLocations). Google shows a geofenced
+ * notification when a user dwells within a Google-set radius of the point.
+ * Maximum of 10 per pass.
+ */
+export type GoogleLocation = {
+    /** -90.0 to +90.0 */
+    latitude: number;
+    /** -180.0 to +180.0 */
+    longitude: number;
+};
 /** Barcode information */
 export type GoogleBarcode = {
     /** QR_CODE, PDF_417, AZTEC, CODE_128, EAN_13, ... */
@@ -84,18 +159,26 @@ export type GoogleBarcode = {
     value: string;
     altText: string;
 };
-/** Generic pass object data (https://developers.google.com/wallet/generic) */
+export type GooglePass_style_generic = {
+    type: 'generic';
+    data: GoogleGeneric;
+};
+export type GooglePass_style_offer = {
+    type: 'offer';
+    data: GoogleOffer;
+};
+export type GooglePass_style_loyalty = {
+    type: 'loyalty';
+    data: GoogleLoyalty;
+};
+export type GooglePass_style = GooglePass_style_generic | GooglePass_style_offer | GooglePass_style_loyalty;
+/** Pass object data; style-specific fields live in the oneof. */
 export type GooglePass = {
     /**
      * Server-assigned on creation; never set by the client. The full Google
      * object id is "{issuer_id}.{serial_number}".
      */
     serialNumber: string;
-    /** required; the issuer/program name at the top */
-    cardTitle: string;
-    /** required; the main title of the card */
-    header: string;
-    subheader: string;
     /** "#rrggbb" */
     hexBackgroundColor: string;
     /** Google Wallet images are referenced by public HTTPS URL, not uploaded. */
@@ -105,11 +188,6 @@ export type GooglePass = {
     /** Fields shown in the details view (the "back" of the pass). */
     textModules: GoogleTextModule[];
     links: GoogleLinkModule[];
-    /**
-     * Fields pinned to the front of the card via the class
-     * cardTemplateOverride: up to 6, rendered as up to 3 rows of 2.
-     */
-    cardFields: GoogleTextModule[];
     /**
      * ISO 8601; when set, Google auto-expires the pass at this time
      * (validTimeInterval.end). Empty means no expiry.
@@ -117,6 +195,9 @@ export type GooglePass = {
     expirationTime: string;
     /** CTA button on the front of the pass; swappable per campaign. */
     appLink: GoogleAppLink;
+    /** Geofenced-notification points (max 10). */
+    locations: GoogleLocation[];
+    style: GooglePass_style;
 };
 /** Get config request */
 export type GetConfigRequest = {
@@ -193,6 +274,10 @@ export type GetPassResponse = {
 export type GooglePassRecord = {
     serialNumber: string;
     objectId: string;
+    /**
+     * Display title/header: card_title/header for generic passes, the
+     * style-specific equivalents (provider/title, program/member) otherwise.
+     */
     cardTitle: string;
     header: string;
     userId: string;
@@ -200,6 +285,8 @@ export type GooglePassRecord = {
     updatedAt: Date;
     /** ACTIVE, INACTIVE */
     state: string;
+    /** generic, offer, loyalty */
+    style: string;
 };
 /** Set pass state request */
 export type SetPassStateRequest = {
@@ -234,3 +321,24 @@ export type ListPassesResponse = {
     perPage: number;
     total: number;
 };
+/** Template info */
+export type GoogleTemplateInfo = {
+    filename: string;
+    name: string;
+    description: string;
+    /** generic, offer, loyalty */
+    style: string;
+};
+export type ListTemplatesRequest = {};
+/** List templates response */
+export type ListTemplatesResponse = {
+    templates: GoogleTemplateInfo[];
+};
+/** Get template request */
+export type GetTemplateRequest = {
+    filename: string;
+};
+/** Get template response */
+export type GetTemplateResponse = {
+    template: GooglePass;
+};