@pushwoosh/rpc-gateway-apple-passkit 0.1.114 → 0.1.115

package/data.js

@@ -1279,6 +1279,9 @@ export const data = {
             },
             "message": {
                 "type": "string"
+            },
+            "installLink": {
+                "type": "string"
             }
         }
     },
@@ -1557,6 +1560,9 @@ export const data = {
         "fields": {
             "pass": {
                 "type": "pushwoosh.passkit.v1.PassRecord"
+            },
+            "installLink": {
+                "type": "string"
             }
         }
     },

package/package.json

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

package/pushwoosh_passkit_v1.d.ts

@@ -13,34 +13,29 @@ export type PassKitService_DownloadPass = RpcMethod<DownloadPassRequest, Downloa
 export type PassKitService_GetPassRegistrations = RpcMethod<GetPassRegistrationsRequest, GetPassRegistrationsResponse>;
 /** PassKit Designer Service - Main API for pass creation and management */
 export interface PassKitService {
-    /** Validate a pass configuration */
+    /** Checks an Apple Wallet pass definition against Apple's rules without creating anything; returns errors and warnings. Use before create_apple_wallet_pass. */
     ValidatePass: PassKitService_ValidatePass;
-    /** Create a new pass (.pkpass file) */
+    /** Creates one standalone Apple Wallet pass (.pkpass) for an application (code XXXXX-XXXXX), signed with the application's Pass Type ID certificate; icon and logo images are required, passed as bytes. Returns the serial number and the install link to send. For one design issued to many users use create_wallet_campaign instead. */
     CreatePass: PassKitService_CreatePass;
-    /** Get server configuration */
+    /** Reports whether Apple Wallet is set up for an application (code XXXXX-XXXXX): has_certificate, the Pass Type ID, the Apple Team ID and the web service URL install links are built on. has_certificate=false means the setup has not been done yet. */
     GetConfig: PassKitService_GetConfig;
-    /** List available templates */
+    /** Lists the built-in Apple Wallet pass templates (boarding pass, coupon, event ticket, generic, store card) to start a design from. */
     ListTemplates: PassKitService_ListTemplates;
-    /** Get a specific template */
+    /** Returns one built-in Apple Wallet pass template (filename from list_apple_wallet_templates) as a full pass definition to adapt. */
     GetTemplate: PassKitService_GetTemplate;
-    /** Update an existing pass */
+    /** Updates a standalone Apple Wallet pass by serial number and pushes the change to every device that added it; holders keep the same card. */
     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.
-     */
+    /** Shows a lock-screen message on every device that added the Apple Wallet pass (serial number), without changing the pass content. */
     SendPassMessage: PassKitService_SendPassMessage;
-    /** Delete an existing pass */
+    /** Deletes a standalone Apple Wallet pass by serial number; it stops updating on devices that added it. */
     DeletePass: PassKitService_DeletePass;
-    /** List all passes */
+    /** Lists the Apple Wallet passes of an application (code XXXXX-XXXXX), newest first by default; page is zero-based. */
     ListPasses: PassKitService_ListPasses;
-    /** Get a single pass by serial number */
+    /** Returns one Apple Wallet pass by serial number with its definition and install link. */
     GetPass: PassKitService_GetPass;
-    /** Download the .pkpass file of an already created pass */
+    /** Returns the signed .pkpass file of an existing Apple Wallet pass as bytes. */
     DownloadPass: PassKitService_DownloadPass;
-    /** Get registrations for a pass */
+    /** Lists the devices that added an Apple Wallet pass (serial number): how many holders actually installed it. */
     GetPassRegistrations: PassKitService_GetPassRegistrations;
 }
 /** Pass Field - represents a field in the pass */
