@gooddata/api-client-tiger 10.1.0-alpha.3 → 10.1.0-alpha.4

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 (41) hide show
  1. package/esm/__version.d.ts +1 -1
  2. package/esm/__version.js +1 -1
  3. package/esm/api-client-tiger.d.ts +2255 -965
  4. package/esm/generated/afm-rest-api/api.d.ts +440 -2
  5. package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
  6. package/esm/generated/afm-rest-api/api.js +363 -0
  7. package/esm/generated/afm-rest-api/api.js.map +1 -1
  8. package/esm/generated/afm-rest-api/openapi-spec.json +828 -625
  9. package/esm/generated/export-json-api/api.d.ts +89 -89
  10. package/esm/generated/export-json-api/api.d.ts.map +1 -1
  11. package/esm/generated/export-json-api/api.js +42 -42
  12. package/esm/generated/export-json-api/api.js.map +1 -1
  13. package/esm/generated/export-json-api/openapi-spec.json +5 -5
  14. package/esm/generated/metadata-json-api/api.d.ts +1508 -901
  15. package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
  16. package/esm/generated/metadata-json-api/api.js +647 -18
  17. package/esm/generated/metadata-json-api/api.js.map +1 -1
  18. package/esm/generated/metadata-json-api/openapi-spec.json +4876 -4845
  19. package/esm/generated/result-json-api/api.d.ts +157 -0
  20. package/esm/generated/result-json-api/api.d.ts.map +1 -1
  21. package/esm/generated/result-json-api/api.js +139 -0
  22. package/esm/generated/result-json-api/api.js.map +1 -1
  23. package/esm/generated/result-json-api/openapi-spec.json +73 -0
  24. package/esm/generated/scan-json-api/api.d.ts +343 -0
  25. package/esm/generated/scan-json-api/api.d.ts.map +1 -1
  26. package/esm/generated/scan-json-api/api.js +102 -0
  27. package/esm/generated/scan-json-api/api.js.map +1 -1
  28. package/esm/generated/scan-json-api/openapi-spec.json +257 -0
  29. package/esm/index.d.ts +3 -3
  30. package/esm/index.d.ts.map +1 -1
  31. package/esm/index.js +3 -2
  32. package/esm/index.js.map +1 -1
  33. package/esm/metadataUtilities.d.ts +2 -2
  34. package/esm/metadataUtilities.d.ts.map +1 -1
  35. package/esm/metadataUtilities.js +1 -1
  36. package/esm/metadataUtilities.js.map +1 -1
  37. package/esm/organizationUtilities.d.ts +2 -2
  38. package/esm/organizationUtilities.d.ts.map +1 -1
  39. package/esm/organizationUtilities.js +1 -1
  40. package/esm/organizationUtilities.js.map +1 -1
  41. package/package.json +3 -3
@@ -24,6 +24,7 @@ export const ApiEntitlementNameEnum = {
24
24
  WHITE_LABELING: "WhiteLabeling",
25
25
  WORKSPACE_COUNT: "WorkspaceCount",
26
26
  USER_TELEMETRY_DISABLED: "UserTelemetryDisabled",
27
+ EXPERIMENTAL_FEATURES: "ExperimentalFeatures",
27
28
  };
