authhero 5.8.1 → 5.9.0

package/dist/types/routes/management-api/organizations.d.ts

@@ -0,0 +1,896 @@
+import { OpenAPIHono } from "@hono/zod-openapi";
+import { Bindings, Variables } from "../../types";
+export declare const organizationRoutes: OpenAPIHono<{
+    Bindings: Bindings;
+    Variables: Variables;
+}, {
+    "/": {
+        $get: {
+            input: {
+                query: {
+                    page?: string | undefined;
+                    per_page?: string | undefined;
+                    include_totals?: string | undefined;
+                    from?: string | undefined;
+                    take?: string | undefined;
+                    sort?: string | undefined;
+                    q?: string | undefined;
+                    from_date?: unknown;
+                    to_date?: unknown;
+                };
+            } & {
+                header: {
+                    "tenant-id"?: string | undefined;
+                };
+            };
+            output: {
+                created_at: string;
+                updated_at: string;
+                id: string;
+                name: string;
+                display_name?: string | undefined;
+                branding?: {
+                    logo_url?: string | undefined;
+                    colors?: {
+                        primary?: string | undefined;
+                        page_background?: string | undefined;
+                    } | undefined;
+                } | undefined;
+                metadata?: {
+                    [x: string]: any;
+                } | undefined;
+                enabled_connections?: {
+                    connection_id: string;
+                    assign_membership_on_login: boolean;
+                    show_as_button: boolean;
+                    is_signup_enabled: boolean;
+                }[] | undefined;
+                token_quota?: {
+                    client_credentials?: {
+                        enforce: boolean;
+                        per_day: number;
+                        per_hour: number;
+                    } | undefined;
+                } | undefined;
+            }[] | {
+                start: number;
+                limit: number;
+                length: number;
+                organizations: {
+                    created_at: string;
+                    updated_at: string;
+                    id: string;
+                    name: string;
+                    display_name?: string | undefined;
+                    branding?: {
+                        logo_url?: string | undefined;
+                        colors?: {
+                            primary?: string | undefined;
+                            page_background?: string | undefined;
+                        } | undefined;
+                    } | undefined;
+                    metadata?: {
+                        [x: string]: any;
+                    } | undefined;
+                    enabled_connections?: {
+                        connection_id: string;
+                        assign_membership_on_login: boolean;
+                        show_as_button: boolean;
+                        is_signup_enabled: boolean;
+                    }[] | undefined;
+                    token_quota?: {
+                        client_credentials?: {
+                            enforce: boolean;
+                            per_day: number;
+                            per_hour: number;
+                        } | undefined;
+                    } | undefined;
+                }[];
+                total?: number | undefined;
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/:id": {
+        $get: {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                header: {
+                    "tenant-id"?: string | undefined;
+                };
+            };
+            output: {
+                created_at: string;
+                updated_at: string;
+                id: string;
+                name: string;
+                display_name?: string | undefined;
+                branding?: {
+                    logo_url?: string | undefined;
+                    colors?: {
+                        primary?: string | undefined;
+                        page_background?: string | undefined;
+                    } | undefined;
+                } | undefined;
+                metadata?: {
+                    [x: string]: any;
+                } | undefined;
+                enabled_connections?: {
+                    connection_id: string;
+                    assign_membership_on_login: boolean;
+                    show_as_button: boolean;
+                    is_signup_enabled: boolean;
+                }[] | undefined;
+                token_quota?: {
+                    client_credentials?: {
+                        enforce: boolean;
+                        per_day: number;
+                        per_hour: number;
+                    } | undefined;
+                } | undefined;
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/:id": {
+        $delete: {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                header: {
+                    "tenant-id"?: string | undefined;
+                };
+            };
+            output: {};
+            outputFormat: string;
+            status: 200;
+        };
+    };
+} & {
+    "/:id": {
+        $patch: {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                header: {
+                    "tenant-id"?: string | undefined;
+                };
+            } & {
+                json: {
+                    id?: string | undefined;
+                    name?: string | undefined;
+                    display_name?: string | undefined;
+                    branding?: {
+                        logo_url?: string | undefined;
+                        colors?: {
+                            primary?: string | undefined;
+                            page_background?: string | undefined;
+                        } | undefined;
+                    } | undefined;
+                    metadata?: Record<string, any> | undefined;
+                    enabled_connections?: {
+                        connection_id: string;
+                        assign_membership_on_login?: boolean | undefined;
+                        show_as_button?: boolean | undefined;
+                        is_signup_enabled?: boolean | undefined;
+                    }[] | undefined;
+                    token_quota?: {
+                        client_credentials?: {
+                            enforce?: boolean | undefined;
+                            per_day?: number | undefined;
+                            per_hour?: number | undefined;
+                        } | undefined;
+                    } | undefined;
+                };
+            };
+            output: {
+                created_at: string;
+                updated_at: string;
+                id: string;
+                name: string;
+                display_name?: string | undefined;
+                branding?: {
+                    logo_url?: string | undefined;
+                    colors?: {
+                        primary?: string | undefined;
+                        page_background?: string | undefined;
+                    } | undefined;
+                } | undefined;
+                metadata?: {
+                    [x: string]: any;
+                } | undefined;
+                enabled_connections?: {
+                    connection_id: string;
+                    assign_membership_on_login: boolean;
+                    show_as_button: boolean;
+                    is_signup_enabled: boolean;
+                }[] | undefined;
+                token_quota?: {
+                    client_credentials?: {
+                        enforce: boolean;
+                        per_day: number;
+                        per_hour: number;
+                    } | undefined;
+                } | undefined;
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/": {
+        $post: {
+            input: {
+                header: {
+                    "tenant-id"?: string | undefined;
+                };
+            } & {
+                json: {
+                    name: string;
+                    id?: string | undefined;
+                    display_name?: string | undefined;
+                    branding?: {
+                        logo_url?: string | undefined;
+                        colors?: {
+                            primary?: string | undefined;
+                            page_background?: string | undefined;
+                        } | undefined;
+                    } | undefined;
+                    metadata?: Record<string, any> | undefined;
+                    enabled_connections?: {
+                        connection_id: string;
+                        assign_membership_on_login?: boolean | undefined;
+                        show_as_button?: boolean | undefined;
+                        is_signup_enabled?: boolean | undefined;
+                    }[] | undefined;
+                    token_quota?: {
+                        client_credentials?: {
+                            enforce?: boolean | undefined;
+                            per_day?: number | undefined;
+                            per_hour?: number | undefined;
+                        } | undefined;
+                    } | undefined;
+                };
+            };
+            output: {
+                created_at: string;
+                updated_at: string;
+                id: string;
+                name: string;
+                display_name?: string | undefined;
+                branding?: {
+                    logo_url?: string | undefined;
+                    colors?: {
+                        primary?: string | undefined;
+                        page_background?: string | undefined;
+                    } | undefined;
+                } | undefined;
+                metadata?: {
+                    [x: string]: any;
+                } | undefined;
+                enabled_connections?: {
+                    connection_id: string;
+                    assign_membership_on_login: boolean;
+                    show_as_button: boolean;
+                    is_signup_enabled: boolean;
+                }[] | undefined;
+                token_quota?: {
+                    client_credentials?: {
+                        enforce: boolean;
+                        per_day: number;
+                        per_hour: number;
+                    } | undefined;
+                } | undefined;
+            };
+            outputFormat: "json";
+            status: 201;
+        };
+    };
+} & {
+    "/:id/members": {
+        $get: {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                query: {
+                    page?: string | undefined;
+                    per_page?: string | undefined;
+                    include_totals?: string | undefined;
+                    from?: string | undefined;
+                    take?: string | undefined;
+                    sort?: string | undefined;
+                    q?: string | undefined;
+                    from_date?: unknown;
+                    to_date?: unknown;
+                };
+            } & {
+                header: {
+                    "tenant-id"?: string | undefined;
+                };
+            };
+            output: {
+                user_id: string;
+                roles: {}[];
+                email?: string | undefined;
+            }[] | {
+                start: number;
+                limit: number;
+                total: number;
+                members: {
+                    user_id: string;
+                    roles: {}[];
+                    email?: string | undefined;
+                }[];
+            } | {
+                members: {
+                    user_id: string;
+                    roles: {}[];
+                    email?: string | undefined;
+                }[];
+                next?: string | undefined;
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/:id/members": {
+        $post: {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                header: {
+                    "tenant-id"?: string | undefined;
+                };
+            } & {
+                json: {
+                    members: string[];
+                };
+            };
+            output: {};
+            outputFormat: string;
+            status: 204;
+        };
+    };
+} & {
+    "/:id/members": {
+        $delete: {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                header: {
+                    "tenant-id"?: string | undefined;
+                };
+            } & {
+                json: {
+                    members: string[];
+                };
+            };
+            output: {};
+            outputFormat: string;
+            status: 200;
+        };
+    };
+} & {
+    "/:id/members/:user_id/roles": {
+        $get: {
+            input: {
+                param: {
+                    id: string;
+                    user_id: string;
+                };
+            } & {
+                query: {
+                    page?: string | undefined;
+                    per_page?: string | undefined;
+                    include_totals?: string | undefined;
+                    from?: string | undefined;
+                    take?: string | undefined;
+                    sort?: string | undefined;
+                    q?: string | undefined;
+                    from_date?: unknown;
+                    to_date?: unknown;
+                };
+            } & {
+                header: {
+                    "tenant-id"?: string | undefined;
+                };
+            };
+            output: {
+                name: string;
+                id: string;
+                description?: string | undefined;
+                is_system?: boolean | undefined;
+                metadata?: {
+                    [x: string]: any;
+                } | undefined;
+                created_at?: string | undefined;
+                updated_at?: string | undefined;
+            }[];
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/:id/members/:user_id/roles": {
+        $post: {
+            input: {
+                param: {
+                    id: string;
+                    user_id: string;
+                };
+            } & {
+                header: {
+                    "tenant-id"?: string | undefined;
+                };
+            } & {
+                json: {
+                    roles: string[];
+                };
+            };
+            output: {};
+            outputFormat: string;
+            status: 201;
+        };
+    };
+} & {
+    "/:id/members/:user_id/roles": {
+        $delete: {
+            input: {
+                param: {
+                    id: string;
+                    user_id: string;
+                };
+            } & {
+                header: {
+                    "tenant-id"?: string | undefined;
+                };
+            } & {
+                json: {
+                    roles: string[];
+                };
+            };
+            output: {};
+            outputFormat: string;
+            status: 200;
+        };
+    };
+} & {
+    "/:id/roles": {
+        $get: {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                query: {
+                    page?: string | undefined;
+                    per_page?: string | undefined;
+                    include_totals?: string | undefined;
+                    from?: string | undefined;
+                    take?: string | undefined;
+                    sort?: string | undefined;
+                    q?: string | undefined;
+                    from_date?: unknown;
+                    to_date?: unknown;
+                };
+            } & {
+                header: {
+                    "tenant-id"?: string | undefined;
+                };
+            };
+            output: {
+                name: string;
+                id: string;
+                description?: string | undefined;
+                is_system?: boolean | undefined;
+                metadata?: {
+                    [x: string]: any;
+                } | undefined;
+                created_at?: string | undefined;
+                updated_at?: string | undefined;
+            }[];
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/:id/invitations": {
+        $get: {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                query: {
+                    page?: string | undefined;
+                    per_page?: string | undefined;
+                    include_totals?: string | undefined;
+                    fields?: string | undefined;
+                    include_fields?: string | undefined;
+                    sort?: string | undefined;
+                };
+            } & {
+                header: {
+                    "tenant-id"?: string | undefined;
+                };
+            };
+            output: {
+                id: string;
+                created_at: string;
+                expires_at: string;
+                client_id: string;
+                inviter: {
+                    name?: string | undefined;
+                };
+                invitee: {
+                    email?: string | undefined;
+                };
+                organization_id: string;
+                invitation_url: string;
+                ticket_id?: string | undefined;
+                connection_id?: string | undefined;
+                app_metadata?: {
+                    [x: string]: any;
+                } | undefined;
+                user_metadata?: {
+                    [x: string]: any;
+                } | undefined;
+                ttl_sec?: number | undefined;
+                roles?: string[] | undefined;
+                send_invitation_email?: boolean | undefined;
+            }[] | {
+                invitations: {
+                    id: string;
+                    created_at: string;
+                    expires_at: string;
+                    client_id: string;
+                    inviter: {
+                        name?: string | undefined;
+                    };
+                    invitee: {
+                        email?: string | undefined;
+                    };
+                    organization_id: string;
+                    invitation_url: string;
+                    ticket_id?: string | undefined;
+                    connection_id?: string | undefined;
+                    app_metadata?: {
+                        [x: string]: any;
+                    } | undefined;
+                    user_metadata?: {
+                        [x: string]: any;
+                    } | undefined;
+                    ttl_sec?: number | undefined;
+                    roles?: string[] | undefined;
+                    send_invitation_email?: boolean | undefined;
+                }[];
+                start: number;
+                limit: number;
+                length: number;
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/:id/invitations/:invitation_id": {
+        $get: {
+            input: {
+                param: {
+                    id: string;
+                    invitation_id: string;
+                };
+            } & {
+                header: {
+                    "tenant-id"?: string | undefined;
+                };
+            };
+            output: {};
+            outputFormat: string;
+            status: 404;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                    invitation_id: string;
+                };
+            } & {
+                header: {
+                    "tenant-id"?: string | undefined;
+                };
+            };
+            output: {
+                id: string;
+                created_at: string;
+                expires_at: string;
+                client_id: string;
+                inviter: {
+                    name?: string | undefined;
+                };
+                invitee: {
+                    email?: string | undefined;
+                };
+                organization_id: string;
+                invitation_url: string;
+                ticket_id?: string | undefined;
+                connection_id?: string | undefined;
+                app_metadata?: {
+                    [x: string]: any;
+                } | undefined;
+                user_metadata?: {
+                    [x: string]: any;
+                } | undefined;
+                ttl_sec?: number | undefined;
+                roles?: string[] | undefined;
+                send_invitation_email?: boolean | undefined;
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/:id/invitations": {
+        $post: {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                header: {
+                    "tenant-id"?: string | undefined;
+                };
+            } & {
+                json: {
+                    client_id: string;
+                    inviter: {
+                        name?: string | undefined;
+                    };
+                    invitee: {
+                        email?: string | undefined;
+                    };
+                    id?: string | undefined;
+                    app_metadata?: Record<string, any> | undefined;
+                    user_metadata?: Record<string, any> | undefined;
+                    connection_id?: string | undefined;
+                    roles?: string[] | undefined;
+                    ttl_sec?: number | undefined;
+                    send_invitation_email?: boolean | undefined;
+                };
+            };
+            output: {
+                id: string;
+                created_at: string;
+                expires_at: string;
+                client_id: string;
+                inviter: {
+                    name?: string | undefined;
+                };
+                invitee: {
+                    email?: string | undefined;
+                };
+                organization_id: string;
+                invitation_url: string;
+                ticket_id?: string | undefined;
+                connection_id?: string | undefined;
+                app_metadata?: {
+                    [x: string]: any;
+                } | undefined;
+                user_metadata?: {
+                    [x: string]: any;
+                } | undefined;
+                ttl_sec?: number | undefined;
+                roles?: string[] | undefined;
+                send_invitation_email?: boolean | undefined;
+            };
+            outputFormat: "json";
+            status: 201;
+        };
+    };
+} & {
+    "/:id/invitations/:invitation_id": {
+        $delete: {
+            input: {
+                param: {
+                    id: string;
+                    invitation_id: string;
+                };
+            } & {
+                header: {
+                    "tenant-id"?: string | undefined;
+                };
+            };
+            output: {};
+            outputFormat: string;
+            status: 204;
+        } | {
+            input: {
+                param: {
+                    id: string;
+                    invitation_id: string;
+                };
+            } & {
+                header: {
+                    "tenant-id"?: string | undefined;
+                };
+            };
+            output: {};
+            outputFormat: string;
+            status: 404;
+        };
+    };
+} & {
+    "/:id/enabled_connections": {
+        $get: {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                query: {
+                    include_totals?: string | undefined;
+                    page?: string | undefined;
+                    per_page?: string | undefined;
+                };
+            } & {
+                header: {
+                    "tenant-id"?: string | undefined;
+                };
+            };
+            output: {
+                start: number;
+                limit: number;
+                length: number;
+                connections: {
+                    connection_id: string;
+                    assign_membership_on_login: boolean;
+                    show_as_button: boolean;
+                    is_signup_enabled: boolean;
+                    connection?: {
+                        name?: string | undefined;
+                        strategy?: string | undefined;
+                    } | undefined;
+                    created_at?: string | undefined;
+                    updated_at?: string | undefined;
+                }[];
+                total?: number | undefined;
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/:id/enabled_connections": {
+        $post: {
+            input: {
+                param: {
+                    id: string;
+                };
+            } & {
+                header: {
+                    "tenant-id"?: string | undefined;
+                };
+            } & {
+                json: {
+                    connection_id: string;
+                    assign_membership_on_login?: boolean | undefined;
+                    show_as_button?: boolean | undefined;
+                    is_signup_enabled?: boolean | undefined;
+                };
+            };
+            output: {
+                connection_id: string;
+                assign_membership_on_login: boolean;
+                show_as_button: boolean;
+                is_signup_enabled: boolean;
+                connection?: {
+                    name?: string | undefined;
+                    strategy?: string | undefined;
+                } | undefined;
+                created_at?: string | undefined;
+                updated_at?: string | undefined;
+            };
+            outputFormat: "json";
+            status: 201;
+        };
+    };
+} & {
+    "/:id/enabled_connections/:connection_id": {
+        $get: {
+            input: {
+                param: {
+                    id: string;
+                    connection_id: string;
+                };
+            } & {
+                header: {
+                    "tenant-id"?: string | undefined;
+                };
+            };
+            output: {
+                connection_id: string;
+                assign_membership_on_login: boolean;
+                show_as_button: boolean;
+                is_signup_enabled: boolean;
+                connection?: {
+                    name?: string | undefined;
+                    strategy?: string | undefined;
+                } | undefined;
+                created_at?: string | undefined;
+                updated_at?: string | undefined;
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/:id/enabled_connections/:connection_id": {
+        $patch: {
+            input: {
+                param: {
+                    id: string;
+                    connection_id: string;
+                };
+            } & {
+                header: {
+                    "tenant-id"?: string | undefined;
+                };
+            } & {
+                json: {
+                    show_as_button?: boolean | undefined;
+                    assign_membership_on_login?: boolean | undefined;
+                    is_signup_enabled?: boolean | undefined;
+                };
+            };
+            output: {
+                connection_id: string;
+                assign_membership_on_login: boolean;
+                show_as_button: boolean;
+                is_signup_enabled: boolean;
+                connection?: {
+                    name?: string | undefined;
+                    strategy?: string | undefined;
+                } | undefined;
+                created_at?: string | undefined;
+                updated_at?: string | undefined;
+            };
+            outputFormat: "json";
+            status: 200;
+        };
+    };
+} & {
+    "/:id/enabled_connections/:connection_id": {
+        $delete: {
+            input: {
+                param: {
+                    id: string;
+                    connection_id: string;
+                };
+            } & {
+                header: {
+                    "tenant-id"?: string | undefined;
+                };
+            };
+            output: {};
+            outputFormat: string;
+            status: 204;
+        };
+    };
+}, "/">;