@uipath/aops-policy-sdk 1.203.0-preview.203

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 (109) hide show
  1. package/LICENSE.txt +3 -0
  2. package/README.md +60 -0
  3. package/dist/generated/src/apis/ApplicationSettingApi.d.ts +37 -0
  4. package/dist/generated/src/apis/ContentApi.d.ts +198 -0
  5. package/dist/generated/src/apis/DeploymentTypeApi.d.ts +26 -0
  6. package/dist/generated/src/apis/GroupApi.d.ts +74 -0
  7. package/dist/generated/src/apis/GwsPartitionMoveApi.d.ts +196 -0
  8. package/dist/generated/src/apis/HomeApi.d.ts +27 -0
  9. package/dist/generated/src/apis/InternalContentApi.d.ts +45 -0
  10. package/dist/generated/src/apis/LicenseTypeApi.d.ts +93 -0
  11. package/dist/generated/src/apis/MaintenanceApi.d.ts +26 -0
  12. package/dist/generated/src/apis/MessageBusApi.d.ts +40 -0
  13. package/dist/generated/src/apis/MigrationApi.d.ts +25 -0
  14. package/dist/generated/src/apis/ModuleFederationApi.d.ts +28 -0
  15. package/dist/generated/src/apis/NotificationApi.d.ts +37 -0
  16. package/dist/generated/src/apis/OrganizationApi.d.ts +55 -0
  17. package/dist/generated/src/apis/PolicyApi.d.ts +379 -0
  18. package/dist/generated/src/apis/ProductApi.d.ts +125 -0
  19. package/dist/generated/src/apis/RuleApi.d.ts +29 -0
  20. package/dist/generated/src/apis/RulesContractsApi.d.ts +29 -0
  21. package/dist/generated/src/apis/S2SContentApi.d.ts +114 -0
  22. package/dist/generated/src/apis/TenantApi.d.ts +69 -0
  23. package/dist/generated/src/apis/TranslationApi.d.ts +28 -0
  24. package/dist/generated/src/apis/UserApi.d.ts +74 -0
  25. package/dist/generated/src/apis/UserEntitlementsApi.d.ts +31 -0
  26. package/dist/generated/src/apis/UserPoliciesApi.d.ts +40 -0
  27. package/dist/generated/src/apis/index.d.ts +24 -0
  28. package/dist/generated/src/index.d.ts +3 -0
  29. package/dist/generated/src/models/AccountState.d.ts +28 -0
  30. package/dist/generated/src/models/AccountStateDto.d.ts +33 -0
  31. package/dist/generated/src/models/AddLicenseTypeRequest.d.ts +38 -0
  32. package/dist/generated/src/models/CloudEvent.d.ts +82 -0
  33. package/dist/generated/src/models/CompatibilityReportRequest.d.ts +44 -0
  34. package/dist/generated/src/models/CompatibilityReportResponse.d.ts +50 -0
  35. package/dist/generated/src/models/CreateGlobalPolicyWithFormDataRequest.d.ts +33 -0
  36. package/dist/generated/src/models/CreatePolicyRequest.d.ts +62 -0
  37. package/dist/generated/src/models/CreatePolicyWithFormDataRequest.d.ts +40 -0
  38. package/dist/generated/src/models/DataCollectionOptions.d.ts +40 -0
  39. package/dist/generated/src/models/DataMoveRequest.d.ts +64 -0
  40. package/dist/generated/src/models/DataMoveResponse.d.ts +50 -0
  41. package/dist/generated/src/models/DeletePartitionRequestDto.d.ts +50 -0
  42. package/dist/generated/src/models/DeletePartitionResponseDto.d.ts +50 -0
  43. package/dist/generated/src/models/DeleteRequest.d.ts +38 -0
  44. package/dist/generated/src/models/DeleteResponse.d.ts +44 -0
  45. package/dist/generated/src/models/DeployedPolicyDto.d.ts +50 -0
  46. package/dist/generated/src/models/DeployedPolicyWithoutUserDto.d.ts +44 -0
  47. package/dist/generated/src/models/DeploymentLevel.d.ts +26 -0
  48. package/dist/generated/src/models/DeploymentTypeOptions.d.ts +32 -0
  49. package/dist/generated/src/models/EvaluateRule.d.ts +45 -0
  50. package/dist/generated/src/models/FederatedPolicyDto.d.ts +84 -0
  51. package/dist/generated/src/models/FederatedPolicyDtoPagedResult.d.ts +39 -0
  52. package/dist/generated/src/models/FinalizeRequest.d.ts +32 -0
  53. package/dist/generated/src/models/FormDataDto.d.ts +38 -0
  54. package/dist/generated/src/models/FormTemplateDto.d.ts +70 -0
  55. package/dist/generated/src/models/GlobalPolicyDto.d.ts +57 -0
  56. package/dist/generated/src/models/GovernanceQueryOptions.d.ts +75 -0
  57. package/dist/generated/src/models/GroupDto.d.ts +63 -0
  58. package/dist/generated/src/models/GroupDtoPagedResult.d.ts +39 -0
  59. package/dist/generated/src/models/GroupPolicyDto.d.ts +50 -0
  60. package/dist/generated/src/models/GroupToAddDto.d.ts +45 -0
  61. package/dist/generated/src/models/ImportPolicyRequest.d.ts +50 -0
  62. package/dist/generated/src/models/InstanceState.d.ts +26 -0
  63. package/dist/generated/src/models/InstanceStateDto.d.ts +33 -0
  64. package/dist/generated/src/models/LicenseTypeDto.d.ts +51 -0
  65. package/dist/generated/src/models/LicenseTypeProductsDto.d.ts +33 -0
  66. package/dist/generated/src/models/MaintenanceModeRequest.d.ts +38 -0
  67. package/dist/generated/src/models/MaintenanceModeResponse.d.ts +44 -0
  68. package/dist/generated/src/models/NotificationDto.d.ts +40 -0
  69. package/dist/generated/src/models/NotificationType.d.ts +25 -0
  70. package/dist/generated/src/models/OrganizationType.d.ts +25 -0
  71. package/dist/generated/src/models/Partition.d.ts +57 -0
  72. package/dist/generated/src/models/PartitionProductDto.d.ts +51 -0
  73. package/dist/generated/src/models/PolicyDto.d.ts +70 -0
  74. package/dist/generated/src/models/PolicyDtoPagedResult.d.ts +39 -0
  75. package/dist/generated/src/models/PolicyExportResponse.d.ts +63 -0
  76. package/dist/generated/src/models/PolicyInfoDto.d.ts +44 -0
  77. package/dist/generated/src/models/PolicyUsageData.d.ts +44 -0
  78. package/dist/generated/src/models/Product.d.ts +45 -0
  79. package/dist/generated/src/models/ProductDto.d.ts +56 -0
  80. package/dist/generated/src/models/PropertiesResponse.d.ts +34 -0
  81. package/dist/generated/src/models/RestorePartitionRequestDto.d.ts +50 -0
  82. package/dist/generated/src/models/RestorePartitionResponseDto.d.ts +44 -0
  83. package/dist/generated/src/models/RollbackRequest.d.ts +38 -0
  84. package/dist/generated/src/models/RollbackResponse.d.ts +44 -0
  85. package/dist/generated/src/models/RulesContractEntity.d.ts +65 -0
  86. package/dist/generated/src/models/RulesContractualOptions.d.ts +33 -0
  87. package/dist/generated/src/models/SeedContentRequest.d.ts +47 -0
  88. package/dist/generated/src/models/SortOrder.d.ts +25 -0
  89. package/dist/generated/src/models/TenantDto.d.ts +57 -0
  90. package/dist/generated/src/models/TenantDtoPagedResult.d.ts +39 -0
  91. package/dist/generated/src/models/TenantPolicyDto.d.ts +56 -0
  92. package/dist/generated/src/models/UpdateFormTemplateRequest.d.ts +51 -0
  93. package/dist/generated/src/models/UpdateLicenseTypeRequest.d.ts +38 -0
  94. package/dist/generated/src/models/UpdatePolicyRequest.d.ts +68 -0
  95. package/dist/generated/src/models/UserDto.d.ts +69 -0
  96. package/dist/generated/src/models/UserDtoPagedResult.d.ts +39 -0
  97. package/dist/generated/src/models/UserPolicyDto.d.ts +50 -0
  98. package/dist/generated/src/models/UserToAddDto.d.ts +45 -0
  99. package/dist/generated/src/models/Version.d.ts +32 -0
  100. package/dist/generated/src/models/VersionDto.d.ts +44 -0
  101. package/dist/generated/src/models/index.d.ts +72 -0
  102. package/dist/generated/src/runtime.d.ts +184 -0
  103. package/dist/index.js +8516 -0
  104. package/dist/policy-resolver.js +1969 -0
  105. package/dist/src/client-factory.d.ts +7 -0
  106. package/dist/src/index.d.ts +4 -0
  107. package/dist/src/policy-resolver.d.ts +102 -0
  108. package/dist/src/user-agent.d.ts +1 -0
  109. package/package.json +46 -0
