@moovio/sdk 0.10.0 → 0.10.2

package/src/models/operations/getterminalconfiguration.ts

@@ -0,0 +1,229 @@
+/*
+ * 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 GetTerminalConfigurationGlobals = {
+  /**
+   * 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 GetTerminalConfigurationRequest = {
+  accountID: string;
+  terminalApplicationID: string;
+};
+
+export type GetTerminalConfigurationResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.TerminalConfiguration;
+};
+
+/** @internal */
+export const GetTerminalConfigurationGlobals$inboundSchema: z.ZodType<
+  GetTerminalConfigurationGlobals,
+  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 GetTerminalConfigurationGlobals$Outbound = {
+  "x-moov-version": string;
+};
+
+/** @internal */
+export const GetTerminalConfigurationGlobals$outboundSchema: z.ZodType<
+  GetTerminalConfigurationGlobals$Outbound,
+  z.ZodTypeDef,
+  GetTerminalConfigurationGlobals
+> = 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 GetTerminalConfigurationGlobals$ {
+  /** @deprecated use `GetTerminalConfigurationGlobals$inboundSchema` instead. */
+  export const inboundSchema = GetTerminalConfigurationGlobals$inboundSchema;
+  /** @deprecated use `GetTerminalConfigurationGlobals$outboundSchema` instead. */
+  export const outboundSchema = GetTerminalConfigurationGlobals$outboundSchema;
+  /** @deprecated use `GetTerminalConfigurationGlobals$Outbound` instead. */
+  export type Outbound = GetTerminalConfigurationGlobals$Outbound;
+}
+
+export function getTerminalConfigurationGlobalsToJSON(
+  getTerminalConfigurationGlobals: GetTerminalConfigurationGlobals,
+): string {
+  return JSON.stringify(
+    GetTerminalConfigurationGlobals$outboundSchema.parse(
+      getTerminalConfigurationGlobals,
+    ),
+  );
+}
+
+export function getTerminalConfigurationGlobalsFromJSON(
+  jsonString: string,
+): SafeParseResult<GetTerminalConfigurationGlobals, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetTerminalConfigurationGlobals$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetTerminalConfigurationGlobals' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetTerminalConfigurationRequest$inboundSchema: z.ZodType<
+  GetTerminalConfigurationRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  accountID: z.string(),
+  terminalApplicationID: z.string(),
+});
+
+/** @internal */
+export type GetTerminalConfigurationRequest$Outbound = {
+  accountID: string;
+  terminalApplicationID: string;
+};
+
+/** @internal */
+export const GetTerminalConfigurationRequest$outboundSchema: z.ZodType<
+  GetTerminalConfigurationRequest$Outbound,
+  z.ZodTypeDef,
+  GetTerminalConfigurationRequest
+> = z.object({
+  accountID: z.string(),
+  terminalApplicationID: 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 GetTerminalConfigurationRequest$ {
+  /** @deprecated use `GetTerminalConfigurationRequest$inboundSchema` instead. */
+  export const inboundSchema = GetTerminalConfigurationRequest$inboundSchema;
+  /** @deprecated use `GetTerminalConfigurationRequest$outboundSchema` instead. */
+  export const outboundSchema = GetTerminalConfigurationRequest$outboundSchema;
+  /** @deprecated use `GetTerminalConfigurationRequest$Outbound` instead. */
+  export type Outbound = GetTerminalConfigurationRequest$Outbound;
+}
+
+export function getTerminalConfigurationRequestToJSON(
+  getTerminalConfigurationRequest: GetTerminalConfigurationRequest,
+): string {
+  return JSON.stringify(
+    GetTerminalConfigurationRequest$outboundSchema.parse(
+      getTerminalConfigurationRequest,
+    ),
+  );
+}
+
+export function getTerminalConfigurationRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GetTerminalConfigurationRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetTerminalConfigurationRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetTerminalConfigurationRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetTerminalConfigurationResponse$inboundSchema: z.ZodType<
+  GetTerminalConfigurationResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())),
+  Result: components.TerminalConfiguration$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+
+/** @internal */
+export type GetTerminalConfigurationResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result: components.TerminalConfiguration$Outbound;
+};
+
+/** @internal */
+export const GetTerminalConfigurationResponse$outboundSchema: z.ZodType<
+  GetTerminalConfigurationResponse$Outbound,
+  z.ZodTypeDef,
+  GetTerminalConfigurationResponse
+> = z.object({
+  headers: z.record(z.array(z.string())),
+  result: components.TerminalConfiguration$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 GetTerminalConfigurationResponse$ {
+  /** @deprecated use `GetTerminalConfigurationResponse$inboundSchema` instead. */
+  export const inboundSchema = GetTerminalConfigurationResponse$inboundSchema;
+  /** @deprecated use `GetTerminalConfigurationResponse$outboundSchema` instead. */
+  export const outboundSchema = GetTerminalConfigurationResponse$outboundSchema;
+  /** @deprecated use `GetTerminalConfigurationResponse$Outbound` instead. */
+  export type Outbound = GetTerminalConfigurationResponse$Outbound;
+}
+
+export function getTerminalConfigurationResponseToJSON(
+  getTerminalConfigurationResponse: GetTerminalConfigurationResponse,
+): string {
+  return JSON.stringify(
+    GetTerminalConfigurationResponse$outboundSchema.parse(
+      getTerminalConfigurationResponse,
+    ),
+  );
+}
+
+export function getTerminalConfigurationResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetTerminalConfigurationResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetTerminalConfigurationResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetTerminalConfigurationResponse' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -65,6 +65,7 @@ export * from "./getschedules.js";
 export * from "./getsweep.js";
 export * from "./getsweepconfig.js";
 export * from "./getterminalapplication.js";
+export * from "./getterminalconfiguration.js";
 export * from "./gettermsofservicetoken.js";
 export * from "./gettransfer.js";
 export * from "./getunderwriting.js";

package/src/sdk/sdk.ts

@@ -31,6 +31,7 @@ import { Representatives } from "./representatives.js";
 import { Scheduling } from "./scheduling.js";
 import { Sweeps } from "./sweeps.js";
 import { TerminalApplications } from "./terminalapplications.js";
+import { TerminalConfigurations } from "./terminalconfigurations.js";
 import { Transfers } from "./transfers.js";
 import { Underwriting } from "./underwriting.js";
 import { Wallets } from "./wallets.js";
@@ -112,6 +113,13 @@ export class Moov extends ClientSDK {
     return (this._sweeps ??= new Sweeps(this._options));
   }
 
+  private _terminalConfigurations?: TerminalConfigurations;
+  get terminalConfigurations(): TerminalConfigurations {
+    return (this._terminalConfigurations ??= new TerminalConfigurations(
+      this._options,
+    ));
+  }
+
   private _transfers?: Transfers;
   get transfers(): Transfers {
     return (this._transfers ??= new Transfers(this._options));

package/src/sdk/terminalconfigurations.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { terminalConfigurationsGet } from "../funcs/terminalConfigurationsGet.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class TerminalConfigurations extends ClientSDK {
+  /**
+   * Fetch the configuration for a given Terminal Application
+   *
+   * To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
+   * you'll need to specify the `/accounts/{accountID}/terminal-configuration.read` scope.
+   */
+  async get(
+    request: operations.GetTerminalConfigurationRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetTerminalConfigurationResponse> {
+    return unwrapAsync(terminalConfigurationsGet(
+      this,
+      request,
+      options,
+    ));
+  }
+}