@appsemble/utils 0.29.11 → 0.30.1

package/api/paths/apps/appId/secrets/saml/secretId.js

@@ -0,0 +1,39 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { $ref: '#/components/parameters/appSamlSecretId' },
+    ],
+    put: {
+        tags: ['main', 'app', 'secret', 'saml'],
+        operationId: 'updateAppSamlSecret',
+        requestBody: {
+            content: {
+                'application/json': {
+                    schema: {},
+                },
+            },
+        },
+        security: [{ studio: [] }],
+        responses: {
+            200: {
+                description: 'The updated SAML secret.',
+                content: {
+                    'application/json': {
+                        schema: {},
+                    },
+                },
+            },
+        },
+    },
+    delete: {
+        tags: ['main', 'app', 'secret', 'saml'],
+        operationId: 'deleteAppSamlSecret',
+        security: [{ studio: [] }],
+        responses: {
+            204: {
+                description: 'The deleted SAML secret.',
+            },
+        },
+    },
+};
+//# sourceMappingURL=secretId.js.map

package/api/paths/apps/appId/secrets/saml.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const pathItems: OpenAPIV3.PathItemObject;

package/api/paths/apps/appId/secrets/saml.js

@@ -0,0 +1,54 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    post: {
+        tags: ['main', 'app', 'secret', 'saml'],
+        operationId: 'createAppSamlSecret',
+        requestBody: {
+            content: {
+                'application/json': {
+                    schema: {},
+                },
+            },
+        },
+        security: [{ studio: [] }, { cli: ['apps:write'] }],
+        responses: {
+            201: {
+                description: 'A list of the SAML secrets for the app.',
+                content: {
+                    'application/json': {
+                        schema: {},
+                    },
+                },
+            },
+        },
+    },
+    get: {
+        tags: ['main', 'app', 'secret', 'saml'],
+        operationId: 'getAppSamlSecrets',
+        security: [{ studio: [] }],
+        responses: {
+            200: {
+                description: 'A list of the SAML secrets for the app.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: {},
+                        },
+                    },
+                },
+            },
+        },
+    },
+    delete: {
+        tags: ['main', 'app', 'secret', 'saml'],
+        operationId: 'deleteAppSamlSecrets',
+        security: [{ studio: [] }, { cli: ['apps:write'] }],
+        responses: {
+            204: {
+                description: 'The deleted app saml secrets.',
+            },
+        },
+    },
+};
+//# sourceMappingURL=saml.js.map

package/api/paths/apps/appId/secrets/scim.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const pathItems: OpenAPIV3.PathItemObject;

package/api/paths/apps/appId/secrets/scim.js

