@gobodo/gobodo-api-heyapi 1.0.0 → 1.0.1

package/dist/client/types.gen.d.ts

@@ -4116,6 +4116,25 @@ export type RbacPolicyValidationResponse = {
     policyId?: number;
     policyFormat?: 'JSON' | 'YAML' | 'REGO';
 };
+export type RbacPolicyDefaultsResult = {
+    schemaId?: number;
+    objectTypesProcessed?: number;
+    actionTypesProcessed?: number;
+    relationshipTypesProcessed?: number;
+    objectTypesFailed?: number;
+    actionTypesFailed?: number;
+    relationshipTypesFailed?: number;
+    policiesCreated?: number;
+    policiesExisting?: number;
+    errors?: Array<string>;
+};
+export type RbacTypePolicyDefaultsResult = {
+    typeKind?: 'objecttype' | 'actiontype' | 'relationshiptype';
+    typeId?: number;
+    created?: number;
+    existing?: number;
+    linkMode?: string;
+};
 export type RbacPrivilegeInput = {
     privilege?: string;
     scope?: RbacScopeReference;
@@ -36588,6 +36607,314 @@ export type UpsertRbacPolicyResponses = {
     200: RbacPolicy;
 };
 export type UpsertRbacPolicyResponse = UpsertRbacPolicyResponses[keyof UpsertRbacPolicyResponses];
+export type GenerateDefaultRbacPoliciesData = {
+    body?: never;
+    headers?: {
+        /**
+         * Not supported here: this write cannot be staged, so a request carrying a transaction id is rejected with 400 rather than run outside the transaction. Alias: X-Gobodo-Transaction-Id.
+         */
+        transactionid?: string;
+        /**
+         * Id of the organization page to perform this operation as; the caller must administer the page. Alias: X-Gobodo-Post-As-Page.
+         */
+        'zeusportal-postas'?: number;
+        /**
+         * Id of the application to perform this operation as; the caller must administer the application. Alias: X-Gobodo-Post-As-App.
+         */
+        'zeusportal-postas-app'?: number;
+        /**
+         * Id of the site to perform this operation as; the caller must administer the site. Alias: X-Gobodo-Post-As-Site.
+         */
+        'zeusportal-postas-site'?: number;
+        /**
+         * Id of the console organization to perform this operation as; the caller needs create permission in the organization. Alias: X-Gobodo-Post-As-Organization.
+         */
+        'zeusportal-postas-org'?: number;
+    };
+    path?: never;
+    query?: {
+        /**
+         * REST request cache key. Repeat the parameter or send one JSON array string. Applies only where the platform enables the REST request cache.
+         */
+        cachekey?: Array<string>;
+        /**
+         * Scope of the cachekey entry.
+         */
+        cachescope?: 'APPLICATION' | 'SESSION' | 'USER' | 'ALL';
+        /**
+         * Cache duration override in seconds, capped by the platform maximum.
+         */
+        cacheduration?: number;
+        /**
+         * Cache group(s) the cachekey entry belongs to. Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+         */
+        cachegroup?: Array<string>;
+        /**
+         * Users the cachekey entry applies to (used to clear entries cached for those users). Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+         */
+        cacheuser?: Array<string>;
+        /**
+         * On writes, a JSON array of {"key": [...], "scope": "APPLICATION|SESSION|USER|ALL"} entries whose cached responses are removed.
+         */
+        invalidationkeys?: string;
+    };
+    url: '/rbac/policies/generate-defaults';
+};
+export type GenerateDefaultRbacPoliciesResponses = {
+    /**
+     * OK
+     */
+    200: RbacPolicyDefaultsResult;
+};
+export type GenerateDefaultRbacPoliciesResponse = GenerateDefaultRbacPoliciesResponses[keyof GenerateDefaultRbacPoliciesResponses];
+export type GenerateSchemaDefaultRbacPoliciesData = {
+    body?: never;
+    headers?: {
+        /**
+         * Not supported here: this write cannot be staged, so a request carrying a transaction id is rejected with 400 rather than run outside the transaction. Alias: X-Gobodo-Transaction-Id.
+         */
+        transactionid?: string;
+        /**
+         * Id of the organization page to perform this operation as; the caller must administer the page. Alias: X-Gobodo-Post-As-Page.
+         */
+        'zeusportal-postas'?: number;
+        /**
+         * Id of the application to perform this operation as; the caller must administer the application. Alias: X-Gobodo-Post-As-App.
+         */
+        'zeusportal-postas-app'?: number;
+        /**
+         * Id of the site to perform this operation as; the caller must administer the site. Alias: X-Gobodo-Post-As-Site.
+         */
+        'zeusportal-postas-site'?: number;
+        /**
+         * Id of the console organization to perform this operation as; the caller needs create permission in the organization. Alias: X-Gobodo-Post-As-Organization.
+         */
+        'zeusportal-postas-org'?: number;
+    };
+    path: {
+        schemaId: number;
+    };
+    query?: {
+        /**
+         * REST request cache key. Repeat the parameter or send one JSON array string. Applies only where the platform enables the REST request cache.
+         */
+        cachekey?: Array<string>;
+        /**
+         * Scope of the cachekey entry.
+         */
+        cachescope?: 'APPLICATION' | 'SESSION' | 'USER' | 'ALL';
+        /**
+         * Cache duration override in seconds, capped by the platform maximum.
+         */
+        cacheduration?: number;
+        /**
+         * Cache group(s) the cachekey entry belongs to. Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+         */
+        cachegroup?: Array<string>;
+        /**
+         * Users the cachekey entry applies to (used to clear entries cached for those users). Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+         */
+        cacheuser?: Array<string>;
+        /**
+         * On writes, a JSON array of {"key": [...], "scope": "APPLICATION|SESSION|USER|ALL"} entries whose cached responses are removed.
+         */
+        invalidationkeys?: string;
+    };
+    url: '/rbac/policies/generate-defaults/schema/{schemaId}';
+};
+export type GenerateSchemaDefaultRbacPoliciesResponses = {
+    /**
+     * OK
+     */
+    200: RbacPolicyDefaultsResult;
+};
+export type GenerateSchemaDefaultRbacPoliciesResponse = GenerateSchemaDefaultRbacPoliciesResponses[keyof GenerateSchemaDefaultRbacPoliciesResponses];
+export type GenerateRelationshipTypeDefaultRbacPoliciesData = {
+    body?: never;
+    headers?: {
+        /**
+         * Not supported here: this write cannot be staged, so a request carrying a transaction id is rejected with 400 rather than run outside the transaction. Alias: X-Gobodo-Transaction-Id.
+         */
+        transactionid?: string;
+        /**
+         * Id of the organization page to perform this operation as; the caller must administer the page. Alias: X-Gobodo-Post-As-Page.
+         */
+        'zeusportal-postas'?: number;
+        /**
+         * Id of the application to perform this operation as; the caller must administer the application. Alias: X-Gobodo-Post-As-App.
+         */
+        'zeusportal-postas-app'?: number;
+        /**
+         * Id of the site to perform this operation as; the caller must administer the site. Alias: X-Gobodo-Post-As-Site.
+         */
+        'zeusportal-postas-site'?: number;
+        /**
+         * Id of the console organization to perform this operation as; the caller needs create permission in the organization. Alias: X-Gobodo-Post-As-Organization.
+         */
+        'zeusportal-postas-org'?: number;
+    };
+    path: {
+        typeId: number;
+    };
+    query?: {
+        /**
+         * REST request cache key. Repeat the parameter or send one JSON array string. Applies only where the platform enables the REST request cache.
+         */
+        cachekey?: Array<string>;
+        /**
+         * Scope of the cachekey entry.
+         */
+        cachescope?: 'APPLICATION' | 'SESSION' | 'USER' | 'ALL';
+        /**
+         * Cache duration override in seconds, capped by the platform maximum.
+         */
+        cacheduration?: number;
+        /**
+         * Cache group(s) the cachekey entry belongs to. Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+         */
+        cachegroup?: Array<string>;
+        /**
+         * Users the cachekey entry applies to (used to clear entries cached for those users). Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+         */
+        cacheuser?: Array<string>;
+        /**
+         * On writes, a JSON array of {"key": [...], "scope": "APPLICATION|SESSION|USER|ALL"} entries whose cached responses are removed.
+         */
+        invalidationkeys?: string;
+    };
+    url: '/rbac/policies/generate-defaults/relationshiptype/{typeId}';
+};
+export type GenerateRelationshipTypeDefaultRbacPoliciesResponses = {
+    /**
+     * OK
+     */
+    200: RbacTypePolicyDefaultsResult;
+};
+export type GenerateRelationshipTypeDefaultRbacPoliciesResponse = GenerateRelationshipTypeDefaultRbacPoliciesResponses[keyof GenerateRelationshipTypeDefaultRbacPoliciesResponses];
+export type GenerateObjectTypeDefaultRbacPoliciesData = {
+    body?: never;
+    headers?: {
+        /**
+         * Not supported here: this write cannot be staged, so a request carrying a transaction id is rejected with 400 rather than run outside the transaction. Alias: X-Gobodo-Transaction-Id.
+         */
+        transactionid?: string;
+        /**
+         * Id of the organization page to perform this operation as; the caller must administer the page. Alias: X-Gobodo-Post-As-Page.
+         */
+        'zeusportal-postas'?: number;
+        /**
+         * Id of the application to perform this operation as; the caller must administer the application. Alias: X-Gobodo-Post-As-App.
+         */
+        'zeusportal-postas-app'?: number;
+        /**
+         * Id of the site to perform this operation as; the caller must administer the site. Alias: X-Gobodo-Post-As-Site.
+         */
+        'zeusportal-postas-site'?: number;
+        /**
+         * Id of the console organization to perform this operation as; the caller needs create permission in the organization. Alias: X-Gobodo-Post-As-Organization.
+         */
+        'zeusportal-postas-org'?: number;
+    };
+    path: {
+        typeId: number;
+    };
+    query?: {
+        /**
+         * REST request cache key. Repeat the parameter or send one JSON array string. Applies only where the platform enables the REST request cache.
+         */
+        cachekey?: Array<string>;
+        /**
+         * Scope of the cachekey entry.
+         */
+        cachescope?: 'APPLICATION' | 'SESSION' | 'USER' | 'ALL';
+        /**
+         * Cache duration override in seconds, capped by the platform maximum.
+         */
+        cacheduration?: number;
+        /**
+         * Cache group(s) the cachekey entry belongs to. Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+         */
+        cachegroup?: Array<string>;
+        /**
+         * Users the cachekey entry applies to (used to clear entries cached for those users). Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+         */
+        cacheuser?: Array<string>;
+        /**
+         * On writes, a JSON array of {"key": [...], "scope": "APPLICATION|SESSION|USER|ALL"} entries whose cached responses are removed.
+         */
+        invalidationkeys?: string;
+    };
+    url: '/rbac/policies/generate-defaults/objecttype/{typeId}';
+};
+export type GenerateObjectTypeDefaultRbacPoliciesResponses = {
+    /**
+     * OK
+     */
+    200: RbacTypePolicyDefaultsResult;
+};
+export type GenerateObjectTypeDefaultRbacPoliciesResponse = GenerateObjectTypeDefaultRbacPoliciesResponses[keyof GenerateObjectTypeDefaultRbacPoliciesResponses];
+export type GenerateActionTypeDefaultRbacPoliciesData = {
+    body?: never;
+    headers?: {
+        /**
+         * Not supported here: this write cannot be staged, so a request carrying a transaction id is rejected with 400 rather than run outside the transaction. Alias: X-Gobodo-Transaction-Id.
+         */
+        transactionid?: string;
+        /**
+         * Id of the organization page to perform this operation as; the caller must administer the page. Alias: X-Gobodo-Post-As-Page.
+         */
+        'zeusportal-postas'?: number;
+        /**
+         * Id of the application to perform this operation as; the caller must administer the application. Alias: X-Gobodo-Post-As-App.
+         */
+        'zeusportal-postas-app'?: number;
+        /**
+         * Id of the site to perform this operation as; the caller must administer the site. Alias: X-Gobodo-Post-As-Site.
+         */
+        'zeusportal-postas-site'?: number;
+        /**
+         * Id of the console organization to perform this operation as; the caller needs create permission in the organization. Alias: X-Gobodo-Post-As-Organization.
+         */
+        'zeusportal-postas-org'?: number;
+    };
+    path: {
+        typeId: number;
+    };
+    query?: {
+        /**
+         * REST request cache key. Repeat the parameter or send one JSON array string. Applies only where the platform enables the REST request cache.
+         */
+        cachekey?: Array<string>;
+        /**
+         * Scope of the cachekey entry.
+         */
+        cachescope?: 'APPLICATION' | 'SESSION' | 'USER' | 'ALL';
+        /**
+         * Cache duration override in seconds, capped by the platform maximum.
+         */
+        cacheduration?: number;
+        /**
+         * Cache group(s) the cachekey entry belongs to. Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+         */
+        cachegroup?: Array<string>;
+        /**
+         * Users the cachekey entry applies to (used to clear entries cached for those users). Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+         */
+        cacheuser?: Array<string>;
+        /**
+         * On writes, a JSON array of {"key": [...], "scope": "APPLICATION|SESSION|USER|ALL"} entries whose cached responses are removed.
+         */
+        invalidationkeys?: string;
+    };
+    url: '/rbac/policies/generate-defaults/actiontype/{typeId}';
+};
+export type GenerateActionTypeDefaultRbacPoliciesResponses = {
+    /**
+     * OK
+     */
+    200: RbacTypePolicyDefaultsResult;
+};
+export type GenerateActionTypeDefaultRbacPoliciesResponse = GenerateActionTypeDefaultRbacPoliciesResponses[keyof GenerateActionTypeDefaultRbacPoliciesResponses];
 export type RevokeRbacRolePrivilegeData = {
     body?: never;
     headers?: {
@@ -65160,6 +65487,68 @@ export type GetRbacAppAccessControlResponses = {
     200: RbacAccessControlCatalog;
 };
 export type GetRbacAppAccessControlResponse = GetRbacAppAccessControlResponses[keyof GetRbacAppAccessControlResponses];
+export type IsPublicationExistsData = {
+    body?: never;
+    headers?: {
+        /**
+         * Ignored on reads. Alias: X-Gobodo-Transaction-Id.
+         */
+        transactionid?: string;
+        /**
+         * Id of the organization page to perform this operation as; the caller must administer the page. Alias: X-Gobodo-Post-As-Page.
+         */
+        'zeusportal-postas'?: number;
+        /**
+         * Id of the application to perform this operation as; the caller must administer the application. Alias: X-Gobodo-Post-As-App.
+         */
+        'zeusportal-postas-app'?: number;
+        /**
+         * Id of the site to perform this operation as; the caller must administer the site. Alias: X-Gobodo-Post-As-Site.
+         */
+        'zeusportal-postas-site'?: number;
+        /**
+         * Id of the console organization to perform this operation as; the caller needs create permission in the organization. Alias: X-Gobodo-Post-As-Organization.
+         */
+        'zeusportal-postas-org'?: number;
+    };
+    path: {
+        id: number;
+    };
+    query?: {
+        /**
+         * REST request cache key. Repeat the parameter or send one JSON array string. Applies only where the platform enables the REST request cache.
+         */
+        cachekey?: Array<string>;
+        /**
+         * Scope of the cachekey entry.
+         */
+        cachescope?: 'APPLICATION' | 'SESSION' | 'USER' | 'ALL';
+        /**
+         * Cache duration override in seconds, capped by the platform maximum.
+         */
+        cacheduration?: number;
+        /**
+         * Cache group(s) the cachekey entry belongs to. Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+         */
+        cachegroup?: Array<string>;
+        /**
+         * Users the cachekey entry applies to (used to clear entries cached for those users). Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+         */
+        cacheuser?: Array<string>;
+        /**
+         * On writes, a JSON array of {"key": [...], "scope": "APPLICATION|SESSION|USER|ALL"} entries whose cached responses are removed.
+         */
+        invalidationkeys?: string;
+    };
+    url: '/publications/{id}/exists';
+};
+export type IsPublicationExistsResponses = {
+    /**
+     * OK
+     */
+    200: boolean;
+};
+export type IsPublicationExistsResponse = IsPublicationExistsResponses[keyof IsPublicationExistsResponses];
 export type ListPublicationsByMemberData = {
     body?: never;
     headers?: {