Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
336 changes: 334 additions & 2 deletions gooddata-api-client/.openapi-generator/FILES

Large diffs are not rendered by default.

241 changes: 240 additions & 1 deletion gooddata-api-client/README.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# AbsoluteGranularityDateFilter

An absolute date range filter defined at a specific granularity. The 'from'/'to' literals must match the format of the chosen granularity (e.g. '2020' for YEAR, '2012-05' for MONTH, '2012-3' for QUARTER, '1996-01' for WEEK, '2010-10-30' for DAY, or a plain ordinal like '6' for periodical granularities such as MONTH_OF_YEAR). At least one of 'from'/'to' must be provided; specifying only one yields an open-ended range.
An absolute date range filter defined at a specific granularity. The 'from'/'to' literals must match the format of the chosen granularity (e.g. '2020' for YEAR, '2012-05' for MONTH, '2012-3' for QUARTER, '1996-01' for WEEK, '2010-10-30' for DAY, '2010-10-30 13' for HOUR, '2010-10-30 13:30' for MINUTE, '2010-10-30 13:30:45' for SECOND, or a plain ordinal like '6' for periodical granularities such as MONTH_OF_YEAR). At least one of 'from'/'to' must be provided; specifying only one yields an open-ended range.

## Properties
Name | Type | Description | Notes
Expand Down
16 changes: 16 additions & 0 deletions gooddata-api-client/docs/AbsolutePublisherDocumentPeriod.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# AbsolutePublisherDocumentPeriod

A period between two dates.

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**_from** | **date** | First day of the period, inclusive. |
**to** | **date** | Last day of the period, inclusive. |
**type** | **str** | | defaults to "absolute"
**granularity** | **str** | Date granularity of the period. | defaults to "GDC.time.date"
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# AbsolutePublisherDocumentPeriodAllOf


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**_from** | **date** | First day of the period, inclusive. | [optional]
**granularity** | **str** | Date granularity of the period. | [optional] if omitted the server will use the default value of "GDC.time.date"
**to** | **date** | Last day of the period, inclusive. | [optional]
**type** | **str** | Type of the period. | [optional] if omitted the server will use the default value of "absolute"
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


1,166 changes: 1,034 additions & 132 deletions gooddata-api-client/docs/ActionsApi.md

Large diffs are not rendered by default.

370 changes: 370 additions & 0 deletions gooddata-api-client/docs/AnalyticsModelApi.md

Large diffs are not rendered by default.

13 changes: 13 additions & 0 deletions gooddata-api-client/docs/AnalyzeSavRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# AnalyzeSavRequest

Bulk SPSS (.sav) file analysis request.

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**analyze_requests** | [**[AnalyzeSavRequestItem]**](AnalyzeSavRequestItem.md) | List of individual SPSS file analysis requests. |
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


14 changes: 14 additions & 0 deletions gooddata-api-client/docs/AnalyzeSavRequestItem.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# AnalyzeSavRequestItem

SPSS (.sav) file analysis request.

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**location** | **str** | Location of the SPSS file to analyze. |
**config** | [**AnalyzeSavRequestItemConfig**](AnalyzeSavRequestItemConfig.md) | | [optional]
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


13 changes: 13 additions & 0 deletions gooddata-api-client/docs/AnalyzeSavRequestItemConfig.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# AnalyzeSavRequestItemConfig

SPSS (.sav) file analysis request config.

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**result_rows** | **int** | Number of rows to return as the preview of the file. The default is 100, the maximum is 1000. | [optional]
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


15 changes: 15 additions & 0 deletions gooddata-api-client/docs/AnalyzeSavResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# AnalyzeSavResponse

Describes the results of an analysis of a single SPSS (.sav) file.

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**columns** | [**[AnalyzeSavResponseColumn]**](AnalyzeSavResponseColumn.md) | List of column metadata. |
**location** | **str** | Location of the analyzed file in the source data source. |
**preview_data** | **[[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]]** | Preview of the first N rows of the file. |
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


16 changes: 16 additions & 0 deletions gooddata-api-client/docs/AnalyzeSavResponseColumn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# AnalyzeSavResponseColumn

Describes a column of an SPSS file.

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Name of the column as specified in the file. |
**type** | **str** | Type of the column (e.g. string, float64, date32). |
**label** | **str** | Label of the column, in a survey file usually the question text. Null if there is none. | [optional]
**value_labels** | [**[AnalyzeSavResponseValueLabel]**](AnalyzeSavResponseValueLabel.md) | Labels of the column values in file order. Null if there are none. | [optional]
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