@@ -0,0 +1,43 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    get: {
+        tags: ['main', 'app', 'secret', 'scim'],
+        operationId: 'getAppScimSecret',
+        description: 'Get app SCIM secret configuration',
+        security: [{ studio: [] }],
+        responses: {
+            200: {
+                description: 'The app SCIM configuration',
+                content: {
+                    'application/json': {
+                        schema: { $ref: '#/components/schemas/ScimSecret' },
+                    },
+                },
+            },
+        },
+    },
+    patch: {
+        tags: ['main', 'app', 'secret', 'scim'],
+        operationId: 'updateAppScimSecret',
+        description: 'Update app SCIM secret configuration',
+        requestBody: {
+            content: {
+                'application/json': {
+                    schema: { $ref: '#/components/schemas/ScimSecret' },
+                },
+            },
+        },
+        security: [{ studio: [] }, { cli: ['apps:write'] }],
+        responses: {
+            200: {
+                description: 'The app SCIM configuration',
+                content: {
+                    'application/json': {
+                        schema: { $ref: '#/components/schemas/ScimSecret' },
+                    },
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=scim.js.map

package/api/paths/apps/appId/secrets/service/secretId.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const pathItems: OpenAPIV3.PathItemObject;

package/api/paths/apps/appId/secrets/service/secretId.js

@@ -0,0 +1,39 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { $ref: '#/components/parameters/serviceSecretId' },
+    ],
+    put: {
+        tags: ['main', 'app', 'secret', 'service'],
+        operationId: 'updateAppServiceSecret',
+        requestBody: {
+            content: {
+                'application/json': {
+                    schema: { $ref: '#/components/schemas/AppServiceSecret' },
+                },
+            },
+        },
+        security: [{ studio: [] }],
+        responses: {
+            200: {
+                description: 'The updated app service secret.',
+                content: {
+                    'application/json': {
+                        schema: { $ref: '#/components/schemas/AppServiceSecret' },
+                    },
+                },
+            },
+        },
+    },
+    delete: {
+        tags: ['main', 'app', 'secret', 'service'],
+        operationId: 'deleteAppServiceSecret',
+        security: [{ studio: [] }],
+        responses: {
+            204: {
+                description: 'The deleted app service secret.',
+            },
+        },
+    },
+};
+//# sourceMappingURL=secretId.js.map

package/api/paths/apps/appId/secrets/service.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const pathItems: OpenAPIV3.PathItemObject;

package/api/paths/apps/appId/secrets/service.js

@@ -0,0 +1,54 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    post: {
+        tags: ['main', 'app', 'secret', 'service'],
+        operationId: 'createAppServiceSecret',
+        requestBody: {
+            content: {
+                'application/json': {
+                    schema: { $ref: '#/components/schemas/AppServiceSecret' },
+                },
+            },
+        },
+        security: [{ studio: [] }, { cli: ['apps:write'] }],
+        responses: {
+            201: {
+                description: 'The created app service secret.',
+                content: {
+                    'application/json': {
+                        schema: { $ref: '#/components/schemas/AppServiceSecret' },
+                    },
+                },
+            },
+        },
+    },
+    get: {
+        tags: ['main', 'app', 'secret', 'service'],
+        operationId: 'getAppServiceSecrets',
+        security: [{ studio: [] }],
+        responses: {
+            200: {
+                description: 'The list of app service secrets.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: { $ref: '#/components/schemas/AppServiceSecret' },
+                        },
+                    },
+                },
+            },
+        },
+    },
+    delete: {
+        tags: ['main', 'app', 'secret', 'service'],
+        operationId: 'deleteAppServiceSecrets',
+        security: [{ studio: [] }, { cli: ['apps:write'] }],
+        responses: {
+            204: {
+                description: 'The deleted app service secrets.',
+            },
+        },
+    },
+};
+//# sourceMappingURL=service.js.map

package/api/paths/apps/appId/secrets/ssl.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const pathItems: OpenAPIV3.PathItemObject;

package/api/paths/apps/appId/secrets/ssl.js

@@ -0,0 +1,37 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    get: {
+        tags: ['main', 'app', 'secret', 'ssl'],
+        description: 'Get the SSL certificate of an app',
+        operationId: 'getAppSslSecret',
+        responses: {
+            200: {
+                description: 'The SSL secret of the app.',
+                $ref: '#/components/schemas/SSLSecret',
+            },
+        },
+        security: [{ studio: [] }],
+    },
+    put: {
+        tags: ['main', 'app', 'secret', 'ssl'],
+        description: 'Update the app’s SSL secret',
+        operationId: 'updateAppSslSecret',
+        requestBody: {
+            content: {
+                'application/json': {
+                    schema: {
+                        $ref: '#/components/schemas/SSLSecret',
+                    },
+                },
+            },
+        },
+        responses: {
+            200: {
+                description: 'The updated SSL secret.',
+                $ref: '#/components/schemas/SSLSecret',
+            },
+        },
+        security: [{ studio: [] }, { cli: ['apps:write'] }],
+    },
+};
+//# sourceMappingURL=ssl.js.map

package/api/paths/apps/appId/snapshots/snapshotId.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const pathItems: OpenAPIV3.PathItemObject;

package/api/paths/apps/appId/snapshots/snapshotId.js

