@appsemble/utils 0.29.10 → 0.30.1

package/api/paths/organizations/organizationId/apps.js

@@ -0,0 +1,33 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/organizationId' }],
+    get: {
+        tags: ['main', 'organization', 'app'],
+        parameters: [
+            {
+                name: 'language',
+                schema: { type: 'string' },
+                description: 'The language to include the translations of, if available',
+                in: 'query',
+            },
+        ],
+        description: 'Get a list of an organization’s apps. Private apps are excluded unless the user is in the organization.',
+        operationId: 'getOrganizationApps',
+        responses: {
+            200: {
+                description: 'The list of this organization’s apps.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: {
+                                $ref: '#/components/schemas/App',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }, {}],
+    },
+};
+//# sourceMappingURL=apps.js.map

package/api/paths/organizations/organizationId/blocks.d.ts

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

package/api/paths/organizations/organizationId/blocks.js

@@ -0,0 +1,25 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/organizationId' }],
+    get: {
+        tags: ['main', 'organization', 'block'],
+        description: 'Get a list of an organization’s blocks.',
+        operationId: 'getOrganizationBlocks',
+        responses: {
+            200: {
+                description: 'The list of this organization’s blocks.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: {
+                                $ref: '#/components/schemas/BlockVersion',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }, {}],
+    },
+};
+//# sourceMappingURL=blocks.js.map

package/api/paths/organizations/organizationId/icon.d.ts

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

package/api/paths/organizations/organizationId/icon.js

@@ -0,0 +1,14 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/organizationId' }],
+    get: {
+        tags: ['organization'],
+        description: 'Get the organization icon.',
+        operationId: 'getOrganizationIcon',
+        responses: {
+            200: {
+                description: 'The icon that represents the organization.',
+            },
+        },
+    },
+};
+//# sourceMappingURL=icon.js.map

package/api/paths/organizations/organizationId/invites/resend.d.ts

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

package/api/paths/organizations/organizationId/invites/resend.js