package/LICENSE.txt ADDED
@@ -0,0 +1,3 @@
1
+ © 2026 UiPath
2
+ Use of this product is subject (a) to the applicable licensing agreement available: https://www.uipath.com/legal/trust-and-security/legal-terms#content-1 and, (b) for paid products listed here https://licensing.uipath.com/: the licensing agreement agreed between you and UiPath.
3
+ (UiPath means UiPath SRL with headquarters at 4 Vasile Alecsandri Str. and 11 Constantin Daniel Str., Building A, floors 5 and 6, District 1, Bucharest 010639, Romania and UiPath Inc. with principal place of business: One Vanderbilt Avenue, 60th Floor, New York, NY 10017)
package/README.md ADDED
@@ -0,0 +1,60 @@
1
+ # AOps Governance SDK
2
+
3
+ This package generates a TypeScript SDK for UiPath AOps governance APIs.
4
+
5
+ ## Usage
6
+
7
+ ### Generate SDK
8
+
9
+ ```bash
10
+ bun run generate
11
+ ```
12
+
13
+ This reads the committed `swagger/swagger_governance.json` (no network call) and uses `openapi-generator-cli` to produce the typed client under `generated/`. The generated sources are committed to the repository.
14
+
15
+ ### Creating a typed client
16
+
17
+ ```ts
18
+ import { createApiClient, PolicyApi } from "@uipath/aops-policy-sdk";
19
+
20
+ const api = await createApiClient(PolicyApi);
21
+ const policies = await api.policyGetAllPoliciesByQueryOptions({
22
+ productName: "StudioX",
23
+ });
24
+ ```
25
+
26
+ `createApiClient` pulls login/org context from `@uipath/auth` and builds a `Configuration` scoped to `{baseUrl}/{orgId}/roboticsops_`.
27
+
28
+ ### Resolving whether a tenant is governed (`/resolver`)
29
+
30
+ ```ts
31
+ import { resolvePolicyAsync } from "@uipath/aops-policy-sdk/resolver";
32
+
33
+ const resolution = await resolvePolicyAsync({
34
+ subject: {
35
+ organizationId,
36
+ tenantId,
37
+ product: "Development",
38
+ licenseType: "Development",
39
+ },
40
+ baseUrl: "https://cloud.uipath.com",
41
+ accessToken,
42
+ clientVersion: pkg.version,
43
+ });
44
+
45
+ switch (resolution.outcome) {
46
+ case "governed": // resolution.document is the policy, byte for byte
47
+ case "ungoverned": // a 204 — nobody publishes a policy for this subject
48
+ case "unknown": // resolution.reason says why the question went unanswered
49
+ }
50
+ ```
51
+
52
+ Separate from the root barrel on purpose: the root pulls in `createApiClient`, which needs `@uipath/auth` and is node-only. The `/resolver` subpath has no runtime dependencies and no `node:` imports, so it works in the browser bundle too.
53
+
54
+ Three things it deliberately does not do. It never returns `ungoverned` for anything but a `204` — a `404`, a `5xx` or an expired token are all `unknown`, which is not the same claim. It never retries; a `Retry-After` is parsed into `audit.retryAfterSeconds` and the decision is the caller's. And it never touches the document: no reparse, no reserialize, because callers checksum that string.
55
+
56
+ `product` and `licenseType` have no defaults. A default here is how two callers came to ask the same tenant different questions and get different answers; the command layer owns that choice.
57
+
58
+ ## Documentation
59
+
60
+ For the detailed generated API reference, see [generated/README.md](./generated/README.md).
@@ -0,0 +1,37 @@
1
+ /**
2
+ * StudioAdmin API
3
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ *
5
+ * The version of the OpenAPI document: V1
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import * as runtime from '../runtime';
13
+ import type { InstanceStateDto } from '../models/index';
14
+ export interface ApplicationSettingSetInstanceStateRequest {
15
+ instanceStateDto?: InstanceStateDto;
16
+ }
17
+ /**
18
+ *
19
+ */
20
+ export declare class ApplicationSettingApi extends runtime.BaseAPI {
21
+ /**
22
+ * Returns the current instance operational state (e.g., active, maintenance).
23
+ */
24
+ applicationSettingGetInstanceStateRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InstanceStateDto>>;
25
+ /**
26
+ * Returns the current instance operational state (e.g., active, maintenance).
27
+ */
28
+ applicationSettingGetInstanceState(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InstanceStateDto>;
29
+ /**
30
+ * Sets the instance operational state. Returns 202 Accepted while the change is applied asynchronously.
31
+ */
32
+ applicationSettingSetInstanceStateRaw(requestParameters: ApplicationSettingSetInstanceStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
33
+ /**
34
+ * Sets the instance operational state. Returns 202 Accepted while the change is applied asynchronously.
35
+ */
36
+ applicationSettingSetInstanceState(requestParameters?: ApplicationSettingSetInstanceStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
37
+ }
@@ -0,0 +1,198 @@
1
+ /**
2
+ * StudioAdmin API
3
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ *
5
+ * The version of the OpenAPI document: V1
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import * as runtime from '../runtime';
13
+ import type { FormTemplateDto, ProductDto, UpdateFormTemplateRequest } from '../models/index';
14
+ export interface ContentAllowFormTemplateVersionRequest {
15
+ productName: string;
16
+ major: number;
17
+ minor: number;
18
+ hotfix: number;
19
+ }
20
+ export interface ContentCreateNewFormTemplateVersionRequest {
21
+ productName: string;
22
+ formTemplateDto?: FormTemplateDto;
23
+ }
24
+ export interface ContentCreateNewProductWithFormTemplateRequest {
25
+ formTemplateDto?: FormTemplateDto;
26
+ }
27
+ export interface ContentDeleteNewFormTemplateVersionRequest {
28
+ productName: string;
29
+ major: number;
30
+ minor: number;
31
+ hotfix: number;
32
+ }
33
+ export interface ContentGetAllTemplatesByProductIdentifierRequest {
34
+ productName: string;
35
+ }
36
+ export interface ContentGetFormioTemplatesByProductIdentifierRequest {
37
+ productIdentifier: string;
38
+ }
39
+ export interface ContentGetProductByNameNoPartitionRequest {
40
+ productIdentifier: string;
41
+ }
42
+ export interface ContentGetTemplateVersionRequest {
43
+ productName: string;
44
+ major: number;
45
+ minor: number;
46
+ hotfix: number;
47
+ }
48
+ export interface ContentRestrictFormTemplateVersionRequest {
49
+ productName: string;
50
+ major: number;
51
+ minor: number;
52
+ hotfix: number;
53
+ }
54
+ export interface ContentUpdateFormTemplateRequest {
55
+ updateFormTemplateRequest?: UpdateFormTemplateRequest;
56
+ }
57
+ export interface ContentUpdatePartitionFormTemplatesAllChangesRequest {
58
+ requestBody?: Array<string>;
59
+ }
60
+ export interface ContentUpdatePartitionFormTemplatesHavingOnlySilentChangesRequest {
61
+ requestBody?: Array<string>;
62
+ }
63
+ export interface ContentUploadFormTemplatesRequest {
64
+ file?: Blob;
65
+ }
66
+ /**
67
+ *
68
+ */
69
+ export declare class ContentApi extends runtime.BaseAPI {
70
+ /**
71
+ * Updates isRestricted flag to false
72
+ */
73
+ contentAllowFormTemplateVersionRaw(requestParameters: ContentAllowFormTemplateVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FormTemplateDto>>;
74
+ /**
75
+ * Updates isRestricted flag to false
76
+ */
77
+ contentAllowFormTemplateVersion(requestParameters: ContentAllowFormTemplateVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FormTemplateDto>;
78
+ /**
79
+ * Create new version for an existing product.
80
+ */
81
+ contentCreateNewFormTemplateVersionRaw(requestParameters: ContentCreateNewFormTemplateVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FormTemplateDto>>;
82
+ /**
83
+ * Create new version for an existing product.
84
+ */
85
+ contentCreateNewFormTemplateVersion(requestParameters: ContentCreateNewFormTemplateVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FormTemplateDto>;
86
+ /**
87
+ * Create new product with an initial version.
88
+ */
89
+ contentCreateNewProductWithFormTemplateRaw(requestParameters: ContentCreateNewProductWithFormTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FormTemplateDto>>;
90
+ /**
91
+ * Create new product with an initial version.
92
+ */
93
+ contentCreateNewProductWithFormTemplate(requestParameters?: ContentCreateNewProductWithFormTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FormTemplateDto>;
94
+ /**
95
+ * WARNING! Use this only in E2E TEST.
96
+ */
97
+ contentDeleteNewFormTemplateVersionRaw(requestParameters: ContentDeleteNewFormTemplateVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
98
+ /**
99
+ * WARNING! Use this only in E2E TEST.
100
+ */
101
+ contentDeleteNewFormTemplateVersion(requestParameters: ContentDeleteNewFormTemplateVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
102
+ /**
103
+ * Returns all products without applying partition filtering. For content creator use only.
104
+ */
105
+ contentGetAllProductsNoPartitionRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ProductDto>>>;
106
+ /**
107
+ * Returns all products without applying partition filtering. For content creator use only.
108
+ */
109
+ contentGetAllProductsNoPartition(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ProductDto>>;
110
+ /**
111
+ * Returns all template versions for the specified product across all restriction states. For content creator use only.
112
+ */
113
+ contentGetAllTemplatesByProductIdentifierRaw(requestParameters: ContentGetAllTemplatesByProductIdentifierRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<FormTemplateDto>>>;
114
+ /**
115
+ * Returns all template versions for the specified product across all restriction states. For content creator use only.
116
+ */
117
+ contentGetAllTemplatesByProductIdentifier(requestParameters: ContentGetAllTemplatesByProductIdentifierRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<FormTemplateDto>>;
118
+ /**
119
+ * Returns all form templates available to the current partition, applying restriction rules.
120
+ */
121
+ contentGetFormTemplatesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<FormTemplateDto>>>;
122
+ /**
123
+ * Returns all form templates available to the current partition, applying restriction rules.
124
+ */
125
+ contentGetFormTemplates(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<FormTemplateDto>>;
126
+ /**
127
+ * Returns the template versions currently assigned to the partition.
128
+ */
129
+ contentGetFormTemplatesForPartitionRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<FormTemplateDto>>>;
130
+ /**
131
+ * Returns the template versions currently assigned to the partition.
132
+ */
133
+ contentGetFormTemplatesForPartition(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<FormTemplateDto>>;
134
+ /**
135
+ * Returns the active form template for the specified product within the current partition.
136
+ */
137
+ contentGetFormioTemplatesByProductIdentifierRaw(requestParameters: ContentGetFormioTemplatesByProductIdentifierRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FormTemplateDto>>;
138
+ /**
139
+ * Returns the active form template for the specified product within the current partition.
140
+ */
141
+ contentGetFormioTemplatesByProductIdentifier(requestParameters: ContentGetFormioTemplatesByProductIdentifierRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FormTemplateDto>;
142
+ /**
143
+ * Returns a single product by its identifier without applying partition filtering. For content creator use only.
144
+ */
145
+ contentGetProductByNameNoPartitionRaw(requestParameters: ContentGetProductByNameNoPartitionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProductDto>>;
146
+ /**
147
+ * Returns a single product by its identifier without applying partition filtering. For content creator use only.
148
+ */
149
+ contentGetProductByNameNoPartition(requestParameters: ContentGetProductByNameNoPartitionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProductDto>;
150
+ /**
151
+ * Returns a specific template version for the given product. For content creator use only.
152
+ */
153
+ contentGetTemplateVersionRaw(requestParameters: ContentGetTemplateVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FormTemplateDto>>;
154
+ /**
155
+ * Returns a specific template version for the given product. For content creator use only.
156
+ */
157
+ contentGetTemplateVersion(requestParameters: ContentGetTemplateVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FormTemplateDto>;
158
+ /**
159
+ * Updates isRestricted flag to true
160
+ */
161
+ contentRestrictFormTemplateVersionRaw(requestParameters: ContentRestrictFormTemplateVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FormTemplateDto>>;
162
+ /**
163
+ * Updates isRestricted flag to true
164
+ */
165
+ contentRestrictFormTemplateVersion(requestParameters: ContentRestrictFormTemplateVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FormTemplateDto>;
166
+ /**
167
+ * Update form template with the same version.
168
+ */
169
+ contentUpdateFormTemplateRaw(requestParameters: ContentUpdateFormTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FormTemplateDto>>;
170
+ /**
171
+ * Update form template with the same version.
172
+ */
173
+ contentUpdateFormTemplate(requestParameters?: ContentUpdateFormTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FormTemplateDto>;
174
+ /**
175
+ * Applies all pending template updates (including breaking changes) to the partition for the specified template IDs.
176
+ */
177
+ contentUpdatePartitionFormTemplatesAllChangesRaw(requestParameters: ContentUpdatePartitionFormTemplatesAllChangesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>>;
178
+ /**
179
+ * Applies all pending template updates (including breaking changes) to the partition for the specified template IDs.
180
+ */
181
+ contentUpdatePartitionFormTemplatesAllChanges(requestParameters?: ContentUpdatePartitionFormTemplatesAllChangesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
182
+ /**
183
+ * Applies silent (non-breaking) template updates to the partition for the specified template IDs.
184
+ */
185
+ contentUpdatePartitionFormTemplatesHavingOnlySilentChangesRaw(requestParameters: ContentUpdatePartitionFormTemplatesHavingOnlySilentChangesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>>;
186
+ /**
187
+ * Applies silent (non-breaking) template updates to the partition for the specified template IDs.
188
+ */
189
+ contentUpdatePartitionFormTemplatesHavingOnlySilentChanges(requestParameters?: ContentUpdatePartitionFormTemplatesHavingOnlySilentChangesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
190
+ /**
191
+ * Uploads a zip archive containing form templates, license types, and translations. On-prem only.
192
+ */
193
+ contentUploadFormTemplatesRaw(requestParameters: ContentUploadFormTemplatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
194
+ /**
195
+ * Uploads a zip archive containing form templates, license types, and translations. On-prem only.
196
+ */
197
+ contentUploadFormTemplates(requestParameters?: ContentUploadFormTemplatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
198
+ }
@@ -0,0 +1,26 @@
1
+ /**
2
+ * StudioAdmin API
3
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ *
5
+ * The version of the OpenAPI document: V1
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import * as runtime from '../runtime';
13
+ import type { DeploymentTypeOptions } from '../models/index';
14
+ /**
15
+ *
16
+ */
17
+ export declare class DeploymentTypeApi extends runtime.BaseAPI {
18
+ /**
19
+ * Returns the deployment type configuration (e.g., SaaS, OnPrem) for this instance.
20
+ */
21
+ deploymentTypeGetDeploymentTypeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeploymentTypeOptions>>;
22
+ /**
23
+ * Returns the deployment type configuration (e.g., SaaS, OnPrem) for this instance.
24
+ */
25
+ deploymentTypeGetDeploymentType(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeploymentTypeOptions>;
26
+ }
@@ -0,0 +1,74 @@
1
+ /**
2
+ * StudioAdmin API
3
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ *
5
+ * The version of the OpenAPI document: V1
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import * as runtime from '../runtime';
13
+ import type { GroupDto, GroupDtoPagedResult, GroupToAddDto } from '../models/index';
14
+ export interface GroupAddGroupRequest {
15
+ groupToAddDto?: GroupToAddDto;
16
+ }
17
+ export interface GroupDeleteGroupRequest {
18
+ groupIdentifier: string;
19
+ }
20
+ export interface GroupGetAllGroupsRequest {
21
+ pageIndex?: number;
22
+ pageSize?: number;
23
+ }
24
+ export interface GroupGetGroupByIdentifierRequest {
25
+ identifier: string;
26
+ }
27
+ export interface GroupSaveGroupPoliciesRequest {
28
+ groupDto?: GroupDto;
29
+ }
30
+ /**
31
+ *
32
+ */
33
+ export declare class GroupApi extends runtime.BaseAPI {
34
+ /**
35
+ * Adds a new group to the governance system.
36
+ */
37
+ groupAddGroupRaw(requestParameters: GroupAddGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GroupDto>>;
38
+ /**
39
+ * Adds a new group to the governance system.
40
+ */
41
+ groupAddGroup(requestParameters?: GroupAddGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GroupDto>;
42
+ /**
43
+ * Deletes a group and all its policy assignments.
44
+ */
45
+ groupDeleteGroupRaw(requestParameters: GroupDeleteGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GroupDto>>;
46
+ /**
47
+ * Deletes a group and all its policy assignments.
48
+ */
49
+ groupDeleteGroup(requestParameters: GroupDeleteGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GroupDto>;
50
+ /**
51
+ * Returns a paged list of all groups, syncing the latest data from CIS.
52
+ */
53
+ groupGetAllGroupsRaw(requestParameters: GroupGetAllGroupsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GroupDtoPagedResult>>;
54
+ /**
55
+ * Returns a paged list of all groups, syncing the latest data from CIS.
56
+ */
57
+ groupGetAllGroups(requestParameters?: GroupGetAllGroupsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GroupDtoPagedResult>;
58
+ /**
59
+ * Returns a single group by its identifier.
60
+ */
61
+ groupGetGroupByIdentifierRaw(requestParameters: GroupGetGroupByIdentifierRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GroupDto>>;
62
+ /**
63
+ * Returns a single group by its identifier.
64
+ */
65
+ groupGetGroupByIdentifier(requestParameters: GroupGetGroupByIdentifierRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GroupDto>;
66
+ /**
67
+ * Saves (upserts) all policy assignments for a group.
68
+ */
69
+ groupSaveGroupPoliciesRaw(requestParameters: GroupSaveGroupPoliciesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GroupDto>>;
70
+ /**
71
+ * Saves (upserts) all policy assignments for a group.
72
+ */
73
+ groupSaveGroupPolicies(requestParameters?: GroupSaveGroupPoliciesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GroupDto>;
74
+ }
@@ -0,0 +1,196 @@
1
+ /**
2
+ * StudioAdmin API
3
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ *
5
+ * The version of the OpenAPI document: V1
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import * as runtime from '../runtime';
13
+ import type { CompatibilityReportRequest, CompatibilityReportResponse, DataMoveRequest, DataMoveResponse, DeleteRequest, DeleteResponse, FinalizeRequest, MaintenanceModeRequest, MaintenanceModeResponse, PropertiesResponse, RollbackRequest, RollbackResponse } from '../models/index';
14
+ export interface GwsPartitionMoveDeletePartitionFromSourceRequest {
15
+ partitionId: string;
16
+ deleteRequest?: DeleteRequest;
17
+ }
18
+ export interface GwsPartitionMoveFinalizeOnDestinationRequest {
19
+ partitionId: string;
20
+ finalizeRequest?: FinalizeRequest;
21
+ }
22
+ export interface GwsPartitionMoveFinalizeOnSourceRequest {
23
+ partitionId: string;
24
+ finalizeRequest?: FinalizeRequest;
25
+ }
26
+ export interface GwsPartitionMoveGenerateDataCompatibilityReportOnDestinationRequest {
27
+ partitionId: string;
28
+ compatibilityReportRequest?: CompatibilityReportRequest;
29
+ }
30
+ export interface GwsPartitionMoveGenerateDataCompatibilityReportOnSourceRequest {
31
+ partitionId: string;
32
+ compatibilityReportRequest?: CompatibilityReportRequest;
33
+ }
34
+ export interface GwsPartitionMoveGetPropertiesOnDestinationRequest {
35
+ partitionId: string;
36
+ }
37
+ export interface GwsPartitionMoveGetPropertiesOnSourceRequest {
38
+ partitionId: string;
39
+ }
40
+ export interface GwsPartitionMoveRollbackMigrationOnDestinationRequest {
41
+ partitionId: string;
42
+ rollbackRequest?: RollbackRequest;
43
+ }
44
+ export interface GwsPartitionMoveRollbackMigrationOnSourceRequest {
45
+ partitionId: string;
46
+ rollbackRequest?: RollbackRequest;
47
+ }
48
+ export interface GwsPartitionMoveRunDataMoveOnDestinationRequest {
49
+ partitionId: string;
50
+ dataMoveRequest?: DataMoveRequest;
51
+ }
52
+ export interface GwsPartitionMoveRunDataMoveOnSourceRequest {
53
+ partitionId: string;
54
+ dataMoveRequest?: DataMoveRequest;
55
+ }
56
+ export interface GwsPartitionMoveRunPreMaintenanceDataMoveOnDestinationRequest {
57
+ partitionId: string;
58
+ dataMoveRequest?: DataMoveRequest;
59
+ }
60
+ export interface GwsPartitionMoveRunPreMaintenanceDataMoveOnSourceRequest {
61
+ partitionId: string;
62
+ dataMoveRequest?: DataMoveRequest;
63
+ }
64
+ export interface GwsPartitionMoveStartMaintenanceModeOnDestinationRequest {
65
+ partitionId: string;
66
+ maintenanceModeRequest?: MaintenanceModeRequest;
67
+ }
68
+ export interface GwsPartitionMoveStartMaintenanceModeOnSourceRequest {
69
+ partitionId: string;
70
+ maintenanceModeRequest?: MaintenanceModeRequest;
71
+ }
72
+ /**
73
+ *
74
+ */
75
+ export declare class GwsPartitionMoveApi extends runtime.BaseAPI {
76
+ /**
77
+ * Deletes partition data from the source after a successful move to the destination.
78
+ */
79
+ gwsPartitionMoveDeletePartitionFromSourceRaw(requestParameters: GwsPartitionMoveDeletePartitionFromSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteResponse>>;
80
+ /**
81
+ * Deletes partition data from the source after a successful move to the destination.
82
+ */
83
+ gwsPartitionMoveDeletePartitionFromSource(requestParameters: GwsPartitionMoveDeletePartitionFromSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteResponse>;
84
+ /**
85
+ * Finalizes the partition migration on the destination side, completing the move workflow.
86
+ */
87
+ gwsPartitionMoveFinalizeOnDestinationRaw(requestParameters: GwsPartitionMoveFinalizeOnDestinationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
88
+ /**
89
+ * Finalizes the partition migration on the destination side, completing the move workflow.
90
+ */
91
+ gwsPartitionMoveFinalizeOnDestination(requestParameters: GwsPartitionMoveFinalizeOnDestinationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
92
+ /**
93
+ * Finalizes the partition migration on the source side, completing the move workflow.
94
+ */
95
+ gwsPartitionMoveFinalizeOnSourceRaw(requestParameters: GwsPartitionMoveFinalizeOnSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
96
+ /**
97
+ * Finalizes the partition migration on the source side, completing the move workflow.
98
+ */
99
+ gwsPartitionMoveFinalizeOnSource(requestParameters: GwsPartitionMoveFinalizeOnSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
100
+ /**
101
+ * Generates a pre or post data-move compatibility report on the destination for the given partition.
102
+ */
103
+ gwsPartitionMoveGenerateDataCompatibilityReportOnDestinationRaw(requestParameters: GwsPartitionMoveGenerateDataCompatibilityReportOnDestinationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompatibilityReportResponse>>;
104
+ /**
105
+ * Generates a pre or post data-move compatibility report on the destination for the given partition.
106
+ */
107
+ gwsPartitionMoveGenerateDataCompatibilityReportOnDestination(requestParameters: GwsPartitionMoveGenerateDataCompatibilityReportOnDestinationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompatibilityReportResponse>;
108
+ /**
109
+ * Generates a pre or post data-move compatibility report on the source for the given partition.
110
+ */
111
+ gwsPartitionMoveGenerateDataCompatibilityReportOnSourceRaw(requestParameters: GwsPartitionMoveGenerateDataCompatibilityReportOnSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompatibilityReportResponse>>;
112
+ /**
113
+ * Generates a pre or post data-move compatibility report on the source for the given partition.
114
+ */
115
+ gwsPartitionMoveGenerateDataCompatibilityReportOnSource(requestParameters: GwsPartitionMoveGenerateDataCompatibilityReportOnSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompatibilityReportResponse>;
116
+ /**
117
+ * Retrieves partition move properties from the destination side.
118
+ */
119
+ gwsPartitionMoveGetPropertiesOnDestinationRaw(requestParameters: GwsPartitionMoveGetPropertiesOnDestinationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PropertiesResponse>>;
120
+ /**
121
+ * Retrieves partition move properties from the destination side.
122
+ */
123
+ gwsPartitionMoveGetPropertiesOnDestination(requestParameters: GwsPartitionMoveGetPropertiesOnDestinationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PropertiesResponse>;
124
+ /**
125
+ * Retrieves partition move properties from the source side.
126
+ */
127
+ gwsPartitionMoveGetPropertiesOnSourceRaw(requestParameters: GwsPartitionMoveGetPropertiesOnSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PropertiesResponse>>;
128
+ /**
129
+ * Retrieves partition move properties from the source side.
130
+ */
131
+ gwsPartitionMoveGetPropertiesOnSource(requestParameters: GwsPartitionMoveGetPropertiesOnSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PropertiesResponse>;
132
+ /**
133
+ * Rolls back the partition migration on the destination, reverting any imported data.
134
+ */
135
+ gwsPartitionMoveRollbackMigrationOnDestinationRaw(requestParameters: GwsPartitionMoveRollbackMigrationOnDestinationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RollbackResponse>>;
136
+ /**
137
+ * Rolls back the partition migration on the destination, reverting any imported data.
138
+ */
139
+ gwsPartitionMoveRollbackMigrationOnDestination(requestParameters: GwsPartitionMoveRollbackMigrationOnDestinationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RollbackResponse>;
140
+ /**
141
+ * Rolls back the partition migration on the source, restoring it to its pre-move state.
142
+ */
143
+ gwsPartitionMoveRollbackMigrationOnSourceRaw(requestParameters: GwsPartitionMoveRollbackMigrationOnSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RollbackResponse>>;
144
+ /**
145
+ * Rolls back the partition migration on the source, restoring it to its pre-move state.
146
+ */
147
+ gwsPartitionMoveRollbackMigrationOnSource(requestParameters: GwsPartitionMoveRollbackMigrationOnSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RollbackResponse>;
148
+ /**
149
+ * Executes the full data move into the destination partition.
150
+ */
151
+ gwsPartitionMoveRunDataMoveOnDestinationRaw(requestParameters: GwsPartitionMoveRunDataMoveOnDestinationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataMoveResponse>>;
152
+ /**
153
+ * Executes the full data move into the destination partition.
154
+ */
155
+ gwsPartitionMoveRunDataMoveOnDestination(requestParameters: GwsPartitionMoveRunDataMoveOnDestinationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataMoveResponse>;
156
+ /**
157
+ * Executes the full data move from the source partition.
158
+ */
159
+ gwsPartitionMoveRunDataMoveOnSourceRaw(requestParameters: GwsPartitionMoveRunDataMoveOnSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataMoveResponse>>;
160
+ /**
161
+ * Executes the full data move from the source partition.
162
+ */
163
+ gwsPartitionMoveRunDataMoveOnSource(requestParameters: GwsPartitionMoveRunDataMoveOnSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataMoveResponse>;
164
+ /**
165
+ * Executes a pre-maintenance data sync on the destination. Currently a no-op; always returns Completed.
166
+ */
167
+ gwsPartitionMoveRunPreMaintenanceDataMoveOnDestinationRaw(requestParameters: GwsPartitionMoveRunPreMaintenanceDataMoveOnDestinationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataMoveResponse>>;
168
+ /**
169
+ * Executes a pre-maintenance data sync on the destination. Currently a no-op; always returns Completed.
170
+ */
171
+ gwsPartitionMoveRunPreMaintenanceDataMoveOnDestination(requestParameters: GwsPartitionMoveRunPreMaintenanceDataMoveOnDestinationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataMoveResponse>;
172
+ /**
173
+ * Executes a pre-maintenance data sync on the source. Currently a no-op; always returns Completed.
174
+ */
175
+ gwsPartitionMoveRunPreMaintenanceDataMoveOnSourceRaw(requestParameters: GwsPartitionMoveRunPreMaintenanceDataMoveOnSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataMoveResponse>>;
176
+ /**
177
+ * Executes a pre-maintenance data sync on the source. Currently a no-op; always returns Completed.
178
+ */
179
+ gwsPartitionMoveRunPreMaintenanceDataMoveOnSource(requestParameters: GwsPartitionMoveRunPreMaintenanceDataMoveOnSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataMoveResponse>;
180
+ /**
181
+ * Puts the destination partition into maintenance mode in preparation for receiving data.
182
+ */
183
+ gwsPartitionMoveStartMaintenanceModeOnDestinationRaw(requestParameters: GwsPartitionMoveStartMaintenanceModeOnDestinationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MaintenanceModeResponse>>;
184
+ /**
185
+ * Puts the destination partition into maintenance mode in preparation for receiving data.
186
+ */
187
+ gwsPartitionMoveStartMaintenanceModeOnDestination(requestParameters: GwsPartitionMoveStartMaintenanceModeOnDestinationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MaintenanceModeResponse>;
188
+ /**
189
+ * Puts the source partition into maintenance mode, blocking new governance requests.
190
+ */
191
+ gwsPartitionMoveStartMaintenanceModeOnSourceRaw(requestParameters: GwsPartitionMoveStartMaintenanceModeOnSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MaintenanceModeResponse>>;
192
+ /**
193
+ * Puts the source partition into maintenance mode, blocking new governance requests.
194
+ */
195
+ gwsPartitionMoveStartMaintenanceModeOnSource(requestParameters: GwsPartitionMoveStartMaintenanceModeOnSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MaintenanceModeResponse>;
196
+ }
@@ -0,0 +1,27 @@
1
+ /**
2
+ * StudioAdmin API
3
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ *
5
+ * The version of the OpenAPI document: V1
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import * as runtime from '../runtime';
13
+ /**
14
+ *
15
+ */
16
+ export declare class HomeApi extends runtime.BaseAPI {
17
+ /**
18
+ * Resolves the current partition name from the request context and builds the redirect URL as `{GovernanceWebUrl}{partitionName}/roboticsops_/home`. No redirect occurs if the partition cannot be resolved.
19
+ * Redirects the root URL to the governance web UI for the current partition.
20
+ */
21
+ homeRedirectToWebRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
22
+ /**
23
+ * Resolves the current partition name from the request context and builds the redirect URL as `{GovernanceWebUrl}{partitionName}/roboticsops_/home`. No redirect occurs if the partition cannot be resolved.
24
+ * Redirects the root URL to the governance web UI for the current partition.
25
+ */
26
+ homeRedirectToWeb(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
27
+ }