@dalmore/api-contracts 0.0.0-dev.d070175 → 0.0.0-dev.d29fb02

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (188) hide show
  1. package/README.md +23 -19
  2. package/common/types/account-contact.types.ts +2 -1
  3. package/common/types/account-manager.types.ts +3 -7
  4. package/common/types/account-setting.types.ts +65 -0
  5. package/common/types/account.types.ts +1 -0
  6. package/common/types/auth.types.ts +7 -18
  7. package/common/types/bonus-tier.types.ts +9 -0
  8. package/common/types/common.types.ts +26 -0
  9. package/common/types/contact-us.types.ts +6 -2
  10. package/common/types/covered-person.types.ts +2 -1
  11. package/common/types/escrow-account.types.ts +3 -3
  12. package/common/types/individuals.types.ts +3 -2
  13. package/common/types/investor-account.types.ts +2 -1
  14. package/common/types/invite.types.ts +27 -1
  15. package/common/types/issuer-offering.types.ts +5 -8
  16. package/common/types/legal-entity.types.ts +3 -2
  17. package/common/types/mail-template.types.ts +34 -0
  18. package/common/types/note.types.ts +1 -1
  19. package/common/types/notification.types.ts +525 -29
  20. package/common/types/site-settings.types.ts +2 -1
  21. package/common/types/trade.types.ts +47 -1
  22. package/common/types/trusted-contact.types.ts +7 -7
  23. package/common/types/user.types.ts +2 -5
  24. package/index.ts +10 -0
  25. package/package.json +23 -32
  26. package/contracts/compliance/account-contacts/index.ts +0 -82
  27. package/contracts/compliance/account-managers/index.ts +0 -142
  28. package/contracts/compliance/accounts/index.ts +0 -187
  29. package/contracts/compliance/activities/index.ts +0 -55
  30. package/contracts/compliance/aic/index.ts +0 -60
  31. package/contracts/compliance/api-keys/index.ts +0 -91
  32. package/contracts/compliance/assets/index.ts +0 -122
  33. package/contracts/compliance/auth/index.ts +0 -134
  34. package/contracts/compliance/batch-jobs/index.ts +0 -62
  35. package/contracts/compliance/bonus-tiers/index.ts +0 -74
  36. package/contracts/compliance/checklist/index.ts +0 -87
  37. package/contracts/compliance/checklist-items/index.ts +0 -86
  38. package/contracts/compliance/covered-persons/index.ts +0 -97
  39. package/contracts/compliance/dashboard/index.ts +0 -111
  40. package/contracts/compliance/data-records/index.ts +0 -116
  41. package/contracts/compliance/data-rooms/index.ts +0 -113
  42. package/contracts/compliance/default-theme-configs/index.ts +0 -95
  43. package/contracts/compliance/disbursement/index.ts +0 -165
  44. package/contracts/compliance/disbursement-approval-users/index.ts +0 -84
  45. package/contracts/compliance/disbursement-transactions/index.ts +0 -37
  46. package/contracts/compliance/domain-filters/index.ts +0 -117
  47. package/contracts/compliance/email-themes/index.ts +0 -284
  48. package/contracts/compliance/escrow-accounts/index.ts +0 -85
  49. package/contracts/compliance/exchange-api-keys/index.ts +0 -129
  50. package/contracts/compliance/exchange-imports/index.ts +0 -137
  51. package/contracts/compliance/files/index.ts +0 -267
  52. package/contracts/compliance/files-public/index.ts +0 -188
  53. package/contracts/compliance/health/index.ts +0 -26
  54. package/contracts/compliance/index.ts +0 -147
  55. package/contracts/compliance/individuals/index.ts +0 -57
  56. package/contracts/compliance/investor-accounts/index.ts +0 -141
  57. package/contracts/compliance/invites/index.ts +0 -137
  58. package/contracts/compliance/issuer-bank-accounts/index.ts +0 -81
  59. package/contracts/compliance/issuer-payment-methods/index.ts +0 -81
  60. package/contracts/compliance/issuers/index.ts +0 -97
  61. package/contracts/compliance/job-items/index.ts +0 -58
  62. package/contracts/compliance/jobs/index.ts +0 -59
  63. package/contracts/compliance/kyb/index.ts +0 -54
  64. package/contracts/compliance/kyc/index.ts +0 -77
  65. package/contracts/compliance/legal-entities/index.ts +0 -57
  66. package/contracts/compliance/login-histories/index.ts +0 -37
  67. package/contracts/compliance/notes/index.ts +0 -69
  68. package/contracts/compliance/notion-databases/index.ts +0 -107
  69. package/contracts/compliance/notion-pages/index.ts +0 -105
  70. package/contracts/compliance/offering-reports/index.ts +0 -149
  71. package/contracts/compliance/offerings/index.ts +0 -233
  72. package/contracts/compliance/pages/index.ts +0 -178
  73. package/contracts/compliance/payment-methods/index.ts +0 -57
  74. package/contracts/compliance/rejection-reasons/index.ts +0 -32
  75. package/contracts/compliance/review/index.ts +0 -169
  76. package/contracts/compliance/roles/index.ts +0 -34
  77. package/contracts/compliance/secondary-customers/index.ts +0 -77
  78. package/contracts/compliance/secondary-orders/index.ts +0 -60
  79. package/contracts/compliance/secondary-trades/index.ts +0 -100
  80. package/contracts/compliance/secure-requests/index.ts +0 -54
  81. package/contracts/compliance/signer/index.ts +0 -369
  82. package/contracts/compliance/site-links/index.ts +0 -128
  83. package/contracts/compliance/site-settings/index.ts +0 -669
  84. package/contracts/compliance/sites/index.ts +0 -56
  85. package/contracts/compliance/state-machine/index.ts +0 -94
  86. package/contracts/compliance/tasks/index.ts +0 -91
  87. package/contracts/compliance/third-parties/index.ts +0 -52
  88. package/contracts/compliance/trade-line-items/index.ts +0 -59
  89. package/contracts/compliance/trades/index.ts +0 -230
  90. package/contracts/compliance/transactions/index.ts +0 -161
  91. package/contracts/compliance/user-manuals/index.ts +0 -271
  92. package/contracts/compliance/user-settings/index.ts +0 -189
  93. package/contracts/compliance/users/index.ts +0 -221
  94. package/contracts/compliance/webhooks/index.ts +0 -41
  95. package/contracts/compliance-apikey/accounts/index.ts +0 -58
  96. package/contracts/compliance-apikey/index.ts +0 -14
  97. package/contracts/index.ts +0 -6
  98. package/contracts/investors/account-contacts/index.ts +0 -58
  99. package/contracts/investors/aic/index.ts +0 -59
  100. package/contracts/investors/assets/index.ts +0 -61
  101. package/contracts/investors/auth/index.ts +0 -116
  102. package/contracts/investors/bonus-tiers/index.ts +0 -55
  103. package/contracts/investors/cart/index.ts +0 -75
  104. package/contracts/investors/contact-us/index.ts +0 -48
  105. package/contracts/investors/data-records/index.ts +0 -113
  106. package/contracts/investors/data-rooms/index.ts +0 -96
  107. package/contracts/investors/files/index.ts +0 -167
  108. package/contracts/investors/files-public/index.ts +0 -185
  109. package/contracts/investors/index.ts +0 -72
  110. package/contracts/investors/individuals/index.ts +0 -121
  111. package/contracts/investors/investor-accounts/index.ts +0 -110
  112. package/contracts/investors/issuer-payment-methods/index.ts +0 -36
  113. package/contracts/investors/issuers/index.ts +0 -30
  114. package/contracts/investors/legal-entities/index.ts +0 -93
  115. package/contracts/investors/notes/index.ts +0 -69
  116. package/contracts/investors/offerings/index.ts +0 -93
  117. package/contracts/investors/pages/index.ts +0 -88
  118. package/contracts/investors/payment-methods/index.ts +0 -149
  119. package/contracts/investors/portfolios/index.ts +0 -53
  120. package/contracts/investors/sites/index.ts +0 -96
  121. package/contracts/investors/tasks/index.ts +0 -111
  122. package/contracts/investors/trade-line-items/index.ts +0 -75
  123. package/contracts/investors/trades/index.ts +0 -114
  124. package/contracts/investors/transactions/index.ts +0 -37
  125. package/contracts/investors/trusted-contacts/index.ts +0 -93
  126. package/contracts/investors/user-manuals/index.ts +0 -62
  127. package/contracts/investors/user-settings/index.ts +0 -170
  128. package/contracts/investors/users/index.ts +0 -45
  129. package/contracts/investors/webhooks/index.ts +0 -30
  130. package/contracts/issuers/account-contacts/index.ts +0 -76
  131. package/contracts/issuers/account-integrations/index.ts +0 -97
  132. package/contracts/issuers/accounts/index.ts +0 -97
  133. package/contracts/issuers/activities/index.ts +0 -54
  134. package/contracts/issuers/aic/index.ts +0 -39
  135. package/contracts/issuers/api-key-logs/index.ts +0 -53
  136. package/contracts/issuers/api-keys/index.ts +0 -93
  137. package/contracts/issuers/assets/index.ts +0 -122
  138. package/contracts/issuers/auth/index.ts +0 -152
  139. package/contracts/issuers/bonus-tiers/index.ts +0 -73
  140. package/contracts/issuers/contact-us/index.ts +0 -48
  141. package/contracts/issuers/covered-persons/index.ts +0 -136
  142. package/contracts/issuers/dashboard/index.ts +0 -72
  143. package/contracts/issuers/data-records/index.ts +0 -257
  144. package/contracts/issuers/data-rooms/index.ts +0 -134
  145. package/contracts/issuers/disbursement-approval-users/index.ts +0 -82
  146. package/contracts/issuers/disbursement-transactions/index.ts +0 -53
  147. package/contracts/issuers/disbursements/index.ts +0 -189
  148. package/contracts/issuers/email-themes/index.ts +0 -242
  149. package/contracts/issuers/escrow-accounts/index.ts +0 -81
  150. package/contracts/issuers/exchange-api-keys/index.ts +0 -144
  151. package/contracts/issuers/files/index.ts +0 -166
  152. package/contracts/issuers/files-public/index.ts +0 -166
  153. package/contracts/issuers/health/index.ts +0 -24
  154. package/contracts/issuers/index.ts +0 -112
  155. package/contracts/issuers/investor-accounts/index.ts +0 -148
  156. package/contracts/issuers/invites/index.ts +0 -129
  157. package/contracts/issuers/issuer/index.ts +0 -94
  158. package/contracts/issuers/issuer-bank-accounts/index.ts +0 -81
  159. package/contracts/issuers/issuer-payment-methods/index.ts +0 -136
  160. package/contracts/issuers/kyc/index.ts +0 -38
  161. package/contracts/issuers/login-histories/index.ts +0 -51
  162. package/contracts/issuers/notes/index.ts +0 -69
  163. package/contracts/issuers/offerings/index.ts +0 -206
  164. package/contracts/issuers/pages/index.ts +0 -138
  165. package/contracts/issuers/payment-methods/index.ts +0 -61
  166. package/contracts/issuers/portfolios/index.ts +0 -36
  167. package/contracts/issuers/rejection-reasons/index.ts +0 -32
  168. package/contracts/issuers/review/index.ts +0 -63
  169. package/contracts/issuers/secondary-customers/index.ts +0 -55
  170. package/contracts/issuers/secondary-orders/index.ts +0 -57
  171. package/contracts/issuers/secondary-trades/index.ts +0 -57
  172. package/contracts/issuers/secure-requests/index.ts +0 -34
  173. package/contracts/issuers/site-links/index.ts +0 -116
  174. package/contracts/issuers/site-settings/index.ts +0 -585
  175. package/contracts/issuers/sites/index.ts +0 -32
  176. package/contracts/issuers/tasks/index.ts +0 -111
  177. package/contracts/issuers/trades/index.ts +0 -132
  178. package/contracts/issuers/transactions/index.ts +0 -158
  179. package/contracts/issuers/user-manuals/index.ts +0 -62
  180. package/contracts/issuers/user-settings/index.ts +0 -170
  181. package/contracts/issuers/users/index.ts +0 -126
  182. package/contracts/secondaries/accounts/index.ts +0 -58
  183. package/contracts/secondaries/index.ts +0 -23
  184. package/contracts/secondaries/secondary-customers/index.ts +0 -55
  185. package/contracts/secondaries/secondary-issuers/index.ts +0 -94
  186. package/contracts/secondaries/secondary-orders/index.ts +0 -56
  187. package/contracts/secondaries/secondary-securities/index.ts +0 -95
  188. package/contracts/secondaries/secondary-trades/index.ts +0 -56
