@pushwoosh/rpc-gateway-apple-passkit 0.1.116 → 0.1.118

package/package.json

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

package/pushwoosh_googlewallet_v1.d.ts

@@ -11,7 +11,7 @@ export type GoogleWalletService_DeletePass = RpcMethod<DeletePassRequest, Delete
 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.
+ * Google Wallet Service - issues Google Wallet 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
@@ -20,38 +20,27 @@ export type GoogleWalletService_GetTemplate = RpcMethod<GetTemplateRequest, GetT
  * devices itself (no push infrastructure on our side).
  */
 export interface GoogleWalletService {
-    /** Get Google Wallet configuration state for an application */
+    /** Reports whether Google Wallet is set up for an application (code XXXXX-XXXXX): issuer_id, pushwoosh_service_account_email (the address the customer invites into their issuer as Developer) and issuer_status — OK: passes can be issued; NOT_INVITED: the address is not among the issuer's users yet; NOT_OWNED: none of the issuer's users is a user of this Pushwoosh account; UNAVAILABLE: Google did not answer, retry later. Empty issuer_id means no setup; save the issuer id with update_platform_configuration (google_wallet_configuration.google_wallet_issuer_id). */
     GetConfig: GoogleWalletService_GetConfig;
-    /** Validate a pass configuration */
+    /** Checks a Google Wallet pass definition against Google's rules without creating anything; returns errors and warnings. Use before create_google_wallet_pass or before saving a Google campaign design. */
     ValidatePass: GoogleWalletService_ValidatePass;
-    /** Create a new pass object in Google Wallet */
+    /** Creates one standalone Google Wallet pass for an application (code XXXXX-XXXXX) and a Pushwoosh User ID; exactly one style (generic, offer, loyalty, event_ticket, gift_card, flight, transit) must be set, images are public HTTPS URLs. Returns the serial number and the "Save to Google Wallet" link to send. For one design issued to many users use create_wallet_campaign with PLATFORM_GOOGLE instead. */
     CreatePass: GoogleWalletService_CreatePass;
-    /** Update an existing pass object (patch; Google delivers the update) */
+    /** Updates a standalone Google Wallet pass by serial number; Google delivers the change to every holder. notify_message shows a notification with that text, empty means a silent update. The style cannot change. Passes of a campaign change through update_wallet_campaign. */
     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).
-     */
+    /** Returns the "Save to Google Wallet" link of an existing pass (application code XXXXX-XXXXX and serial number); it also works as a QR code. */
     GetSaveLink: GoogleWalletService_GetSaveLink;
-    /** Get a single pass by serial number. */
+    /** Returns one Google Wallet pass of an application (code XXXXX-XXXXX) by serial number: style, state (ACTIVE/INACTIVE), User ID and the full pass definition. */
     GetPass: GoogleWalletService_GetPass;
-    /** List passes of an application. */
+    /** Lists the Google Wallet passes of an application (code XXXXX-XXXXX), newest first; query matches the serial number, the User ID or the barcode. */
     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.
-     */
+    /** Activates (active=true) or invalidates (active=false) a Google Wallet pass; an invalidated pass moves to the holder's "Expired passes" and can be activated again. */
     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.
-     */
+    /** Deletes a Google Wallet pass: Google cannot remove it from a holder's phone, so it is invalidated there and our record is dropped. Irreversible; call only on an explicit yes. */
     DeletePass: GoogleWalletService_DeletePass;
-    /** List example pass templates. */
+    /** Lists the example Google Wallet pass templates, one per style (generic, offer, loyalty, eventTicket, giftCard, flight, transit). */
     ListTemplates: GoogleWalletService_ListTemplates;
-    /** Get an example pass template by filename. */
+    /** Returns an example Google Wallet pass by template filename from list_google_wallet_templates; start a pass or a Google campaign design from it. */
     GetTemplate: GoogleWalletService_GetTemplate;
 }
 /** Text module - a labeled block of text on the pass details view */

package/pushwoosh_walletcampaign_v1.d.ts

@@ -17,7 +17,7 @@ export type WalletCampaignService_DeletePassOverride = RpcMethod<DeletePassOverr
  * and the shared field values, issued passes hold only what is theirs.
  */
 export interface WalletCampaignService {
-    /** Creates a Wallet Pass Campaign: one pass design (design_json, the same shape as an Apple pass definition) issued to many users of an application (code XXXXX-XXXXX). shared_fields hold the values every pass shows and update everywhere when changed; personal_fields are per user, from a tag or from input at issue time. images map a slot (icon, logo, strip, background, footer, thumbnail) to a media file uuid from create_media_file; icon is required. A new campaign is a draft: set status ACTIVE to issue and to run tag sync. Platform and pass style cannot change later. */
+    /** Creates a Wallet Pass Campaign: one pass design issued to many users of an application (code XXXXX-XXXXX), on PLATFORM_APPLE (design_json shaped as an Apple pass definition) or PLATFORM_GOOGLE (shaped as a Google Wallet pass, start from get_google_wallet_template; field keys are text module ids, {Tag} placeholders work in any text). shared_fields hold the values every pass shows and update everywhere when changed; personal_fields are per user, from a tag or from input at issue time. images map a slot to a media file uuid from create_media_file — Apple: icon, logo, strip, background, footer, thumbnail, icon required; Google: logo, hero. A new campaign is a draft: set status ACTIVE to issue and to run tag sync. Platform and pass style cannot change later. */
     CreateCampaign: WalletCampaignService_CreateCampaign;
     /** Lists the Wallet Pass Campaigns of an application (code XXXXX-XXXXX) with how many passes each issued. */
     ListCampaigns: WalletCampaignService_ListCampaigns;
@@ -159,14 +159,14 @@ export type CampaignPass = {
 export type CreateCampaignRequest = {
     /** Application code (format XXXXX-XXXXX). */
     applicationCode: string;
-    /** PLATFORM_APPLE for Apple Wallet. */
+    /** PLATFORM_APPLE for Apple Wallet, PLATFORM_GOOGLE for Google Wallet. */
     platform: Platform;
-    /** Apple: boardingPass, coupon, eventTicket, storeCard or generic. */
+    /** Apple: boardingPass, coupon, eventTicket, storeCard or generic. Google: generic, offer, loyalty, eventTicket, giftCard, flight or transit. */
     passStyle: string;
     /** Internal name, not shown on the pass. */
     name: string;
     description: string;
-    /** The pass definition as JSON (colors, logo text, barcode, field layout); start from get_apple_wallet_template. */
+    /** The pass definition as JSON (colors, logo text, barcode, field layout); start from get_apple_wallet_template or get_google_wallet_template. */
     designJson: string;
     /** Field key -> value shown on every pass; editing it later updates all issued passes. */
     sharedFields: Record<string, string>;