@medalsocial/sdk 1.3.0 → 1.5.0

package/dist/openapi/medal-social.openapi.json

@@ -53,6 +53,10 @@
     {
       "name": "Webhooks",
       "description": "Manage webhook endpoints and inspect their deliveries."
+    },
+    {
+      "name": "Channels",
+      "description": "Partner channel connect — mint hosted connect links and manage the resulting channel connections."
     }
   ],
   "paths": {
@@ -123,7 +127,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_PostCreateResult"
+                  "$ref": "#/components/schemas/ApiResponse_PostCreateResult"
                 }
               }
             }
@@ -147,7 +151,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_ChannelArray"
+                  "$ref": "#/components/schemas/ApiResponse_ChannelArray"
                 }
               }
             }
@@ -176,7 +180,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_PostDetail"
+                  "$ref": "#/components/schemas/ApiResponse_PostDetail"
                 }
               }
             }
@@ -208,7 +212,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_Success"
+                  "$ref": "#/components/schemas/ApiResponse_Success"
                 }
               }
             }
@@ -230,7 +234,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_Success"
+                  "$ref": "#/components/schemas/ApiResponse_Success"
                 }
               }
             }
@@ -269,7 +273,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_ScheduleResult"
+                  "$ref": "#/components/schemas/ApiResponse_ScheduleResult"
                 }
               }
             }
@@ -298,7 +302,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_PublishResult"
+                  "$ref": "#/components/schemas/ApiResponse_PublishResult"
                 }
               }
             }
@@ -332,7 +336,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_EmailSendResult"
+                  "$ref": "#/components/schemas/ApiResponse_EmailSendResult"
                 }
               }
             }
@@ -366,7 +370,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_BatchSendSummary"
+                  "$ref": "#/components/schemas/ApiResponse_BatchSendSummary"
                 }
               }
             }
@@ -390,7 +394,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_EmailTemplateArray"
+                  "$ref": "#/components/schemas/ApiResponse_EmailTemplateArray"
                 }
               }
             }
@@ -435,7 +439,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_EmailTemplateDetail"
+                  "$ref": "#/components/schemas/ApiResponse_EmailTemplateDetail"
                 }
               }
             }
@@ -464,7 +468,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_EmailSend"
+                  "$ref": "#/components/schemas/ApiResponse_EmailSend"
                 }
               }
             }
@@ -557,7 +561,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_ContactCreateResult"
+                  "$ref": "#/components/schemas/ApiResponse_ContactCreateResult"
                 }
               }
             }
@@ -603,7 +607,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_ImportContactsResult"
+                  "$ref": "#/components/schemas/ApiResponse_ImportContactsResult"
                 }
               }
             }
@@ -632,7 +636,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_Contact"
+                  "$ref": "#/components/schemas/ApiResponse_Contact"
                 }
               }
             }
@@ -664,7 +668,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_ContactUpdateResult"
+                  "$ref": "#/components/schemas/ApiResponse_ContactUpdateResult"
                 }
               }
             }
@@ -686,7 +690,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_ContactRemoveResult"
+                  "$ref": "#/components/schemas/ApiResponse_ContactRemoveResult"
                 }
               }
             }
@@ -762,7 +766,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_ContactNoteResult"
+                  "$ref": "#/components/schemas/ApiResponse_ContactNoteResult"
                 }
               }
             }
@@ -840,7 +844,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_DealCreateResult"
+                  "$ref": "#/components/schemas/ApiResponse_DealCreateResult"
                 }
               }
             }
@@ -869,7 +873,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_Deal"
+                  "$ref": "#/components/schemas/ApiResponse_Deal"
                 }
               }
             }
@@ -901,7 +905,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_DealUpdateResult"
+                  "$ref": "#/components/schemas/ApiResponse_DealUpdateResult"
                 }
               }
             }
@@ -923,7 +927,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_DealRemoveResult"
+                  "$ref": "#/components/schemas/ApiResponse_DealRemoveResult"
                 }
               }
             }
@@ -947,7 +951,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_GdprExportRequest"
+                  "$ref": "#/components/schemas/ApiResponse_GdprExportRequest"
                 }
               }
             }
@@ -971,7 +975,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_GdprExportArray"
+                  "$ref": "#/components/schemas/ApiResponse_GdprExportArray"
                 }
               }
             }
@@ -1000,7 +1004,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_GdprExport"
+                  "$ref": "#/components/schemas/ApiResponse_GdprExport"
                 }
               }
             }
@@ -1034,7 +1038,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_ConsentResult"
+                  "$ref": "#/components/schemas/ApiResponse_ConsentResult"
                 }
               }
             }
@@ -1069,7 +1073,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_ConsentRecordArray"
+                  "$ref": "#/components/schemas/ApiResponse_ConsentRecordArray"
                 }
               }
             }
