@appsemble/utils 0.29.11 → 0.30.1

package/api/paths/apps/appId/saml/secretId/authn.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/authn.js

@@ -0,0 +1,37 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { $ref: '#/components/parameters/appSamlSecretId' },
+    ],
+    post: {
+        tags: ['main', 'app', 'saml'],
+        operationId: 'createAppSamlAuthnRequest',
+        security: [{ studio: [] }, {}],
+        requestBody: {
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'object',
+                        properties: {
+                            redirectUri: { type: 'string' },
+                            scope: { type: 'string' },
+                            state: { type: 'string' },
+                            timezone: { enum: Intl.supportedValuesOf('timeZone') },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            201: {
+                description: 'A list of the SAML secrets for the app.',
+                content: {
+                    'application/json': {
+                        schema: {},
+                    },
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=authn.js.map

package/api/paths/apps/appId/saml/secretId/metadata.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/metadata.js

@@ -0,0 +1,21 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { $ref: '#/components/parameters/appSamlSecretId' },
+    ],
+    get: {
+        tags: ['main', 'app', 'saml'],
+        operationId: 'getAppSamlEntityId',
+        responses: {
+            200: {
+                description: 'Get the SAML entity ID metadata',
+                content: {
+                    'application/xml': {
+                        schema: {},
+                    },
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=metadata.js.map

package/api/paths/apps/appId/scim/resource-types/resourceTypeId.d.ts

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

package/api/paths/apps/appId/scim/resource-types/resourceTypeId.js

@@ -0,0 +1,25 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { name: 'resourceTypeId', in: 'path', schema: { type: 'string' } },
+    ],
+    get: {
+        tags: ['main', 'app', 'scim'],
+        security: [{ scim: [] }],
+        operationId: 'getAppScimResourceType',
+        responses: {
+            200: {
+                description: 'SCIM user',
+                content: {
+                    'application/scim+json': {
+                        schema: {
+                        // XXX
+                        // $ref: '#/components/schemas/ScimUser',
+                        },
+                    },
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=resourceTypeId.js.map

package/api/paths/apps/appId/scim/resource-types.d.ts

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

package/api/paths/apps/appId/scim/resource-types.js

@@ -0,0 +1,22 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    get: {
+        tags: ['main', 'app', 'scim'],
+        security: [{ scim: [] }],
+        operationId: 'getAppScimResourceTypes',
+        responses: {
+            200: {
+                description: 'SCIM user',
+                content: {
+                    'application/scim+json': {
+                        schema: {
+                        // XXX
+                        // $ref: '#/components/schemas/ScimUser',
+                        },
+                    },
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=resource-types.js.map

package/api/paths/apps/appId/scim/schemas/schemaId.d.ts

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

package/api/paths/apps/appId/scim/schemas/schemaId.js

@@ -0,0 +1,24 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { name: 'schemaId', in: 'path', schema: { type: 'string' } },
+    ],
+    get: {
+        tags: ['main', 'app', 'scim'],
+        security: [{ scim: [] }],
+        operationId: 'getAppScimSchema',
+        responses: {
+            200: {
+                description: 'The SCIM Schema',
+                content: {
+                    'application/scim+json': {
+                        schema: {
+                            $ref: '#/components/schemas/ScimUser',
+                        },
+                    },
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=schemaId.js.map

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

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

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

@@ -0,0 +1,21 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    get: {
+        tags: ['main', 'app', 'scim'],
+        security: [{ scim: [] }],
+        operationId: 'getAppScimSchemas',
+        responses: {
+            200: {
+                description: 'The SCIM Schema',
+                content: {
+                    'application/scim+json': {
+                        schema: {
+                            $ref: '#/components/schemas/ScimUser',
+                        },
+                    },
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=schemas.js.map

package/api/paths/apps/appId/scim/service-provider-config.d.ts

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

package/api/paths/apps/appId/scim/service-provider-config.js

@@ -0,0 +1,22 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    get: {
+        tags: ['main', 'app', 'scim'],
+        security: [{ scim: [] }],
+        operationId: 'getAppScimServiceProviderConfig',
+        responses: {
+            200: {
+                description: 'SCIM user',
+                content: {
+                    'application/scim+json': {
+                        schema: {
+                        // XXX
+                        // $ref: '#/components/schemas/ScimUser',
+                        },
+                    },
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=service-provider-config.js.map

package/api/paths/apps/appId/scim/users/userId.d.ts

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

package/api/paths/apps/appId/scim/users/userId.js

@@ -0,0 +1,92 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        {
+            name: 'userId',
+            in: 'path',
+            description: 'The ID of the member to perform the operation on',
+            required: true,
+            schema: { $ref: '#/components/schemas/User/properties/id' },
+        },
+    ],
+    get: {
+        tags: ['main', 'app', 'scim'],
+        security: [{ scim: [] }],
+        operationId: 'getAppScimUser',
+        responses: {
+            200: {
+                description: 'SCIM user',
+                content: {
+                    'application/scim+json': {
+                        schema: {
+                            $ref: '#/components/schemas/ScimUser',
+                        },
+                    },
+                },
+            },
+        },
+    },
+    delete: {
+        tags: ['main', 'app', 'scim'],
+        security: [{ scim: [] }],
+        operationId: 'deleteAppScimUser',
+        responses: {
+            204: {
+                description: 'SCIM user',
+            },
+        },
+    },
+    put: {
+        tags: ['main', 'app', 'scim'],
+        security: [{ scim: [] }],
+        operationId: 'updateAppScimUser',
+        requestBody: {
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'object',
+                        additionalProperties: true,
+                    },
+                },
+                'application/scim+json': {
+                    schema: {
+                        type: 'object',
+                        additionalProperties: true,
+                    },
+                },
+            },
+        },
+        responses: {
+            200: {
+                description: 'SCIM user',
+            },
+        },
+    },
+    patch: {
+        tags: ['main', 'app', 'scim'],
+        security: [{ scim: [] }],
+        operationId: 'patchAppScimUser',
+        requestBody: {
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'object',
+                        additionalProperties: true,
+                    },
+                },
+                'application/scim+json': {
+                    schema: {
+                        type: 'object',
+                        additionalProperties: true,
+                    },
+                },
+            },
+        },
+        responses: {
+            200: {
+                description: 'SCIM user',
+            },
+        },
+    },
+};
+//# sourceMappingURL=userId.js.map

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

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

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

@@ -0,0 +1,58 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    post: {
+        tags: ['main', 'app', 'scim'],
+        security: [{ scim: [] }],
+        operationId: 'createAppScimUser',
+        requestBody: {
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'object',
+                        additionalProperties: true,
+                    },
+                },
+                'application/scim+json': {
+                    schema: {
+                        type: 'object',
+                        additionalProperties: true,
+                    },
+                },
+            },
+        },
+        responses: {
+            201: {
+                description: 'Integrated SCIM user schema',
+                content: {
+                    'application/scim+json': {
+                        schema: {
+                            $ref: '#/components/schemas/ScimUser',
+                        },
+                    },
+                },
+            },
+        },
+    },
+    get: {
+        tags: ['main', 'app', 'scim'],
+        security: [{ scim: [] }],
+        operationId: 'getAppScimUsers',
+        parameters: [
+            { name: 'count', in: 'query', schema: { type: 'number' } },
+            { name: 'startIndex', in: 'query', schema: { type: 'number' } },
+        ],
+        responses: {
+            200: {
+                description: 'SCIM user',
+                content: {
+                    'application/scim+json': {
+                        schema: {
+                            $ref: '#/components/schemas/ScimUser',
+                        },
+                    },
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=users.js.map

package/api/paths/apps/appId/screenshots/screenshotId.d.ts

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

package/api/paths/apps/appId/screenshots/screenshotId.js

@@ -0,0 +1,28 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { $ref: '#/components/parameters/screenshotId' },
+    ],
+    get: {
+        tags: ['main', 'app', 'screenshot'],
+        description: 'Get a screenshot of an app.',
+        operationId: 'getAppScreenshot',
+        responses: {
+            200: {
+                description: 'The app screenshot',
+            },
+        },
+    },
+    delete: {
+        tags: ['main', 'app', 'screenshot'],
+        description: 'Delete an existing screenshot.',
+        operationId: 'deleteAppScreenshot',
+        responses: {
+            200: {
+                description: 'The screenshot has been successfully deleted.',
+            },
+        },
+        security: [{ studio: [] }, { cli: ['apps:write'] }],
+    },
+};
+//# sourceMappingURL=screenshotId.js.map

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

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

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

@@ -0,0 +1,55 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/appId' }],
+    post: {
+        tags: ['main', 'app', 'screenshot'],
+        description: 'Add one or multiple screenshots of an app.',
+        operationId: 'createAppScreenshot',
+        requestBody: {
+            content: {
+                'multipart/form-data': {
+                    schema: {
+                        type: 'object',
+                        properties: {
+                            screenshots: {
+                                type: 'array',
+                                description: 'Screenshots to showcase in the store',
+                                minItems: 1,
+                                items: {
+                                    type: 'string',
+                                    format: 'binary',
+                                },
+                            },
+                            language: {
+                                type: 'string',
+                                description: 'The language for which the screenshots will be uploaded',
+                            },
+                        },
+                    },
+                    encoding: {
+                        screenshots: {
+                            contentType: 'image/png,image/jpeg,image/tiff,image/webp',
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            201: {
+                description: 'The screenshots have been successfully created.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: {
+                                type: 'integer',
+                                description: 'The ID of the newly created screenshot.',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }, { cli: ['apps:write'] }],
+    },
+};
+//# sourceMappingURL=screenshots.js.map

package/api/paths/apps/appId/secrets/oauth2/secretId/verify.d.ts

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

package/api/paths/apps/appId/secrets/oauth2/secretId/verify.js

@@ -0,0 +1,47 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { $ref: '#/components/parameters/appOAuth2SecretId' },
+    ],
+    post: {
+        tags: ['main', 'app', 'secret', 'oauth2'],
+        operationId: 'verifyAppOAuth2SecretCode',
+        security: [{ studio: [] }, {}],
+        requestBody: {
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'object',
+                        required: ['code', 'scope', 'redirectUri', 'timezone'],
+                        properties: {
+                            code: { type: 'string' },
+                            scope: { type: 'string' },
+                            redirectUri: { type: 'string' },
+                            timezone: { type: 'string' },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            200: {
+                description: `
+            Get a partial app OAuth2 secret
+
+            Only public facing values are output on this endpoint.
+          `,
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'object',
+                            properties: {
+                                code: { type: 'string' },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    },
+};
+//# sourceMappingURL=verify.js.map

package/api/paths/apps/appId/secrets/oauth2/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/oauth2/secretId.js

@@ -0,0 +1,60 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/appId' },
+        { $ref: '#/components/parameters/appOAuth2SecretId' },
+    ],
+    get: {
+        tags: ['main', 'app', 'secret', 'oauth2'],
+        operationId: 'getAppOAuth2Secret',
+        responses: {
+            200: {
+                description: `
+            Get a partial app OAuth2 secret
+
+            Only public facing values are output on this endpoint.
+          `,
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: { $ref: '#/components/schemas/AppOAuth2Secret' },
+                        },
+                    },
+                },
+            },
+        },
+    },
+    put: {
+        tags: ['main', 'app', 'secret', 'oauth2'],
+        operationId: 'updateAppOAuth2Secret',
+        requestBody: {
+            content: {
+                'application/json': {
+                    schema: { $ref: '#/components/schemas/AppOAuth2Secret' },
+                },
+            },
+        },
+        security: [{ studio: [] }],
+        responses: {
+            200: {
+                description: 'The updated OAuth2 secret.',
+                content: {
+                    'application/json': {
+                        schema: { $ref: '#/components/schemas/AppOAuth2Secret' },
+                    },
+                },
+            },
+        },
+    },
+    delete: {
+        tags: ['main', 'app', 'secret', 'oauth2'],
+        operationId: 'deleteAppOAuth2Secret',
+        security: [{ studio: [] }],
+        responses: {
+            204: {
+                description: 'The deleted OAuth2 secret.',
+            },
+        },
+    },
+};
+//# sourceMappingURL=secretId.js.map

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

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

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

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

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

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