28
29
  export const AssigneeIdentifierTypeEnum = {
29
30
  USER: "user",
@@ -285,6 +286,7 @@ export const EntitlementsRequestEntitlementsNameEnum = {
285
286
  WHITE_LABELING: "WhiteLabeling",
286
287
  WORKSPACE_COUNT: "WorkspaceCount",
287
288
  USER_TELEMETRY_DISABLED: "UserTelemetryDisabled",
289
+ EXPERIMENTAL_FEATURES: "ExperimentalFeatures",
288
290
  };
289
291
  export const EntityIdentifierTypeEnum = {
290
292
  ANALYTICAL_DASHBOARD: "analyticalDashboard",
@@ -511,6 +513,10 @@ export const JsonApiDataSourceIdentifierOutAttributesTypeEnum = {
511
513
  MARIADB: "MARIADB",
512
514
  ORACLE: "ORACLE",
513
515
  };
516
+ export const JsonApiDataSourceIdentifierOutMetaPermissionsEnum = {
517
+ MANAGE: "MANAGE",
518
+ USE: "USE",
519
+ };
514
520
  export const JsonApiDataSourceIdentifierOutWithLinksTypeEnum = {
515
521
  DATA_SOURCE_IDENTIFIER: "dataSourceIdentifier",
516
522
  };
@@ -570,10 +576,6 @@ export const JsonApiDataSourceOutAttributesCacheStrategyEnum = {
570
576
  ALWAYS: "ALWAYS",
571
577
  NEVER: "NEVER",
572
578
  };
573
- export const JsonApiDataSourceOutMetaPermissionsEnum = {
574
- MANAGE: "MANAGE",
575
- USE: "USE",
576
- };
577
579
  export const JsonApiDataSourceOutWithLinksTypeEnum = {
578
580
  DATA_SOURCE: "dataSource",
579
581
  };
@@ -785,6 +787,20 @@ export const JsonApiOrganizationSettingInTypeEnum = {
785
787
  export const JsonApiOrganizationSettingOutTypeEnum = {
786
788
  ORGANIZATION_SETTING: "organizationSetting",
787
789
  };
790
+ export const JsonApiOrganizationSettingOutAttributesTypeEnum = {
791
+ TIMEZONE: "TIMEZONE",
792
+ ACTIVE_THEME: "ACTIVE_THEME",
793
+ ACTIVE_COLOR_PALETTE: "ACTIVE_COLOR_PALETTE",
794
+ WHITE_LABELING: "WHITE_LABELING",
795
+ LOCALE: "LOCALE",
796
+ METADATA_LOCALE: "METADATA_LOCALE",
797
+ FORMAT_LOCALE: "FORMAT_LOCALE",
798
+ MAPBOX_TOKEN: "MAPBOX_TOKEN",
799
+ WEEK_START: "WEEK_START",
800
+ SHOW_HIDDEN_CATALOG_ITEMS: "SHOW_HIDDEN_CATALOG_ITEMS",
801
+ OPERATOR_OVERRIDES: "OPERATOR_OVERRIDES",
802
+ TIMEZONE_VALIDATION_ENABLED: "TIMEZONE_VALIDATION_ENABLED",
803
+ };
788
804
  export const JsonApiOrganizationSettingOutWithLinksTypeEnum = {
789
805
  ORGANIZATION_SETTING: "organizationSetting",
790
806
  };
@@ -860,20 +876,6 @@ export const JsonApiUserPatchTypeEnum = {
860
876
  export const JsonApiUserSettingInTypeEnum = {
861
877
  USER_SETTING: "userSetting",
862
878
  };
863
- export const JsonApiUserSettingInAttributesTypeEnum = {
864
- TIMEZONE: "TIMEZONE",
865
- ACTIVE_THEME: "ACTIVE_THEME",
866
- ACTIVE_COLOR_PALETTE: "ACTIVE_COLOR_PALETTE",
867
- WHITE_LABELING: "WHITE_LABELING",
868
- LOCALE: "LOCALE",
869
- METADATA_LOCALE: "METADATA_LOCALE",
870
- FORMAT_LOCALE: "FORMAT_LOCALE",
871
- MAPBOX_TOKEN: "MAPBOX_TOKEN",
872
- WEEK_START: "WEEK_START",
873
- SHOW_HIDDEN_CATALOG_ITEMS: "SHOW_HIDDEN_CATALOG_ITEMS",
874
- OPERATOR_OVERRIDES: "OPERATOR_OVERRIDES",
875
- TIMEZONE_VALIDATION_ENABLED: "TIMEZONE_VALIDATION_ENABLED",
876
- };
877
879
  export const JsonApiUserSettingOutTypeEnum = {
878
880
  USER_SETTING: "userSetting",
879
881
  };
@@ -11953,6 +11955,7 @@ export const EntitiesApiAxiosParamCreator = function (configuration) {
11953
11955
  },
11954
11956
  /**
11955
11957
  *
11958
+ * @summary Delete an Export Definition
11956
11959
  * @param {string} workspaceId
11957
11960
  * @param {string} objectId
11958
11961
  * @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
@@ -13214,6 +13217,7 @@ export const EntitiesApiAxiosParamCreator = function (configuration) {
13214
13217
  },
13215
13218
  /**
13216
13219
  *
13220
+ * @summary Get all Export Definitions
13217
13221
  * @param {string} workspaceId
13218
13222
  * @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
13219
13223
  * @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
@@ -14893,6 +14897,7 @@ export const EntitiesApiAxiosParamCreator = function (configuration) {
14893
14897
  },
14894
14898
  /**
14895
14899
  *
14900
+ * @summary Get an Export Definition
14896
14901
  * @param {string} workspaceId
14897
14902
  * @param {string} objectId
14898
14903
  * @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
@@ -16202,6 +16207,7 @@ export const EntitiesApiAxiosParamCreator = function (configuration) {
16202
16207
  },
16203
16208
  /**
16204
16209
  *
16210
+ * @summary Patch an Export Definition
16205
16211
  * @param {string} workspaceId
16206
16212
  * @param {string} objectId
16207
16213
  * @param {JsonApiExportDefinitionPatchDocument} jsonApiExportDefinitionPatchDocument
@@ -17376,6 +17382,7 @@ export const EntitiesApiAxiosParamCreator = function (configuration) {
17376
17382
  },
17377
17383
  /**
17378
17384
  *
17385
+ * @summary Put an Export Definition
17379
17386
  * @param {string} workspaceId
17380
17387
  * @param {string} objectId
17381
17388
  * @param {JsonApiExportDefinitionInDocument} jsonApiExportDefinitionInDocument
@@ -18599,6 +18606,7 @@ export const EntitiesApiFp = function (configuration) {
18599
18606
  },
18600
18607
  /**
18601
18608
  *
18609
+ * @summary Delete an Export Definition
18602
18610
  * @param {string} workspaceId
18603
18611
  * @param {string} objectId
18604
18612
  * @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
@@ -18991,6 +18999,7 @@ export const EntitiesApiFp = function (configuration) {
18991
18999
  },
18992
19000
  /**
18993
19001
  *
19002
+ * @summary Get all Export Definitions
18994
19003
  * @param {string} workspaceId
18995
19004
  * @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
18996
19005
  * @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
@@ -19505,6 +19514,7 @@ export const EntitiesApiFp = function (configuration) {
19505
19514
  },
19506
19515
  /**
19507
19516
  *
19517
+ * @summary Get an Export Definition
19508
19518
  * @param {string} workspaceId
19509
19519
  * @param {string} objectId
19510
19520
  * @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
@@ -19899,6 +19909,7 @@ export const EntitiesApiFp = function (configuration) {
19899
19909
  },
19900
19910
  /**
19901
19911
  *
19912
+ * @summary Patch an Export Definition
19902
19913
  * @param {string} workspaceId
19903
19914
  * @param {string} objectId
19904
19915
  * @param {JsonApiExportDefinitionPatchDocument} jsonApiExportDefinitionPatchDocument
@@ -20223,6 +20234,7 @@ export const EntitiesApiFp = function (configuration) {
20223
20234
  },
20224
20235
  /**
20225
20236
  *
20237
+ * @summary Put an Export Definition
20226
20238
  * @param {string} workspaceId
20227
20239
  * @param {string} objectId
20228
20240
  * @param {JsonApiExportDefinitionInDocument} jsonApiExportDefinitionInDocument
@@ -20831,6 +20843,7 @@ export const EntitiesApiFactory = function (configuration, basePath, axios) {
20831
20843
  },
20832
20844
  /**
20833
20845
  *
20846
+ * @summary Delete an Export Definition
20834
20847
  * @param {EntitiesApiDeleteEntityExportDefinitionsRequest} requestParameters Request parameters.
20835
20848
  * @param {*} [options] Override http request option.
20836
20849
  * @throws {RequiredError}
@@ -21154,6 +21167,7 @@ export const EntitiesApiFactory = function (configuration, basePath, axios) {
21154
21167
  },
21155
21168
  /**
21156
21169
  *
21170
+ * @summary Get all Export Definitions
21157
21171
  * @param {EntitiesApiGetAllEntitiesExportDefinitionsRequest} requestParameters Request parameters.
21158
21172
  * @param {*} [options] Override http request option.
21159
21173
  * @throws {RequiredError}
@@ -21543,6 +21557,7 @@ export const EntitiesApiFactory = function (configuration, basePath, axios) {
21543
21557
  },
21544
21558
  /**
21545
21559
  *
21560
+ * @summary Get an Export Definition
21546
21561
  * @param {EntitiesApiGetEntityExportDefinitionsRequest} requestParameters Request parameters.
21547
21562
  * @param {*} [options] Override http request option.
21548
21563
  * @throws {RequiredError}
@@ -21878,6 +21893,7 @@ export const EntitiesApiFactory = function (configuration, basePath, axios) {
21878
21893
  },
21879
21894
  /**
21880
21895
  *
21896
+ * @summary Patch an Export Definition
21881
21897
  * @param {EntitiesApiPatchEntityExportDefinitionsRequest} requestParameters Request parameters.
21882
21898
  * @param {*} [options] Override http request option.
21883
21899
  * @throws {RequiredError}
@@ -22153,6 +22169,7 @@ export const EntitiesApiFactory = function (configuration, basePath, axios) {
22153
22169
  },
22154
22170
  /**
22155
22171
  *
22172
+ * @summary Put an Export Definition
22156
22173
  * @param {EntitiesApiUpdateEntityExportDefinitionsRequest} requestParameters Request parameters.
22157
22174
  * @param {*} [options] Override http request option.
22158
22175
  * @throws {RequiredError}
@@ -22756,6 +22773,7 @@ export class EntitiesApi extends BaseAPI {
22756
22773
  }
22757
22774
  /**
22758
22775
  *
22776
+ * @summary Delete an Export Definition
22759
22777
  * @param {EntitiesApiDeleteEntityExportDefinitionsRequest} requestParameters Request parameters.
22760
22778
  * @param {*} [options] Override http request option.
22761
22779
  * @throws {RequiredError}
@@ -23106,6 +23124,7 @@ export class EntitiesApi extends BaseAPI {
23106
23124
  }
23107
23125
  /**
23108
23126
  *
23127
+ * @summary Get all Export Definitions
23109
23128
  * @param {EntitiesApiGetAllEntitiesExportDefinitionsRequest} requestParameters Request parameters.
23110
23129
  * @param {*} [options] Override http request option.
23111
23130
  * @throws {RequiredError}
@@ -23532,6 +23551,7 @@ export class EntitiesApi extends BaseAPI {
23532
23551
  }
23533
23552
  /**
23534
23553
  *
23554
+ * @summary Get an Export Definition
23535
23555
  * @param {EntitiesApiGetEntityExportDefinitionsRequest} requestParameters Request parameters.
23536
23556
  * @param {*} [options] Override http request option.
23537
23557
  * @throws {RequiredError}
@@ -23895,6 +23915,7 @@ export class EntitiesApi extends BaseAPI {
23895
23915
  }
23896
23916
  /**
23897
23917
  *
23918
+ * @summary Patch an Export Definition
23898
23919
  * @param {EntitiesApiPatchEntityExportDefinitionsRequest} requestParameters Request parameters.
23899
23920
  * @param {*} [options] Override http request option.
23900
23921
  * @throws {RequiredError}
@@ -24193,6 +24214,7 @@ export class EntitiesApi extends BaseAPI {
24193
24214
  }
24194
24215
  /**
24195
24216
  *
24217
+ * @summary Put an Export Definition
24196
24218
  * @param {EntitiesApiUpdateEntityExportDefinitionsRequest} requestParameters Request parameters.
24197
24219
  * @param {*} [options] Override http request option.
24198
24220
  * @throws {RequiredError}
@@ -24729,6 +24751,593 @@ export class EntitlementApi extends BaseAPI {
24729
24751
  .then((request) => request(this.axios, this.basePath));
24730
24752
  }
24731
24753
  }
24754
+ /**
24755
+ * ExportDefinitionsApi - axios parameter creator
24756
+ * @export
24757
+ */
24758
+ export const ExportDefinitionsApiAxiosParamCreator = function (configuration) {
24759
+ return {
24760
+ /**
24761
+ *
24762
+ * @summary Post Export Definitions
24763
+ * @param {string} workspaceId
24764
+ * @param {JsonApiExportDefinitionPostOptionalIdDocument} jsonApiExportDefinitionPostOptionalIdDocument
24765
+ * @param {Array<'visualizationObjects' | 'userIdentifiers' | 'visualizationObject' | 'createdBy' | 'modifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include&#x3D;entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \&quot;ALL\&quot; is present, all possible includes are used (include&#x3D;ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
24766
+ * @param {*} [options] Override http request option.
24767
+ * @throws {RequiredError}
24768
+ */
24769
+ createEntityExportDefinitions: async (workspaceId, jsonApiExportDefinitionPostOptionalIdDocument, include, options = {}) => {
24770
+ // verify required parameter 'workspaceId' is not null or undefined
24771
+ assertParamExists("createEntityExportDefinitions", "workspaceId", workspaceId);
24772
+ // verify required parameter 'jsonApiExportDefinitionPostOptionalIdDocument' is not null or undefined
24773
+ assertParamExists("createEntityExportDefinitions", "jsonApiExportDefinitionPostOptionalIdDocument", jsonApiExportDefinitionPostOptionalIdDocument);
24774
+ const localVarPath = `/api/v1/entities/workspaces/{workspaceId}/exportDefinitions`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
24775
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
24776
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
24777
+ let baseOptions;
24778
+ if (configuration) {
24779
+ baseOptions = configuration.baseOptions;
24780
+ }
24781
+ const localVarRequestOptions = { method: "POST", ...baseOptions, ...options };
24782
+ const localVarHeaderParameter = {};
24783
+ const localVarQueryParameter = {};
24784
+ if (include) {
24785
+ localVarQueryParameter["include"] = include.join(COLLECTION_FORMATS.csv);
24786
+ }
24787
+ localVarHeaderParameter["Content-Type"] = "application/vnd.gooddata.api+json";
24788
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
24789
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
24790
+ localVarRequestOptions.headers = {
24791
+ ...localVarHeaderParameter,
24792
+ ...headersFromBaseOptions,
24793
+ ...options.headers,
24794
+ };
24795
+ const needsSerialization = typeof jsonApiExportDefinitionPostOptionalIdDocument !== "string" ||
24796
+ localVarRequestOptions.headers["Content-Type"] === "application/json";
24797
+ localVarRequestOptions.data = needsSerialization
24798
+ ? JSON.stringify(jsonApiExportDefinitionPostOptionalIdDocument !== undefined
24799
+ ? jsonApiExportDefinitionPostOptionalIdDocument
24800
+ : {})
24801
+ : jsonApiExportDefinitionPostOptionalIdDocument || "";
24802
+ return {
24803
+ url: toPathString(localVarUrlObj),
24804
+ options: localVarRequestOptions,
24805
+ };
24806
+ },
24807
+ /**
24808
+ *
24809
+ * @summary Delete an Export Definition
24810
+ * @param {string} workspaceId
24811
+ * @param {string} objectId
24812
+ * @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title&#x3D;&#x3D;\&#39;Some Title\&#39;;description&#x3D;&#x3D;\&#39;desc\&#39;). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty&#x3D;&#x3D;\&#39;Value 123\&#39;).
24813
+ * @param {*} [options] Override http request option.
24814
+ * @throws {RequiredError}
24815
+ */
24816
+ deleteEntityExportDefinitions: async (workspaceId, objectId, filter, options = {}) => {
24817
+ // verify required parameter 'workspaceId' is not null or undefined
24818
+ assertParamExists("deleteEntityExportDefinitions", "workspaceId", workspaceId);
24819
+ // verify required parameter 'objectId' is not null or undefined
24820
+ assertParamExists("deleteEntityExportDefinitions", "objectId", objectId);
24821
+ const localVarPath = `/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}`
24822
+ .replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
24823
+ .replace(`{${"objectId"}}`, encodeURIComponent(String(objectId)));
24824
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
24825
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
24826
+ let baseOptions;
24827
+ if (configuration) {
24828
+ baseOptions = configuration.baseOptions;
24829
+ }
24830
+ const localVarRequestOptions = { method: "DELETE", ...baseOptions, ...options };
24831
+ const localVarHeaderParameter = {};
24832
+ const localVarQueryParameter = {};
24833
+ if (filter !== undefined) {
24834
+ localVarQueryParameter["filter"] = filter;
24835
+ }
24836
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
24837
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
24838
+ localVarRequestOptions.headers = {
24839
+ ...localVarHeaderParameter,
24840
+ ...headersFromBaseOptions,
24841
+ ...options.headers,
24842
+ };
24843
+ return {
24844
+ url: toPathString(localVarUrlObj),
24845
+ options: localVarRequestOptions,
24846
+ };
24847
+ },
24848
+ /**
24849
+ *
24850
+ * @summary Get all Export Definitions
24851
+ * @param {string} workspaceId
24852
+ * @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
24853
+ * @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title&#x3D;&#x3D;\&#39;Some Title\&#39;;description&#x3D;&#x3D;\&#39;desc\&#39;). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty&#x3D;&#x3D;\&#39;Value 123\&#39;).
24854
+ * @param {Array<'visualizationObjects' | 'userIdentifiers' | 'visualizationObject' | 'createdBy' | 'modifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include&#x3D;entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \&quot;ALL\&quot; is present, all possible includes are used (include&#x3D;ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
24855
+ * @param {number} [page] Zero-based page index (0..N)
24856
+ * @param {number} [size] The size of the page to be returned
24857
+ * @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
24858
+ * @param {boolean} [xGDCVALIDATERELATIONS]
24859
+ * @param {Array<'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
24860
+ * @param {*} [options] Override http request option.
24861
+ * @throws {RequiredError}
24862
+ */
24863
+ getAllEntitiesExportDefinitions: async (workspaceId, origin, filter, include, page, size, sort, xGDCVALIDATERELATIONS, metaInclude, options = {}) => {
24864
+ // verify required parameter 'workspaceId' is not null or undefined
24865
+ assertParamExists("getAllEntitiesExportDefinitions", "workspaceId", workspaceId);
24866
+ const localVarPath = `/api/v1/entities/workspaces/{workspaceId}/exportDefinitions`.replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)));
24867
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
24868
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
24869
+ let baseOptions;
24870
+ if (configuration) {
24871
+ baseOptions = configuration.baseOptions;
24872
+ }
24873
+ const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
24874
+ const localVarHeaderParameter = {};
24875
+ const localVarQueryParameter = {};
24876
+ if (origin !== undefined) {
24877
+ localVarQueryParameter["origin"] = origin;
24878
+ }
24879
+ if (filter !== undefined) {
24880
+ localVarQueryParameter["filter"] = filter;
24881
+ }
24882
+ if (include) {
24883
+ localVarQueryParameter["include"] = include.join(COLLECTION_FORMATS.csv);
24884
+ }
24885
+ if (page !== undefined) {
24886
+ localVarQueryParameter["page"] = page;
24887
+ }
24888
+ if (size !== undefined) {
24889
+ localVarQueryParameter["size"] = size;
24890
+ }
24891
+ if (sort) {
24892
+ localVarQueryParameter["sort"] = sort;
24893
+ }
24894
+ if (metaInclude) {
24895
+ localVarQueryParameter["metaInclude"] = Array.from(metaInclude).join(COLLECTION_FORMATS.csv);
24896
+ }
24897
+ if (xGDCVALIDATERELATIONS !== undefined && xGDCVALIDATERELATIONS !== null) {
24898
+ localVarHeaderParameter["X-GDC-VALIDATE-RELATIONS"] = String(JSON.stringify(xGDCVALIDATERELATIONS));
24899
+ }
24900
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
24901
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
24902
+ localVarRequestOptions.headers = {
24903
+ ...localVarHeaderParameter,
24904
+ ...headersFromBaseOptions,
24905
+ ...options.headers,
24906
+ };
24907
+ return {
24908
+ url: toPathString(localVarUrlObj),
24909
+ options: localVarRequestOptions,
24910
+ };
24911
+ },
24912
+ /**
24913
+ *
24914
+ * @summary Get an Export Definition
24915
+ * @param {string} workspaceId
24916
+ * @param {string} objectId
24917
+ * @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title&#x3D;&#x3D;\&#39;Some Title\&#39;;description&#x3D;&#x3D;\&#39;desc\&#39;). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty&#x3D;&#x3D;\&#39;Value 123\&#39;).
24918
+ * @param {Array<'visualizationObjects' | 'userIdentifiers' | 'visualizationObject' | 'createdBy' | 'modifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include&#x3D;entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \&quot;ALL\&quot; is present, all possible includes are used (include&#x3D;ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
24919
+ * @param {boolean} [xGDCVALIDATERELATIONS]
24920
+ * @param {*} [options] Override http request option.
24921
+ * @throws {RequiredError}
24922
+ */
24923
+ getEntityExportDefinitions: async (workspaceId, objectId, filter, include, xGDCVALIDATERELATIONS, options = {}) => {
24924
+ // verify required parameter 'workspaceId' is not null or undefined
24925
+ assertParamExists("getEntityExportDefinitions", "workspaceId", workspaceId);
24926
+ // verify required parameter 'objectId' is not null or undefined
24927
+ assertParamExists("getEntityExportDefinitions", "objectId", objectId);
24928
+ const localVarPath = `/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}`
24929
+ .replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
24930
+ .replace(`{${"objectId"}}`, encodeURIComponent(String(objectId)));
24931
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
24932
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
24933
+ let baseOptions;
24934
+ if (configuration) {
24935
+ baseOptions = configuration.baseOptions;
24936
+ }
24937
+ const localVarRequestOptions = { method: "GET", ...baseOptions, ...options };
24938
+ const localVarHeaderParameter = {};
24939
+ const localVarQueryParameter = {};
24940
+ if (filter !== undefined) {
24941
+ localVarQueryParameter["filter"] = filter;
24942
+ }
24943
+ if (include) {
24944
+ localVarQueryParameter["include"] = include.join(COLLECTION_FORMATS.csv);
24945
+ }
24946
+ if (xGDCVALIDATERELATIONS !== undefined && xGDCVALIDATERELATIONS !== null) {
24947
+ localVarHeaderParameter["X-GDC-VALIDATE-RELATIONS"] = String(JSON.stringify(xGDCVALIDATERELATIONS));
24948
+ }
24949
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
24950
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
24951
+ localVarRequestOptions.headers = {
24952
+ ...localVarHeaderParameter,
24953
+ ...headersFromBaseOptions,
24954
+ ...options.headers,
24955
+ };
24956
+ return {
24957
+ url: toPathString(localVarUrlObj),
24958
+ options: localVarRequestOptions,
24959
+ };
24960
+ },
24961
+ /**
24962
+ *
24963
+ * @summary Patch an Export Definition
24964
+ * @param {string} workspaceId
24965
+ * @param {string} objectId
24966
+ * @param {JsonApiExportDefinitionPatchDocument} jsonApiExportDefinitionPatchDocument
24967
+ * @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title&#x3D;&#x3D;\&#39;Some Title\&#39;;description&#x3D;&#x3D;\&#39;desc\&#39;). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty&#x3D;&#x3D;\&#39;Value 123\&#39;).
24968
+ * @param {Array<'visualizationObjects' | 'userIdentifiers' | 'visualizationObject' | 'createdBy' | 'modifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include&#x3D;entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \&quot;ALL\&quot; is present, all possible includes are used (include&#x3D;ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
24969
+ * @param {*} [options] Override http request option.
24970
+ * @throws {RequiredError}
24971
+ */
24972
+ patchEntityExportDefinitions: async (workspaceId, objectId, jsonApiExportDefinitionPatchDocument, filter, include, options = {}) => {
24973
+ // verify required parameter 'workspaceId' is not null or undefined
24974
+ assertParamExists("patchEntityExportDefinitions", "workspaceId", workspaceId);
24975
+ // verify required parameter 'objectId' is not null or undefined
24976
+ assertParamExists("patchEntityExportDefinitions", "objectId", objectId);
24977
+ // verify required parameter 'jsonApiExportDefinitionPatchDocument' is not null or undefined
24978
+ assertParamExists("patchEntityExportDefinitions", "jsonApiExportDefinitionPatchDocument", jsonApiExportDefinitionPatchDocument);
24979
+ const localVarPath = `/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}`
24980
+ .replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
24981
+ .replace(`{${"objectId"}}`, encodeURIComponent(String(objectId)));
24982
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
24983
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
24984
+ let baseOptions;
24985
+ if (configuration) {
24986
+ baseOptions = configuration.baseOptions;
24987
+ }
24988
+ const localVarRequestOptions = { method: "PATCH", ...baseOptions, ...options };
24989
+ const localVarHeaderParameter = {};
24990
+ const localVarQueryParameter = {};
24991
+ if (filter !== undefined) {
24992
+ localVarQueryParameter["filter"] = filter;
24993
+ }
24994
+ if (include) {
24995
+ localVarQueryParameter["include"] = include.join(COLLECTION_FORMATS.csv);
24996
+ }
24997
+ localVarHeaderParameter["Content-Type"] = "application/vnd.gooddata.api+json";
24998
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
24999
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
25000
+ localVarRequestOptions.headers = {
25001
+ ...localVarHeaderParameter,
25002
+ ...headersFromBaseOptions,
25003
+ ...options.headers,
25004
+ };
25005
+ const needsSerialization = typeof jsonApiExportDefinitionPatchDocument !== "string" ||
25006
+ localVarRequestOptions.headers["Content-Type"] === "application/json";
25007
+ localVarRequestOptions.data = needsSerialization
25008
+ ? JSON.stringify(jsonApiExportDefinitionPatchDocument !== undefined
25009
+ ? jsonApiExportDefinitionPatchDocument
25010
+ : {})
25011
+ : jsonApiExportDefinitionPatchDocument || "";
25012
+ return {
25013
+ url: toPathString(localVarUrlObj),
25014
+ options: localVarRequestOptions,
25015
+ };
25016
+ },
25017
+ /**
25018
+ *
25019
+ * @summary Put an Export Definition
25020
+ * @param {string} workspaceId
25021
+ * @param {string} objectId
25022
+ * @param {JsonApiExportDefinitionInDocument} jsonApiExportDefinitionInDocument
25023
+ * @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title&#x3D;&#x3D;\&#39;Some Title\&#39;;description&#x3D;&#x3D;\&#39;desc\&#39;). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty&#x3D;&#x3D;\&#39;Value 123\&#39;).
25024
+ * @param {Array<'visualizationObjects' | 'userIdentifiers' | 'visualizationObject' | 'createdBy' | 'modifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include&#x3D;entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \&quot;ALL\&quot; is present, all possible includes are used (include&#x3D;ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
25025
+ * @param {*} [options] Override http request option.
25026
+ * @throws {RequiredError}
25027
+ */
25028
+ updateEntityExportDefinitions: async (workspaceId, objectId, jsonApiExportDefinitionInDocument, filter, include, options = {}) => {
25029
+ // verify required parameter 'workspaceId' is not null or undefined
25030
+ assertParamExists("updateEntityExportDefinitions", "workspaceId", workspaceId);
25031
+ // verify required parameter 'objectId' is not null or undefined
25032
+ assertParamExists("updateEntityExportDefinitions", "objectId", objectId);
25033
+ // verify required parameter 'jsonApiExportDefinitionInDocument' is not null or undefined
25034
+ assertParamExists("updateEntityExportDefinitions", "jsonApiExportDefinitionInDocument", jsonApiExportDefinitionInDocument);
25035
+ const localVarPath = `/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}`
25036
+ .replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId)))
25037
+ .replace(`{${"objectId"}}`, encodeURIComponent(String(objectId)));
25038
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
25039
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
25040
+ let baseOptions;
25041
+ if (configuration) {
25042
+ baseOptions = configuration.baseOptions;
25043
+ }
25044
+ const localVarRequestOptions = { method: "PUT", ...baseOptions, ...options };
25045
+ const localVarHeaderParameter = {};
25046
+ const localVarQueryParameter = {};
25047
+ if (filter !== undefined) {
25048
+ localVarQueryParameter["filter"] = filter;
25049
+ }
25050
+ if (include) {
25051
+ localVarQueryParameter["include"] = include.join(COLLECTION_FORMATS.csv);
25052
+ }
25053
+ localVarHeaderParameter["Content-Type"] = "application/vnd.gooddata.api+json";
25054
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
25055
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
25056
+ localVarRequestOptions.headers = {
25057
+ ...localVarHeaderParameter,
25058
+ ...headersFromBaseOptions,
25059
+ ...options.headers,
25060
+ };
25061
+ const needsSerialization = typeof jsonApiExportDefinitionInDocument !== "string" ||
25062
+ localVarRequestOptions.headers["Content-Type"] === "application/json";
25063
+ localVarRequestOptions.data = needsSerialization
25064
+ ? JSON.stringify(jsonApiExportDefinitionInDocument !== undefined
25065
+ ? jsonApiExportDefinitionInDocument
25066
+ : {})
25067
+ : jsonApiExportDefinitionInDocument || "";
25068
+ return {
25069
+ url: toPathString(localVarUrlObj),
25070
+ options: localVarRequestOptions,
25071
+ };
25072
+ },
25073
+ };
25074
+ };
25075
+ /**
25076
+ * ExportDefinitionsApi - functional programming interface
25077
+ * @export
25078
+ */
25079
+ export const ExportDefinitionsApiFp = function (configuration) {
25080
+ const localVarAxiosParamCreator = ExportDefinitionsApiAxiosParamCreator(configuration);
25081
+ return {
25082
+ /**
25083
+ *
25084
+ * @summary Post Export Definitions
25085
+ * @param {string} workspaceId
25086
+ * @param {JsonApiExportDefinitionPostOptionalIdDocument} jsonApiExportDefinitionPostOptionalIdDocument
25087
+ * @param {Array<'visualizationObjects' | 'userIdentifiers' | 'visualizationObject' | 'createdBy' | 'modifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include&#x3D;entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \&quot;ALL\&quot; is present, all possible includes are used (include&#x3D;ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
25088
+ * @param {*} [options] Override http request option.
25089
+ * @throws {RequiredError}
25090
+ */
25091
+ async createEntityExportDefinitions(workspaceId, jsonApiExportDefinitionPostOptionalIdDocument, include, options) {
25092
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createEntityExportDefinitions(workspaceId, jsonApiExportDefinitionPostOptionalIdDocument, include, options);
25093
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
25094
+ },
25095
+ /**
25096
+ *
25097
+ * @summary Delete an Export Definition
25098
+ * @param {string} workspaceId
25099
+ * @param {string} objectId
25100
+ * @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title&#x3D;&#x3D;\&#39;Some Title\&#39;;description&#x3D;&#x3D;\&#39;desc\&#39;). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty&#x3D;&#x3D;\&#39;Value 123\&#39;).
25101
+ * @param {*} [options] Override http request option.
25102
+ * @throws {RequiredError}
25103
+ */
25104
+ async deleteEntityExportDefinitions(workspaceId, objectId, filter, options) {
25105
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteEntityExportDefinitions(workspaceId, objectId, filter, options);
25106
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
25107
+ },
25108
+ /**
25109
+ *
25110
+ * @summary Get all Export Definitions
25111
+ * @param {string} workspaceId
25112
+ * @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
25113
+ * @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title&#x3D;&#x3D;\&#39;Some Title\&#39;;description&#x3D;&#x3D;\&#39;desc\&#39;). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty&#x3D;&#x3D;\&#39;Value 123\&#39;).
25114
+ * @param {Array<'visualizationObjects' | 'userIdentifiers' | 'visualizationObject' | 'createdBy' | 'modifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include&#x3D;entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \&quot;ALL\&quot; is present, all possible includes are used (include&#x3D;ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
25115
+ * @param {number} [page] Zero-based page index (0..N)
25116
+ * @param {number} [size] The size of the page to be returned
25117
+ * @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
25118
+ * @param {boolean} [xGDCVALIDATERELATIONS]
25119
+ * @param {Array<'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
25120
+ * @param {*} [options] Override http request option.
25121
+ * @throws {RequiredError}
25122
+ */
25123
+ async getAllEntitiesExportDefinitions(workspaceId, origin, filter, include, page, size, sort, xGDCVALIDATERELATIONS, metaInclude, options) {
25124
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getAllEntitiesExportDefinitions(workspaceId, origin, filter, include, page, size, sort, xGDCVALIDATERELATIONS, metaInclude, options);
25125
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
25126
+ },
25127
+ /**
25128
+ *
25129
+ * @summary Get an Export Definition
25130
+ * @param {string} workspaceId
25131
+ * @param {string} objectId
25132
+ * @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title&#x3D;&#x3D;\&#39;Some Title\&#39;;description&#x3D;&#x3D;\&#39;desc\&#39;). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty&#x3D;&#x3D;\&#39;Value 123\&#39;).
25133
+ * @param {Array<'visualizationObjects' | 'userIdentifiers' | 'visualizationObject' | 'createdBy' | 'modifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include&#x3D;entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \&quot;ALL\&quot; is present, all possible includes are used (include&#x3D;ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
25134
+ * @param {boolean} [xGDCVALIDATERELATIONS]
25135
+ * @param {*} [options] Override http request option.
25136
+ * @throws {RequiredError}
25137
+ */
25138
+ async getEntityExportDefinitions(workspaceId, objectId, filter, include, xGDCVALIDATERELATIONS, options) {
25139
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getEntityExportDefinitions(workspaceId, objectId, filter, include, xGDCVALIDATERELATIONS, options);
25140
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
25141
+ },
25142
+ /**
25143
+ *
25144
+ * @summary Patch an Export Definition
25145
+ * @param {string} workspaceId
25146
+ * @param {string} objectId
25147
+ * @param {JsonApiExportDefinitionPatchDocument} jsonApiExportDefinitionPatchDocument
25148
+ * @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title&#x3D;&#x3D;\&#39;Some Title\&#39;;description&#x3D;&#x3D;\&#39;desc\&#39;). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty&#x3D;&#x3D;\&#39;Value 123\&#39;).
25149
+ * @param {Array<'visualizationObjects' | 'userIdentifiers' | 'visualizationObject' | 'createdBy' | 'modifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include&#x3D;entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \&quot;ALL\&quot; is present, all possible includes are used (include&#x3D;ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
25150
+ * @param {*} [options] Override http request option.
25151
+ * @throws {RequiredError}
25152
+ */
25153
+ async patchEntityExportDefinitions(workspaceId, objectId, jsonApiExportDefinitionPatchDocument, filter, include, options) {
25154
+ const localVarAxiosArgs = await localVarAxiosParamCreator.patchEntityExportDefinitions(workspaceId, objectId, jsonApiExportDefinitionPatchDocument, filter, include, options);
25155
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
25156
+ },
25157
+ /**
25158
+ *
25159
+ * @summary Put an Export Definition
25160
+ * @param {string} workspaceId
25161
+ * @param {string} objectId
25162
+ * @param {JsonApiExportDefinitionInDocument} jsonApiExportDefinitionInDocument
25163
+ * @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title&#x3D;&#x3D;\&#39;Some Title\&#39;;description&#x3D;&#x3D;\&#39;desc\&#39;). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty&#x3D;&#x3D;\&#39;Value 123\&#39;).
25164
+ * @param {Array<'visualizationObjects' | 'userIdentifiers' | 'visualizationObject' | 'createdBy' | 'modifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include&#x3D;entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \&quot;ALL\&quot; is present, all possible includes are used (include&#x3D;ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
25165
+ * @param {*} [options] Override http request option.
25166
+ * @throws {RequiredError}
25167
+ */
25168
+ async updateEntityExportDefinitions(workspaceId, objectId, jsonApiExportDefinitionInDocument, filter, include, options) {
25169
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateEntityExportDefinitions(workspaceId, objectId, jsonApiExportDefinitionInDocument, filter, include, options);
25170
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
25171
+ },
25172
+ };
25173
+ };
25174
+ /**
25175
+ * ExportDefinitionsApi - factory interface
25176
+ * @export
25177
+ */
25178
+ export const ExportDefinitionsApiFactory = function (configuration, basePath, axios) {
25179
+ const localVarFp = ExportDefinitionsApiFp(configuration);
25180
+ return {
25181
+ /**
25182
+ *
25183
+ * @summary Post Export Definitions
25184
+ * @param {ExportDefinitionsApiCreateEntityExportDefinitionsRequest} requestParameters Request parameters.
25185
+ * @param {*} [options] Override http request option.
25186
+ * @throws {RequiredError}
25187
+ */
25188
+ createEntityExportDefinitions(requestParameters, options) {
25189
+ return localVarFp
25190
+ .createEntityExportDefinitions(requestParameters.workspaceId, requestParameters.jsonApiExportDefinitionPostOptionalIdDocument, requestParameters.include, options)
25191
+ .then((request) => request(axios, basePath));
25192
+ },
25193
+ /**
25194
+ *
25195
+ * @summary Delete an Export Definition
25196
+ * @param {ExportDefinitionsApiDeleteEntityExportDefinitionsRequest} requestParameters Request parameters.
25197
+ * @param {*} [options] Override http request option.
25198
+ * @throws {RequiredError}
25199
+ */
25200
+ deleteEntityExportDefinitions(requestParameters, options) {
25201
+ return localVarFp
25202
+ .deleteEntityExportDefinitions(requestParameters.workspaceId, requestParameters.objectId, requestParameters.filter, options)
25203
+ .then((request) => request(axios, basePath));
25204
+ },
25205
+ /**
25206
+ *
25207
+ * @summary Get all Export Definitions
25208
+ * @param {ExportDefinitionsApiGetAllEntitiesExportDefinitionsRequest} requestParameters Request parameters.
25209
+ * @param {*} [options] Override http request option.
25210
+ * @throws {RequiredError}
25211
+ */
25212
+ getAllEntitiesExportDefinitions(requestParameters, options) {
25213
+ return localVarFp
25214
+ .getAllEntitiesExportDefinitions(requestParameters.workspaceId, requestParameters.origin, requestParameters.filter, requestParameters.include, requestParameters.page, requestParameters.size, requestParameters.sort, requestParameters.xGDCVALIDATERELATIONS, requestParameters.metaInclude, options)
25215
+ .then((request) => request(axios, basePath));
25216
+ },
25217
+ /**
25218
+ *
25219
+ * @summary Get an Export Definition
25220
+ * @param {ExportDefinitionsApiGetEntityExportDefinitionsRequest} requestParameters Request parameters.
25221
+ * @param {*} [options] Override http request option.
25222
+ * @throws {RequiredError}
25223
+ */
25224
+ getEntityExportDefinitions(requestParameters, options) {
25225
+ return localVarFp
25226
+ .getEntityExportDefinitions(requestParameters.workspaceId, requestParameters.objectId, requestParameters.filter, requestParameters.include, requestParameters.xGDCVALIDATERELATIONS, options)
25227
+ .then((request) => request(axios, basePath));
25228
+ },
25229
+ /**
25230
+ *
25231
+ * @summary Patch an Export Definition
25232
+ * @param {ExportDefinitionsApiPatchEntityExportDefinitionsRequest} requestParameters Request parameters.
25233
+ * @param {*} [options] Override http request option.
25234
+ * @throws {RequiredError}
25235
+ */
25236
+ patchEntityExportDefinitions(requestParameters, options) {
25237
+ return localVarFp
25238
+ .patchEntityExportDefinitions(requestParameters.workspaceId, requestParameters.objectId, requestParameters.jsonApiExportDefinitionPatchDocument, requestParameters.filter, requestParameters.include, options)
25239
+ .then((request) => request(axios, basePath));
25240
+ },
25241
+ /**
25242
+ *
25243
+ * @summary Put an Export Definition
25244
+ * @param {ExportDefinitionsApiUpdateEntityExportDefinitionsRequest} requestParameters Request parameters.
25245
+ * @param {*} [options] Override http request option.
25246
+ * @throws {RequiredError}
25247
+ */
25248
+ updateEntityExportDefinitions(requestParameters, options) {
25249
+ return localVarFp
25250
+ .updateEntityExportDefinitions(requestParameters.workspaceId, requestParameters.objectId, requestParameters.jsonApiExportDefinitionInDocument, requestParameters.filter, requestParameters.include, options)
25251
+ .then((request) => request(axios, basePath));
25252
+ },
25253
+ };
25254
+ };
25255
+ /**
25256
+ * ExportDefinitionsApi - object-oriented interface
25257
+ * @export
25258
+ * @class ExportDefinitionsApi
25259
+ * @extends {BaseAPI}
25260
+ */
25261
+ export class ExportDefinitionsApi extends BaseAPI {
25262
+ /**
25263
+ *
25264
+ * @summary Post Export Definitions
25265
+ * @param {ExportDefinitionsApiCreateEntityExportDefinitionsRequest} requestParameters Request parameters.
25266
+ * @param {*} [options] Override http request option.
25267
+ * @throws {RequiredError}
25268
+ * @memberof ExportDefinitionsApi
25269
+ */
25270
+ createEntityExportDefinitions(requestParameters, options) {
25271
+ return ExportDefinitionsApiFp(this.configuration)
25272
+ .createEntityExportDefinitions(requestParameters.workspaceId, requestParameters.jsonApiExportDefinitionPostOptionalIdDocument, requestParameters.include, options)
25273
+ .then((request) => request(this.axios, this.basePath));
25274
+ }
25275
+ /**
25276
+ *
25277
+ * @summary Delete an Export Definition
25278
+ * @param {ExportDefinitionsApiDeleteEntityExportDefinitionsRequest} requestParameters Request parameters.
25279
+ * @param {*} [options] Override http request option.
25280
+ * @throws {RequiredError}
25281
+ * @memberof ExportDefinitionsApi
25282
+ */
25283
+ deleteEntityExportDefinitions(requestParameters, options) {
25284
+ return ExportDefinitionsApiFp(this.configuration)
25285
+ .deleteEntityExportDefinitions(requestParameters.workspaceId, requestParameters.objectId, requestParameters.filter, options)
25286
+ .then((request) => request(this.axios, this.basePath));
25287
+ }
25288
+ /**
25289
+ *
25290
+ * @summary Get all Export Definitions
25291
+ * @param {ExportDefinitionsApiGetAllEntitiesExportDefinitionsRequest} requestParameters Request parameters.
25292
+ * @param {*} [options] Override http request option.
25293
+ * @throws {RequiredError}
25294
+ * @memberof ExportDefinitionsApi
25295
+ */
25296
+ getAllEntitiesExportDefinitions(requestParameters, options) {
25297
+ return ExportDefinitionsApiFp(this.configuration)
25298
+ .getAllEntitiesExportDefinitions(requestParameters.workspaceId, requestParameters.origin, requestParameters.filter, requestParameters.include, requestParameters.page, requestParameters.size, requestParameters.sort, requestParameters.xGDCVALIDATERELATIONS, requestParameters.metaInclude, options)
25299
+ .then((request) => request(this.axios, this.basePath));
25300
+ }
25301
+ /**
25302
+ *
25303
+ * @summary Get an Export Definition
25304
+ * @param {ExportDefinitionsApiGetEntityExportDefinitionsRequest} requestParameters Request parameters.
25305
+ * @param {*} [options] Override http request option.
25306
+ * @throws {RequiredError}
25307
+ * @memberof ExportDefinitionsApi
25308
+ */
25309
+ getEntityExportDefinitions(requestParameters, options) {
25310
+ return ExportDefinitionsApiFp(this.configuration)
25311
+ .getEntityExportDefinitions(requestParameters.workspaceId, requestParameters.objectId, requestParameters.filter, requestParameters.include, requestParameters.xGDCVALIDATERELATIONS, options)
25312
+ .then((request) => request(this.axios, this.basePath));
25313
+ }
25314
+ /**
25315
+ *
25316
+ * @summary Patch an Export Definition
25317
+ * @param {ExportDefinitionsApiPatchEntityExportDefinitionsRequest} requestParameters Request parameters.
25318
+ * @param {*} [options] Override http request option.
25319
+ * @throws {RequiredError}
25320
+ * @memberof ExportDefinitionsApi
25321
+ */
25322
+ patchEntityExportDefinitions(requestParameters, options) {
25323
+ return ExportDefinitionsApiFp(this.configuration)
25324
+ .patchEntityExportDefinitions(requestParameters.workspaceId, requestParameters.objectId, requestParameters.jsonApiExportDefinitionPatchDocument, requestParameters.filter, requestParameters.include, options)
25325
+ .then((request) => request(this.axios, this.basePath));
25326
+ }
25327
+ /**
25328
+ *
25329
+ * @summary Put an Export Definition
25330
+ * @param {ExportDefinitionsApiUpdateEntityExportDefinitionsRequest} requestParameters Request parameters.
25331
+ * @param {*} [options] Override http request option.
25332
+ * @throws {RequiredError}
25333
+ * @memberof ExportDefinitionsApi
25334
+ */
25335
+ updateEntityExportDefinitions(requestParameters, options) {
25336
+ return ExportDefinitionsApiFp(this.configuration)
25337
+ .updateEntityExportDefinitions(requestParameters.workspaceId, requestParameters.objectId, requestParameters.jsonApiExportDefinitionInDocument, requestParameters.filter, requestParameters.include, options)
25338
+ .then((request) => request(this.axios, this.basePath));
25339
+ }
25340
+ }
24732
25341
  /**
24733
25342
  * FactsApi - axios parameter creator
24734
25343
  * @export
@@ -43648,6 +44257,7 @@ export const WorkspaceObjectControllerApiAxiosParamCreator = function (configura
43648
44257
  },
43649
44258
  /**
43650
44259
  *
44260
+ * @summary Delete an Export Definition
43651
44261
  * @param {string} workspaceId
43652
44262
  * @param {string} objectId
43653
44263
  * @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title&#x3D;&#x3D;\&#39;Some Title\&#39;;description&#x3D;&#x3D;\&#39;desc\&#39;). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty&#x3D;&#x3D;\&#39;Value 123\&#39;).
@@ -44355,6 +44965,7 @@ export const WorkspaceObjectControllerApiAxiosParamCreator = function (configura
44355
44965
  },
44356
44966
  /**
44357
44967
  *
44968
+ * @summary Get all Export Definitions
44358
44969
  * @param {string} workspaceId
44359
44970
  * @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
44360
44971
  * @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title&#x3D;&#x3D;\&#39;Some Title\&#39;;description&#x3D;&#x3D;\&#39;desc\&#39;). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty&#x3D;&#x3D;\&#39;Value 123\&#39;).
@@ -45304,6 +45915,7 @@ export const WorkspaceObjectControllerApiAxiosParamCreator = function (configura
45304
45915
  },
45305
45916
  /**
45306
45917
  *
45918
+ * @summary Get an Export Definition
45307
45919
  * @param {string} workspaceId
45308
45920
  * @param {string} objectId
45309
45921
  * @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title&#x3D;&#x3D;\&#39;Some Title\&#39;;description&#x3D;&#x3D;\&#39;desc\&#39;). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty&#x3D;&#x3D;\&#39;Value 123\&#39;).
@@ -46045,6 +46657,7 @@ export const WorkspaceObjectControllerApiAxiosParamCreator = function (configura
46045
46657
  },
46046
46658
  /**
46047
46659
  *
46660
+ * @summary Patch an Export Definition
46048
46661
  * @param {string} workspaceId
46049
46662
  * @param {string} objectId
46050
46663
  * @param {JsonApiExportDefinitionPatchDocument} jsonApiExportDefinitionPatchDocument
@@ -46704,6 +47317,7 @@ export const WorkspaceObjectControllerApiAxiosParamCreator = function (configura
46704
47317
  },
46705
47318
  /**
46706
47319
  *
47320
+ * @summary Put an Export Definition
46707
47321
  * @param {string} workspaceId
46708
47322
  * @param {string} objectId
46709
47323
  * @param {JsonApiExportDefinitionInDocument} jsonApiExportDefinitionInDocument
@@ -47367,6 +47981,7 @@ export const WorkspaceObjectControllerApiFp = function (configuration) {
47367
47981
  },
47368
47982
  /**
47369
47983
  *
47984
+ * @summary Delete an Export Definition
47370
47985
  * @param {string} workspaceId
47371
47986
  * @param {string} objectId
47372
47987
  * @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title&#x3D;&#x3D;\&#39;Some Title\&#39;;description&#x3D;&#x3D;\&#39;desc\&#39;). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty&#x3D;&#x3D;\&#39;Value 123\&#39;).
@@ -47583,6 +48198,7 @@ export const WorkspaceObjectControllerApiFp = function (configuration) {
47583
48198
  },
47584
48199
  /**
47585
48200
  *
48201
+ * @summary Get all Export Definitions
47586
48202
  * @param {string} workspaceId
47587
48203
  * @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
47588
48204
  * @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title&#x3D;&#x3D;\&#39;Some Title\&#39;;description&#x3D;&#x3D;\&#39;desc\&#39;). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty&#x3D;&#x3D;\&#39;Value 123\&#39;).
@@ -47866,6 +48482,7 @@ export const WorkspaceObjectControllerApiFp = function (configuration) {
47866
48482
  },
47867
48483
  /**
47868
48484
  *
48485
+ * @summary Get an Export Definition
47869
48486
  * @param {string} workspaceId
47870
48487
  * @param {string} objectId
47871
48488
  * @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title&#x3D;&#x3D;\&#39;Some Title\&#39;;description&#x3D;&#x3D;\&#39;desc\&#39;). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty&#x3D;&#x3D;\&#39;Value 123\&#39;).
@@ -48082,6 +48699,7 @@ export const WorkspaceObjectControllerApiFp = function (configuration) {
48082
48699
  },
48083
48700
  /**
48084
48701
  *
48702
+ * @summary Patch an Export Definition
48085
48703
  * @param {string} workspaceId
48086
48704
  * @param {string} objectId
48087
48705
  * @param {JsonApiExportDefinitionPatchDocument} jsonApiExportDefinitionPatchDocument
@@ -48259,6 +48877,7 @@ export const WorkspaceObjectControllerApiFp = function (configuration) {
48259
48877
  },
48260
48878
  /**
48261
48879
  *
48880
+ * @summary Put an Export Definition
48262
48881
  * @param {string} workspaceId
48263
48882
  * @param {string} objectId
48264
48883
  * @param {JsonApiExportDefinitionInDocument} jsonApiExportDefinitionInDocument
@@ -48578,6 +49197,7 @@ export const WorkspaceObjectControllerApiFactory = function (configuration, base
48578
49197
  },
48579
49198
  /**
48580
49199
  *
49200
+ * @summary Delete an Export Definition
48581
49201
  * @param {WorkspaceObjectControllerApiDeleteEntityExportDefinitionsRequest} requestParameters Request parameters.
48582
49202
  * @param {*} [options] Override http request option.
48583
49203
  * @throws {RequiredError}
@@ -48745,6 +49365,7 @@ export const WorkspaceObjectControllerApiFactory = function (configuration, base
48745
49365
  },
48746
49366
  /**
48747
49367
  *
49368
+ * @summary Get all Export Definitions
48748
49369
  * @param {WorkspaceObjectControllerApiGetAllEntitiesExportDefinitionsRequest} requestParameters Request parameters.
48749
49370
  * @param {*} [options] Override http request option.
48750
49371
  * @throws {RequiredError}
@@ -48936,6 +49557,7 @@ export const WorkspaceObjectControllerApiFactory = function (configuration, base
48936
49557
  },
48937
49558
  /**
48938
49559
  *
49560
+ * @summary Get an Export Definition
48939
49561
  * @param {WorkspaceObjectControllerApiGetEntityExportDefinitionsRequest} requestParameters Request parameters.
48940
49562
  * @param {*} [options] Override http request option.
48941
49563
  * @throws {RequiredError}
@@ -49103,6 +49725,7 @@ export const WorkspaceObjectControllerApiFactory = function (configuration, base
49103
49725
  },
49104
49726
  /**
49105
49727
  *
49728
+ * @summary Patch an Export Definition
49106
49729
  * @param {WorkspaceObjectControllerApiPatchEntityExportDefinitionsRequest} requestParameters Request parameters.
49107
49730
  * @param {*} [options] Override http request option.
49108
49731
  * @throws {RequiredError}
@@ -49246,6 +49869,7 @@ export const WorkspaceObjectControllerApiFactory = function (configuration, base
49246
49869
  },
49247
49870
  /**
49248
49871
  *
49872
+ * @summary Put an Export Definition
49249
49873
  * @param {WorkspaceObjectControllerApiUpdateEntityExportDefinitionsRequest} requestParameters Request parameters.
49250
49874
  * @param {*} [options] Override http request option.
49251
49875
  * @throws {RequiredError}
@@ -49558,6 +50182,7 @@ export class WorkspaceObjectControllerApi extends BaseAPI {
49558
50182
  }
49559
50183
  /**
49560
50184
  *
50185
+ * @summary Delete an Export Definition
49561
50186
  * @param {WorkspaceObjectControllerApiDeleteEntityExportDefinitionsRequest} requestParameters Request parameters.
49562
50187
  * @param {*} [options] Override http request option.
49563
50188
  * @throws {RequiredError}
@@ -49739,6 +50364,7 @@ export class WorkspaceObjectControllerApi extends BaseAPI {
49739
50364
  }
49740
50365
  /**
49741
50366
  *
50367
+ * @summary Get all Export Definitions
49742
50368
  * @param {WorkspaceObjectControllerApiGetAllEntitiesExportDefinitionsRequest} requestParameters Request parameters.
49743
50369
  * @param {*} [options] Override http request option.
49744
50370
  * @throws {RequiredError}
@@ -49946,6 +50572,7 @@ export class WorkspaceObjectControllerApi extends BaseAPI {
49946
50572
  }
49947
50573
  /**
49948
50574
  *
50575
+ * @summary Get an Export Definition
49949
50576
  * @param {WorkspaceObjectControllerApiGetEntityExportDefinitionsRequest} requestParameters Request parameters.
49950
50577
  * @param {*} [options] Override http request option.
49951
50578
  * @throws {RequiredError}
@@ -50127,6 +50754,7 @@ export class WorkspaceObjectControllerApi extends BaseAPI {
50127
50754
  }
50128
50755
  /**
50129
50756
  *
50757
+ * @summary Patch an Export Definition
50130
50758
  * @param {WorkspaceObjectControllerApiPatchEntityExportDefinitionsRequest} requestParameters Request parameters.
50131
50759
  * @param {*} [options] Override http request option.
50132
50760
  * @throws {RequiredError}
@@ -50282,6 +50910,7 @@ export class WorkspaceObjectControllerApi extends BaseAPI {
50282
50910
  }
50283
50911
  /**
50284
50912
  *
50913
+ * @summary Put an Export Definition
50285
50914
  * @param {WorkspaceObjectControllerApiUpdateEntityExportDefinitionsRequest} requestParameters Request parameters.
50286
50915
  * @param {*} [options] Override http request option.
50287
50916
  * @throws {RequiredError}