chore: deprecate endpoints (#3022)

packages/trpc/server/document-router/attachment/create-attachment.ts

@@ -12,8 +12,10 @@ export const createAttachmentRoute = authenticatedProcedure
       method: 'POST',
       path: '/document/attachment/create',
       summary: 'Create attachment',
-      description: 'Create a new attachment for a document',
+      description:
+        'Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Create a new attachment for a document',
       tags: ['Document'],
+      deprecated: true,
     },
   })
   .input(ZCreateAttachmentRequestSchema)

packages/trpc/server/document-router/attachment/delete-attachment.ts

@@ -10,8 +10,10 @@ export const deleteAttachmentRoute = authenticatedProcedure
       method: 'POST',
       path: '/document/attachment/delete',
       summary: 'Delete attachment',
-      description: 'Delete an attachment from a document',
+      description:
+        'Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Delete an attachment from a document',
       tags: ['Document'],
+      deprecated: true,
     },
   })
   .input(ZDeleteAttachmentRequestSchema)

packages/trpc/server/document-router/attachment/find-attachments.ts

@@ -12,8 +12,10 @@ export const findAttachmentsRoute = authenticatedProcedure
       method: 'GET',
       path: '/document/attachment',
       summary: 'Find attachments',
-      description: 'Find all attachments for a document',
+      description:
+        'Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Find all attachments for a document',
       tags: ['Document'],
+      deprecated: true,
     },
   })
   .input(ZFindAttachmentsRequestSchema)

packages/trpc/server/document-router/attachment/update-attachment.ts

@@ -10,8 +10,10 @@ export const updateAttachmentRoute = authenticatedProcedure
       method: 'POST',
       path: '/document/attachment/update',
       summary: 'Update attachment',
-      description: 'Update an existing attachment',
+      description:
+        'Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Update an existing attachment',
       tags: ['Document'],
+      deprecated: true,
     },
   })
   .input(ZUpdateAttachmentRequestSchema)

packages/trpc/server/document-router/create-document-temporary.types.ts

@@ -27,7 +27,7 @@ export const createDocumentTemporaryMeta: TrpcRouteMeta = {
     path: '/document/create/beta',
     summary: 'Create document',
     description:
-      'You will need to upload the PDF to the provided URL returned. Note: Once V2 API is released, this will be removed since we will allow direct uploads, instead of using an upload URL.',
+      'Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. You will need to upload the PDF to the provided URL returned. This endpoint will be removed since we will allow direct uploads, instead of using an upload URL.',
     tags: ['Document'],
     deprecated: true,
   },

packages/trpc/server/document-router/create-document.types.ts

@@ -25,8 +25,10 @@ export const createDocumentMeta: TrpcRouteMeta = {
     path: '/document/create',
     contentTypes: ['multipart/form-data'],
     summary: 'Create document',
-    description: 'Create a document using form data.',
+    description:
+      'Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide.',
     tags: ['Document'],
+    deprecated: true,
   },
 };
 

packages/trpc/server/document-router/delete-document.types.ts

@@ -8,7 +8,10 @@ export const deleteDocumentMeta: TrpcRouteMeta = {
     method: 'POST',
     path: '/document/delete',
     summary: 'Delete document',
+    description:
+      'Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide.',
     tags: ['Document'],
+    deprecated: true,
   },
 };
 

packages/trpc/server/document-router/distribute-document.types.ts

@@ -19,8 +19,10 @@ export const distributeDocumentMeta: TrpcRouteMeta = {
     method: 'POST',
     path: '/document/distribute',
     summary: 'Distribute document',
-    description: 'Send the document out to recipients based on your distribution method',
+    description:
+      'Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Send the document out to recipients based on your distribution method',
     tags: ['Document'],
+    deprecated: true,
   },
 };
 

packages/trpc/server/document-router/download-document-beta.types.ts

@@ -7,8 +7,10 @@ export const downloadDocumentMeta: TrpcRouteMeta = {
     method: 'GET',
     path: '/document/{documentId}/download-beta',
     summary: 'Download document (beta)',
-    description: 'Get a pre-signed download URL for the original or signed version of a document',
+    description:
+      'Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Get a pre-signed download URL for the original or signed version of a document',
     tags: ['Document'],
+    deprecated: true,
   },
 };
 

packages/trpc/server/document-router/download-document.types.ts

@@ -7,7 +7,10 @@ export const downloadDocumentMeta: TrpcRouteMeta = {
     method: 'GET',
     path: '/document/{documentId}/download',
     summary: 'Download document',
+    description:
+      'Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide.',
     tags: ['Document'],
+    deprecated: true,
     responseHeaders: z.object({
       'Content-Type': z.literal('application/pdf'),
     }),

packages/trpc/server/document-router/duplicate-document.types.ts

@@ -7,7 +7,10 @@ export const duplicateDocumentMeta: TrpcRouteMeta = {
     method: 'POST',
     path: '/document/duplicate',
     summary: 'Duplicate document',
+    description:
+      'Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide.',
     tags: ['Document'],
+    deprecated: true,
   },
 };
 

packages/trpc/server/document-router/find-documents.types.ts

@@ -10,8 +10,10 @@ export const ZFindDocumentsMeta: TrpcRouteMeta = {
     method: 'GET',
     path: '/document',
     summary: 'Find documents',
-    description: 'Find documents based on a search criteria',
+    description:
+      'Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Find documents based on a search criteria',
     tags: ['Document'],
+    deprecated: true,
   },
 };
 

packages/trpc/server/document-router/get-document.types.ts

@@ -8,8 +8,10 @@ export const getDocumentMeta: TrpcRouteMeta = {
     method: 'GET',
     path: '/document/{documentId}',
     summary: 'Get document',
-    description: 'Returns a document given an ID',
+    description:
+      'Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Returns a document given an ID',
     tags: ['Document'],
+    deprecated: true,
   },
 };
 

packages/trpc/server/document-router/get-documents-by-ids.types.ts

@@ -8,8 +8,10 @@ export const getDocumentsByIdsMeta: TrpcRouteMeta = {
     method: 'POST',
     path: '/document/get-many',
     summary: 'Get multiple documents',
-    description: 'Retrieve multiple documents by their IDs',
+    description:
+      'Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Retrieve multiple documents by their IDs',
     tags: ['Document'],
+    deprecated: true,
   },
 };
 

packages/trpc/server/document-router/redistribute-document.types.ts

@@ -9,8 +9,9 @@ export const redistributeDocumentMeta: TrpcRouteMeta = {
     path: '/document/redistribute',
     summary: 'Redistribute document',
     description:
-      'Redistribute the document to the provided recipients who have not actioned the document. Will use the distribution method set in the document',
+      'Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide. Redistribute the document to the provided recipients who have not actioned the document. Will use the distribution method set in the document',
     tags: ['Document'],
+    deprecated: true,
   },
 };
 

packages/trpc/server/document-router/update-document.types.ts

@@ -13,7 +13,10 @@ export const updateDocumentMeta: TrpcRouteMeta = {
     method: 'POST',
     path: '/document/update',
     summary: 'Update document',
+    description:
+      'Deprecated: this endpoint is being replaced by the Envelope API. See https://docs.documenso.com/docs/developers/api/migrate-to-envelopes for the migration guide.',
     tags: ['Document'],
+    deprecated: true,
   },
 };