@@ -0,0 +1,47 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        {
+            name: 'snapshotId',
+            in: 'path',
+            description: 'The ID of the snapshot',
+            required: true,
+            schema: { type: 'number', description: 'The ID of the snapshot.' },
+        },
+    ],
+    get: {
+        tags: ['main', 'app', 'snapshot'],
+        description: 'Get a single snapshot made of the app.',
+        operationId: 'getAppSnapshot',
+        responses: {
+            200: {
+                description: 'The snapshot',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'object',
+                            properties: {
+                                id: { type: 'integer', description: 'The ID of the snapshot.' },
+                                yaml: { type: 'string', description: 'The app definition.' },
+                                $created: {
+                                    type: 'string',
+                                    format: 'date-time',
+                                    description: 'The creation date of the snapshot.',
+                                },
+                                $author: {
+                                    type: 'object',
+                                    properties: {
+                                        id: { $ref: '#/components/schemas/User/properties/id' },
+                                        name: { $ref: '#/components/schemas/User/properties/name' },
+                                    },
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }, { cli: ['apps:write'] }],
+    },
+};
+//# sourceMappingURL=snapshotId.js.map

package/api/paths/apps/appId/snapshots.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const pathItems: OpenAPIV3.PathItemObject;

package/api/paths/apps/appId/snapshots.js

@@ -0,0 +1,40 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    get: {
+        tags: ['main', 'app', 'snapshot'],
+        description: 'Get a list of snapshots made of the app.',
+        operationId: 'getAppSnapshots',
+        responses: {
+            200: {
+                description: 'The available snapshots',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: {
+                                type: 'object',
+                                properties: {
+                                    id: { type: 'number', description: 'The ID of the snapshot.' },
+                                    $created: {
+                                        type: 'string',
+                                        format: 'date-time',
+                                        description: 'The creation date of the snapshot.',
+                                    },
+                                    $author: {
+                                        type: 'object',
+                                        properties: {
+                                            id: { $ref: '#/components/schemas/User/properties/id' },
+                                            name: { $ref: '#/components/schemas/User/properties/name' },
+                                        },
+                                    },
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }, { cli: ['apps:write'] }],
+    },
+};
+//# sourceMappingURL=snapshots.js.map

package/api/paths/apps/appId/style/block/organizationId/blockId.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const pathItems: OpenAPIV3.PathItemObject;

package/api/paths/apps/appId/style/block/organizationId/blockId.js

@@ -0,0 +1,53 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { $ref: '#/components/parameters/organizationId' },
+        { $ref: '#/components/parameters/blockId' },
+    ],
+    get: {
+        tags: ['common', 'app'],
+        description: 'Get the app style for a block.',
+        operationId: 'getAppBlockStyle',
+        responses: {
+            200: {
+                description: 'The stylesheet associated with this block for this app.',
+                content: {
+                    'text/css': {},
+                },
+            },
+        },
+    },
+    post: {
+        tags: ['main', 'app', 'block'],
+        description: 'Upload a block stylesheet for this app.',
+        operationId: 'setAppBlockStyle',
+        requestBody: {
+            description: 'The new app block stylesheet.',
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'object',
+                        required: ['style'],
+                        properties: {
+                            style: {
+                                type: 'string',
+                            },
+                            force: {
+                                type: 'boolean',
+                                writeOnly: true,
+                                description: 'If this is true, the app lock is ignored.',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            204: {
+                description: 'The block style has been updated successfully.',
+            },
+        },
+        security: [{ studio: [] }, { cli: ['apps:write'] }],
+    },
+};
+//# sourceMappingURL=blockId.js.map

package/api/paths/apps/appId/style/core.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const pathItems: OpenAPIV3.PathItemObject;

package/api/paths/apps/appId/style/core.js

@@ -0,0 +1,17 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    get: {
+        tags: ['common', 'app'],
+        description: 'Get the core style for this app.',
+        operationId: 'getAppCoreStyle',
+        responses: {
+            200: {
+                description: 'The core stylesheet associated with this app.',
+                content: {
+                    'text/css': {},
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=core.js.map

package/api/paths/apps/appId/style/shared.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const pathItems: OpenAPIV3.PathItemObject;

package/api/paths/apps/appId/style/shared.js

@@ -0,0 +1,17 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    get: {
+        tags: ['common', 'app'],
+        description: 'Get the shared style for this app.',
+        operationId: 'getAppSharedStyle',
+        responses: {
+            200: {
+                description: 'The shared stylesheet associated with this app.',
+                content: {
+                    'text/css': {},
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=shared.js.map

package/api/paths/apps/appId/subscriptions.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const pathItems: OpenAPIV3.PathItemObject;

package/api/paths/apps/appId/subscriptions.js

@@ -0,0 +1,91 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    get: {
+        tags: ['main', 'app', 'subscription'],
+        parameters: [{ $ref: '#/components/parameters/endpoint' }],
+        description: 'Fetch all subscription settings of an app.',
+        operationId: 'getAppSubscription',
+        responses: {
+            200: {
+                description: 'The subscription settings.',
+                $ref: '#/components/responses/subscriptions',
+            },
+        },
+    },
+    post: {
+        tags: ['main', 'app', 'subscription'],
+        description: 'Subscribe to an app’s push notifications',
+        operationId: 'createAppSubscription',
+        requestBody: {
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'object',
+                        description: 'A serialized PushSubscription object',
+                        required: ['endpoint', 'keys'],
+                        properties: {
+                            endpoint: {
+                                type: 'string',
+                            },
+                            keys: {
+                                type: 'object',
+                                required: ['p256dh', 'auth'],
+                                properties: {
+                                    p256dh: { type: 'string' },
+                                    auth: { type: 'string' },
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            204: {
+                description: 'The subscription has successfully been registered.',
+            },
+        },
+        security: [{ studio: [] }, { app: ['openid'] }, {}],
+    },
+    patch: {
+        tags: ['main', 'app', 'subscription'],
+        description: 'Subscribe to an app’s push notifications. If value isn’t set it will toggle between subscribing and unsubscribing.',
+        operationId: 'updateAppSubscription',
+        requestBody: {
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'object',
+                        required: ['endpoint', 'resource', 'action'],
+                        properties: {
+                            endpoint: {
+                                type: 'string',
+                                format: 'uri',
+                            },
+                            resource: {
+                                type: 'string',
+                            },
+                            action: {
+                                type: 'string',
+                                enum: ['create', 'update', 'delete'],
+                            },
+                            value: {
+                                type: 'boolean',
+                            },
+                            resourceId: {
+                                type: 'number',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            204: {
+                description: 'The subscription has successfully been updated.',
+            },
+        },
+        security: [{ studio: [] }, { app: ['openid'] }, {}],
+    },
+};
+//# sourceMappingURL=subscriptions.js.map

package/api/paths/apps/appId/variables/variableId.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const pathItems: OpenAPIV3.PathItemObject;

package/api/paths/apps/appId/variables/variableId.js

@@ -0,0 +1,39 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { $ref: '#/components/parameters/appVariableId' },
+    ],
+    put: {
+        tags: ['main', 'app', 'variable'],
+        operationId: 'updateAppVariable',
+        requestBody: {
+            content: {
+                'application/json': {
+                    schema: { $ref: '#/components/schemas/AppVariable' },
+                },
+            },
+        },
+        security: [{ studio: [] }],
+        responses: {
+            200: {
+                description: 'The updated app variable.',
+                content: {
+                    'application/json': {
+                        schema: { $ref: '#/components/schemas/AppVariable' },
+                    },
+                },
+            },
+        },
+    },
+    delete: {
+        tags: ['main', 'app', 'variable'],
+        operationId: 'deleteAppVariable',
+        security: [{ studio: [] }],
+        responses: {
+            204: {
+                description: 'The deleted app variable.',
+            },
+        },
+    },
+};
+//# sourceMappingURL=variableId.js.map

package/api/paths/apps/appId/variables.d.ts

@@ -0,0 +1,2 @@
+import { type OpenAPIV3 } from 'openapi-types';
+export declare const pathItems: OpenAPIV3.PathItemObject;