@gleanwork/api-client 0.14.19 → 0.15.0

package/src/funcs/datasourcesRotateDatasourceCredentials.ts

@@ -0,0 +1,196 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 494d27ff47ff
+ */
+
+import { GleanCore } from "../core.js";
+import { encodeJSON, encodeSimple } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.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 * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Rotate datasource instance credentials
+ *
+ * @remarks
+ * Rotates the credentials that a datasource instance uses to connect to its upstream system. Replaces the active credential material with the supplied values and returns the credential status after rotation. Access is limited to callers with the ADMIN scope; the handler enforces this check.
+ * Only keys recognized as credential material for the datasource type may be set in `credentials.values` (e.g. `clientSecret`, `apiToken`, `privateKey`, depending on the configured auth method). Unrecognized keys, or keys that correspond to non-credential configuration, cause a 400; other instance configuration must be updated via PATCH /configure/datasources/{datasourceId}/instances/{instanceId}.
+ */
+export function datasourcesRotateDatasourceCredentials(
+  client: GleanCore,
+  rotateDatasourceCredentialsRequest:
+    components.RotateDatasourceCredentialsRequest,
+  datasourceInstanceId: string,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.DatasourceCredentialStatusResponse,
+    | errors.ErrorResponse
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    rotateDatasourceCredentialsRequest,
+    datasourceInstanceId,
+    options,
+  ));
+}
+
+async function $do(
+  client: GleanCore,
+  rotateDatasourceCredentialsRequest:
+    components.RotateDatasourceCredentialsRequest,
+  datasourceInstanceId: string,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.DatasourceCredentialStatusResponse,
+      | errors.ErrorResponse
+      | GleanBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const input: operations.RotateDatasourceCredentialsRequest = {
+    rotateDatasourceCredentialsRequest: rotateDatasourceCredentialsRequest,
+    datasourceInstanceId: datasourceInstanceId,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      operations.RotateDatasourceCredentialsRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.RotateDatasourceCredentialsRequest, {
+    explode: true,
+  });
+
+  const pathParams = {
+    datasourceInstanceId: encodeSimple(
+      "datasourceInstanceId",
+      payload.datasourceInstanceId,
+      { explode: false, charEncoding: "percent" },
+    ),
+  };
+  const path = pathToFunc(
+    "/rest/api/v1/datasource/{datasourceInstanceId}/credentials",
+  )(pathParams);
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiToken);
+  const securityInput = secConfig == null ? {} : { apiToken: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "rotateDatasourceCredentials",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiToken,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    components.DatasourceCredentialStatusResponse,
+    | errors.ErrorResponse
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.DatasourceCredentialStatusResponse$inboundSchema),
+    M.jsonErr([400, 403, 404], errors.ErrorResponse$inboundSchema),
+    M.fail([401, "4XX"]),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/entitiesGetPersonPhoto.ts

@@ -0,0 +1,203 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: c5da648aa63d
+ */
+
+import { GleanCore } from "../core.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { GleanBaseError } from "../models/errors/gleanbaseerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+export enum GetPersonPhotoAcceptEnum {
+  imageJpeg = "image/jpeg",
+  imagePng = "image/png",
+}
+
+/**
+ * Get person photo
+ *
+ * @remarks
+ * Returns the profile photo bytes for a person whose photo is stored in Glean (crawled from an identity source or user-uploaded via admin console). Photos hosted externally (e.g. Slack CDN) are not served by this endpoint; callers should follow the photoUrl from /people or /listentities directly. Responses include a Cache-Control header (max-age=3600) to reduce redundant fetches.
+ */
+export function entitiesGetPersonPhoto(
+  client: GleanCore,
+  personId: string,
+  ds?: string | undefined,
+  options?: RequestOptions & {
+    acceptHeaderOverride?: GetPersonPhotoAcceptEnum;
+  },
+): APIPromise<
+  Result<
+    operations.GetPersonPhotoResponse,
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    personId,
+    ds,
+    options,
+  ));
+}
+
+async function $do(
+  client: GleanCore,
+  personId: string,
+  ds?: string | undefined,
+  options?: RequestOptions & {
+    acceptHeaderOverride?: GetPersonPhotoAcceptEnum;
+  },
+): Promise<
+  [
+    Result<
+      operations.GetPersonPhotoResponse,
+      | GleanBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const input: operations.GetPersonPhotoRequest = {
+    personId: personId,
+    ds: ds,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) => operations.GetPersonPhotoRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    person_id: encodeSimple("person_id", payload.person_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/rest/api/v1/people/{person_id}/photo")(pathParams);
+
+  const query = encodeFormQuery({
+    "ds": payload.ds,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: options?.acceptHeaderOverride || "image/jpeg;q=1, image/png;q=0",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiToken);
+  const securityInput = secConfig == null ? {} : { apiToken: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "getPersonPhoto",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiToken,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.GetPersonPhotoResponse,
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.stream(200, operations.GetPersonPhotoResponse$inboundSchema, {
+      ctype: "image/png",
+      hdrs: true,
+      key: "Result",
+    }),
+    M.stream(200, operations.GetPersonPhotoResponse$inboundSchema, {
+      ctype: "image/jpeg",
+      hdrs: true,
+      key: "Result",
+    }),
+    M.fail([400, 401, 404, 429, "4XX"]),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/indexingCustomMetadataDelete.ts

@@ -0,0 +1,207 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 223e63a6dde2
+ */
+
+import { GleanCore } from "../core.js";
+import { encodeSimple } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.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 { DeleteRestApiIndexDocumentDocIdCustomMetadataGroupNameServerList } from "../models/operations/deleterestapiindexdocumentdocidcustommetadatagroupname.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Remove custom metadata
+ *
+ * @remarks
+ * Removes all custom metadata for the specified metadata group from a document.
+ */
+export function indexingCustomMetadataDelete(
+  client: GleanCore,
+  docId: string,
+  groupName: string,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.SuccessResponse,
+    | errors.ErrorInfoResponse
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    docId,
+    groupName,
+    options,
+  ));
+}
+
+async function $do(
+  client: GleanCore,
+  docId: string,
+  groupName: string,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.SuccessResponse,
+      | errors.ErrorInfoResponse
+      | GleanBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const input:
+    operations.DeleteRestApiIndexDocumentDocIdCustomMetadataGroupNameRequest = {
+      docId: docId,
+      groupName: groupName,
+    };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      operations
+        .DeleteRestApiIndexDocumentDocIdCustomMetadataGroupNameRequest$outboundSchema
+        .parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const baseURL = options?.serverURL
+    || pathToFunc(
+      DeleteRestApiIndexDocumentDocIdCustomMetadataGroupNameServerList[0],
+      { charEncoding: "percent" },
+    )({
+      instance: "instance-name",
+    });
+
+  const pathParams = {
+    docId: encodeSimple("docId", payload.docId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+    groupName: encodeSimple("groupName", payload.groupName, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc(
+    "/rest/api/index/document/{docId}/custom-metadata/{groupName}",
+  )(pathParams);
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiToken);
+  const securityInput = secConfig == null ? {} : { apiToken: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: baseURL ?? "",
+    operationID:
+      "delete_/rest/api/index/document/{docId}/custom-metadata/{groupName}",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiToken,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "DELETE",
+    baseURL: baseURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    components.SuccessResponse,
+    | errors.ErrorInfoResponse
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.SuccessResponse$inboundSchema),
+    M.jsonErr([400, 401, 404, 429], errors.ErrorInfoResponse$inboundSchema),
+    M.jsonErr(500, errors.ErrorInfoResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}