@moovio/sdk 0.15.6 → 0.16.0

package/src/models/operations/getpublicimage.ts

@@ -0,0 +1,244 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 GetPublicImageRequest = {
+  ifNoneMatch?: string | undefined;
+  publicID: string;
+  /**
+   * Optional parameter to request a resized version of the image (WxH).
+   *
+   * @remarks
+   *
+   * If either dimension is 0, the image will be scaled proportionally based on
+   * the non-zero dimension. Dimensions are capped at 2048 pixels. A default size
+   * of 400x400 will be used if this parameter is omitted.
+   */
+  size?: string | undefined;
+};
+
+export type GetPublicImageResponseResult =
+  | ReadableStream<Uint8Array>
+  | ReadableStream<Uint8Array>
+  | ReadableStream<Uint8Array>;
+
+export type GetPublicImageResponse = {
+  headers: { [k: string]: Array<string> };
+  result:
+    | ReadableStream<Uint8Array>
+    | ReadableStream<Uint8Array>
+    | ReadableStream<Uint8Array>;
+};
+
+/** @internal */
+export const GetPublicImageRequest$inboundSchema: z.ZodType<
+  GetPublicImageRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  "if-none-match": z.string().optional(),
+  publicID: z.string(),
+  size: z.string().default("400x400"),
+}).transform((v) => {
+  return remap$(v, {
+    "if-none-match": "ifNoneMatch",
+  });
+});
+
+/** @internal */
+export type GetPublicImageRequest$Outbound = {
+  "if-none-match"?: string | undefined;
+  publicID: string;
+  size: string;
+};
+
+/** @internal */
+export const GetPublicImageRequest$outboundSchema: z.ZodType<
+  GetPublicImageRequest$Outbound,
+  z.ZodTypeDef,
+  GetPublicImageRequest
+> = z.object({
+  ifNoneMatch: z.string().optional(),
+  publicID: z.string(),
+  size: z.string().default("400x400"),
+}).transform((v) => {
+  return remap$(v, {
+    ifNoneMatch: "if-none-match",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetPublicImageRequest$ {
+  /** @deprecated use `GetPublicImageRequest$inboundSchema` instead. */
+  export const inboundSchema = GetPublicImageRequest$inboundSchema;
+  /** @deprecated use `GetPublicImageRequest$outboundSchema` instead. */
+  export const outboundSchema = GetPublicImageRequest$outboundSchema;
+  /** @deprecated use `GetPublicImageRequest$Outbound` instead. */
+  export type Outbound = GetPublicImageRequest$Outbound;
+}
+
+export function getPublicImageRequestToJSON(
+  getPublicImageRequest: GetPublicImageRequest,
+): string {
+  return JSON.stringify(
+    GetPublicImageRequest$outboundSchema.parse(getPublicImageRequest),
+  );
+}
+
+export function getPublicImageRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GetPublicImageRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetPublicImageRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetPublicImageRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetPublicImageResponseResult$inboundSchema: z.ZodType<
+  GetPublicImageResponseResult,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.instanceof(ReadableStream<Uint8Array>),
+  z.instanceof(ReadableStream<Uint8Array>),
+  z.instanceof(ReadableStream<Uint8Array>),
+]);
+
+/** @internal */
+export type GetPublicImageResponseResult$Outbound =
+  | ReadableStream<Uint8Array>
+  | ReadableStream<Uint8Array>
+  | ReadableStream<Uint8Array>;
+
+/** @internal */
+export const GetPublicImageResponseResult$outboundSchema: z.ZodType<
+  GetPublicImageResponseResult$Outbound,
+  z.ZodTypeDef,
+  GetPublicImageResponseResult
+> = z.union([
+  z.instanceof(ReadableStream<Uint8Array>),
+  z.instanceof(ReadableStream<Uint8Array>),
+  z.instanceof(ReadableStream<Uint8Array>),
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetPublicImageResponseResult$ {
+  /** @deprecated use `GetPublicImageResponseResult$inboundSchema` instead. */
+  export const inboundSchema = GetPublicImageResponseResult$inboundSchema;
+  /** @deprecated use `GetPublicImageResponseResult$outboundSchema` instead. */
+  export const outboundSchema = GetPublicImageResponseResult$outboundSchema;
+  /** @deprecated use `GetPublicImageResponseResult$Outbound` instead. */
+  export type Outbound = GetPublicImageResponseResult$Outbound;
+}
+
+export function getPublicImageResponseResultToJSON(
+  getPublicImageResponseResult: GetPublicImageResponseResult,
+): string {
+  return JSON.stringify(
+    GetPublicImageResponseResult$outboundSchema.parse(
+      getPublicImageResponseResult,
+    ),
+  );
+}
+
+export function getPublicImageResponseResultFromJSON(
+  jsonString: string,
+): SafeParseResult<GetPublicImageResponseResult, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetPublicImageResponseResult$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetPublicImageResponseResult' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetPublicImageResponse$inboundSchema: z.ZodType<
+  GetPublicImageResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())),
+  Result: z.union([
+    z.instanceof(ReadableStream<Uint8Array>),
+    z.instanceof(ReadableStream<Uint8Array>),
+    z.instanceof(ReadableStream<Uint8Array>),
+  ]),
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+
+/** @internal */
+export type GetPublicImageResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result:
+    | ReadableStream<Uint8Array>
+    | ReadableStream<Uint8Array>
+    | ReadableStream<Uint8Array>;
+};
+
+/** @internal */
+export const GetPublicImageResponse$outboundSchema: z.ZodType<
+  GetPublicImageResponse$Outbound,
+  z.ZodTypeDef,
+  GetPublicImageResponse
+> = z.object({
+  headers: z.record(z.array(z.string())),
+  result: z.union([
+    z.instanceof(ReadableStream<Uint8Array>),
+    z.instanceof(ReadableStream<Uint8Array>),
+    z.instanceof(ReadableStream<Uint8Array>),
+  ]),
+}).transform((v) => {
+  return remap$(v, {
+    headers: "Headers",
+    result: "Result",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetPublicImageResponse$ {
+  /** @deprecated use `GetPublicImageResponse$inboundSchema` instead. */
+  export const inboundSchema = GetPublicImageResponse$inboundSchema;
+  /** @deprecated use `GetPublicImageResponse$outboundSchema` instead. */
+  export const outboundSchema = GetPublicImageResponse$outboundSchema;
+  /** @deprecated use `GetPublicImageResponse$Outbound` instead. */
+  export type Outbound = GetPublicImageResponse$Outbound;
+}
+
+export function getPublicImageResponseToJSON(
+  getPublicImageResponse: GetPublicImageResponse,
+): string {
+  return JSON.stringify(
+    GetPublicImageResponse$outboundSchema.parse(getPublicImageResponse),
+  );
+}
+
+export function getPublicImageResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetPublicImageResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetPublicImageResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetPublicImageResponse' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -27,6 +27,7 @@ export * from "./createtransfer.js";
 export * from "./createtransferoptions.js";
 export * from "./createwallet.js";
 export * from "./deletedisputeevidencefile.js";
+export * from "./deleteimage.js";
 export * from "./deleterepresentative.js";
 export * from "./deleteterminalapplication.js";
 export * from "./disablebankaccount.js";
@@ -54,6 +55,7 @@ export * from "./getenrichmentaddress.js";
 export * from "./getenrichmentprofile.js";
 export * from "./getfiledetails.js";
 export * from "./getfullissuedcard.js";
+export * from "./getimagemetadata.js";
 export * from "./getissuedcard.js";
 export * from "./getissuedcardauthorization.js";
 export * from "./getissuedcardtransaction.js";
@@ -62,6 +64,7 @@ export * from "./getonboardinginvite.js";
 export * from "./getpaymentlink.js";
 export * from "./getpaymentlinkqrcode.js";
 export * from "./getpaymentmethod.js";
+export * from "./getpublicimage.js";
 export * from "./getrefund.js";
 export * from "./getrepresentative.js";
 export * from "./getscheduledoccurrence.js";
@@ -96,6 +99,7 @@ export * from "./listfeeplanagreements.js";
 export * from "./listfeeplans.js";
 export * from "./listfeesfetch.js";
 export * from "./listfiles.js";
+export * from "./listimagemetadata.js";
 export * from "./listindustries.js";
 export * from "./listinstitutions.js";
 export * from "./listissuedcardauthorizationevents.js";

package/src/models/operations/listimagemetadata.ts

@@ -0,0 +1,219 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ListImageMetadataGlobals = {
+  /**
+   * Specify an API version.
+   *
+   * @remarks
+   *
+   * API versioning follows the format `vYYYY.QQ.BB`, where
+   *   - `YYYY` is the year
+   *   - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
+   *   - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter.
+   *     - For example, `v2024.01.00` is the initial release of the first quarter of 2024.
+   *
+   * The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
+   */
+  xMoovVersion?: string | undefined;
+};
+
+export type ListImageMetadataRequest = {
+  accountID: string;
+};
+
+export type ListImageMetadataResponse = {
+  headers: { [k: string]: Array<string> };
+  result: Array<components.ImageMetadata>;
+};
+
+/** @internal */
+export const ListImageMetadataGlobals$inboundSchema: z.ZodType<
+  ListImageMetadataGlobals,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  "x-moov-version": z.string().default("v2024.01.00"),
+}).transform((v) => {
+  return remap$(v, {
+    "x-moov-version": "xMoovVersion",
+  });
+});
+
+/** @internal */
+export type ListImageMetadataGlobals$Outbound = {
+  "x-moov-version": string;
+};
+
+/** @internal */
+export const ListImageMetadataGlobals$outboundSchema: z.ZodType<
+  ListImageMetadataGlobals$Outbound,
+  z.ZodTypeDef,
+  ListImageMetadataGlobals
+> = z.object({
+  xMoovVersion: z.string().default("v2024.01.00"),
+}).transform((v) => {
+  return remap$(v, {
+    xMoovVersion: "x-moov-version",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListImageMetadataGlobals$ {
+  /** @deprecated use `ListImageMetadataGlobals$inboundSchema` instead. */
+  export const inboundSchema = ListImageMetadataGlobals$inboundSchema;
+  /** @deprecated use `ListImageMetadataGlobals$outboundSchema` instead. */
+  export const outboundSchema = ListImageMetadataGlobals$outboundSchema;
+  /** @deprecated use `ListImageMetadataGlobals$Outbound` instead. */
+  export type Outbound = ListImageMetadataGlobals$Outbound;
+}
+
+export function listImageMetadataGlobalsToJSON(
+  listImageMetadataGlobals: ListImageMetadataGlobals,
+): string {
+  return JSON.stringify(
+    ListImageMetadataGlobals$outboundSchema.parse(listImageMetadataGlobals),
+  );
+}
+
+export function listImageMetadataGlobalsFromJSON(
+  jsonString: string,
+): SafeParseResult<ListImageMetadataGlobals, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListImageMetadataGlobals$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListImageMetadataGlobals' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListImageMetadataRequest$inboundSchema: z.ZodType<
+  ListImageMetadataRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  accountID: z.string(),
+});
+
+/** @internal */
+export type ListImageMetadataRequest$Outbound = {
+  accountID: string;
+};
+
+/** @internal */
+export const ListImageMetadataRequest$outboundSchema: z.ZodType<
+  ListImageMetadataRequest$Outbound,
+  z.ZodTypeDef,
+  ListImageMetadataRequest
+> = z.object({
+  accountID: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListImageMetadataRequest$ {
+  /** @deprecated use `ListImageMetadataRequest$inboundSchema` instead. */
+  export const inboundSchema = ListImageMetadataRequest$inboundSchema;
+  /** @deprecated use `ListImageMetadataRequest$outboundSchema` instead. */
+  export const outboundSchema = ListImageMetadataRequest$outboundSchema;
+  /** @deprecated use `ListImageMetadataRequest$Outbound` instead. */
+  export type Outbound = ListImageMetadataRequest$Outbound;
+}
+
+export function listImageMetadataRequestToJSON(
+  listImageMetadataRequest: ListImageMetadataRequest,
+): string {
+  return JSON.stringify(
+    ListImageMetadataRequest$outboundSchema.parse(listImageMetadataRequest),
+  );
+}
+
+export function listImageMetadataRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ListImageMetadataRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListImageMetadataRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListImageMetadataRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListImageMetadataResponse$inboundSchema: z.ZodType<
+  ListImageMetadataResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())),
+  Result: z.array(components.ImageMetadata$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+
+/** @internal */
+export type ListImageMetadataResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result: Array<components.ImageMetadata$Outbound>;
+};
+
+/** @internal */
+export const ListImageMetadataResponse$outboundSchema: z.ZodType<
+  ListImageMetadataResponse$Outbound,
+  z.ZodTypeDef,
+  ListImageMetadataResponse
+> = z.object({
+  headers: z.record(z.array(z.string())),
+  result: z.array(components.ImageMetadata$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    headers: "Headers",
+    result: "Result",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListImageMetadataResponse$ {
+  /** @deprecated use `ListImageMetadataResponse$inboundSchema` instead. */
+  export const inboundSchema = ListImageMetadataResponse$inboundSchema;
+  /** @deprecated use `ListImageMetadataResponse$outboundSchema` instead. */
+  export const outboundSchema = ListImageMetadataResponse$outboundSchema;
+  /** @deprecated use `ListImageMetadataResponse$Outbound` instead. */
+  export type Outbound = ListImageMetadataResponse$Outbound;
+}
+
+export function listImageMetadataResponseToJSON(
+  listImageMetadataResponse: ListImageMetadataResponse,
+): string {
+  return JSON.stringify(
+    ListImageMetadataResponse$outboundSchema.parse(listImageMetadataResponse),
+  );
+}
+
+export function listImageMetadataResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListImageMetadataResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListImageMetadataResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListImageMetadataResponse' from JSON`,
+  );
+}

package/src/sdk/images.ts

@@ -0,0 +1,74 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { imagesDelete } from "../funcs/imagesDelete.js";
+import { imagesGetMetadata } from "../funcs/imagesGetMetadata.js";
+import {
+  GetPublicAcceptEnum,
+  imagesGetPublic,
+} from "../funcs/imagesGetPublic.js";
+import { imagesList } from "../funcs/imagesList.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export { GetPublicAcceptEnum } from "../funcs/imagesGetPublic.js";
+
+export class Images extends ClientSDK {
+  /**
+   * List metadata for all images in the specified account.
+   */
+  async list(
+    request: operations.ListImageMetadataRequest,
+    options?: RequestOptions,
+  ): Promise<operations.ListImageMetadataResponse> {
+    return unwrapAsync(imagesList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retrieve metadata for a specific image by its ID.
+   */
+  async getMetadata(
+    request: operations.GetImageMetadataRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetImageMetadataResponse> {
+    return unwrapAsync(imagesGetMetadata(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Permanently delete an image by its ID.
+   */
+  async delete(
+    request: operations.DeleteImageRequest,
+    options?: RequestOptions,
+  ): Promise<operations.DeleteImageResponse | undefined> {
+    return unwrapAsync(imagesDelete(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get an image by its public ID.
+   */
+  async getPublic(
+    request: operations.GetPublicImageRequest,
+    options?: RequestOptions & { acceptHeaderOverride?: GetPublicAcceptEnum },
+  ): Promise<operations.GetPublicImageResponse | undefined> {
+    return unwrapAsync(imagesGetPublic(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -20,6 +20,7 @@ import { EnrichedAddress } from "./enrichedaddress.js";
 import { EnrichedProfile } from "./enrichedprofile.js";
 import { FeePlans } from "./feeplans.js";
 import { Files } from "./files.js";
+import { Images } from "./images.js";
 import { Industries } from "./industries.js";
 import { Institutions } from "./institutions.js";
 import { IssuingTransactions } from "./issuingtransactions.js";
@@ -90,6 +91,11 @@ export class Moov extends ClientSDK {
     return (this._files ??= new Files(this._options));
   }
 
+  private _images?: Images;
+  get images(): Images {
+    return (this._images ??= new Images(this._options));
+  }
+
   private _paymentLinks?: PaymentLinks;
   get paymentLinks(): PaymentLinks {
     return (this._paymentLinks ??= new PaymentLinks(this._options));