@@ -216,6 +211,8 @@ export type CreatePassResponse = {
      */
     serialNumber: string;
     message: string;
+    /** Link a recipient opens to add the pass to Apple Wallet (also good for a QR code). */
+    installLink: string;
 };
 /** Get config response */
 export type GetConfigResponse = {
@@ -345,6 +342,8 @@ export type GetPassRequest = {
 /** Get pass response */
 export type GetPassResponse = {
     pass: PassRecord;
+    /** Link a recipient opens to add the pass to Apple Wallet. */
+    installLink: string;
 };
 /** Device registration info */
 export type DeviceRegistration = {

package/pushwoosh_walletcampaign_v1.d.ts

@@ -17,35 +17,31 @@ 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. */
     CreateCampaign: WalletCampaignService_CreateCampaign;
+    /** Lists the Wallet Pass Campaigns of an application (code XXXXX-XXXXX) with how many passes each issued. */
     ListCampaigns: WalletCampaignService_ListCampaigns;
+    /** Returns one Wallet Pass Campaign: design, shared and personal fields, images, status and the current revision a patch must quote. */
     GetCampaign: WalletCampaignService_GetCampaign;
-    /**
-     * Patch the campaign and propagate shared field changes to its passes.
-     * Answers 202: delivery runs in a job. dry_run only reports the impact.
-     */
+    /** Changes a Wallet Pass Campaign and delivers the change to every issued pass in a background job. Quote revision from get_wallet_campaign and list every changed field in update_mask (an empty mask is refused). Passes where a field was edited by hand keep it unless force_overwrite. Run with dry_run=true first to show how many passes it touches; returns the job id to follow with get_wallet_campaign_job. */
     PatchCampaign: WalletCampaignService_PatchCampaign;
-    /**
-     * Delete the campaign. Shared values are materialized into its passes first,
-     * so already issued passes keep working as standalone.
-     */
+    /** Deletes a Wallet Pass Campaign. Issued passes keep working as standalone passes with the campaign's last values; only the shared editing is gone. */
     DeleteCampaign: WalletCampaignService_DeleteCampaign;
+    /** Lists the change history of a Wallet Pass Campaign: who changed what, and the delivery job of each change. */
     ListCampaignRevisions: WalletCampaignService_ListCampaignRevisions;
-    /**
-     * Issue one pass from the campaign: only personal values travel in, shared
-     * ones come from the campaign at render time.
-     */
+    /** Issues one pass from a Wallet Pass Campaign to a user (Pushwoosh User ID). Only personal values with source INPUT are passed; shared and tag values come from the campaign. Returns the install link to send to the user. */
     IssuePass: WalletCampaignService_IssuePass;
+    /** Lists the passes issued from a Wallet Pass Campaign; query matches serial number, User ID or barcode. */
     ListCampaignPasses: WalletCampaignService_ListCampaignPasses;
-    /**
-     * Attach standalone passes to the campaign. Values differing from the
-     * campaign become overrides instead of being silently replaced.
-     */
+    /** Attaches existing standalone passes (serial numbers) to a Wallet Pass Campaign of the same style; differing values are kept as hand edits. */
     AttachPasses: WalletCampaignService_AttachPasses;
+    /** Returns the progress of a Wallet Pass Campaign delivery job: passes updated, skipped, failed, and the failures. */
     GetJob: WalletCampaignService_GetJob;
+    /** Retries the failed passes of a Wallet Pass Campaign delivery job. */
     RetryJob: WalletCampaignService_RetryJob;
+    /** Stops a running Wallet Pass Campaign delivery job; passes already updated stay updated. */
     CancelJob: WalletCampaignService_CancelJob;
-    /** Drop one override so the field takes the campaign value again. */
+    /** Drops the hand edit of one field on one campaign pass so it shows the campaign value again. */
     DeletePassOverride: WalletCampaignService_DeletePassOverride;
 }
 export type Platform = 'PLATFORM_UNSPECIFIED' | 'PLATFORM_APPLE' | 'PLATFORM_GOOGLE';
@@ -161,13 +157,20 @@ export type CampaignPass = {
     updatedAt: Date;
 };
 export type CreateCampaignRequest = {
+    /** Application code (format XXXXX-XXXXX). */
     applicationCode: string;
+    /** PLATFORM_APPLE for Apple Wallet. */
     platform: Platform;
+    /** Apple: boardingPass, coupon, eventTicket, storeCard or generic. */
     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. */
     designJson: string;
+    /** Field key -> value shown on every pass; editing it later updates all issued passes. */
     sharedFields: Record<string, string>;
+    /** Per-user fields: from a tag (source TAG) or typed in at issue time (source INPUT). */
     personalFields: PersonalFieldSpec[];
     status: CampaignStatus;
     /** Image slot -> media_files.uuid, uploaded through MediaFilesService beforehand. */
@@ -256,7 +259,9 @@ export type ListCampaignRevisionsResponse = {
 };
 export type IssuePassRequest = {
     campaignId: number;
+    /** Pushwoosh User ID of the recipient. */
     userId: string;
+    /** Field key -> value for personal fields with source INPUT. */
     personal: Record<string, string>;
 };
 export type IssuePassResponse = {