@connectedxm/admin 6.23.7 → 6.24.2
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.
- package/dist/index.cjs +19 -0
- package/dist/index.d.cts +22 -1
- package/dist/index.d.ts +22 -1
- package/dist/index.js +17 -0
- package/openapi.json +64 -1
- package/package.json +1 -1
- package/.cursor/rules/creating-a-mutation.mdc +0 -17
- package/.cursor/rules/creating-a-query.mdc +0 -16
- package/.cursor/rules/index-exports.mdc +0 -5
package/dist/index.js
CHANGED
|
@@ -36125,6 +36125,21 @@ var useDeleteCustomReport = (options = {}) => {
|
|
|
36125
36125
|
return useConnectedMutation(DeleteCustomReport, options);
|
|
36126
36126
|
};
|
|
36127
36127
|
|
|
36128
|
+
// src/mutations/reports/useExportCustomReport.ts
|
|
36129
|
+
var ExportCustomReport = async ({
|
|
36130
|
+
reportId,
|
|
36131
|
+
adminApiParams
|
|
36132
|
+
}) => {
|
|
36133
|
+
const connectedXM = await GetAdminAPI(adminApiParams);
|
|
36134
|
+
const { data } = await connectedXM.post(
|
|
36135
|
+
`/reports/custom/${reportId}/export`
|
|
36136
|
+
);
|
|
36137
|
+
return data;
|
|
36138
|
+
};
|
|
36139
|
+
var useExportCustomReport = (options = {}) => {
|
|
36140
|
+
return useConnectedMutation(ExportCustomReport, options);
|
|
36141
|
+
};
|
|
36142
|
+
|
|
36128
36143
|
// src/mutations/reports/useUpdateCustomReport.ts
|
|
36129
36144
|
var UpdateCustomReport = async ({
|
|
36130
36145
|
reportId,
|
|
@@ -40254,6 +40269,7 @@ export {
|
|
|
40254
40269
|
EventSource,
|
|
40255
40270
|
EventType,
|
|
40256
40271
|
ExportAccount,
|
|
40272
|
+
ExportCustomReport,
|
|
40257
40273
|
ExportStatus,
|
|
40258
40274
|
ExportStreamSession,
|
|
40259
40275
|
FEATURED_CHANNELS_QUERY_KEY,
|
|
@@ -42228,6 +42244,7 @@ export {
|
|
|
42228
42244
|
useEnableLivestream,
|
|
42229
42245
|
useEventGetPassTypeCoupons,
|
|
42230
42246
|
useExportAccount,
|
|
42247
|
+
useExportCustomReport,
|
|
42231
42248
|
useExportStreamSession,
|
|
42232
42249
|
useGenerateMeetingSessionSummary,
|
|
42233
42250
|
useGenerateVideoCaptions,
|
package/openapi.json
CHANGED
|
@@ -76182,6 +76182,59 @@
|
|
|
76182
76182
|
]
|
|
76183
76183
|
}
|
|
76184
76184
|
},
|
|
76185
|
+
"/reports/custom/{reportId}/export": {
|
|
76186
|
+
"post": {
|
|
76187
|
+
"operationId": "ExportCustomReport",
|
|
76188
|
+
"summary": "Export Custom Report",
|
|
76189
|
+
"description": "Export Custom Report endpoint",
|
|
76190
|
+
"parameters": [
|
|
76191
|
+
{
|
|
76192
|
+
"in": "path",
|
|
76193
|
+
"name": "reportId",
|
|
76194
|
+
"schema": {
|
|
76195
|
+
"type": "string"
|
|
76196
|
+
},
|
|
76197
|
+
"description": "The report identifier",
|
|
76198
|
+
"required": true
|
|
76199
|
+
}
|
|
76200
|
+
],
|
|
76201
|
+
"responses": {
|
|
76202
|
+
"200": {
|
|
76203
|
+
"description": "Successful response",
|
|
76204
|
+
"content": {
|
|
76205
|
+
"application/json": {
|
|
76206
|
+
"schema": {
|
|
76207
|
+
"type": "object",
|
|
76208
|
+
"properties": {
|
|
76209
|
+
"status": {
|
|
76210
|
+
"type": "string",
|
|
76211
|
+
"enum": [
|
|
76212
|
+
"ok"
|
|
76213
|
+
]
|
|
76214
|
+
},
|
|
76215
|
+
"message": {
|
|
76216
|
+
"type": "string",
|
|
76217
|
+
"example": "Success message."
|
|
76218
|
+
},
|
|
76219
|
+
"data": {
|
|
76220
|
+
"nullable": true
|
|
76221
|
+
}
|
|
76222
|
+
},
|
|
76223
|
+
"required": [
|
|
76224
|
+
"status",
|
|
76225
|
+
"message",
|
|
76226
|
+
"data"
|
|
76227
|
+
]
|
|
76228
|
+
}
|
|
76229
|
+
}
|
|
76230
|
+
}
|
|
76231
|
+
}
|
|
76232
|
+
},
|
|
76233
|
+
"tags": [
|
|
76234
|
+
"Reports"
|
|
76235
|
+
]
|
|
76236
|
+
}
|
|
76237
|
+
},
|
|
76185
76238
|
"/reports/custom/{reportId}/users": {
|
|
76186
76239
|
"get": {
|
|
76187
76240
|
"operationId": "GetCustomReportUsers",
|
|
@@ -95532,6 +95585,9 @@
|
|
|
95532
95585
|
}
|
|
95533
95586
|
],
|
|
95534
95587
|
"nullable": true
|
|
95588
|
+
},
|
|
95589
|
+
"archived": {
|
|
95590
|
+
"type": "boolean"
|
|
95535
95591
|
}
|
|
95536
95592
|
},
|
|
95537
95593
|
"required": [
|
|
@@ -95568,7 +95624,8 @@
|
|
|
95568
95624
|
"seriesId",
|
|
95569
95625
|
"series",
|
|
95570
95626
|
"paymentIntegrationId",
|
|
95571
|
-
"paymentIntegration"
|
|
95627
|
+
"paymentIntegration",
|
|
95628
|
+
"archived"
|
|
95572
95629
|
]
|
|
95573
95630
|
},
|
|
95574
95631
|
"Event": {
|
|
@@ -113314,6 +113371,9 @@
|
|
|
113314
113371
|
"visible": {
|
|
113315
113372
|
"type": "boolean"
|
|
113316
113373
|
},
|
|
113374
|
+
"archived": {
|
|
113375
|
+
"type": "boolean"
|
|
113376
|
+
},
|
|
113317
113377
|
"slug": {
|
|
113318
113378
|
"type": "string",
|
|
113319
113379
|
"nullable": true
|
|
@@ -113566,6 +113626,9 @@
|
|
|
113566
113626
|
"visible": {
|
|
113567
113627
|
"type": "boolean"
|
|
113568
113628
|
},
|
|
113629
|
+
"archived": {
|
|
113630
|
+
"type": "boolean"
|
|
113631
|
+
},
|
|
113569
113632
|
"name": {
|
|
113570
113633
|
"type": "string",
|
|
113571
113634
|
"nullable": true
|
package/package.json
CHANGED
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
description:
|
|
3
|
-
globs:
|
|
4
|
-
alwaysApply: false
|
|
5
|
-
---
|
|
6
|
-
When creating a Mutation file to interact with a put, post, delete endpoint in the API you should follow the same template.
|
|
7
|
-
|
|
8
|
-
1. First check for Params in the [params.ts](mdc:admin-sdk/src/params.ts) file
|
|
9
|
-
2. Then check for the interfaces in [interfaces.ts](mdc:admin-sdk/src/interfaces.ts) file
|
|
10
|
-
3. Create the file in the mutations folder
|
|
11
|
-
- a set of params
|
|
12
|
-
- the function to interact with the api
|
|
13
|
-
- the react-query mutation hook to use the function
|
|
14
|
-
|
|
15
|
-
Create Example: [useCreateAccount.ts](mdc:admin-sdk/src/mutations/account/useCreateAccount.ts)
|
|
16
|
-
Update Example: [useUpdateAccount.ts](mdc:admin-sdk/src/mutations/account/useUpdateAccount.ts)
|
|
17
|
-
Delete Example: [useDeleteAccount.ts](mdc:admin-sdk/src/mutations/account/useDeleteAccount.ts)
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
description:
|
|
3
|
-
globs:
|
|
4
|
-
alwaysApply: false
|
|
5
|
-
---
|
|
6
|
-
When creating a Query function to interact with a get or list endpoint in the API you should follow the same template.
|
|
7
|
-
|
|
8
|
-
1. check or add the interfaces in [interfaces.ts](mdc:admin-sdk/src/interfaces.ts).ts file
|
|
9
|
-
2. Standard Parts of query file:
|
|
10
|
-
- a QueryKey Function
|
|
11
|
-
- a Setter function
|
|
12
|
-
- the function to interact with the api
|
|
13
|
-
- the react-query hook to use the function
|
|
14
|
-
|
|
15
|
-
Single Query Example: [useGetAccount.ts](mdc:admin-web/src/queries/accounts/useGetAccount.ts)
|
|
16
|
-
Infinite Query Example: [useGetAccounts.ts](mdc:admin-web/src/queries/accounts/useGetAccounts.ts)
|