@@ -1127,7 +1131,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_WorkspaceArray"
+                  "$ref": "#/components/schemas/ApiResponse_WorkspaceArray"
                 }
               }
             }
@@ -1233,7 +1237,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_HelpdeskConversation"
+                  "$ref": "#/components/schemas/ApiResponse_HelpdeskConversation"
                 }
               }
             }
@@ -1266,7 +1270,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_HelpdeskConversationUpdateResult"
+                  "$ref": "#/components/schemas/ApiResponse_HelpdeskConversationUpdateResult"
                 }
               }
             }
@@ -1354,7 +1358,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_HelpdeskReplyCreateResult"
+                  "$ref": "#/components/schemas/ApiResponse_HelpdeskReplyCreateResult"
                 }
               }
             }
@@ -1378,7 +1382,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_WebhookEndpointArray"
+                  "$ref": "#/components/schemas/ApiResponse_WebhookEndpointArray"
                 }
               }
             }
@@ -1411,7 +1415,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_WebhookEndpoint"
+                  "$ref": "#/components/schemas/ApiResponse_WebhookEndpoint"
                 }
               }
             }
@@ -1440,7 +1444,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_WebhookEndpoint"
+                  "$ref": "#/components/schemas/ApiResponse_WebhookEndpoint"
                 }
               }
             }
@@ -1473,7 +1477,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_WebhookEndpoint"
+                  "$ref": "#/components/schemas/ApiResponse_WebhookEndpoint"
                 }
               }
             }
@@ -1496,7 +1500,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_WebhookDeleteResult"
+                  "$ref": "#/components/schemas/ApiResponse_WebhookDeleteResult"
                 }
               }
             }
@@ -1536,7 +1540,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_WebhookDeliveryArray"
+                  "$ref": "#/components/schemas/ApiResponse_WebhookDeliveryArray"
                 }
               }
             }
@@ -1566,7 +1570,165 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/Envelope_WebhookTestResult"
+                  "$ref": "#/components/schemas/ApiResponse_WebhookTestResult"
+                }
+              }
+            }
+          },
+          "default": {
+            "$ref": "#/components/responses/ApiError"
+          }
+        }
+      }
+    },
+    "/api/v1/channels/connect-links": {
+      "post": {
+        "tags": [
+          "Channels"
+        ],
+        "operationId": "createChannelConnectLink",
+        "summary": "Mint a hosted connect link",
+        "description": "Mints a single-use hosted connect link that lets an external person (no Medal account required) attach a channel account (e.g. `telegram_inbox`) to the workspace's helpdesk. The response's `data.url` contains the one-time link token EXACTLY ONCE — an idempotent replay (same `Idempotency-Key`) returns the link WITHOUT `url`. Requires the `channel.connect.manage` scope; OAuth callers additionally need the workspace `admin` role.",
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/CreateConnectLinkInput"
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "Minted connect link, including the one-time `url`.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ApiResponse_ConnectLinkCreateResult"
+                }
+              }
+            }
+          },
+          "default": {
+            "$ref": "#/components/responses/ApiError"
+          }
+        }
+      },
+      "get": {
+        "tags": [
+          "Channels"
+        ],
+        "operationId": "listChannelConnectLinks",
+        "summary": "List connect links",
+        "description": "Link tokens are never returned.",
+        "parameters": [
+          {
+            "name": "channel_type",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "status",
+            "in": "query",
+            "schema": {
+              "$ref": "#/components/schemas/ConnectLinkStatus"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "The workspace's connect links.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ApiResponse_ConnectLinkArray"
+                }
+              }
+            }
+          },
+          "default": {
+            "$ref": "#/components/responses/ApiError"
+          }
+        }
+      }
+    },
+    "/api/v1/channels/connect-links/{id}": {
+      "parameters": [
+        {
+          "$ref": "#/components/parameters/Id"
+        }
+      ],
+      "delete": {
+        "tags": [
+          "Channels"
+        ],
+        "operationId": "revokeChannelConnectLink",
+        "summary": "Revoke a connect link",
+        "description": "Revokes a pending connect link so it can no longer be consumed. OAuth callers need the workspace `admin` role.",
+        "responses": {
+          "200": {
+            "description": "Revoke result.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ApiResponse_ConnectLinkRevokeResult"
+                }
+              }
+            }
+          },
+          "default": {
+            "$ref": "#/components/responses/ApiError"
+          }
+        }
+      }
+    },
+    "/api/v1/channels/connections": {
+      "get": {
+        "tags": [
+          "Channels"
+        ],
+        "operationId": "listChannelConnections",
+        "summary": "List channel connections",
+        "responses": {
+          "200": {
+            "description": "The workspace's channel connections (generic shape).",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ApiResponse_ChannelConnectionArray"
+                }
+              }
+            }
+          },
+          "default": {
+            "$ref": "#/components/responses/ApiError"
+          }
+        }
+      }
+    },
+    "/api/v1/channels/connections/{id}": {
+      "parameters": [
+        {
+          "$ref": "#/components/parameters/Id"
+        }
+      ],
+      "delete": {
+        "tags": [
+          "Channels"
+        ],
+        "operationId": "disconnectChannelConnection",
+        "summary": "Disconnect a channel connection",
+        "description": "Disconnects a connected channel account (best-effort platform logout, then local revoke). Emits a `helpdesk.channel_disconnected` webhook event with `reason: \"api_disconnect\"` if the account was previously connected. OAuth callers need the workspace `admin` role.",
+        "responses": {
+          "200": {
+            "description": "Disconnect result.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ApiResponse_ChannelConnectionDisconnectResult"
                 }
               }
             }
@@ -2040,6 +2202,17 @@
           },
           "contact_id": {
             "type": "string"
+          },
+          "idempotency_key": {
+            "type": "string"
+          },
+          "copy_to": {
+            "type": "string",
+            "format": "email"
+          },
+          "copy_reply_to": {
+            "type": "string",
+            "format": "email"
           }
         }
       },
