@shim-finance/typescript-sdk 0.0.1

package/dist/sdk.gen.d.ts

@@ -0,0 +1,22 @@
+import type { Client, Options as Options2, TDataShape } from './client';
+import type { InstitutionsListData, InstitutionsListErrors, InstitutionsListResponses } from './types.gen';
+export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
+    /**
+     * 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?: Record<string, unknown>;
+};
+/**
+ * List institutions
+ *
+ * Returns all connected financial institutions for the authenticated user
+ */
+export declare const institutionsList: <ThrowOnError extends boolean = false>(options?: Options<InstitutionsListData, ThrowOnError>) => import("./client").RequestResult<InstitutionsListResponses, InstitutionsListErrors, ThrowOnError, "fields">;
+//# sourceMappingURL=sdk.gen.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"sdk.gen.d.ts","sourceRoot":"","sources":["../src/sdk.gen.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,OAAO,IAAI,QAAQ,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAExE,OAAO,KAAK,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;AAE3G,MAAM,MAAM,OAAO,CAAC,KAAK,SAAS,UAAU,GAAG,UAAU,EAAE,YAAY,SAAS,OAAO,GAAG,OAAO,IAAI,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAC,GAAG;IACjI;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,GAAI,YAAY,SAAS,OAAO,GAAG,KAAK,EAAE,UAAU,OAAO,CAAC,oBAAoB,EAAE,YAAY,CAAC,gHAAkJ,CAAC"}

package/dist/sdk.gen.js

@@ -0,0 +1,8 @@
+// This file is auto-generated by @hey-api/openapi-ts
+import { client } from './client.gen';
+/**
+ * List institutions
+ *
+ * Returns all connected financial institutions for the authenticated user
+ */
+export const institutionsList = (options) => (options?.client ?? client).get({ url: '/api/v1/institutions', ...options });

package/dist/types.gen.d.ts

@@ -0,0 +1,81 @@
+export type ClientOptions = {
+    baseUrl: 'https://api.shim.finance' | (string & {});
+};
+export type Institution = {
+    id: string;
+    institutionId: string | null;
+    institutionName: string | null;
+    status: 'healthy' | 'error';
+    lastSyncedAt: DateTimeUtc | null;
+    createdAt: DateTimeUtc;
+};
+/**
+ * a string to be decoded into a DateTime.Utc
+ */
+export type DateTimeUtc = string;
+/**
+ * The request did not match the expected schema
+ */
+export type HttpApiDecodeError = {
+    issues: Array<Issue>;
+    message: string;
+    _tag: 'HttpApiDecodeError';
+};
+/**
+ * Represents an error encountered while parsing a value to match the schema
+ */
+export type Issue = {
+    /**
+     * The tag identifying the type of parse issue
+     */
+    _tag: 'Pointer' | 'Unexpected' | 'Missing' | 'Composite' | 'Refinement' | 'Transformation' | 'Type' | 'Forbidden';
+    /**
+     * The path to the property where the issue occurred
+     */
+    path: Array<PropertyKey>;
+    /**
+     * A descriptive message explaining the issue
+     */
+    message: string;
+};
+export type PropertyKey = string | number | {
+    _tag: 'symbol';
+    key: string;
+};
+export type Unauthorized = {
+    message: string;
+    _tag: 'Unauthorized';
+};
+export type InternalError = {
+    message: string;
+    _tag: 'InternalError';
+};
+export type InstitutionsListData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/api/v1/institutions';
+};
+export type InstitutionsListErrors = {
+    /**
+     * The request did not match the expected schema
+     */
+    400: HttpApiDecodeError;
+    /**
+     * Unauthorized
+     */
+    401: Unauthorized;
+    /**
+     * InternalError
+     */
+    500: InternalError;
+};
+export type InstitutionsListError = InstitutionsListErrors[keyof InstitutionsListErrors];
+export type InstitutionsListResponses = {
+    /**
+     * Success
+     */
+    200: Array<Institution>;
+};
+export type InstitutionsListResponse = InstitutionsListResponses[keyof InstitutionsListResponses];
+//# sourceMappingURL=types.gen.d.ts.map

package/dist/types.gen.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.gen.d.ts","sourceRoot":"","sources":["../src/types.gen.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,aAAa,GAAG;IACxB,OAAO,EAAE,0BAA0B,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;CACvD,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC;IAC5B,YAAY,EAAE,WAAW,GAAG,IAAI,CAAC;IACjC,SAAS,EAAE,WAAW,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AAEjC;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC7B,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,oBAAoB,CAAC;CAC9B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,KAAK,GAAG;IAChB;;OAEG;IACH,IAAI,EAAE,SAAS,GAAG,YAAY,GAAG,SAAS,GAAG,WAAW,GAAG,YAAY,GAAG,gBAAgB,GAAG,MAAM,GAAG,WAAW,CAAC;IAClH;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IACzB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG;IACxC,IAAI,EAAE,QAAQ,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,cAAc,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,eAAe,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IAC/B,IAAI,CAAC,EAAE,KAAK,CAAC;IACb,IAAI,CAAC,EAAE,KAAK,CAAC;IACb,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,GAAG,EAAE,sBAAsB,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACjC;;OAEG;IACH,GAAG,EAAE,kBAAkB,CAAC;IACxB;;OAEG;IACH,GAAG,EAAE,YAAY,CAAC;IAClB;;OAEG;IACH,GAAG,EAAE,aAAa,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,sBAAsB,CAAC,MAAM,sBAAsB,CAAC,CAAC;AAEzF,MAAM,MAAM,yBAAyB,GAAG;IACpC;;OAEG;IACH,GAAG,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,yBAAyB,CAAC,MAAM,yBAAyB,CAAC,CAAC"}

package/dist/types.gen.js

@@ -0,0 +1,2 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export {};

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@shim-finance/typescript-sdk",
+  "version": "0.0.1",
+  "description": "TypeScript SDK for the Shim.Finance REST API",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc"
+  },
+  "dependencies": {
+    "@hey-api/client-fetch": "^0.9.0"
+  },
+  "devDependencies": {
+    "typescript": "^5"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Shim-Finance/typescript-sdk"
+  },
+  "license": "MIT"
+}