@appsemble/utils 0.29.10 → 0.30.1

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

@@ -0,0 +1,72 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { name: 'merge', in: 'query', schema: { type: 'boolean' } },
+        { name: 'includeMessages', in: 'query', schema: { type: 'boolean' } },
+    ],
+    get: {
+        tags: ['common', 'apps', 'language'],
+        description: 'Get a list of all languages with messages.',
+        operationId: 'getAppLanguages',
+        responses: {
+            200: {
+                description: 'The list of supported languages',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: {
+                                oneOf: [{ type: 'string' }, { $ref: '#/components/schemas/AppMessages' }],
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    },
+    post: {
+        tags: ['main', 'apps', 'language'],
+        description: 'Upload messages for the given language.',
+        operationId: 'createAppMessages',
+        requestBody: {
+            required: true,
+            content: {
+                'application/json': {
+                    schema: {
+                        oneOf: [
+                            { $ref: '#/components/schemas/AppMessages' },
+                            {
+                                type: 'array',
+                                items: {
+                                    $ref: '#/components/schemas/AppMessages',
+                                },
+                            },
+                        ],
+                    },
+                },
+            },
+        },
+        responses: {
+            201: {
+                description: 'The translation was created.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            oneOf: [
+                                { $ref: '#/components/schemas/AppMessages' },
+                                {
+                                    type: 'array',
+                                    items: {
+                                        $ref: '#/components/schemas/AppMessages',
+                                    },
+                                },
+                            ],
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }, { cli: ['apps:write'] }],
+    },
+};
+//# sourceMappingURL=messages.js.map

package/api/paths/apps/appId/quotas/emails.d.ts

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

package/api/paths/apps/appId/quotas/emails.js

@@ -0,0 +1,36 @@
+export const pathItems = {
+    get: {
+        tags: ['main', 'app', 'quota', 'email'],
+        operationId: 'getAppEmailQuota',
+        parameters: [{ $ref: '#/components/parameters/appId' }],
+        security: [{ studio: [] }, {}],
+        responses: {
+            200: {
+                description: 'Email quota for an app',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'object',
+                            properties: {
+                                used: {
+                                    type: 'number',
+                                    description: 'Number of emails sent today',
+                                },
+                                limit: {
+                                    type: 'number',
+                                    description: 'Maximum number of emails that can be sent today',
+                                },
+                                reset: {
+                                    type: 'string',
+                                    format: 'date-time',
+                                    description: 'Date and time when the quota resets',
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=emails.js.map

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

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

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

@@ -0,0 +1,58 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    get: {
+        tags: ['main', 'app', 'rating'],
+        description: 'Fetch all ratings of an app.',
+        operationId: 'getAppRatings',
+        responses: {
+            200: {
+                description: 'The list of apps ratings.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: {
+                                $ref: '#/components/schemas/Rating',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    },
+    post: {
+        tags: ['main', 'app', 'rating'],
+        description: 'Submit an app rating.',
+        operationId: 'createAppRating',
+        requestBody: {
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'object',
+                        required: ['rating'],
+                        properties: {
+                            rating: {
+                                $ref: '#/components/schemas/Rating/properties/rating',
+                            },
+                            description: {
+                                $ref: '#/components/schemas/Rating/properties/description',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            200: {
+                description: 'The submitted app rating.',
+                content: {
+                    'application/json': {
+                        schema: { $ref: '#/components/schemas/Asset/properties/id' },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }],
+    },
+};
+//# sourceMappingURL=ratings.js.map

package/api/paths/apps/appId/readmes/readmeId.d.ts

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

package/api/paths/apps/appId/readmes/readmeId.js

@@ -0,0 +1,17 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { $ref: '#/components/parameters/readmeId' },
+    ],
+    get: {
+        tags: ['main', 'app', 'readme'],
+        description: 'Get a readme of an app.',
+        operationId: 'getAppReadme',
+        responses: {
+            200: {
+                description: 'The app readme',
+            },
+        },
+    },
+};
+//# sourceMappingURL=readmeId.js.map

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

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

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

@@ -0,0 +1,12 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    post: {
+        tags: ['main', 'app'],
+        operationId: 'reseedDemoApp',
+        responses: {
+            200: { description: 'The app has successfully been reseeded.' },
+        },
+        security: [{ studio: ['apps:write'] }],
+    },
+};
+//# sourceMappingURL=reseed.js.map

package/api/paths/apps/appId/resources/resourceType/count.d.ts

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

package/api/paths/apps/appId/resources/resourceType/count.js

@@ -0,0 +1,30 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { $ref: '#/components/parameters/resourceType' },
+        { $ref: '#/components/parameters/selectedGroupId' },
+    ],
+    get: {
+        tags: ['common', 'app', 'resource'],
+        description: 'Get a count of all resources of this app.',
+        operationId: 'countAppResources',
+        parameters: [
+            { $ref: '#/components/parameters/$filter' },
+            { $ref: '#/components/parameters/$own' },
+        ],
+        responses: {
+            200: {
+                description: 'The count of all this app’s resources of this type.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'number',
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:read'] }, {}],
+    },
+};
+//# sourceMappingURL=count.js.map

package/api/paths/apps/appId/resources/resourceType/resourceId/subscriptions.d.ts

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

package/api/paths/apps/appId/resources/resourceType/resourceId/subscriptions.js

@@ -0,0 +1,31 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { $ref: '#/components/parameters/resourceType' },
+        { $ref: '#/components/parameters/resourceId' },
+        { $ref: '#/components/parameters/endpoint' },
+    ],
+    get: {
+        tags: ['common', 'app', 'resource', 'subscription'],
+        description: 'Get the subscription status of a resource.',
+        operationId: 'getAppResourceSubscription',
+        responses: {
+            200: {
+                description: 'The subscription status of the resource that matches the given id.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'object',
+                            properties: {
+                                id: { type: 'number' },
+                                update: { type: 'boolean' },
+                                delete: { type: 'boolean' },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=subscriptions.js.map

package/api/paths/apps/appId/resources/resourceType/resourceId.d.ts

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

package/api/paths/apps/appId/resources/resourceType/resourceId.js

@@ -0,0 +1,74 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { $ref: '#/components/parameters/resourceType' },
+        { $ref: '#/components/parameters/resourceId' },
+        { $ref: '#/components/parameters/selectedGroupId' },
+    ],
+    get: {
+        tags: ['common', 'app', 'resource'],
+        parameters: [
+            { $ref: '#/components/parameters/view' },
+            {
+                name: '$own',
+                schema: { type: 'boolean' },
+                description: 'If the resources created by the authenticated app member should be included',
+                in: 'query',
+            },
+        ],
+        description: 'Get a single app resource.',
+        operationId: 'getAppResourceById',
+        responses: {
+            200: {
+                description: 'The resource that matches the given id.',
+                $ref: '#/components/responses/resource',
+            },
+        },
+        security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:read'] }, {}],
+    },
+    put: {
+        tags: ['common', 'app', 'resource'],
+        description: 'Update an existing app resource.',
+        operationId: 'updateAppResource',
+        requestBody: {
+            required: true,
+            $ref: '#/components/requestBodies/resource',
+        },
+        responses: {
+            200: {
+                description: 'The updated resource.',
+                $ref: '#/components/responses/resource',
+            },
+        },
+        security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:write'] }, {}],
+    },
+    patch: {
+        tags: ['common', 'app', 'resource'],
+        description: 'Patch an existing app resource.',
+        operationId: 'patchAppResource',
+        requestBody: {
+            required: true,
+            $ref: '#/components/requestBodies/resource',
+        },
+        responses: {
+            200: {
+                description: 'The patched resource.',
+                $ref: '#/components/responses/resource',
+            },
+        },
+        security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:write'] }, {}],
+    },
+    delete: {
+        tags: ['common', 'app', 'resource'],
+        description: 'Delete an existing app resource.',
+        operationId: 'deleteAppResource',
+        responses: {
+            204: {
+                description: 'The app resource has been deleted successfully.',
+                $ref: '#/components/responses/resource',
+            },
+        },
+        security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:write'] }, {}],
+    },
+};
+//# sourceMappingURL=resourceId.js.map

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

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

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

@@ -0,0 +1,26 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { $ref: '#/components/parameters/resourceType' },
+        { $ref: '#/components/parameters/endpoint' },
+    ],
+    get: {
+        tags: ['common', 'app', 'resource', 'subscription'],
+        description: 'Get the current subscription status of this resource.',
+        operationId: 'getAppResourceTypeSubscription',
+        responses: {
+            200: {
+                description: 'The subscription status for this resource.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            $ref: '#/components/schemas/ResourceSubscription',
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }, { app: ['openid'] }, {}],
+    },
+};
+//# sourceMappingURL=subscriptions.js.map

package/api/paths/apps/appId/resources/resourceType.d.ts

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

package/api/paths/apps/appId/resources/resourceType.js

@@ -0,0 +1,171 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { $ref: '#/components/parameters/resourceType' },
+        { $ref: '#/components/parameters/selectedGroupId' },
+    ],
+    get: {
+        tags: ['common', 'app', 'resource'],
+        description: 'Get all resources of this app.',
+        operationId: 'queryAppResources',
+        parameters: [
+            { $ref: '#/components/parameters/view' },
+            { $ref: '#/components/parameters/$filter' },
+            { $ref: '#/components/parameters/$orderby' },
+            { $ref: '#/components/parameters/$select' },
+            { $ref: '#/components/parameters/$skip' },
+            { $ref: '#/components/parameters/$top' },
+            { $ref: '#/components/parameters/$own' },
+        ],
+        responses: {
+            200: {
+                description: 'The list of all this app’s resources of this type.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: {
+                                $ref: '#/components/schemas/Resource',
+                            },
+                        },
+                    },
+                    'text/csv': {
+                        schema: {
+                            type: 'string',
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:read'] }, {}],
+    },
+    post: {
+        tags: ['common', 'app', 'resource'],
+        description: 'Create a new resource for this app.',
+        operationId: 'createAppResource',
+        requestBody: {
+            required: true,
+            description: 'The resource to create',
+            content: {
+                'application/json': {
+                    schema: {
+                        anyOf: [
+                            { $ref: '#/components/schemas/Resource' },
+                            { type: 'array', items: { $ref: '#/components/schemas/Resource' } },
+                        ],
+                    },
+                },
+                'multipart/form-data': {
+                    schema: {
+                        type: 'object',
+                        required: ['resource'],
+                        description: 'A `multipart/form-data` representation of a resource.',
+                        additionalProperties: false,
+                        properties: {
+                            resource: {
+                                type: 'array',
+                                items: { $ref: '#/components/schemas/Resource' },
+                            },
+                            assets: {
+                                type: 'array',
+                                description: 'A list of assets that should be linked to the resource.',
+                                items: {
+                                    type: 'string',
+                                    format: 'binary',
+                                },
+                            },
+                        },
+                    },
+                },
+                'text/csv': {
+                    schema: {
+                        type: 'array',
+                        items: { type: 'object', additionalProperties: { type: 'string' } },
+                    },
+                },
+            },
+        },
+        responses: {
+            201: {
+                description: 'The resource that was created.',
+                $ref: '#/components/responses/resource',
+            },
+        },
+        security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:write'] }, {}],
+    },
+    put: {
+        tags: ['common', 'app', 'resource'],
+        description: 'Update existing app resources.',
+        operationId: 'updateAppResources',
+        requestBody: {
+            required: true,
+            description: 'The resources to update',
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'array',
+                        items: { $ref: '#/components/schemas/Resource' },
+                    },
+                },
+                'multipart/form-data': {
+                    schema: {
+                        type: 'object',
+                        required: ['resource'],
+                        description: 'A `multipart/form-data` representation of a resource.',
+                        additionalProperties: false,
+                        properties: {
+                            resource: {
+                                type: 'array',
+                                items: { $ref: '#/components/schemas/Resource' },
+                            },
+                            assets: {
+                                type: 'array',
+                                description: 'A list of assets that should be linked to the resources.',
+                                items: {
+                                    type: 'string',
+                                    format: 'binary',
+                                },
+                            },
+                        },
+                    },
+                },
+                'text/csv': {
+                    schema: {
+                        type: 'array',
+                        items: { type: 'object', additionalProperties: { type: 'string' } },
+                    },
+                },
+            },
+        },
+        responses: {
+            200: {
+                description: 'The updated resources.',
+                $ref: '#/components/responses/resource',
+            },
+        },
+        security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:write'] }, {}],
+    },
+    delete: {
+        tags: ['common', 'app', 'resource'],
+        description: 'Delete multiple app resources.',
+        operationId: 'deleteAppResources',
+        requestBody: {
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'array',
+                        description: 'An array of resource IDs to remove.',
+                        items: { $ref: '#/components/schemas/Resource/properties/id' },
+                    },
+                },
+            },
+        },
+        responses: {
+            204: {
+                description: 'The app resources have been deleted successfully.',
+            },
+        },
+        security: [{ studio: [] }, { app: ['resources:manage'] }, { cli: ['resources:write'] }, {}],
+    },
+};
+//# sourceMappingURL=resourceType.js.map

package/api/paths/apps/appId/resources/versions.d.ts

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

package/api/paths/apps/appId/resources/versions.js

@@ -0,0 +1,29 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { $ref: '#/components/parameters/resourceType' },
+        { $ref: '#/components/parameters/resourceId' },
+    ],
+    get: {
+        tags: ['main', 'app', 'resource', 'version'],
+        description: 'Get the known history of a resource',
+        operationId: 'getAppResourceVersions',
+        responses: {
+            200: {
+                description: 'The resource that matches the given id.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: {
+                                $ref: '#/components/responses/resource',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }],
+    },
+};
+//# sourceMappingURL=versions.js.map

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

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

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

@@ -0,0 +1,15 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    delete: {
+        tags: ['main', 'app', 'resource'],
+        description: 'Delete all app seed resources.',
+        operationId: 'deleteAppSeedResources',
+        responses: {
+            204: {
+                description: 'The app resources have been deleted successfully.',
+            },
+        },
+        security: [{ cli: ['resources:write'] }, {}],
+    },
+};
+//# sourceMappingURL=resources.js.map

package/api/paths/apps/appId/saml/secretId/acs.d.ts

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

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

@@ -0,0 +1,35 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { $ref: '#/components/parameters/appSamlSecretId' },
+    ],
+    post: {
+        tags: ['main', 'app', 'saml'],
+        operationId: 'assertAppSamlConsumerService',
+        security: [{ studio: [] }, {}],
+        requestBody: {
+            content: {
+                'application/x-www-form-urlencoded': {
+                    schema: {
+                        type: 'object',
+                        properties: {
+                            RelayState: { type: 'string' },
+                            SAMLResponse: { type: 'string' },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            302: {
+                description: 'A list of the SAML secrets for the app.',
+                content: {
+                    'application/json': {
+                        schema: {},
+                    },
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=acs.js.map