@@ -2047,11 +2220,30 @@
         "type": "object",
         "required": [
           "id",
+          "copy_id",
+          "contact_id",
           "status"
         ],
         "properties": {
           "id": {
-            "type": "string"
+            "type": [
+              "string",
+              "null"
+            ],
+            "description": "Email send id — poll GET /api/v1/emails/{id} with it."
+          },
+          "copy_id": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "description": "Send id of the copy_to copy, or null when no copy was requested."
+          },
+          "contact_id": {
+            "type": [
+              "string",
+              "null"
+            ]
           },
           "status": {
             "type": "string"
@@ -2202,7 +2394,8 @@
           "batch_id",
           "total",
           "queued",
-          "failed"
+          "failed",
+          "results"
         ],
         "properties": {
           "batch_id": {
@@ -2216,6 +2409,49 @@
           },
           "failed": {
             "type": "integer"
+          },
+          "results": {
+            "type": "array",
+            "description": "Per-recipient outcome, in request order.",
+            "items": {
+              "$ref": "#/components/schemas/BatchSendRecipientResult"
+            }
+          }
+        }
+      },
+      "BatchSendRecipientResult": {
+        "type": "object",
+        "required": [
+          "email",
+          "id",
+          "status",
+          "error"
+        ],
+        "properties": {
+          "email": {
+            "type": "string",
+            "format": "email"
+          },
+          "id": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "description": "Email send id — poll GET /api/v1/emails/{id} with it. Null when not queued."
+          },
+          "status": {
+            "type": "string",
+            "enum": [
+              "queued",
+              "failed"
+            ]
+          },
+          "error": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "description": "Failure reason for recipients that were not queued."
           }
         }
       },
@@ -3978,6 +4214,207 @@
           }
         }
       },