14 changes: 14 additions & 0 deletions gooddata-api-client/docs/AnalyzeSavResponseValueLabel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# AnalyzeSavResponseValueLabel

Label of one value of an SPSS column.

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**label** | **str** | The label of the value, in a survey file usually the answer text. |
**value** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | The value: a number in a numeric column, a string in a string column. |
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


2 changes: 2 additions & 0 deletions gooddata-api-client/docs/AttributeHeaderAttributeHeader.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,11 @@ Name | Type | Description | Notes
**label_name** | **str** | Label name. |
**local_identifier** | **str** | Local identifier of the attribute this header relates to. |
**primary_label** | [**RestApiIdentifier**](RestApiIdentifier.md) | |
**data_type** | **str** | Data type of the attribute values, only filled for computed attributes. | [optional]
**format** | [**AttributeFormat**](AttributeFormat.md) | | [optional]
**geo_area_config** | [**GeoAreaConfig**](GeoAreaConfig.md) | | [optional]
**granularity** | **str** | Date granularity of the attribute, only filled for date attributes. | [optional]
**number_format** | **str** | Format to be used to format the attribute values, the same kind of format string as the measure format. Only filled for computed attributes with a format. | [optional]
**value_type** | **str** | Attribute value type. | [optional]
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

Expand Down
3 changes: 3 additions & 0 deletions gooddata-api-client/docs/DataSourceControllerApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ with gooddata_api_client.ApiClient() as api_client:
client_secret="client_secret_example",
date_time_semantics="LOCAL",
disable_statistics=True,
ignore_jwt_aud=True,
name="name_example",
parameters=[
JsonApiDataSourceInAttributesParametersInner(
Expand Down Expand Up @@ -390,6 +391,7 @@ with gooddata_api_client.ApiClient() as api_client:
client_secret="client_secret_example",
date_time_semantics="LOCAL",
disable_statistics=True,
ignore_jwt_aud=True,
name="name_example",
parameters=[
JsonApiDataSourceInAttributesParametersInner(
Expand Down Expand Up @@ -501,6 +503,7 @@ with gooddata_api_client.ApiClient() as api_client:
client_secret="client_secret_example",
date_time_semantics="LOCAL",
disable_statistics=True,
ignore_jwt_aud=True,
name="name_example",
parameters=[
JsonApiDataSourceInAttributesParametersInner(
Expand Down
1 change: 1 addition & 0 deletions gooddata-api-client/docs/DataSourceDeclarativeAPIsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,7 @@ with gooddata_api_client.ApiClient() as api_client:
],
disable_statistics=True,
id="pg_local_docker-demo",
ignore_jwt_aud=True,
name="postgres demo",
parameters=[
Parameter(
Expand Down
3 changes: 3 additions & 0 deletions gooddata-api-client/docs/DataSourceEntityAPIsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ with gooddata_api_client.ApiClient() as api_client:
client_secret="client_secret_example",
date_time_semantics="LOCAL",
disable_statistics=True,
ignore_jwt_aud=True,
name="name_example",
parameters=[
JsonApiDataSourceInAttributesParametersInner(
Expand Down Expand Up @@ -550,6 +551,7 @@ with gooddata_api_client.ApiClient() as api_client:
client_secret="client_secret_example",
date_time_semantics="LOCAL",
disable_statistics=True,
ignore_jwt_aud=True,
name="name_example",
parameters=[
JsonApiDataSourceInAttributesParametersInner(
Expand Down Expand Up @@ -661,6 +663,7 @@ with gooddata_api_client.ApiClient() as api_client:
client_secret="client_secret_example",
date_time_semantics="LOCAL",
disable_statistics=True,
ignore_jwt_aud=True,
name="name_example",
parameters=[
JsonApiDataSourceInAttributesParametersInner(
Expand Down
78 changes: 78 additions & 0 deletions gooddata-api-client/docs/DataSourceFilesAnalysisApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ All URIs are relative to *http://localhost*
Method | HTTP request | Description
------------- | ------------- | -------------
[**analyze_csv**](DataSourceFilesAnalysisApi.md#analyze_csv) | **POST** /api/v1/actions/fileStorage/staging/analyzeCsv | Analyze CSV
[**analyze_sav**](DataSourceFilesAnalysisApi.md#analyze_sav) | **POST** /api/v1/actions/fileStorage/staging/analyzeSav | Analyze SPSS files


# **analyze_csv**
Expand Down Expand Up @@ -89,3 +90,80 @@ No authorization required

[[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)

# **analyze_sav**
> [AnalyzeSavResponse] analyze_sav(analyze_sav_request)

Analyze SPSS files

Reads the columns, their labels and the first rows of the SPSS (.sav) files at the given locations.

### Example


```python
import time
import gooddata_api_client
from gooddata_api_client.api import data_source_files_analysis_api
from gooddata_api_client.model.analyze_sav_response import AnalyzeSavResponse
from gooddata_api_client.model.analyze_sav_request import AnalyzeSavRequest
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
host = "http://localhost"
)


# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient() as api_client:
# Create an instance of the API class
api_instance = data_source_files_analysis_api.DataSourceFilesAnalysisApi(api_client)
analyze_sav_request = AnalyzeSavRequest(
analyze_requests=[
AnalyzeSavRequestItem(
config=AnalyzeSavRequestItemConfig(
result_rows=1,
),
location="location_example",
),
],
) # AnalyzeSavRequest |

# example passing only required values which don't have defaults set
try:
# Analyze SPSS files
api_response = api_instance.analyze_sav(analyze_sav_request)
pprint(api_response)
except gooddata_api_client.ApiException as e:
print("Exception when calling DataSourceFilesAnalysisApi->analyze_sav: %s\n" % e)
```


### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**analyze_sav_request** | [**AnalyzeSavRequest**](AnalyzeSavRequest.md)| |

### Return type

[**[AnalyzeSavResponse]**](AnalyzeSavResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json


### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful analysis. | - |

[[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)

82 changes: 81 additions & 1 deletion gooddata-api-client/docs/DataSourceFilesImportApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,15 @@ All URIs are relative to *http://localhost*
Method | HTTP request | Description
------------- | ------------- | -------------
[**import_csv**](DataSourceFilesImportApi.md#import_csv) | **POST** /api/v1/actions/fileStorage/dataSources/{dataSourceId}/importCsv | Import CSV
[**import_sav**](DataSourceFilesImportApi.md#import_sav) | **POST** /api/v1/actions/fileStorage/dataSources/{dataSourceId}/importSav | Import SPSS files


# **import_csv**
> [ImportCsvResponse] import_csv(data_source_id, import_csv_request)

Import CSV

Import the CSV files at the given locations in the staging area to the final location.
Import the CSV files at the given locations in the staging area to the final location. A table that holds an SPSS file cannot take a CSV file.

### Example

Expand Down Expand Up @@ -141,3 +142,82 @@ No authorization required

[[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)

# **import_sav**
> [ImportSavResponse] import_sav(data_source_id, import_sav_request)

Import SPSS files

Import the SPSS (.sav) files at the given locations in the staging area to the final location. A table that holds a CSV file cannot take an SPSS file.

### Example


```python
import time
import gooddata_api_client
from gooddata_api_client.api import data_source_files_import_api
from gooddata_api_client.model.import_sav_response import ImportSavResponse
from gooddata_api_client.model.import_sav_request import ImportSavRequest
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
host = "http://localhost"
)


# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient() as api_client:
# Create an instance of the API class
api_instance = data_source_files_import_api.DataSourceFilesImportApi(api_client)
data_source_id = "dataSourceId_example" # str |
import_sav_request = ImportSavRequest(
tables=[
ImportSavRequestTable(
name="name_example",
source=ImportSavRequestTableSource(
location="location_example",
),
),
],
) # ImportSavRequest |

# example passing only required values which don't have defaults set
try:
# Import SPSS files
api_response = api_instance.import_sav(data_source_id, import_sav_request)
pprint(api_response)
except gooddata_api_client.ApiException as e:
print("Exception when calling DataSourceFilesImportApi->import_sav: %s\n" % e)
```


### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**data_source_id** | **str**| |
**import_sav_request** | [**ImportSavRequest**](ImportSavRequest.md)| |

### Return type

[**[ImportSavResponse]**](ImportSavResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json


### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful import. | - |

[[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)

Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Name | Type | Description | Notes
**description** | **str** | Analytical dashboard description. | [optional]
**modified_at** | **str, none_type** | Time of the last entity modification. | [optional]
**modified_by** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional]
**permissions** | [**[DeclarativeAnalyticalDashboardPermissionsInner]**](DeclarativeAnalyticalDashboardPermissionsInner.md) | A list of permissions. | [optional]
**permissions** | [**[DeclarativeAnalyticalDashboardPermissionsInner]**](DeclarativeAnalyticalDashboardPermissionsInner.md) | A list of permissions. A PUT without this property removes all existing permissions. | [optional]
**summary** | **str** | AI-generated summary of the dashboard content | [optional]
**tags** | **[str]** | A list of tags. | [optional]
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
Expand Down
Loading
Loading