@meshscale/sdk 0.1.7

package/dist/generated/sdk.gen.d.ts

@@ -0,0 +1,123 @@
+import type { Client, ClientMeta, Options as Options2, RequestResult, TDataShape } from './client';
+import type { CreateBuildData, CreateBuildErrors, CreateBuildResponses, CreateDeploymentData, CreateDeploymentErrors, CreateDeploymentResponses, CreateOrganizationData, CreateOrganizationErrors, CreateOrganizationResponses, CreateProjectData, CreateProjectErrors, CreateProjectResponses, DeleteDeploymentData, DeleteDeploymentErrors, DeleteDeploymentResponses, DeleteProjectData, DeleteProjectErrors, DeleteProjectResponses, GetDeploymentData, GetDeploymentErrors, GetDeploymentResponses, GetHealthData, GetHealthErrors, GetHealthResponses, GetProjectData, GetProjectErrors, GetProjectResponses, GetProjectSettingsData, GetProjectSettingsErrors, GetProjectSettingsResponses, GetTeamSettingsData, GetTeamSettingsErrors, GetTeamSettingsResponses, GetUserData, GetUserErrors, GetUserPreferencesData, GetUserPreferencesErrors, GetUserPreferencesResponses, GetUserResponses, ListBuildsData, ListBuildsErrors, ListBuildsResponses, ListDeploymentsData, ListDeploymentsErrors, ListDeploymentsResponses, ListOrganizationsData, ListOrganizationsErrors, ListOrganizationsResponses, ListProjectsData, ListProjectsErrors, ListProjectsResponses, ListRegionsData, ListRegionsErrors, ListRegionsResponses, SetActiveOrganizationData, SetActiveOrganizationErrors, SetActiveOrganizationResponses, UpdateDeploymentData, UpdateDeploymentErrors, UpdateDeploymentResponses, UpdateProjectData, UpdateProjectErrors, UpdateProjectResponses, UpdateProjectSettingsData, UpdateProjectSettingsErrors, UpdateProjectSettingsResponses, UpdateTeamSettingsData, UpdateTeamSettingsErrors, UpdateTeamSettingsResponses, UpdateUserPreferencesData, UpdateUserPreferencesErrors, UpdateUserPreferencesResponses } from './types.gen';
+export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
+    /**
+     * You can provide a client instance returned by `createClient()` instead of
+     * individual options. This might be also useful if you want to implement a
+     * custom client.
+     */
+    client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta;
+};
+/**
+ * Get API health
+ */
+export declare const getHealth: <ThrowOnError extends boolean = false>(options?: Options<GetHealthData, ThrowOnError>) => RequestResult<GetHealthResponses, GetHealthErrors, ThrowOnError>;
+/**
+ * List all deployment regions
+ *
+ * Public region catalogue. Team/project availability is enforced separately by the authenticated organization and project APIs.
+ */
+export declare const listRegions: <ThrowOnError extends boolean = false>(options?: Options<ListRegionsData, ThrowOnError>) => RequestResult<ListRegionsResponses, ListRegionsErrors, ThrowOnError>;
+/**
+ * Get current user
+ */
+export declare const getUser: <ThrowOnError extends boolean = false>(options?: Options<GetUserData, ThrowOnError>) => RequestResult<GetUserResponses, GetUserErrors, ThrowOnError>;
+/**
+ * Get current user preferences
+ */
+export declare const getUserPreferences: <ThrowOnError extends boolean = false>(options?: Options<GetUserPreferencesData, ThrowOnError>) => RequestResult<GetUserPreferencesResponses, GetUserPreferencesErrors, ThrowOnError>;
+/**
+ * Update current user preferences
+ */
+export declare const updateUserPreferences: <ThrowOnError extends boolean = false>(options: Options<UpdateUserPreferencesData, ThrowOnError>) => RequestResult<UpdateUserPreferencesResponses, UpdateUserPreferencesErrors, ThrowOnError>;
+/**
+ * List organizations for the current user
+ */
+export declare const listOrganizations: <ThrowOnError extends boolean = false>(options?: Options<ListOrganizationsData, ThrowOnError>) => RequestResult<ListOrganizationsResponses, ListOrganizationsErrors, ThrowOnError>;
+/**
+ * Set the active organization
+ */
+export declare const setActiveOrganization: <ThrowOnError extends boolean = false>(options: Options<SetActiveOrganizationData, ThrowOnError>) => RequestResult<SetActiveOrganizationResponses, SetActiveOrganizationErrors, ThrowOnError>;
+/**
+ * Create an organization
+ */
+export declare const createOrganization: <ThrowOnError extends boolean = false>(options: Options<CreateOrganizationData, ThrowOnError>) => RequestResult<CreateOrganizationResponses, CreateOrganizationErrors, ThrowOnError>;
+/**
+ * Get active team settings and enabled regions
+ */
+export declare const getTeamSettings: <ThrowOnError extends boolean = false>(options?: Options<GetTeamSettingsData, ThrowOnError>) => RequestResult<GetTeamSettingsResponses, GetTeamSettingsErrors, ThrowOnError>;
+/**
+ * Update active team settings and enabled regions
+ *
+ * enabledRegionIds defines the regions that projects in the team are allowed to use. The server enforces this policy when creating or modifying project regions.
+ */
+export declare const updateTeamSettings: <ThrowOnError extends boolean = false>(options: Options<UpdateTeamSettingsData, ThrowOnError>) => RequestResult<UpdateTeamSettingsResponses, UpdateTeamSettingsErrors, ThrowOnError>;
+/**
+ * List projects in the active organization
+ */
+export declare const listProjects: <ThrowOnError extends boolean = false>(options?: Options<ListProjectsData, ThrowOnError>) => RequestResult<ListProjectsResponses, ListProjectsErrors, ThrowOnError>;
+/**
+ * Create a project with enabled regions
+ *
+ * Every requested region must exist and must be enabled for the active team. This validation is performed server-side, so directly calling the API cannot bypass the team's region policy. The selected default region must be one of the project's enabled regions.
+ */
+export declare const createProject: <ThrowOnError extends boolean = false>(options: Options<CreateProjectData, ThrowOnError>) => RequestResult<CreateProjectResponses, CreateProjectErrors, ThrowOnError>;
+/**
+ * Soft-delete a project
+ */
+export declare const deleteProject: <ThrowOnError extends boolean = false>(options: Options<DeleteProjectData, ThrowOnError>) => RequestResult<DeleteProjectResponses, DeleteProjectErrors, ThrowOnError>;
+/**
+ * Get a project and its enabled regions
+ */
+export declare const getProject: <ThrowOnError extends boolean = false>(options: Options<GetProjectData, ThrowOnError>) => RequestResult<GetProjectResponses, GetProjectErrors, ThrowOnError>;
+/**
+ * Update project status
+ */
+export declare const updateProject: <ThrowOnError extends boolean = false>(options: Options<UpdateProjectData, ThrowOnError>) => RequestResult<UpdateProjectResponses, UpdateProjectErrors, ThrowOnError>;
+/**
+ * Get project settings and enabled regions
+ */
+export declare const getProjectSettings: <ThrowOnError extends boolean = false>(options: Options<GetProjectSettingsData, ThrowOnError>) => RequestResult<GetProjectSettingsResponses, GetProjectSettingsErrors, ThrowOnError>;
+/**
+ * Update project default and enabled regions
+ *
+ * Project regions must be a subset of the active team's enabled regions. Removing a team-enabled region from a team does not automatically change existing project rows; project changes are validated whenever they are written.
+ */
+export declare const updateProjectSettings: <ThrowOnError extends boolean = false>(options: Options<UpdateProjectSettingsData, ThrowOnError>) => RequestResult<UpdateProjectSettingsResponses, UpdateProjectSettingsErrors, ThrowOnError>;
+/**
+ * List builds
+ */
+export declare const listBuilds: <ThrowOnError extends boolean = false>(options?: Options<ListBuildsData, ThrowOnError>) => RequestResult<ListBuildsResponses, ListBuildsErrors, ThrowOnError>;
+/**
+ * Create a build record
+ *
+ * Creates the build record only. Queueing and build execution are intentionally not performed by this API route.
+ */
+export declare const createBuild: <ThrowOnError extends boolean = false>(options: Options<CreateBuildData, ThrowOnError>) => RequestResult<CreateBuildResponses, CreateBuildErrors, ThrowOnError>;
+/**
+ * List deployments
+ */
+export declare const listDeployments: <ThrowOnError extends boolean = false>(options?: Options<ListDeploymentsData, ThrowOnError>) => RequestResult<ListDeploymentsResponses, ListDeploymentsErrors, ThrowOnError>;
+/**
+ * Create a deployment record and empty build
+ *
+ * Creates a deployment and an empty build record transactionally. No queueing or deployment execution is performed. Runtime and artifact objects are not created by this endpoint.
+ */
+export declare const createDeployment: <ThrowOnError extends boolean = false>(options: Options<CreateDeploymentData, ThrowOnError>) => RequestResult<CreateDeploymentResponses, CreateDeploymentErrors, ThrowOnError>;
+/**
+ * Soft-delete deployment
+ */
+export declare const deleteDeployment: <ThrowOnError extends boolean = false>(options: Options<DeleteDeploymentData, ThrowOnError>) => RequestResult<DeleteDeploymentResponses, DeleteDeploymentErrors, ThrowOnError>;
+/**
+ * Get deployment
+ */
+export declare const getDeployment: <ThrowOnError extends boolean = false>(options: Options<GetDeploymentData, ThrowOnError>) => RequestResult<GetDeploymentResponses, GetDeploymentErrors, ThrowOnError>;
+/**
+ * Update deployment metadata
+ */
+export declare const updateDeployment: <ThrowOnError extends boolean = false>(options: Options<UpdateDeploymentData, ThrowOnError>) => RequestResult<UpdateDeploymentResponses, UpdateDeploymentErrors, ThrowOnError>;