+      "ConnectLinkStatus": {
+        "type": "string",
+        "enum": [
+          "pending",
+          "consumed",
+          "expired",
+          "revoked"
+        ]
+      },
+      "ChannelConnectionState": {
+        "type": "string",
+        "enum": [
+          "connecting",
+          "active",
+          "disconnected",
+          "disabled"
+        ]
+      },
+      "CreateConnectLinkInput": {
+        "type": "object",
+        "required": [
+          "channel_type"
+        ],
+        "properties": {
+          "channel_type": {
+            "type": "string",
+            "maxLength": 64,
+            "description": "Channel type to connect (e.g. `telegram_inbox`)."
+          },
+          "label": {
+            "type": "string",
+            "maxLength": 100,
+            "description": "Display label shown on the hosted connect page."
+          },
+          "redirect_url": {
+            "type": "string",
+            "format": "uri",
+            "maxLength": 2000,
+            "description": "URL the hosted page redirects to after a successful connect — must be https."
+          }
+        }
+      },
+      "ConnectLinkCreateResult": {
+        "type": "object",
+        "required": [
+          "id",
+          "channel_type",
+          "label",
+          "status",
+          "expires_at"
+        ],
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "url": {
+            "type": "string",
+            "format": "uri",
+            "description": "Single-use hosted connect URL containing the one-time link token — present ONLY in the live create response. An idempotent replay of the create request omits it; the token can never be retrieved again."
+          },
+          "channel_type": {
+            "type": "string"
+          },
+          "label": {
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "status": {
+            "$ref": "#/components/schemas/ConnectLinkStatus"
+          },
+          "expires_at": {
+            "type": "integer",
+            "description": "Unix timestamp in milliseconds."
+          }
+        }
+      },
+      "ConnectLink": {
+        "type": "object",
+        "required": [
+          "id",
+          "channel_type",
+          "label",
+          "status",
+          "consumed_connection_ref",
+          "expires_at",
+          "created_at"
+        ],
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "channel_type": {
+            "type": "string"
+          },
+          "label": {
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "status": {
+            "$ref": "#/components/schemas/ConnectLinkStatus"
+          },
+          "consumed_connection_ref": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "description": "Stable ref of the connection created by consuming this link, or `null`."
+          },
+          "expires_at": {
+            "type": "integer",
+            "description": "Unix timestamp in milliseconds."
+          },
+          "created_at": {
+            "type": "integer",
+            "description": "Unix timestamp in milliseconds."
+          }
+        }
+      },
+      "ConnectLinkRevokeResult": {
+        "type": "object",
+        "required": [
+          "id",
+          "status"
+        ],
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "status": {
+            "type": "string",
+            "const": "revoked"
+          }
+        }
+      },
+      "ChannelConnection": {
+        "type": "object",
+        "required": [
+          "id",
+          "channel_type",
+          "label",
+          "state",
+          "masked_identity",
+          "last_activity_at",
+          "helpdesk_connection_id"
+        ],
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "channel_type": {
+            "type": "string"
+          },
+          "label": {
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "state": {
+            "$ref": "#/components/schemas/ChannelConnectionState"
+          },
+          "masked_identity": {
+            "type": "string",
+            "description": "Privacy-preserving identity handle (e.g. a masked phone number)."
+          },
+          "last_activity_at": {
+            "type": [
+              "integer",
+              "null"
+            ],
+            "description": "Unix timestamp in milliseconds, or `null` if never active."
+          },
+          "helpdesk_connection_id": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "description": "Linked helpdesk channel connection ID, or `null`."
+          }
+        }
+      },
+      "ChannelConnectionDisconnectResult": {
+        "type": "object",
+        "required": [
+          "id",
+          "state"
+        ],
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "state": {
+            "type": "string",
+            "const": "disconnected"
+          }
+        }
+      },
       "ApiResponse_PostCreateResult": {
         "$ref": "#/components/schemas/Envelope_PostCreateResult"
       },
@@ -4083,6 +4520,21 @@
       "ApiResponse_WebhookTestResult": {
         "$ref": "#/components/schemas/Envelope_WebhookTestResult"
       },
+      "ApiResponse_ConnectLinkCreateResult": {
+        "$ref": "#/components/schemas/Envelope_ConnectLinkCreateResult"
+      },
+      "ApiResponse_ConnectLinkArray": {
+        "$ref": "#/components/schemas/Envelope_ConnectLinkArray"
+      },
+      "ApiResponse_ConnectLinkRevokeResult": {
+        "$ref": "#/components/schemas/Envelope_ConnectLinkRevokeResult"
+      },
+      "ApiResponse_ChannelConnectionArray": {
+        "$ref": "#/components/schemas/Envelope_ChannelConnectionArray"
+      },
+      "ApiResponse_ChannelConnectionDisconnectResult": {
+        "$ref": "#/components/schemas/Envelope_ChannelConnectionDisconnectResult"
+      },
       "PaginatedResponse_Post": {
         "type": "object",
         "required": [
@@ -4596,6 +5048,67 @@
             "$ref": "#/components/schemas/WebhookTestResult"
           }
         }
+      },
+      "Envelope_ConnectLinkCreateResult": {
+        "type": "object",
+        "required": [
+          "data"
+        ],
+        "properties": {
+          "data": {
+            "$ref": "#/components/schemas/ConnectLinkCreateResult"
+          }
+        }
+      },
+      "Envelope_ConnectLinkArray": {
+        "type": "object",
+        "required": [
+          "data"
+        ],
+        "properties": {
+          "data": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ConnectLink"
+            }
+          }
+        }
+      },
+      "Envelope_ConnectLinkRevokeResult": {
+        "type": "object",
+        "required": [
+          "data"
+        ],
+        "properties": {
+          "data": {
+            "$ref": "#/components/schemas/ConnectLinkRevokeResult"
+          }
+        }
+      },
+      "Envelope_ChannelConnectionArray": {
+        "type": "object",
+        "required": [
+          "data"
+        ],
+        "properties": {
+          "data": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ChannelConnection"
+            }
+          }
+        }
+      },
+      "Envelope_ChannelConnectionDisconnectResult": {
+        "type": "object",
+        "required": [
+          "data"
+        ],
+        "properties": {
+          "data": {
+            "$ref": "#/components/schemas/ChannelConnectionDisconnectResult"
+          }
+        }
       }
     }
   }