@connectedxm/admin-sdk 13.1.0 → 13.3.0

package/docs/ExportsApi.md

@@ -0,0 +1,123 @@
+# ExportsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getExport**](#getexport) | **GET** /exports/{exportId} | Get a single export|
+|[**getExports**](#getexports) | **GET** /exports | List data exports|
+
+# **getExport**
+> GetExport200Response getExport()
+
+Returns the status, message and download link of a single data export job by its ID; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
+
+### Example
+
+```typescript
+import {
+    ExportsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ExportsApi(configuration);
+
+let exportId: string; //The export identifier (default to undefined)
+
+const { status, data } = await apiInstance.getExport(
+    exportId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **exportId** | [**string**] | The export identifier | defaults to undefined|
+
+
+### Return type
+
+**GetExport200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[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)
+
+# **getExports**
+> GetExports200Response getExports()
+
+Returns a paginated list of the organization\'s data export jobs, newest first, optionally filtered by status and searchable by export type; requires organization-level read access. A report export\'s download link is null unless the caller can read that report.
+
+### Example
+
+```typescript
+import {
+    ExportsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ExportsApi(configuration);
+
+let status: ExportStatus; //Filter by status (optional) (default to undefined)
+let page: number; //Page number (optional) (default to 1)
+let pageSize: number; //Number of items per page (optional) (default to 25)
+let orderBy: string; //Field to order by (optional) (default to undefined)
+let search: string; //Search query (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getExports(
+    status,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **status** | **ExportStatus** | Filter by status | (optional) defaults to undefined|
+| **page** | [**number**] | Page number | (optional) defaults to 1|
+| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
+| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
+| **search** | [**string**] | Search query | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetExports200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[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)
+

package/docs/GetExport200Response.md

@@ -0,0 +1,24 @@
+# GetExport200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**Export**](Export.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetExport200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetExport200Response = {
+    status,
+    message,
+    data,
+};
+```
+
+[[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/docs/GetExports200Response.md

@@ -0,0 +1,26 @@
+# GetExports200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**Array<Export>**](Export.md) |  | [default to undefined]
+**count** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetExports200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetExports200Response = {
+    status,
+    message,
+    data,
+    count,
+};
+```
+
+[[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/docs/GetReportExport200Response.md

@@ -0,0 +1,24 @@
+# GetReportExport200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**ReportExport**](ReportExport.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetReportExport200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetReportExport200Response = {
+    status,
+    message,
+    data,
+};
+```
+
+[[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/docs/ReportExport.md

@@ -0,0 +1,32 @@
+# ReportExport
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**status** | [**ExportStatus**](ExportStatus.md) |  | [default to undefined]
+**standard** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**downloadUrl** | **string** |  | [default to undefined]
+**expiration** | **string** |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ReportExport } from '@connectedxm/admin-sdk';
+
+const instance: ReportExport = {
+    id,
+    status,
+    standard,
+    message,
+    downloadUrl,
+    expiration,
+    createdAt,
+};
+```
+
+[[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/docs/ReportsApi.md

@@ -7,11 +7,13 @@ All URIs are relative to *https://admin-api.connected.dev*
 |[**createCustomReport**](#createcustomreport) | **POST** /reports/{standard} | Create a custom report from a standard report|
 |[**deleteCustomReport**](#deletecustomreport) | **DELETE** /reports/custom/{reportId} | Delete a custom report|
 |[**deleteCustomReportSchedule**](#deletecustomreportschedule) | **DELETE** /reports/custom/{reportId}/schedule | Delete a custom report\'s schedule|
+|[**downloadReport**](#downloadreport) | **POST** /reports/{standard}/download | Build a standard report as a downloadable CSV|
 |[**exportCustomReport**](#exportcustomreport) | **POST** /reports/custom/{reportId}/export | Export a custom report|
 |[**getCustomReport**](#getcustomreport) | **GET** /reports/custom/{reportId} | Get a custom report\'s configuration|
 |[**getCustomReportSchedule**](#getcustomreportschedule) | **GET** /reports/custom/{reportId}/schedule | Get a custom report\'s send schedule|
 |[**getCustomReports**](#getcustomreports) | **GET** /reports/custom | List an organization\'s custom reports|
 |[**getReport**](#getreport) | **GET** /reports/{standard} | Run a standard report and fetch all its rows|
+|[**getReportExport**](#getreportexport) | **GET** /reports/exports/{exportId} | Get the status of a report download|
 |[**getReports**](#getreports) | **GET** /reports | List available standard reports|
 |[**updateCustomReport**](#updatecustomreport) | **PUT** /reports/custom/{reportId} | Update a custom report|
 |[**upsertCustomReportSchedule**](#upsertcustomreportschedule) | **POST** /reports/custom/{reportId}/schedule | Create or update a custom report\'s schedule|
@@ -166,6 +168,61 @@ const { status, data } = await apiInstance.deleteCustomReportSchedule(
  - **Accept**: application/json
 
 
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[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)
+
+# **downloadReport**
+> DownloadReport200Response downloadReport(reportFilters)
+
+Starts an asynchronous server-side build of every row and column of a standard report and returns a pending export; poll the export by ID until it resolves with a signed CSV download link valid for 24 hours. Requires read permission on the reports resource plus the domain permissions declared by the standard report.
+
+### Example
+
+```typescript
+import {
+    ReportsApi,
+    Configuration,
+    ReportFilters
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ReportsApi(configuration);
+
+let standard: string; //The standard identifier (default to undefined)
+let reportFilters: ReportFilters; //
+
+const { status, data } = await apiInstance.downloadReport(
+    standard,
+    reportFilters
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **reportFilters** | **ReportFilters**|  | |
+| **standard** | [**string**] | The standard identifier | defaults to undefined|
+
+
+### Return type
+
+**DownloadReport200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
@@ -500,6 +557,57 @@ const { status, data } = await apiInstance.getReport(
  - **Accept**: application/json
 
 
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[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)
+
+# **getReportExport**
+> GetReportExport200Response getReportExport()
+
+Retrieves a report download started with DownloadReport: its status (pending, resolved or failed), the signed CSV download link and its expiration once resolved, or the reason it failed. Requires read permission on the reports resource plus the domain permissions declared by the standard report.
+
+### Example
+
+```typescript
+import {
+    ReportsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ReportsApi(configuration);
+
+let exportId: string; //The export identifier (default to undefined)
+
+const { status, data } = await apiInstance.getReportExport(
+    exportId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **exportId** | [**string**] | The export identifier | defaults to undefined|
+
+
+### Return type
+
+**GetReportExport200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@connectedxm/admin-sdk",
-  "version": "13.1.0",
+  "version": "13.3.0",
   "description": "OpenAPI client for @connectedxm/admin-sdk",
   "author": "OpenAPI-Generator Contributors",
   "repository": {