@oomol-lab/open-connector 1.6.2 → 1.6.4

package/assets/open-connector/catalog/apps/walletap.json

@@ -0,0 +1,549 @@
+{
+  "service": "walletap",
+  "displayName": "Walletap",
+  "description": "Manage Walletap passes, customers, campaigns, and related records.",
+  "categories": [
+    "Marketing"
+  ],
+  "authTypes": [
+    "api_key"
+  ],
+  "auth": [
+    {
+      "type": "api_key",
+      "label": "API Key",
+      "placeholder": "wt_live_...",
+      "description": "Walletap API key sent in the X-API-Key header. Create or copy one from Settings > API keys: https://app.walletap.com/settings."
+    }
+  ],
+  "homepageUrl": "https://www.walletap.io/",
+  "actions": [
+    {
+      "id": "walletap.create_pass",
+      "service": "walletap",
+      "name": "create_pass",
+      "description": "Issue one to ten Walletap passes from existing templates.",
+      "operationType": "write",
+      "requiredScopes": [],
+      "providerPermissions": [],
+      "inputSchema": {
+        "type": "object",
+        "properties": {
+          "passes": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "templateId": {
+                  "type": "string",
+                  "description": "The template used to issue the pass."
+                },
+                "id": {
+                  "type": "string",
+                  "description": "A custom pass ID; Walletap generates one when omitted."
+                },
+                "externalId": {
+                  "type": "string",
+                  "description": "The caller-defined ID for this customer or pass."
+                },
+                "email": {
+                  "type": "string",
+                  "description": "The pass holder email address."
+                },
+                "phone": {
+                  "type": "string",
+                  "description": "The pass holder phone number."
+                },
+                "templateFields": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "anyOf": [
+                      {
+                        "type": "string",
+                        "description": "A text pass field value."
+                      },
+                      {
+                        "type": "number",
+                        "description": "A numeric pass field value."
+                      }
+                    ],
+                    "description": "A pass field value rendered as text."
+                  },
+                  "description": "Pass field values keyed by the field IDs configured on the template."
+                },
+                "customFields": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "anyOf": [
+                      {
+                        "type": "string",
+                        "description": "A text pass field value."
+                      },
+                      {
+                        "type": "number",
+                        "description": "A numeric pass field value."
+                      }
+                    ],
+                    "description": "A pass field value rendered as text."
+                  },
+                  "description": "Custom metadata keyed by caller-defined field names."
+                },
+                "memberId": {
+                  "type": "string",
+                  "description": "The membership ID for a membership pass."
+                },
+                "membershipPlanId": {
+                  "type": "string",
+                  "description": "The Walletap membership plan ID."
+                },
+                "locationId": {
+                  "type": "string",
+                  "description": "The Walletap location ID associated with the pass."
+                },
+                "redemptionValue": {
+                  "type": "string",
+                  "description": "The NFC redemption value for the pass."
+                },
+                "balanceIsAdditive": {
+                  "type": "boolean",
+                  "description": "Whether an initial balance adds to an existing pass balance."
+                },
+                "collectedStamps": {
+                  "type": "integer",
+                  "minimum": 0,
+                  "description": "The initial stamp count."
+                }
+              },
+              "additionalProperties": false,
+              "required": [
+                "templateId"
+              ],
+              "description": "One Walletap pass to issue."
+            },
+            "description": "The passes to issue in this request.",
+            "minItems": 1,
+            "maxItems": 10
+          },
+          "sendToEmail": {
+            "type": "boolean",
+            "description": "Whether Walletap should email pass links to the holders."
+          },
+          "sendToPhone": {
+            "type": "boolean",
+            "description": "Whether Walletap should text pass links to the holders."
+          },
+          "locale": {
+            "type": "string",
+            "description": "The locale for pass text and delivery messages."
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "passes"
+        ],
+        "description": "The input for issuing Walletap passes."
+      },
+      "outputSchema": {
+        "type": "object",
+        "properties": {
+          "data": {
+            "description": "The JSON payload returned by Walletap."
+          }
+        },
+        "additionalProperties": false,
+        "description": "A Walletap API response."
+      }
+    },
+    {
+      "id": "walletap.get_pass",
+      "service": "walletap",
+      "name": "get_pass",
+      "description": "Get one Walletap pass by pass ID or by external ID and template ID.",
+      "operationType": "read",
+      "requiredScopes": [],
+      "providerPermissions": [],
+      "inputSchema": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "The Walletap pass ID. Use this or externalId together with templateId."
+          },
+          "externalId": {
+            "type": "string",
+            "description": "The caller-defined pass ID. This must be combined with templateId when id is omitted."
+          },
+          "templateId": {
+            "type": "string",
+            "description": "The template ID. This is required when identifying a pass by externalId."
+          },
+          "includeTemplate": {
+            "type": "boolean",
+            "description": "Whether to include the full template in the response."
+          },
+          "locale": {
+            "type": "string",
+            "description": "The locale used to render pass text, such as en or de."
+          }
+        },
+        "additionalProperties": false,
+        "description": "The input for getting a Walletap pass."
+      },
+      "outputSchema": {
+        "type": "object",
+        "properties": {
+          "data": {
+            "description": "The JSON payload returned by Walletap."
+          }
+        },
+        "additionalProperties": false,
+        "description": "A Walletap API response."
+      }
+    },
+    {
+      "id": "walletap.get_template",
+      "service": "walletap",
+      "name": "get_template",
+      "description": "Get one Walletap template and its configured pass fields.",
+      "operationType": "read",
+      "requiredScopes": [],
+      "providerPermissions": [],
+      "inputSchema": {
+        "type": "object",
+        "properties": {
+          "templateId": {
+            "type": "string",
+            "description": "The Walletap template ID."
+          }
+        },
+        "additionalProperties": false,
+        "description": "The input for getting a Walletap template."
+      },
+      "outputSchema": {
+        "type": "object",
+        "properties": {
+          "data": {
+            "description": "The JSON payload returned by Walletap."
+          }
+        },
+        "additionalProperties": false,
+        "description": "A Walletap API response."
+      }
+    },
+    {
+      "id": "walletap.list_passes",
+      "service": "walletap",
+      "name": "list_passes",
+      "description": "List issued Walletap passes for a template.",
+      "operationType": "read",
+      "requiredScopes": [],
+      "providerPermissions": [],
+      "inputSchema": {
+        "type": "object",
+        "properties": {
+          "templateId": {
+            "type": "string",
+            "description": "The template ID whose passes should be listed."
+          },
+          "limit": {
+            "type": "integer",
+            "minimum": 1,
+            "description": "The maximum number of passes to return."
+          },
+          "startAfter": {
+            "type": "string",
+            "description": "The next-page cursor returned by an earlier request."
+          },
+          "endBefore": {
+            "type": "string",
+            "description": "The previous-page cursor returned by an earlier request."
+          },
+          "status": {
+            "type": "string",
+            "enum": [
+              "all",
+              "installed",
+              "not_installed"
+            ],
+            "description": "The installation status to include."
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "templateId"
+        ],
+        "description": "The input for listing Walletap passes."
+      },
+      "outputSchema": {
+        "type": "object",
+        "properties": {
+          "data": {
+            "description": "The JSON payload returned by Walletap."
+          }
+        },
+        "additionalProperties": false,
+        "description": "A Walletap API response."
+      }
+    },
+    {
+      "id": "walletap.list_templates",
+      "service": "walletap",
+      "name": "list_templates",
+      "description": "List wallet-pass templates owned by the connected Walletap account.",
+      "operationType": "read",
+      "requiredScopes": [],
+      "providerPermissions": [],
+      "inputSchema": {
+        "type": "object",
+        "properties": {
+          "limit": {
+            "type": "integer",
+            "minimum": 1,
+            "maximum": 100,
+            "description": "The maximum number of templates to return, from 1 to 100."
+          },
+          "startingAfter": {
+            "type": "string",
+            "description": "The next-page cursor returned by an earlier request."
+          }
+        },
+        "additionalProperties": false,
+        "description": "The input for listing Walletap templates."
+      },
+      "outputSchema": {
+        "type": "object",
+        "properties": {
+          "data": {
+            "description": "The JSON payload returned by Walletap."
+          }
+        },
+        "additionalProperties": false,
+        "description": "A Walletap API response."
+      }
+    },
+    {
+      "id": "walletap.notify_pass",
+      "service": "walletap",
+      "name": "notify_pass",
+      "description": "Send a push notification to one Walletap pass holder.",
+      "operationType": "write",
+      "requiredScopes": [],
+      "providerPermissions": [],
+      "inputSchema": {
+        "type": "object",
+        "properties": {
+          "passId": {
+            "type": "string",
+            "description": "The Walletap pass ID."
+          },
+          "title": {
+            "type": "string",
+            "description": "The notification title."
+          },
+          "content": {
+            "type": "string",
+            "description": "The notification body; URLs become clickable links."
+          },
+          "validFrom": {
+            "type": "string",
+            "description": "When the notification becomes visible.",
+            "format": "date-time"
+          },
+          "validUntil": {
+            "type": "string",
+            "description": "When the notification expires.",
+            "format": "date-time"
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "passId",
+          "title",
+          "content"
+        ],
+        "description": "The input for notifying a Walletap pass holder."
+      },
+      "outputSchema": {
+        "type": "object",
+        "properties": {
+          "data": {
+            "description": "The JSON payload returned by Walletap."
+          }
+        },
+        "additionalProperties": false,
+        "description": "A Walletap API response."
+      }
+    },
+    {
+      "id": "walletap.search_passes",
+      "service": "walletap",
+      "name": "search_passes",
+      "description": "Search passes in one Walletap template by email address or phone number.",
+      "operationType": "read",
+      "requiredScopes": [],
+      "providerPermissions": [],
+      "inputSchema": {
+        "type": "object",
+        "properties": {
+          "templateId": {
+            "type": "string",
+            "description": "The template ID to search within."
+          },
+          "searchQuery": {
+            "type": "string",
+            "description": "The email address or phone number to search for."
+          }
+        },
+        "additionalProperties": false,
+        "description": "The input for searching Walletap passes."
+      },
+      "outputSchema": {
+        "type": "object",
+        "properties": {
+          "data": {
+            "description": "The JSON payload returned by Walletap."
+          }
+        },
+        "additionalProperties": false,
+        "description": "A Walletap API response."
+      }
+    },
+    {
+      "id": "walletap.update_pass",
+      "service": "walletap",
+      "name": "update_pass",
+      "description": "Update a Walletap pass, including its displayed fields, stamps, balance, or validity.",
+      "operationType": "destructive",
+      "requiredScopes": [],
+      "providerPermissions": [],
+      "inputSchema": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "The Walletap pass ID. Use this or externalId together with templateId."
+          },
+          "externalId": {
+            "type": "string",
+            "description": "The caller-defined pass ID. This must be combined with templateId when id is omitted."
+          },
+          "templateId": {
+            "type": "string",
+            "description": "The template ID. This is required when identifying a pass by externalId."
+          },
+          "templateFields": {
+            "type": "object",
+            "additionalProperties": {
+              "anyOf": [
+                {
+                  "type": "string",
+                  "description": "A text pass field value."
+                },
+                {
+                  "type": "number",
+                  "description": "A numeric pass field value."
+                }
+              ],
+              "description": "A pass field value rendered as text."
+            },
+            "description": "Pass field values keyed by the field IDs configured on the template."
+          },
+          "customFields": {
+            "type": "object",
+            "additionalProperties": {
+              "anyOf": [
+                {
+                  "type": "string",
+                  "description": "A text pass field value."
+                },
+                {
+                  "type": "number",
+                  "description": "A numeric pass field value."
+                }
+              ],
+              "description": "A pass field value rendered as text."
+            },
+            "description": "Custom metadata updates keyed by caller-defined field names."
+          },
+          "isValid": {
+            "type": "boolean",
+            "description": "Whether the pass remains valid; false voids the pass."
+          },
+          "redemptionValue": {
+            "type": "string",
+            "description": "The updated NFC redemption value."
+          },
+          "stampOperation": {
+            "type": "object",
+            "properties": {
+              "operation": {
+                "type": "string",
+                "enum": [
+                  "add",
+                  "set",
+                  "remove",
+                  "removeAll"
+                ],
+                "description": "The stamp operation."
+              },
+              "count": {
+                "type": "integer",
+                "minimum": 0,
+                "description": "The number of stamps to add, set, or remove."
+              },
+              "isTotal": {
+                "type": "boolean",
+                "description": "Whether count is the absolute total across all cards."
+              }
+            },
+            "additionalProperties": false,
+            "required": [
+              "operation"
+            ],
+            "description": "A stamp-count update."
+          },
+          "balanceOperation": {
+            "type": "object",
+            "properties": {
+              "operation": {
+                "type": "string",
+                "enum": [
+                  "add",
+                  "subtract",
+                  "set"
+                ],
+                "description": "The balance operation."
+              },
+              "amount": {
+                "type": "number",
+                "description": "The amount to add, subtract, or set."
+              },
+              "isTotal": {
+                "type": "boolean",
+                "description": "Whether amount is the absolute total."
+              }
+            },
+            "additionalProperties": false,
+            "required": [
+              "operation",
+              "amount"
+            ],
+            "description": "A stored-balance update."
+          }
+        },
+        "additionalProperties": false,
+        "description": "The input for updating a Walletap pass."
+      },
+      "outputSchema": {
+        "type": "object",
+        "properties": {
+          "data": {
+            "description": "The JSON payload returned by Walletap."
+          }
+        },
+        "additionalProperties": false,
+        "description": "A Walletap API response."
+      }
+    }
+  ]
+}