@gleanwork/api-client 0.17.3 → 0.18.0

package/src/models/operations/platformskillsgetversioncontent.ts

@@ -0,0 +1,83 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 191f01905043
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type PlatformSkillsGetVersionContentRequest = {
+  /**
+   * Glean skill ID.
+   */
+  skill_id: string;
+  /**
+   * Major version number.
+   */
+  version: number;
+};
+
+export type PlatformSkillsGetVersionContentResponse = {
+  Headers: { [k: string]: Array<string> };
+  result: ReadableStream<Uint8Array>;
+};
+
+/** @internal */
+export type PlatformSkillsGetVersionContentRequest$Outbound = {
+  skill_id: string;
+  version: number;
+};
+
+/** @internal */
+export const PlatformSkillsGetVersionContentRequest$outboundSchema: z.ZodType<
+  PlatformSkillsGetVersionContentRequest$Outbound,
+  z.ZodTypeDef,
+  PlatformSkillsGetVersionContentRequest
+> = z.object({
+  skill_id: z.string(),
+  version: z.number().int(),
+});
+
+export function platformSkillsGetVersionContentRequestToJSON(
+  platformSkillsGetVersionContentRequest:
+    PlatformSkillsGetVersionContentRequest,
+): string {
+  return JSON.stringify(
+    PlatformSkillsGetVersionContentRequest$outboundSchema.parse(
+      platformSkillsGetVersionContentRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const PlatformSkillsGetVersionContentResponse$inboundSchema: z.ZodType<
+  PlatformSkillsGetVersionContentResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())).default({}),
+  Result: z.instanceof(ReadableStream<Uint8Array>),
+}).transform((v) => {
+  return remap$(v, {
+    "Result": "result",
+  });
+});
+
+export function platformSkillsGetVersionContentResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  PlatformSkillsGetVersionContentResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PlatformSkillsGetVersionContentResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'PlatformSkillsGetVersionContentResponse' from JSON`,
+  );
+}

package/src/models/operations/platformskillslist.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 909cbd063812
+ */
+
+import * as z from "zod/v3";
+
+export type PlatformSkillsListRequest = {
+  /**
+   * Maximum number of skills to return.
+   */
+  page_size?: number | undefined;
+  /**
+   * Opaque pagination cursor from a previous response.
+   */
+  cursor?: string | undefined;
+};
+
+/** @internal */
+export type PlatformSkillsListRequest$Outbound = {
+  page_size?: number | undefined;
+  cursor?: string | undefined;
+};
+
+/** @internal */
+export const PlatformSkillsListRequest$outboundSchema: z.ZodType<
+  PlatformSkillsListRequest$Outbound,
+  z.ZodTypeDef,
+  PlatformSkillsListRequest
+> = z.object({
+  page_size: z.number().int().optional(),
+  cursor: z.string().optional(),
+});
+
+export function platformSkillsListRequestToJSON(
+  platformSkillsListRequest: PlatformSkillsListRequest,
+): string {
+  return JSON.stringify(
+    PlatformSkillsListRequest$outboundSchema.parse(platformSkillsListRequest),
+  );
+}

package/src/models/operations/platformskillslistversions.ts

@@ -0,0 +1,49 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 826a93a86c4e
+ */
+
+import * as z from "zod/v3";
+
+export type PlatformSkillsListVersionsRequest = {
+  /**
+   * Glean skill ID.
+   */
+  skill_id: string;
+  /**
+   * Maximum number of versions to return.
+   */
+  page_size?: number | undefined;
+  /**
+   * Opaque pagination cursor from a previous response.
+   */
+  cursor?: string | undefined;
+};
+
+/** @internal */
+export type PlatformSkillsListVersionsRequest$Outbound = {
+  skill_id: string;
+  page_size?: number | undefined;
+  cursor?: string | undefined;
+};
+
+/** @internal */
+export const PlatformSkillsListVersionsRequest$outboundSchema: z.ZodType<
+  PlatformSkillsListVersionsRequest$Outbound,
+  z.ZodTypeDef,
+  PlatformSkillsListVersionsRequest
+> = z.object({
+  skill_id: z.string(),
+  page_size: z.number().int().optional(),
+  cursor: z.string().optional(),
+});
+
+export function platformSkillsListVersionsRequestToJSON(
+  platformSkillsListVersionsRequest: PlatformSkillsListVersionsRequest,
+): string {
+  return JSON.stringify(
+    PlatformSkillsListVersionsRequest$outboundSchema.parse(
+      platformSkillsListVersionsRequest,
+    ),
+  );
+}

package/src/models/operations/postrestapiindexsubmissionsdatasourceinstancetype.ts

@@ -0,0 +1,92 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 85b9298a2d8c
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export const PostRestApiIndexSubmissionsDatasourceInstanceTypeServerList = [
+  "https://{instance}-be.glean.com",
+] as const;
+
+export type PostRestApiIndexSubmissionsDatasourceInstanceTypeRequest = {
+  /**
+   * Datasource instance that should process the submission
+   */
+  datasourceInstance: string;
+  /**
+   * Submission type registered for the datasource
+   */
+  type: string;
+  requestBody: { [k: string]: any };
+};
+
+/**
+ * Accepted
+ */
+export type PostRestApiIndexSubmissionsDatasourceInstanceTypeResponse = {
+  requestId: string;
+};
+
+/** @internal */
+export type PostRestApiIndexSubmissionsDatasourceInstanceTypeRequest$Outbound =
+  {
+    datasourceInstance: string;
+    type: string;
+    RequestBody: { [k: string]: any };
+  };
+
+/** @internal */
+export const PostRestApiIndexSubmissionsDatasourceInstanceTypeRequest$outboundSchema:
+  z.ZodType<
+    PostRestApiIndexSubmissionsDatasourceInstanceTypeRequest$Outbound,
+    z.ZodTypeDef,
+    PostRestApiIndexSubmissionsDatasourceInstanceTypeRequest
+  > = z.object({
+    datasourceInstance: z.string(),
+    type: z.string(),
+    requestBody: z.record(z.any()),
+  }).transform((v) => {
+    return remap$(v, {
+      requestBody: "RequestBody",
+    });
+  });
+
+export function postRestApiIndexSubmissionsDatasourceInstanceTypeRequestToJSON(
+  postRestApiIndexSubmissionsDatasourceInstanceTypeRequest:
+    PostRestApiIndexSubmissionsDatasourceInstanceTypeRequest,
+): string {
+  return JSON.stringify(
+    PostRestApiIndexSubmissionsDatasourceInstanceTypeRequest$outboundSchema
+      .parse(postRestApiIndexSubmissionsDatasourceInstanceTypeRequest),
+  );
+}
+
+/** @internal */
+export const PostRestApiIndexSubmissionsDatasourceInstanceTypeResponse$inboundSchema:
+  z.ZodType<
+    PostRestApiIndexSubmissionsDatasourceInstanceTypeResponse,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    requestId: z.string(),
+  });
+
+export function postRestApiIndexSubmissionsDatasourceInstanceTypeResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  PostRestApiIndexSubmissionsDatasourceInstanceTypeResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PostRestApiIndexSubmissionsDatasourceInstanceTypeResponse$inboundSchema
+        .parse(JSON.parse(x)),
+    `Failed to parse 'PostRestApiIndexSubmissionsDatasourceInstanceTypeResponse' from JSON`,
+  );
+}

package/src/react-query/index.ts

@@ -107,6 +107,7 @@ export * from "./indexingCustomMetadataUpsert.js";
 export * from "./indexingCustomMetadataUpsertSchema.js";
 export * from "./indexingDatasourcesAdd.js";
 export * from "./indexingDatasourcesRetrieveConfig.js";
+export * from "./indexingDatasourcesSubmit.js";
 export * from "./indexingDatasourceStatus.js";
 export * from "./indexingDocumentsAddOrUpdate.js";
 export * from "./indexingDocumentsBulkIndex.js";
@@ -143,3 +144,12 @@ export * from "./indexingPermissionsUpdatePermissions.js";
 export * from "./indexingShortcutsBulkIndex.js";
 export * from "./indexingShortcutsUpload.js";
 export * from "./searchQuery.js";
+export * from "./skillsCreate.js";
+export * from "./skillsCreateVersion.js";
+export * from "./skillsList.js";
+export * from "./skillsListVersions.js";
+export * from "./skillsRetrieve.js";
+export * from "./skillsRetrieveContent.js";
+export * from "./skillsRetrieveVersion.js";
+export * from "./skillsRetrieveVersionContent.js";
+export * from "./skillsValidate.js";

package/src/react-query/indexingDatasourcesSubmit.ts

@@ -0,0 +1,118 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 2975f214d3b7
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { indexingDatasourcesSubmit } from "../funcs/indexingDatasourcesSubmit.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { GleanBaseError } from "../models/errors/gleanbaseerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { useGleanContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type IndexingDatasourcesSubmitMutationVariables = {
+  requestBody: { [k: string]: any };
+  datasourceInstance: string;
+  type: string;
+  options?: RequestOptions;
+};
+
+export type IndexingDatasourcesSubmitMutationData =
+  operations.PostRestApiIndexSubmissionsDatasourceInstanceTypeResponse;
+
+export type IndexingDatasourcesSubmitMutationError =
+  | errors.ErrorInfoResponse
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Submit datasource data
+ *
+ * @remarks
+ * Validates and asynchronously processes a datasource-specific submission.
+ */
+export function useIndexingDatasourcesSubmitMutation(
+  options?: MutationHookOptions<
+    IndexingDatasourcesSubmitMutationData,
+    IndexingDatasourcesSubmitMutationError,
+    IndexingDatasourcesSubmitMutationVariables
+  >,
+): UseMutationResult<
+  IndexingDatasourcesSubmitMutationData,
+  IndexingDatasourcesSubmitMutationError,
+  IndexingDatasourcesSubmitMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildIndexingDatasourcesSubmitMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyIndexingDatasourcesSubmit(): MutationKey {
+  return ["@gleanwork/api-client", "datasources", "submit"];
+}
+
+export function buildIndexingDatasourcesSubmitMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: IndexingDatasourcesSubmitMutationVariables,
+  ) => Promise<IndexingDatasourcesSubmitMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyIndexingDatasourcesSubmit(),
+    mutationFn: function indexingDatasourcesSubmitMutationFn({
+      requestBody,
+      datasourceInstance,
+      type,
+      options,
+    }): Promise<IndexingDatasourcesSubmitMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(indexingDatasourcesSubmit(
+        client$,
+        requestBody,
+        datasourceInstance,
+        type,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/skillsCreate.ts

@@ -0,0 +1,111 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 7726086743dc
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { skillsCreate } from "../funcs/skillsCreate.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { GleanBaseError } from "../models/errors/gleanbaseerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { unwrapAsync } from "../types/fp.js";
+import { useGleanContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type SkillsCreateMutationVariables = {
+  request: components.PlatformSkillCreateRequest;
+  options?: RequestOptions;
+};
+
+export type SkillsCreateMutationData = components.PlatformSkillCreateResponse;
+
+export type SkillsCreateMutationError =
+  | errors.PlatformProblemDetailError
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Create skill
+ *
+ * @remarks
+ * Create a skill from an uploaded SKILL.md, .zip, or .skill bundle. If the authenticated user already has a skill with the same name, the existing skill is superseded with a new version.
+ */
+export function useSkillsCreateMutation(
+  options?: MutationHookOptions<
+    SkillsCreateMutationData,
+    SkillsCreateMutationError,
+    SkillsCreateMutationVariables
+  >,
+): UseMutationResult<
+  SkillsCreateMutationData,
+  SkillsCreateMutationError,
+  SkillsCreateMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildSkillsCreateMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeySkillsCreate(): MutationKey {
+  return ["@gleanwork/api-client", "skills", "create"];
+}
+
+export function buildSkillsCreateMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: SkillsCreateMutationVariables,
+  ) => Promise<SkillsCreateMutationData>;
+} {
+  return {
+    mutationKey: mutationKeySkillsCreate(),
+    mutationFn: function skillsCreateMutationFn({
+      request,
+      options,
+    }): Promise<SkillsCreateMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(skillsCreate(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/skillsCreateVersion.ts

@@ -0,0 +1,116 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 2bcd9406d548
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { skillsCreateVersion } from "../funcs/skillsCreateVersion.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { GleanBaseError } from "../models/errors/gleanbaseerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { unwrapAsync } from "../types/fp.js";
+import { useGleanContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type SkillsCreateVersionMutationVariables = {
+  platformSkillVersionCreateRequest:
+    components.PlatformSkillVersionCreateRequest;
+  skillId: string;
+  options?: RequestOptions;
+};
+
+export type SkillsCreateVersionMutationData =
+  components.PlatformSkillVersionCreateResponse;
+
+export type SkillsCreateVersionMutationError =
+  | errors.PlatformProblemDetailError
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Create skill version
+ *
+ * @remarks
+ * Create a new immutable version for an existing caller-managed skill from an uploaded SKILL.md, .zip, or .skill bundle.
+ */
+export function useSkillsCreateVersionMutation(
+  options?: MutationHookOptions<
+    SkillsCreateVersionMutationData,
+    SkillsCreateVersionMutationError,
+    SkillsCreateVersionMutationVariables
+  >,
+): UseMutationResult<
+  SkillsCreateVersionMutationData,
+  SkillsCreateVersionMutationError,
+  SkillsCreateVersionMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildSkillsCreateVersionMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeySkillsCreateVersion(): MutationKey {
+  return ["@gleanwork/api-client", "skills", "createVersion"];
+}
+
+export function buildSkillsCreateVersionMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: SkillsCreateVersionMutationVariables,
+  ) => Promise<SkillsCreateVersionMutationData>;
+} {
+  return {
+    mutationKey: mutationKeySkillsCreateVersion(),
+    mutationFn: function skillsCreateVersionMutationFn({
+      platformSkillVersionCreateRequest,
+      skillId,
+      options,
+    }): Promise<SkillsCreateVersionMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(skillsCreateVersion(
+        client$,
+        platformSkillVersionCreateRequest,
+        skillId,
+        mergedOptions,
+      ));
+    },
+  };
+}