@pushwoosh/rpc-gateway-apple-passkit 0.1.39 → 0.1.41

package/data.js

@@ -34,6 +34,30 @@ export const data = {
                 "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}"
             }
         }
     },
@@ -110,6 +134,13 @@ export const data = {
             "links": {
                 "type": "pushwoosh.googlewallet.v1.GoogleLinkModule",
                 "array": true
+            },
+            "cardFields": {
+                "type": "pushwoosh.googlewallet.v1.GoogleTextModule",
+                "array": true
+            },
+            "expirationTime": {
+                "type": "string"
             }
         }
     },
@@ -201,6 +232,9 @@ export const data = {
             },
             "applicationCode": {
                 "type": "string"
+            },
+            "notifyMessage": {
+                "type": "string"
             }
         }
     },
@@ -234,6 +268,139 @@ export const data = {
             }
         }
     },
+    "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",
@@ -274,6 +441,12 @@ export const data = {
                 "method": "post",
                 "path": "/api/pass/update/{serial_number}"
             },
+            "SendPassMessage": {
+                "request": "pushwoosh.passkit.v1.SendPassMessageRequest",
+                "response": "pushwoosh.passkit.v1.UpdatePassResponse",
+                "method": "post",
+                "path": "/api/pass/message/{serial_number}"
+            },
             "DeletePass": {
                 "request": "pushwoosh.passkit.v1.DeletePassRequest",
                 "response": "pushwoosh.passkit.v1.DeletePassResponse",
@@ -791,6 +964,20 @@ export const data = {
             }
         }
     },
+    "pushwoosh.passkit.v1.SendPassMessageRequest": {
+        "type": "I",
+        "fields": {
+            "serialNumber": {
+                "type": "string"
+            },
+            "text": {
+                "type": "string"
+            },
+            "applicationCode": {
+                "type": "string"
+            }
+        }
+    },
     "pushwoosh.passkit.v1.DeletePassRequest": {
         "type": "I",
         "fields": {

package/package.json

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

package/pushwoosh_googlewallet_v1.d.ts

@@ -4,6 +4,10 @@ export type GoogleWalletService_ValidatePass = RpcMethod<ValidatePassRequest, Va
 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.
  *
@@ -28,6 +32,21 @@ export interface GoogleWalletService {
      * 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 = {
@@ -65,8 +84,19 @@ export type GooglePass = {
     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 = {
@@ -92,11 +122,7 @@ export type ValidatePassResponse = {
 export type CreatePassRequest = {
     pass: GooglePass;
     applicationCode: string;
-    /**
-     * Pushwoosh User ID the pass is issued to. Accepted but not yet stored:
-     * it becomes meaningful with pass persistence (GoogleWalletPasses
-     * collection follow-up), mirroring PassKitService.CreatePass.
-     */
+    /** Pushwoosh User ID the pass is issued to (required). */
     userId: string;
 };
 /** Create pass response */
@@ -114,6 +140,11 @@ 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 = {
@@ -129,3 +160,57 @@ export type GetSaveLinkRequest = {
 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_passkit_v1.d.ts

@@ -5,6 +5,7 @@ export type PassKitService_GetConfig = RpcMethod<GetConfigRequest, GetConfigResp
 export type PassKitService_ListTemplates = RpcMethod<ListTemplatesRequest, ListTemplatesResponse>;
 export type PassKitService_GetTemplate = RpcMethod<GetTemplateRequest, GetTemplateResponse>;
 export type PassKitService_UpdatePass = RpcMethod<UpdatePassRequest, UpdatePassResponse>;
+export type PassKitService_SendPassMessage = RpcMethod<SendPassMessageRequest, UpdatePassResponse>;
 export type PassKitService_DeletePass = RpcMethod<DeletePassRequest, DeletePassResponse>;
 export type PassKitService_ListPasses = RpcMethod<ListPassesRequest, ListPassesResponse>;
 export type PassKitService_GetPass = RpcMethod<GetPassRequest, GetPassResponse>;
@@ -24,6 +25,13 @@ export interface PassKitService {
     GetTemplate: PassKitService_GetTemplate;
     /** Update an existing pass */
     UpdatePass: PassKitService_UpdatePass;
+    /**
+     * Send a lock-screen message to every device that installed the pass. Writes
+     * the text into a reserved hidden back field (with a changeMessage) and pushes;
+     * the field is cleared again shortly after so the back stays blank and the same
+     * text can be sent again later.
+     */
+    SendPassMessage: PassKitService_SendPassMessage;
     /** Delete an existing pass */
     DeletePass: PassKitService_DeletePass;
     /** List all passes */
@@ -253,6 +261,12 @@ export type UpdatePassResponse = {
     updateTag: number;
     message: string;
 };
+/** Send pass message request */
+export type SendPassMessageRequest = {
+    serialNumber: string;
+    text: string;
+    applicationCode: string;
+};
 /** Delete pass request */
 export type DeletePassRequest = {
     serialNumber: string;