@appsemble/utils 0.29.11 → 0.30.2

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

@@ -0,0 +1,31 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    get: {
+        tags: ['main', 'app'],
+        description: 'Get the current app icon.',
+        operationId: 'getAppIcon',
+        responses: {
+            200: {
+                description: 'The icon of the app that matches the given id.',
+                content: {
+                    'image/png': {},
+                    'image/jpeg': {},
+                    'image/tiff': {},
+                    'image/webp': {},
+                },
+            },
+        },
+    },
+    delete: {
+        tags: ['main', 'app'],
+        description: 'Delete the current app icon.',
+        operationId: 'deleteAppIcon',
+        responses: {
+            204: {
+                description: 'The icon has been successfully removed',
+            },
+        },
+        security: [{ studio: [] }, { cli: ['apps:write'] }],
+    },
+};
+//# sourceMappingURL=icon.js.map

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

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

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

@@ -0,0 +1,79 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    get: {
+        tags: ['app', 'invite'],
+        description: 'Get a list of invited app members.',
+        operationId: 'getAppInvites',
+        responses: {
+            200: {
+                description: 'The list of all invites.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: {
+                                type: 'object',
+                                properties: {
+                                    email: {
+                                        type: 'string',
+                                        format: 'email',
+                                    },
+                                    role: {
+                                        type: 'string',
+                                    },
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }],
+    },
+    post: {
+        tags: ['app', 'invite'],
+        description: 'Invite a new app member to an app.',
+        operationId: 'createAppInvites',
+        parameters: [{ $ref: '#/components/parameters/selectedGroupId' }],
+        requestBody: {
+            description: 'The invite to create.',
+            required: true,
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'array',
+                        items: {
+                            type: 'object',
+                            required: ['email', 'role'],
+                            properties: {
+                                email: {
+                                    type: 'string',
+                                    format: 'email',
+                                    description: 'The email address of the user to invite.',
+                                },
+                                role: {
+                                    type: 'string',
+                                    description: 'The role to invite the user as.',
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            200: {
+                description: 'The invited member',
+                content: {
+                    'application/json': {
+                        schema: {
+                            $ref: '#/components/schemas/AppMember',
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }, { app: ['app:write'] }],
+    },
+};
+//# sourceMappingURL=invites.js.map

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

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

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

@@ -0,0 +1,35 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    post: {
+        tags: ['main', 'app'],
+        description: 'Update the locked property an app.',
+        operationId: 'setAppLock',
+        requestBody: {
+            required: true,
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'object',
+                        required: ['locked'],
+                        properties: {
+                            locked: {
+                                $ref: '#/components/schemas/App/properties/locked',
+                                description: 'Whether the app should be locked.',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            204: {
+                description: 'Lock status successfully changed',
+                content: {
+                    'application/zip': {},
+                },
+            },
+        },
+        security: [{ studio: [] }, { cli: ['apps:write'] }],
+    },
+};
+//# sourceMappingURL=lock.js.map

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

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

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

@@ -0,0 +1,15 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    delete: {
+        tags: ['main', 'app'],
+        description: 'Delete the current app’s maskable icon.',
+        operationId: 'deleteAppMaskableIcon',
+        responses: {
+            204: {
+                description: 'The icon has been successfully removed',
+            },
+        },
+        security: [{ studio: [] }, { cli: ['apps:write'] }],
+    },
+};
+//# sourceMappingURL=maskableIcon.js.map

package/api/paths/apps/appId/members/current/groups.d.ts

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

package/api/paths/apps/appId/members/current/groups.js

@@ -0,0 +1,30 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    get: {
+        tags: ['app', 'member', 'current-member'],
+        description: 'Get a list of groups that the app member is a member of.',
+        operationId: 'getCurrentAppMemberGroups',
+        responses: {
+            200: {
+                description: 'The list of groups of the app member.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: {
+                                type: 'object',
+                                properties: {
+                                    id: { type: 'number' },
+                                    name: { type: 'string' },
+                                    role: { type: 'string' },
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ app: [] }],
+    },
+};
+//# sourceMappingURL=groups.js.map

package/api/paths/apps/appId/members/current/link.d.ts

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

package/api/paths/apps/appId/members/current/link.js

@@ -0,0 +1,41 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    post: {
+        tags: ['app', 'member', 'current-member'],
+        description: 'Link the app member to an unlinked authorization.',
+        operationId: 'linkCurrentAppMember',
+        security: [{ app: [] }],
+        requestBody: {
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'object',
+                        properties: {
+                            externalId: {
+                                type: 'string',
+                                description: `The external id of the of the external user.
+
+The \`externalId\` maps to the following ids of the external login methods.
+- Appsemble OAuth2 login: \`UserId\`
+- App OAuth2 login: \`sub\`
+- App SAML login: \`nameId\`
+`,
+                            },
+                            secret: {
+                                type: 'string',
+                                description: 'The secret that was used to get the external id.',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            200: {
+                description: '',
+                content: {},
+            },
+        },
+    },
+};
+//# sourceMappingURL=link.js.map

package/api/paths/apps/appId/members/current.d.ts

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

package/api/paths/apps/appId/members/current.js

@@ -0,0 +1,111 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    get: {
+        tags: ['app', 'member', 'current-member'],
+        description: `
+      Get the app member information formatted as OpenID user info.
+
+      See https://connect2id.com/products/server/docs/api/userinfo
+    `,
+        operationId: 'getCurrentAppMember',
+        security: [{ app: ['openid'] }],
+        responses: {
+            200: {
+                description: 'OpenID compatible app member information',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'object',
+                            properties: {
+                                sub: {
+                                    type: 'string',
+                                    description: 'The subject (end-user) identifier. ',
+                                },
+                                name: {
+                                    type: 'string',
+                                    description: 'The full name of the end-user',
+                                },
+                                picture: {
+                                    type: 'string',
+                                    format: 'url',
+                                    description: 'The URL of the profile page for the end-user.',
+                                },
+                                profile: {
+                                    type: 'string',
+                                    format: 'url',
+                                    description: 'The URL to the app member profile.',
+                                },
+                                email: {
+                                    type: 'string',
+                                    format: 'email',
+                                    description: 'The end-user’s preferred email address.',
+                                },
+                                email_verified: {
+                                    type: 'boolean',
+                                    description: 'True if the end-user’s email address has been verified, else false.',
+                                },
+                                properties: {
+                                    type: 'object',
+                                    description: 'Custom app member properties.',
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    },
+    patch: {
+        description: 'Update the data of the currently logged in app member',
+        tags: ['app', 'member'],
+        operationId: 'patchCurrentAppMember',
+        security: [{ studio: [] }, { app: [] }],
+        requestBody: {
+            content: {
+                'multipart/form-data': {
+                    schema: {
+                        type: 'object',
+                        additionalProperties: false,
+                        properties: {
+                            name: {
+                                type: 'string',
+                            },
+                            picture: {
+                                type: 'string',
+                                format: 'binary',
+                                description: 'The member’s profile picture.',
+                            },
+                            properties: {
+                                type: 'object',
+                                additionalProperties: { type: 'string' },
+                                description: 'The member’s custom properties.',
+                            },
+                            locale: {
+                                type: 'string',
+                                description: 'The preferred locale of the user.',
+                            },
+                        },
+                    },
+                    encoding: {
+                        picture: {
+                            contentType: 'image/png,image/jpeg,image/tiff,image/webp',
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            200: {
+                description: 'The patched app member',
+                content: {
+                    'application/json': {
+                        schema: {
+                            $ref: '#/components/schemas/AppMember',
+                        },
+                    },
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=current.js.map

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

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

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

@@ -0,0 +1,29 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { $ref: '#/components/parameters/roles' },
+        { $ref: '#/components/parameters/selectedGroupId' },
+    ],
+    get: {
+        tags: ['common', 'app', 'member'],
+        description: 'Fetch all members of an app.',
+        operationId: 'queryAppMembers',
+        security: [{ studio: [] }, { app: ['openid'] }, {}],
+        responses: {
+            200: {
+                description: 'The list of app members.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: {
+                                $ref: '#/components/schemas/AppMemberInfo',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=members.js.map

package/api/paths/apps/appId/messages/language.d.ts

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

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

@@ -0,0 +1,47 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { $ref: '#/components/parameters/language' },
+        {
+            in: 'query',
+            name: 'merge',
+            description: 'Whether the language’s messages should be merged with its base language.',
+            schema: { type: 'string' },
+        },
+        {
+            in: 'query',
+            name: 'override',
+            description: 'Whether the app’s language overrides should be included and merged.',
+            schema: { type: 'string', default: 'true' },
+        },
+    ],
+    delete: {
+        tags: ['main', 'apps', 'language'],
+        description: 'Delete the app’s messages for this language.',
+        operationId: 'deleteAppMessages',
+        responses: {
+            204: {
+                description: 'The messages have successfully been deleted.',
+            },
+        },
+        security: [{ studio: [] }],
+    },
+    get: {
+        tags: ['common', 'apps', 'language'],
+        description: 'Get the app’s messages for this language.',
+        operationId: 'getAppMessages',
+        responses: {
+            200: {
+                description: 'The app messages for the selected language.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            $ref: '#/components/schemas/AppMessages',
+                        },
+                    },
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=language.js.map

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

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

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;