@@ -1,61 +0,0 @@
1
- import { initContract } from '@ts-rest/core';
2
- import {
3
- ForbiddenError,
4
- InternalError,
5
- NotFoundError,
6
- UnauthorizedError,
7
- userIdSchema,
8
- } from '../../../common/types';
9
- import {
10
- paymentMethodIdSchema,
11
- PaymentMethodResponse,
12
- PaymentMethodResponseArray,
13
- } from '../../../common/types/payment-methods.types';
14
- import { z } from 'zod';
15
-
16
- const c = initContract();
17
-
18
- export const paymentMethodsContract = c.router(
19
- {
20
- getPaymentMethods: {
21
- summary: 'get payment methods',
22
- method: 'GET',
23
- path: '/',
24
- metadata: {
25
- auth: true,
26
- },
27
- query: z.object({
28
- userId: userIdSchema.optional(),
29
- }),
30
- responses: {
31
- 200: PaymentMethodResponseArray,
32
- 401: UnauthorizedError,
33
- 403: ForbiddenError,
34
- 404: NotFoundError,
35
- 500: InternalError,
36
- },
37
- },
38
-
39
- getPaymentMethod: {
40
- summary: 'GET payment method',
41
- method: 'GET',
42
- path: '/:id',
43
- metadata: {
44
- auth: true,
45
- },
46
- pathParams: z.object({
47
- id: paymentMethodIdSchema,
48
- }),
49
- responses: {
50
- 200: PaymentMethodResponse,
51
- 401: UnauthorizedError,
52
- 403: ForbiddenError,
53
- 404: NotFoundError,
54
- 500: InternalError,
55
- },
56
- },
57
- },
58
- {
59
- pathPrefix: 'payment-methods',
60
- },
61
- );
@@ -1,36 +0,0 @@
1
- import { initContract } from '@ts-rest/core';
2
- import {
3
- ForbiddenError,
4
- InternalError,
5
- UnauthorizedError,
6
- } from '../../../common/types';
7
- import { z } from 'zod';
8
- import { investorAccountIdSchema } from '../../../common/types/investor-account.types';
9
- import { AccountPortfolioResponse } from '../../../common/types/portfolio.types';
10
-
11
- const c = initContract();
12
-
13
- export const portfoliosContract = c.router(
14
- {
15
- getAccountPortfolio: {
16
- summary: 'GET Account portfolio',
17
- method: 'GET',
18
- path: '/:id',
19
- metadata: {
20
- auth: true,
21
- },
22
- pathParams: z.object({
23
- id: investorAccountIdSchema,
24
- }),
25
- responses: {
26
- 200: AccountPortfolioResponse,
27
- 401: UnauthorizedError,
28
- 403: ForbiddenError,
29
- 500: InternalError,
30
- },
31
- },
32
- },
33
- {
34
- pathPrefix: 'portfolios',
35
- },
36
- );
@@ -1,32 +0,0 @@
1
- import { initContract } from '@ts-rest/core';
2
- import {
3
- ForbiddenError,
4
- InternalError,
5
- UnauthorizedError,
6
- } from '../../../common/types';
7
- import { z } from 'zod';
8
- import { RejectionReasonZod } from '../../../common/types/rejection-reasons.types';
9
-
10
- const c = initContract();
11
-
12
- export const rejectionReasonsContract = c.router(
13
- {
14
- getRejectionReasons: {
15
- summary: 'Get rejection reasons',
16
- method: 'GET',
17
- path: '/',
18
- metadata: {
19
- auth: true,
20
- },
21
- responses: {
22
- 200: z.array(RejectionReasonZod),
23
- 401: UnauthorizedError,
24
- 403: ForbiddenError,
25
- 500: InternalError,
26
- },
27
- },
28
- },
29
- {
30
- pathPrefix: 'rejection-reasons',
31
- },
32
- );
@@ -1,63 +0,0 @@
1
- import { initContract } from '@ts-rest/core';
2
- import {
3
- ForbiddenError,
4
- InternalError,
5
- UnauthorizedError,
6
- PostReviewBody,
7
- PostReviewResponse,
8
- } from '../../../common/types';
9
-
10
- const c = initContract();
11
-
12
- export const reviewContract = c.router(
13
- {
14
- postReviewKyc: {
15
- summary: 'Post KYC review for individuals',
16
- method: 'POST',
17
- path: '/kyc',
18
- metadata: {
19
- auth: true,
20
- },
21
- body: PostReviewBody,
22
- responses: {
23
- 201: PostReviewResponse,
24
- 401: UnauthorizedError,
25
- 403: ForbiddenError,
26
- 500: InternalError,
27
- },
28
- },
29
- postReviewAml: {
30
- summary: 'Post AML review for individuals',
31
- method: 'POST',
32
- path: '/aml',
33
- metadata: {
34
- auth: true,
35
- },
36
- body: PostReviewBody,
37
- responses: {
38
- 201: PostReviewResponse,
39
- 401: UnauthorizedError,
40
- 403: ForbiddenError,
41
- 500: InternalError,
42
- },
43
- },
44
- postReviewAic: {
45
- summary: 'Post AIC review for individuals',
46
- method: 'POST',
47
- path: '/aic',
48
- metadata: {
49
- auth: true,
50
- },
51
- body: PostReviewBody,
52
- responses: {
53
- 201: PostReviewResponse,
54
- 401: UnauthorizedError,
55
- 403: ForbiddenError,
56
- 500: InternalError,
57
- },
58
- },
59
- },
60
- {
61
- pathPrefix: 'review',
62
- },
63
- );
@@ -1,55 +0,0 @@
1
- import { initContract } from '@ts-rest/core';
2
- import {
3
- IPaginatedSecondaryCustomers,
4
- SecondaryCustomerFiltersZod,
5
- secondaryCustomerIdSchema,
6
- SecondaryCustomer,
7
- } from '../../../common/types/secondary-customer.types';
8
- import {
9
- ForbiddenError,
10
- NotFoundError,
11
- UnauthorizedError,
12
- PaginationOptionsZod,
13
- } from '../../../common/types';
14
- import { z } from 'zod';
15
-
16
- const c = initContract();
17
-
18
- export const secondaryCustomersContract = c.router(
19
- {
20
- getCustomers: {
21
- summary: 'Get Customers',
22
- method: 'GET',
23
- path: '',
24
- metadata: {
25
- auth: true,
26
- },
27
- query: PaginationOptionsZod.merge(SecondaryCustomerFiltersZod),
28
- responses: {
29
- 200: IPaginatedSecondaryCustomers,
30
- 401: UnauthorizedError,
31
- 403: ForbiddenError,
32
- },
33
- },
34
- getCustomer: {
35
- summary: 'Get Customer',
36
- method: 'GET',
37
- path: '/:id',
38
- metadata: {
39
- auth: true,
40
- },
41
- pathParams: z.object({
42
- id: secondaryCustomerIdSchema,
43
- }),
44
- responses: {
45
- 200: SecondaryCustomer,
46
- 401: UnauthorizedError,
47
- 403: ForbiddenError,
48
- 404: NotFoundError,
49
- },
50
- },
51
- },
52
- {
53
- pathPrefix: 'secondary-customers',
54
- },
55
- );
@@ -1,57 +0,0 @@
1
- import { initContract } from '@ts-rest/core';
2
- import { z } from 'zod';
3
- import { PaginationOptionsZod } from '../../../common/types/common.types';
4
- import {
5
- ForbiddenError,
6
- InternalError,
7
- NotFoundError,
8
- UnauthorizedError,
9
- } from '../../../common/types/error-responses.types';
10
- import {
11
- IPaginatedSecondaryOrders,
12
- SecondaryOrder,
13
- secondaryOrderIdSchema,
14
- SecondaryOrderFiltersZod,
15
- } from '../../../common/types/secondary-order.types';
16
- const c = initContract();
17
-
18
- export const secondaryOrdersContract = c.router(
19
- {
20
- getSecondaryOrders: {
21
- method: 'GET',
22
- path: '',
23
- query: PaginationOptionsZod.merge(SecondaryOrderFiltersZod),
24
- metadata: {
25
- auth: true,
26
- },
27
- summary: 'Get all secondary orders',
28
- responses: {
29
- 200: IPaginatedSecondaryOrders,
30
- 401: UnauthorizedError,
31
- 403: ForbiddenError,
32
- 500: InternalError,
33
- },
34
- },
35
- getSecondaryOrder: {
36
- method: 'GET',
37
- path: '/:id',
38
- metadata: {
39
- auth: true,
40
- },
41
- pathParams: z.object({
42
- id: secondaryOrderIdSchema,
43
- }),
44
- summary: 'Get a secondary order by id',
45
- responses: {
46
- 200: SecondaryOrder,
47
- 401: UnauthorizedError,
48
- 403: ForbiddenError,
49
- 404: NotFoundError,
50
- 500: InternalError,
51
- },
52
- },
53
- },
54
- {
55
- pathPrefix: 'secondary-orders',
56
- },
57
- );
@@ -1,57 +0,0 @@
1
- import { initContract } from '@ts-rest/core';
2
- import { z } from 'zod';
3
- import { PaginationOptionsZod } from '../../../common/types/common.types';
4
- import {
5
- ForbiddenError,
6
- InternalError,
7
- NotFoundError,
8
- UnauthorizedError,
9
- } from '../../../common/types/error-responses.types';
10
- import {
11
- IPaginatedSecondaryTrades,
12
- secondaryTradeIdSchema,
13
- SecondaryTradeFiltersZod,
14
- SecondaryTradeZod,
15
- } from '../../../common/types/secondary-trade.types';
16
- const c = initContract();
17
-
18
- export const secondaryTradesContract = c.router(
19
- {
20
- getSecondaryTrades: {
21
- method: 'GET',
22
- path: '',
23
- query: PaginationOptionsZod.merge(SecondaryTradeFiltersZod),
24
- metadata: {
25
- auth: true,
26
- },
27
- summary: 'Get all secondary trades',
28
- responses: {
29
- 200: IPaginatedSecondaryTrades,
30
- 401: UnauthorizedError,
31
- 403: ForbiddenError,
32
- 500: InternalError,
33
- },
34
- },
35
- getSecondaryTrade: {
36
- method: 'GET',
37
- path: '/:id',
38
- metadata: {
39
- auth: true,
40
- },
41
- pathParams: z.object({
42
- id: secondaryTradeIdSchema,
43
- }),
44
- summary: 'Get a secondary trade by id',
45
- responses: {
46
- 200: SecondaryTradeZod,
47
- 401: UnauthorizedError,
48
- 403: ForbiddenError,
49
- 404: NotFoundError,
50
- 500: InternalError,
51
- },
52
- },
53
- },
54
- {
55
- pathPrefix: 'secondary-trades',
56
- },
57
- );
@@ -1,34 +0,0 @@
1
- import { initContract } from '@ts-rest/core';
2
- import {
3
- NotFoundError,
4
- UnauthorizedError,
5
- InternalError,
6
- BadRequestError,
7
- } from '../../../common/types';
8
- import {
9
- PostSecureRequestBody,
10
- SecureRequestZod,
11
- } from '../../../common/types/secure-request.types';
12
-
13
- const c = initContract();
14
-
15
- export const secureRequestContract = c.router(
16
- {
17
- postSecureRequest: {
18
- summary: 'Create Secure Request for Issuer integration. Ex: NorthCap',
19
- method: 'POST',
20
- path: '/',
21
- body: PostSecureRequestBody,
22
- responses: {
23
- 202: SecureRequestZod,
24
- 400: BadRequestError,
25
- 401: UnauthorizedError,
26
- 404: NotFoundError,
27
- 500: InternalError,
28
- },
29
- },
30
- },
31
- {
32
- pathPrefix: 'secure-request',
33
- },
34
- );
@@ -1,116 +0,0 @@
1
- import { initContract } from '@ts-rest/core';
2
- import {
3
- PaginationOptionsZod,
4
- UnauthorizedError,
5
- SiteLinkFiltersZod,
6
- IPaginatedSiteLink,
7
- PostSiteLinkZod,
8
- ISiteLink,
9
- BadRequestError,
10
- NotFoundError,
11
- ForbiddenError,
12
- InternalError,
13
- siteLinkIdSchema,
14
- SiteLinkDeleteResponse,
15
- SiteLinksIncludeQuery,
16
- } from '../../../common/types';
17
- import { z } from 'zod';
18
- const c = initContract();
19
-
20
- export const siteLinksContract = c.router(
21
- {
22
- getSiteLinks: {
23
- summary: 'Get site links',
24
- method: 'GET',
25
- path: '',
26
- metadata: {
27
- auth: true,
28
- },
29
- query: PaginationOptionsZod.merge(SiteLinkFiltersZod),
30
- responses: {
31
- 200: IPaginatedSiteLink,
32
- 400: BadRequestError,
33
- 401: UnauthorizedError,
34
- },
35
- },
36
- getSiteLink: {
37
- summary: 'Get a site link',
38
- method: 'GET',
39
- path: '/:id',
40
- metadata: {
41
- auth: true,
42
- },
43
- pathParams: z.object({
44
- id: siteLinkIdSchema,
45
- }),
46
- query: z.object({}).merge(SiteLinksIncludeQuery),
47
- responses: {
48
- 200: ISiteLink,
49
- 400: BadRequestError,
50
- 401: UnauthorizedError,
51
- 403: ForbiddenError,
52
- 404: NotFoundError,
53
- 500: InternalError,
54
- },
55
- },
56
- postSiteLink: {
57
- summary: 'Create a site link',
58
- method: 'POST',
59
- path: '',
60
- metadata: {
61
- auth: true,
62
- },
63
- body: PostSiteLinkZod,
64
- responses: {
65
- 201: ISiteLink,
66
- 400: BadRequestError,
67
- 401: UnauthorizedError,
68
- 403: ForbiddenError,
69
- 404: NotFoundError,
70
- 500: InternalError,
71
- },
72
- },
73
- patchSiteLink: {
74
- summary: 'Update a site link',
75
- method: 'PATCH',
76
- path: '/:id',
77
- metadata: {
78
- auth: true,
79
- },
80
- pathParams: z.object({
81
- id: siteLinkIdSchema,
82
- }),
83
- body: PostSiteLinkZod,
84
- responses: {
85
- 201: ISiteLink,
86
- 400: BadRequestError,
87
- 401: UnauthorizedError,
88
- 403: ForbiddenError,
89
- 404: NotFoundError,
90
- 500: InternalError,
91
- },
92
- },
93
- deleteSiteLink: {
94
- summary: 'Delete a site link',
95
- method: 'DELETE',
96
- path: '/:id',
97
- metadata: {
98
- auth: true,
99
- },
100
- pathParams: z.object({
101
- id: siteLinkIdSchema,
102
- }),
103
- responses: {
104
- 204: SiteLinkDeleteResponse,
105
- 400: BadRequestError,
106
- 401: UnauthorizedError,
107
- 403: ForbiddenError,
108
- 404: NotFoundError,
109
- 500: InternalError,
110
- },
111
- },
112
- },
113
- {
114
- pathPrefix: 'site-links',
115
- },
116
- );