@@ -0,0 +1,32 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/organizationId' }],
+    post: {
+        tags: ['organization'],
+        description: 'Request to resend an invitation.',
+        operationId: 'resendOrganizationInvite',
+        requestBody: {
+            description: 'The email of the person to resend the invitation to.',
+            required: true,
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'object',
+                        required: ['email'],
+                        properties: {
+                            email: {
+                                type: 'string',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            204: {
+                description: 'The invite has been sent.',
+            },
+        },
+        security: [{ studio: [] }],
+    },
+};
+//# sourceMappingURL=resend.js.map

package/api/paths/organizations/organizationId/invites.d.ts

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

package/api/paths/organizations/organizationId/invites.js

@@ -0,0 +1,108 @@
+import { predefinedOrganizationRoles } from '@appsemble/types';
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/organizationId' }],
+    get: {
+        tags: ['main', 'organization', 'invite'],
+        description: 'Get a list of invited organization members.',
+        operationId: 'getOrganizationInvites',
+        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',
+                                        enum: predefinedOrganizationRoles,
+                                    },
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }],
+    },
+    post: {
+        tags: ['main', 'organization', 'invite'],
+        description: 'Invite a new member to the organization that matches the given id.',
+        operationId: 'createOrganizationInvites',
+        requestBody: {
+            description: 'The member to invite.',
+            required: true,
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'array',
+                        items: {
+                            type: 'object',
+                            required: ['email', 'role'],
+                            properties: {
+                                email: {
+                                    type: 'string',
+                                    format: 'email',
+                                },
+                                role: {
+                                    type: 'string',
+                                    enum: predefinedOrganizationRoles,
+                                },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            201: {
+                description: 'The newly invited member.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            $ref: '#/components/schemas/User',
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }],
+    },
+    delete: {
+        tags: ['main', 'organization', 'invite'],
+        description: 'Revoke a member invitation.',
+        operationId: 'deleteOrganizationInvite',
+        requestBody: {
+            description: 'The email address to revoke the invite of.',
+            required: true,
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'object',
+                        required: ['email'],
+                        properties: {
+                            email: {
+                                type: 'string',
+                                format: 'email',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            204: {
+                description: 'The invitation has been successfully revoked.',
+            },
+        },
+        security: [{ studio: [] }],
+    },
+};
+//# sourceMappingURL=invites.js.map

package/api/paths/organizations/organizationId/members/memberId/role.d.ts

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

package/api/paths/organizations/organizationId/members/memberId/role.js

@@ -0,0 +1,50 @@
+import { predefinedOrganizationRoles } from '@appsemble/types';
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/organizationId' },
+        {
+            name: 'organizationMemberId',
+            in: 'path',
+            description: 'The ID of the member',
+            required: true,
+            schema: { $ref: '#/components/schemas/User/properties/id' },
+        },
+    ],
+    put: {
+        tags: ['main', 'organization', 'member'],
+        description: 'Set the role of the member within the organization.',
+        operationId: 'updateOrganizationMemberRole',
+        requestBody: {
+            description: 'The role to set.',
+            required: true,
+            content: {
+                'application/json': {
+                    schema: {
+                        type: 'object',
+                        required: ['role'],
+                        properties: {
+                            role: {
+                                type: 'string',
+                                enum: predefinedOrganizationRoles,
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            200: {
+                description: 'The member’s role has been successfully updated.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            $ref: '#/components/schemas/OrganizationMember',
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }],
+    },
+};
+//# sourceMappingURL=role.js.map

package/api/paths/organizations/organizationId/members/memberId.d.ts

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

package/api/paths/organizations/organizationId/members/memberId.js

@@ -0,0 +1,25 @@
+export const pathItems = {
+    parameters: [
+        { $ref: '#/components/parameters/organizationId' },
+        {
+            name: 'organizationMemberId',
+            in: 'path',
+            description: 'The ID of the member to remove',
+            required: true,
+            $ref: '#/components/schemas/User/properties/id',
+            schema: { $ref: '#/components/schemas/User/properties/id' },
+        },
+    ],
+    delete: {
+        tags: ['main', 'organization', 'member'],
+        description: 'Remove a member from the organization that matches the given id, or leave the organization if the member id matches the user’s member id',
+        operationId: 'removeOrganizationMember',
+        responses: {
+            204: {
+                description: 'The member has been successfully removed.',
+            },
+        },
+        security: [{ studio: [] }],
+    },
+};
+//# sourceMappingURL=memberId.js.map

package/api/paths/organizations/organizationId/members.d.ts

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

package/api/paths/organizations/organizationId/members.js

@@ -0,0 +1,25 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/organizationId' }],
+    get: {
+        tags: ['main', 'organization', 'member'],
+        description: 'Get a list of organization members.',
+        operationId: 'getOrganizationMembers',
+        responses: {
+            200: {
+                description: 'The list of all members.',
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'array',
+                            items: {
+                                $ref: '#/components/schemas/OrganizationMember',
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        security: [{ studio: [] }],
+    },
+};
+//# sourceMappingURL=members.js.map

package/api/paths/organizations/organizationId.d.ts

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

package/api/paths/organizations/organizationId.js

@@ -0,0 +1,67 @@
+export const pathItems = {
+    parameters: [{ $ref: '#/components/parameters/organizationId' }],
+    get: {
+        tags: ['main', 'organization'],
+        description: 'Get a single organization.',
+        operationId: 'getOrganization',
+        responses: {
+            200: {
+                $ref: '#/components/responses/organization',
+            },
+        },
+    },
+    patch: {
+        tags: ['main', 'organization'],
+        description: 'Update an organization',
+        operationId: 'patchOrganization',
+        requestBody: {
+            content: {
+                'multipart/form-data': {
+                    schema: {
+                        type: 'object',
+                        properties: {
+                            name: {
+                                $ref: '#/components/schemas/Organization/properties/name',
+                            },
+                            description: {
+                                $ref: '#/components/schemas/Organization/properties/description',
+                            },
+                            email: {
+                                $ref: '#/components/schemas/Organization/properties/email',
+                            },
+                            website: {
+                                $ref: '#/components/schemas/Organization/properties/website',
+                            },
+                            icon: {
+                                type: 'string',
+                                format: 'binary',
+                                description: 'The organization icon.',
+                            },
+                        },
+                    },
+                    encoding: {
+                        icon: {
+                            contentType: 'image/png,image/jpeg,image/tiff,image/webp',
+                        },
+                    },
+                },
+            },
+        },
+        responses: {
+            200: { $ref: '#/components/responses/organization' },
+        },
+        security: [{ studio: [] }, { cli: ['organizations:write'] }],
+    },
+    delete: {
+        tags: ['main', 'organization'],
+        description: 'Delete an organization.',
+        operationId: 'deleteOrganization',
+        responses: {
+            200: {
+                description: 'successfully deleted organization',
+            },
+        },
+        security: [{ studio: [] }, {}],
+    },
+};
+//# sourceMappingURL=organizationId.js.map

package/api/paths/organizations.d.ts

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