@pushwoosh/rpc-gateway-apple-passkit 0.1.38 → 0.1.40

package/data.js

@@ -1,6 +1,406 @@
 /* eslint-disable */
 /* Autogenerated code */
 export const data = {
+    "pushwoosh.googlewallet.v1.GoogleWalletService": {
+        "type": "S",
+        "key": "googleWallet",
+        "methods": {
+            "GetConfig": {
+                "request": "pushwoosh.googlewallet.v1.GetConfigRequest",
+                "response": "pushwoosh.googlewallet.v1.GetConfigResponse",
+                "method": "get",
+                "path": "/api/google/config"
+            },
+            "ValidatePass": {
+                "request": "pushwoosh.googlewallet.v1.ValidatePassRequest",
+                "response": "pushwoosh.googlewallet.v1.ValidatePassResponse",
+                "method": "post",
+                "path": "/api/google/pass/validate"
+            },
+            "CreatePass": {
+                "request": "pushwoosh.googlewallet.v1.CreatePassRequest",
+                "response": "pushwoosh.googlewallet.v1.CreatePassResponse",
+                "method": "post",
+                "path": "/api/google/pass/create"
+            },
+            "UpdatePass": {
+                "request": "pushwoosh.googlewallet.v1.UpdatePassRequest",
+                "response": "pushwoosh.googlewallet.v1.UpdatePassResponse",
+                "method": "post",
+                "path": "/api/google/pass/update/{serial_number}"
+            },
+            "GetSaveLink": {
+                "request": "pushwoosh.googlewallet.v1.GetSaveLinkRequest",
+                "response": "pushwoosh.googlewallet.v1.GetSaveLinkResponse",
+                "method": "get",
+                "path": "/api/google/pass/{application_code}/{serial_number}/save-link"
+            },
+            "GetPass": {
+                "request": "pushwoosh.googlewallet.v1.GetPassRequest",
+                "response": "pushwoosh.googlewallet.v1.GetPassResponse",
+                "method": "get",
+                "path": "/api/google/pass/{application_code}/{serial_number}"
+            },
+            "ListPasses": {
+                "request": "pushwoosh.googlewallet.v1.ListPassesRequest",
+                "response": "pushwoosh.googlewallet.v1.ListPassesResponse",
+                "method": "get",
+                "path": "/api/google/passes"
+            },
+            "SetPassState": {
+                "request": "pushwoosh.googlewallet.v1.SetPassStateRequest",
+                "response": "pushwoosh.googlewallet.v1.SetPassStateResponse",
+                "method": "post",
+                "path": "/api/google/pass/{application_code}/{serial_number}/state"
+            },
+            "DeletePass": {
+                "request": "pushwoosh.googlewallet.v1.DeletePassRequest",
+                "response": "pushwoosh.googlewallet.v1.DeletePassResponse",
+                "method": "delete",
+                "path": "/api/google/pass/{application_code}/{serial_number}"
+            }
+        }
+    },
+    "pushwoosh.googlewallet.v1.GoogleTextModule": {
+        "type": "I",
+        "fields": {
+            "id": {
+                "type": "string"
+            },
+            "header": {
+                "type": "string"
+            },
+            "body": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.googlewallet.v1.GoogleLinkModule": {
+        "type": "I",
+        "fields": {
+            "uri": {
+                "type": "string"
+            },
+            "description": {
+                "type": "string"
+            }
+        }
+    },
+    "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"
+            },
+            "cardTitle": {
+                "type": "string"
+            },
+            "header": {
+                "type": "string"
+            },
+            "subheader": {
+                "type": "string"
+            },
+            "hexBackgroundColor": {
+                "type": "string"
+            },
+            "logoUrl": {
+                "type": "string"
+            },
+            "heroImageUrl": {
+                "type": "string"
+            },
+            "barcode": {
+                "type": "pushwoosh.googlewallet.v1.GoogleBarcode"
+            },
+            "textModules": {
+                "type": "pushwoosh.googlewallet.v1.GoogleTextModule",
+                "array": true
+            },
+            "links": {
+                "type": "pushwoosh.googlewallet.v1.GoogleLinkModule",
+                "array": true
+            },
+            "cardFields": {
+                "type": "pushwoosh.googlewallet.v1.GoogleTextModule",
+                "array": true
+            },
+            "expirationTime": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.googlewallet.v1.GetConfigRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.googlewallet.v1.GetConfigResponse": {
+        "type": "I",
+        "fields": {
+            "hasServiceAccount": {
+                "type": "boolean"
+            },
+            "issuerId": {
+                "type": "string"
+            },
+            "serviceAccountEmail": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.googlewallet.v1.ValidatePassRequest": {
+        "type": "I",
+        "fields": {
+            "pass": {
+                "type": "pushwoosh.googlewallet.v1.GooglePass"
+            }
+        }
+    },
+    "pushwoosh.googlewallet.v1.ValidatePassResponse": {
+        "type": "I",
+        "fields": {
+            "valid": {
+                "type": "boolean"
+            },
+            "errors": {
+                "type": "string",
+                "array": true
+            },
+            "warnings": {
+                "type": "string",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.googlewallet.v1.CreatePassRequest": {
+        "type": "I",
+        "fields": {
+            "pass": {
+                "type": "pushwoosh.googlewallet.v1.GooglePass"
+            },
+            "applicationCode": {
+                "type": "string"
+            },
+            "userId": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.googlewallet.v1.CreatePassResponse": {
+        "type": "I",
+        "fields": {
+            "serialNumber": {
+                "type": "string"
+            },
+            "objectId": {
+                "type": "string"
+            },
+            "saveLink": {
+                "type": "string"
+            },
+            "message": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.googlewallet.v1.UpdatePassRequest": {
+        "type": "I",
+        "fields": {
+            "serialNumber": {
+                "type": "string"
+            },
+            "updates": {
+                "type": "pushwoosh.googlewallet.v1.GooglePass"
+            },
+            "applicationCode": {
+                "type": "string"
+            },
+            "notifyMessage": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.googlewallet.v1.UpdatePassResponse": {
+        "type": "I",
+        "fields": {
+            "success": {
+                "type": "boolean"
+            },
+            "message": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.googlewallet.v1.GetSaveLinkRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "serialNumber": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.googlewallet.v1.GetSaveLinkResponse": {
+        "type": "I",
+        "fields": {
+            "saveLink": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.googlewallet.v1.GetPassRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "serialNumber": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.googlewallet.v1.GetPassResponse": {
+        "type": "I",
+        "fields": {
+            "pass": {
+                "type": "pushwoosh.googlewallet.v1.GooglePass"
+            }
+        }
+    },
+    "pushwoosh.googlewallet.v1.GooglePassRecord": {
+        "type": "I",
+        "fields": {
+            "serialNumber": {
+                "type": "string"
+            },
+            "objectId": {
+                "type": "string"
+            },
+            "cardTitle": {
+                "type": "string"
+            },
+            "header": {
+                "type": "string"
+            },
+            "userId": {
+                "type": "string"
+            },
+            "createdAt": {
+                "type": "Date"
+            },
+            "updatedAt": {
+                "type": "Date"
+            },
+            "state": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.googlewallet.v1.SetPassStateRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "serialNumber": {
+                "type": "string"
+            },
+            "active": {
+                "type": "boolean"
+            }
+        }
+    },
+    "pushwoosh.googlewallet.v1.SetPassStateResponse": {
+        "type": "I",
+        "fields": {}
+    },
+    "pushwoosh.googlewallet.v1.DeletePassRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "serialNumber": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.googlewallet.v1.DeletePassResponse": {
+        "type": "I",
+        "fields": {}
+    },
+    "pushwoosh.googlewallet.v1.ListPassesRequest.OrderBy": {
+        "type": "E",
+        "values": [
+            "UPDATED",
+            "CREATED"
+        ]
+    },
+    "pushwoosh.googlewallet.v1.ListPassesRequest.OrderDirection": {
+        "type": "E",
+        "values": [
+            "DESC",
+            "ASC"
+        ]
+    },
+    "pushwoosh.googlewallet.v1.ListPassesRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "orderBy": {
+                "type": "pushwoosh.googlewallet.v1.ListPassesRequest.OrderBy"
+            },
+            "orderDirection": {
+                "type": "pushwoosh.googlewallet.v1.ListPassesRequest.OrderDirection"
+            },
+            "page": {
+                "type": "number"
+            },
+            "perPage": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.googlewallet.v1.ListPassesResponse": {
+        "type": "I",
+        "fields": {
+            "passes": {
+                "type": "pushwoosh.googlewallet.v1.GooglePassRecord",
+                "array": true
+            },
+            "page": {
+                "type": "number"
+            },
+            "perPage": {
+                "type": "number"
+            },
+            "total": {
+                "type": "number"
+            }
+        }
+    },
     "pushwoosh.passkit.v1.PassKitService": {
         "type": "S",
         "key": "passKit",

package/index.d.ts

@@ -1,6 +1,8 @@
+import { GoogleWalletService as pushwoosh_googlewallet_v1_GoogleWalletService } from './pushwoosh_googlewallet_v1';
 import { PassKitService as pushwoosh_passkit_v1_PassKitService } from './pushwoosh_passkit_v1';
 import { PassKitWebService as pushwoosh_passkit_v1_PassKitWebService } from './pushwoosh_passkit_v1';
 export type API = {
+    googleWallet: pushwoosh_googlewallet_v1_GoogleWalletService;
     passKit: pushwoosh_passkit_v1_PassKitService;
     passKitWeb: pushwoosh_passkit_v1_PassKitWebService;
 };

package/package.json

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

package/pushwoosh_googlewallet_v1.d.ts

@@ -0,0 +1,216 @@
+import { RpcMethod } from './commonTypes';
+export type GoogleWalletService_GetConfig = RpcMethod<GetConfigRequest, GetConfigResponse>;
+export type GoogleWalletService_ValidatePass = RpcMethod<ValidatePassRequest, ValidatePassResponse>;
+export type GoogleWalletService_CreatePass = RpcMethod<CreatePassRequest, CreatePassResponse>;
+export type GoogleWalletService_UpdatePass = RpcMethod<UpdatePassRequest, UpdatePassResponse>;
+export type GoogleWalletService_GetSaveLink = RpcMethod<GetSaveLinkRequest, GetSaveLinkResponse>;
+export type GoogleWalletService_GetPass = RpcMethod<GetPassRequest, GetPassResponse>;
+export type GoogleWalletService_ListPasses = RpcMethod<ListPassesRequest, ListPassesResponse>;
+export type GoogleWalletService_SetPassState = RpcMethod<SetPassStateRequest, SetPassStateResponse>;
+export type GoogleWalletService_DeletePass = RpcMethod<DeletePassRequest, DeletePassResponse>;
+/**
+ * Google Wallet Service - issues Generic passes via the Google Wallet API.
+ *
+ * Unlike Apple PassKit there is no signed file to host: the pass class and
+ * object live on Google's side (walletobjects REST API), and the user installs
+ * the pass via a "save link" - an RS256 JWT signed with the issuer's service
+ * account key. Updates are plain object patches; Google delivers them to
+ * devices itself (no push infrastructure on our side).
+ */
+export interface GoogleWalletService {
+    /** Get Google Wallet configuration state for an application */
+    GetConfig: GoogleWalletService_GetConfig;
+    /** Validate a pass configuration */
+    ValidatePass: GoogleWalletService_ValidatePass;
+    /** Create a new pass object in Google Wallet */
+    CreatePass: GoogleWalletService_CreatePass;
+    /** Update an existing pass object (patch; Google delivers the update) */
+    UpdatePass: GoogleWalletService_UpdatePass;
+    /**
+     * Get an "Add to Google Wallet" save link for an already created pass.
+     * The link is a thin JWT: it references the object by id only; the object
+     * itself must already exist (created via CreatePass).
+     */
+    GetSaveLink: GoogleWalletService_GetSaveLink;
+    /** Get a single pass by serial number. */
+    GetPass: GoogleWalletService_GetPass;
+    /** List passes of an application. */
+    ListPasses: GoogleWalletService_ListPasses;
+    /**
+     * Activate or invalidate a pass (Google state ACTIVE/INACTIVE). An
+     * invalidated pass moves to the user's "Expired passes" section; the record
+     * is kept so it can be re-activated.
+     */
+    SetPassState: GoogleWalletService_SetPassState;
+    /**
+     * Delete a pass: invalidate it in Google (it cannot be force-removed from a
+     * user's device) and drop our stored record.
+     */
+    DeletePass: GoogleWalletService_DeletePass;
+}
+/** Text module - a labeled block of text on the pass details view */
+export type GoogleTextModule = {
+    id: string;
+    header: string;
+    body: string;
+};
+/** Link module - an external link on the pass details view */
+export type GoogleLinkModule = {
+    uri: string;
+    description: string;
+};
+/** Barcode information */
+export type GoogleBarcode = {
+    /** QR_CODE, PDF_417, AZTEC, CODE_128, EAN_13, ... */
+    format: string;
+    value: string;
+    altText: string;
+};
+/** Generic pass object data (https://developers.google.com/wallet/generic) */
+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. */
+    logoUrl: string;
+    heroImageUrl: string;
+    barcode: GoogleBarcode;
+    /** 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.
+     */
+    expirationTime: string;
+};
+/** Get config request */
+export type GetConfigRequest = {
+    applicationCode: string;
+};
+/** Get config response */
+export type GetConfigResponse = {
+    hasServiceAccount: boolean;
+    issuerId: string;
+    serviceAccountEmail: string;
+};
+/** Validate pass request */
+export type ValidatePassRequest = {
+    pass: GooglePass;
+};
+/** Validate pass response */
+export type ValidatePassResponse = {
+    valid: boolean;
+    errors: string[];
+    warnings: string[];
+};
+/** Create pass request */
+export type CreatePassRequest = {
+    pass: GooglePass;
+    applicationCode: string;
+    /** Pushwoosh User ID the pass is issued to (required). */
+    userId: string;
+};
+/** Create pass response */
+export type CreatePassResponse = {
+    /** Server-assigned unique identity of the created pass (object id suffix). */
+    serialNumber: string;
+    /** Full Google Wallet object id: "{issuer_id}.{serial_number}". */
+    objectId: string;
+    /** "Add to Google Wallet" link: https://pay.google.com/gp/v/save/{jwt} */
+    saveLink: string;
+    message: string;
+};
+/** Update pass request */
+export type UpdatePassRequest = {
+    serialNumber: string;
+    updates: GooglePass;
+    applicationCode: string;
+    /**
+     * When non-empty, push an Android notification with this text to everyone
+     * who saved the pass; empty means a silent update.
+     */
+    notifyMessage: string;
+};
+/** Update pass response */
+export type UpdatePassResponse = {
+    success: boolean;
+    message: string;
+};
+/** Get save link request */
+export type GetSaveLinkRequest = {
+    applicationCode: string;
+    serialNumber: string;
+};
+/** Get save link response */
+export type GetSaveLinkResponse = {
+    saveLink: string;
+};
+/** Get pass request */
+export type GetPassRequest = {
+    applicationCode: string;
+    serialNumber: string;
+};
+/** Get pass response */
+export type GetPassResponse = {
+    pass: GooglePass;
+};
+/** Pass record for listing. */
+export type GooglePassRecord = {
+    serialNumber: string;
+    objectId: string;
+    cardTitle: string;
+    header: string;
+    userId: string;
+    createdAt: Date;
+    updatedAt: Date;
+    /** ACTIVE, INACTIVE */
+    state: string;
+};
+/** Set pass state request */
+export type SetPassStateRequest = {
+    applicationCode: string;
+    serialNumber: string;
+    /** true => ACTIVE, false => INACTIVE (invalidated) */
+    active: boolean;
+};
+export type SetPassStateResponse = {};
+/** Delete pass request */
+export type DeletePassRequest = {
+    applicationCode: string;
+    serialNumber: string;
+};
+export type DeletePassResponse = {};
+export type ListPassesRequest_OrderBy = 'UPDATED' | 'CREATED';
+export type ListPassesRequest_OrderDirection = 'DESC' | 'ASC';
+/** List passes request */
+export type ListPassesRequest = {
+    applicationCode: string;
+    orderBy: ListPassesRequest_OrderBy;
+    orderDirection: ListPassesRequest_OrderDirection;
+    /** zero-based page index */
+    page: number;
+    /** 0 => server default page size */
+    perPage: number;
+};
+/** List passes response */
+export type ListPassesResponse = {
+    passes: GooglePassRecord[];
+    page: number;
+    perPage: number;
+    total: number;
+};

package/pushwoosh_googlewallet_v1.js

@@ -0,0 +1,3 @@
+/* eslint-disable */
+/* Autogenerated code */
+export {};