@connectedxm/admin-sdk 6.25.0 → 6.26.0

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.
@@ -6,12 +6,15 @@ All URIs are relative to *https://admin-api.connected.dev*
6
6
  |------------- | ------------- | -------------|
7
7
  |[**createCustomReport**](#createcustomreport) | **POST** /reports/{standard} | Create Custom Report|
8
8
  |[**deleteCustomReport**](#deletecustomreport) | **DELETE** /reports/custom/{reportId} | Delete Custom Report|
9
+ |[**deleteCustomReportSchedule**](#deletecustomreportschedule) | **DELETE** /reports/custom/{reportId}/schedule | Delete Custom Report Schedule|
9
10
  |[**exportCustomReport**](#exportcustomreport) | **POST** /reports/custom/{reportId}/export | Export Custom Report|
10
11
  |[**getCustomReport**](#getcustomreport) | **GET** /reports/custom/{reportId} | Get Custom Report|
12
+ |[**getCustomReportSchedule**](#getcustomreportschedule) | **GET** /reports/custom/{reportId}/schedule | Get Custom Report Schedule|
11
13
  |[**getCustomReports**](#getcustomreports) | **GET** /reports/custom | Get Custom Reports|
12
14
  |[**getReport**](#getreport) | **GET** /reports/{standard} | Get Report|
13
15
  |[**getReports**](#getreports) | **GET** /reports | Get Reports|
14
16
  |[**updateCustomReport**](#updatecustomreport) | **PUT** /reports/custom/{reportId} | Update Custom Report|
17
+ |[**upsertCustomReportSchedule**](#upsertcustomreportschedule) | **POST** /reports/custom/{reportId}/schedule | Upsert Custom Report Schedule|
15
18
 
16
19
  # **createCustomReport**
17
20
  > GetCustomReport200Response createCustomReport(customReportCreateInputs)
@@ -112,6 +115,57 @@ const { status, data } = await apiInstance.deleteCustomReport(
112
115
  - **Accept**: application/json
113
116
 
114
117
 
118
+ ### HTTP response details
119
+ | Status code | Description | Response headers |
120
+ |-------------|-------------|------------------|
121
+ |**200** | Successful response | - |
122
+
123
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
124
+
125
+ # **deleteCustomReportSchedule**
126
+ > GetCustomReportSchedule200Response deleteCustomReportSchedule()
127
+
128
+ Delete Custom Report Schedule endpoint
129
+
130
+ ### Example
131
+
132
+ ```typescript
133
+ import {
134
+ ReportsApi,
135
+ Configuration
136
+ } from '@connectedxm/admin-sdk';
137
+
138
+ const configuration = new Configuration();
139
+ const apiInstance = new ReportsApi(configuration);
140
+
141
+ let reportId: string; //The report identifier (default to undefined)
142
+
143
+ const { status, data } = await apiInstance.deleteCustomReportSchedule(
144
+ reportId
145
+ );
146
+ ```
147
+
148
+ ### Parameters
149
+
150
+ |Name | Type | Description | Notes|
151
+ |------------- | ------------- | ------------- | -------------|
152
+ | **reportId** | [**string**] | The report identifier | defaults to undefined|
153
+
154
+
155
+ ### Return type
156
+
157
+ **GetCustomReportSchedule200Response**
158
+
159
+ ### Authorization
160
+
161
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
162
+
163
+ ### HTTP request headers
164
+
165
+ - **Content-Type**: Not defined
166
+ - **Accept**: application/json
167
+
168
+
115
169
  ### HTTP response details
116
170
  | Status code | Description | Response headers |
117
171
  |-------------|-------------|------------------|
@@ -218,6 +272,57 @@ const { status, data } = await apiInstance.getCustomReport(
218
272
  - **Accept**: application/json
219
273
 
220
274
 
275
+ ### HTTP response details
276
+ | Status code | Description | Response headers |
277
+ |-------------|-------------|------------------|
278
+ |**200** | Successful response | - |
279
+
280
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
281
+
282
+ # **getCustomReportSchedule**
283
+ > GetCustomReportSchedule200Response getCustomReportSchedule()
284
+
285
+ Get Custom Report Schedule endpoint
286
+
287
+ ### Example
288
+
289
+ ```typescript
290
+ import {
291
+ ReportsApi,
292
+ Configuration
293
+ } from '@connectedxm/admin-sdk';
294
+
295
+ const configuration = new Configuration();
296
+ const apiInstance = new ReportsApi(configuration);
297
+
298
+ let reportId: string; //The report identifier (default to undefined)
299
+
300
+ const { status, data } = await apiInstance.getCustomReportSchedule(
301
+ reportId
302
+ );
303
+ ```
304
+
305
+ ### Parameters
306
+
307
+ |Name | Type | Description | Notes|
308
+ |------------- | ------------- | ------------- | -------------|
309
+ | **reportId** | [**string**] | The report identifier | defaults to undefined|
310
+
311
+
312
+ ### Return type
313
+
314
+ **GetCustomReportSchedule200Response**
315
+
316
+ ### Authorization
317
+
318
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
319
+
320
+ ### HTTP request headers
321
+
322
+ - **Content-Type**: Not defined
323
+ - **Accept**: application/json
324
+
325
+
221
326
  ### HTTP response details
222
327
  | Status code | Description | Response headers |
223
328
  |-------------|-------------|------------------|
@@ -450,3 +555,58 @@ const { status, data } = await apiInstance.updateCustomReport(
450
555
 
451
556
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
452
557
 
558
+ # **upsertCustomReportSchedule**
559
+ > UpsertCustomReportSchedule200Response upsertCustomReportSchedule(customReportScheduleInputs)
560
+
561
+ Upsert Custom Report Schedule endpoint
562
+
563
+ ### Example
564
+
565
+ ```typescript
566
+ import {
567
+ ReportsApi,
568
+ Configuration,
569
+ CustomReportScheduleInputs
570
+ } from '@connectedxm/admin-sdk';
571
+
572
+ const configuration = new Configuration();
573
+ const apiInstance = new ReportsApi(configuration);
574
+
575
+ let reportId: string; //The report identifier (default to undefined)
576
+ let customReportScheduleInputs: CustomReportScheduleInputs; //
577
+
578
+ const { status, data } = await apiInstance.upsertCustomReportSchedule(
579
+ reportId,
580
+ customReportScheduleInputs
581
+ );
582
+ ```
583
+
584
+ ### Parameters
585
+
586
+ |Name | Type | Description | Notes|
587
+ |------------- | ------------- | ------------- | -------------|
588
+ | **customReportScheduleInputs** | **CustomReportScheduleInputs**| | |
589
+ | **reportId** | [**string**] | The report identifier | defaults to undefined|
590
+
591
+
592
+ ### Return type
593
+
594
+ **UpsertCustomReportSchedule200Response**
595
+
596
+ ### Authorization
597
+
598
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
599
+
600
+ ### HTTP request headers
601
+
602
+ - **Content-Type**: application/json
603
+ - **Accept**: application/json
604
+
605
+
606
+ ### HTTP response details
607
+ | Status code | Description | Response headers |
608
+ |-------------|-------------|------------------|
609
+ |**200** | Successful response | - |
610
+
611
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
612
+
@@ -0,0 +1,24 @@
1
+ # UpsertCustomReportSchedule200Response
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **status** | **string** | | [default to undefined]
9
+ **message** | **string** | | [default to undefined]
10
+ **data** | [**CustomReportSchedule**](CustomReportSchedule.md) | | [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { UpsertCustomReportSchedule200Response } from '@connectedxm/admin-sdk';
16
+
17
+ const instance: UpsertCustomReportSchedule200Response = {
18
+ status,
19
+ message,
20
+ data,
21
+ };
22
+ ```
23
+
24
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@connectedxm/admin-sdk",
3
- "version": "6.25.0",
3
+ "version": "6.26.0",
4
4
  "description": "OpenAPI client for @connectedxm/admin-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {