@financeable/aggregation 0.2.5 → 0.3.1

package/src/models/components/security.ts

@@ -0,0 +1,62 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type Security = {
+  clientCredentials?: string | undefined;
+};
+
+/** @internal */
+export const Security$inboundSchema: z.ZodType<
+  Security,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  clientCredentials: z.string().optional(),
+});
+
+/** @internal */
+export type Security$Outbound = {
+  clientCredentials?: string | undefined;
+};
+
+/** @internal */
+export const Security$outboundSchema: z.ZodType<
+  Security$Outbound,
+  z.ZodTypeDef,
+  Security
+> = z.object({
+  clientCredentials: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Security$ {
+  /** @deprecated use `Security$inboundSchema` instead. */
+  export const inboundSchema = Security$inboundSchema;
+  /** @deprecated use `Security$outboundSchema` instead. */
+  export const outboundSchema = Security$outboundSchema;
+  /** @deprecated use `Security$Outbound` instead. */
+  export type Outbound = Security$Outbound;
+}
+
+export function securityToJSON(security: Security): string {
+  return JSON.stringify(Security$outboundSchema.parse(security));
+}
+
+export function securityFromJSON(
+  jsonString: string,
+): SafeParseResult<Security, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Security$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Security' from JSON`,
+  );
+}

package/src/models/components/tokenrequest.ts

@@ -0,0 +1,133 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Must be 'client_credentials'
+ */
+export const GrantType = {
+  ClientCredentials: "client_credentials",
+} as const;
+/**
+ * Must be 'client_credentials'
+ */
+export type GrantType = ClosedEnum<typeof GrantType>;
+
+/**
+ * Token request for client credentials flow
+ */
+export type TokenRequest = {
+  /**
+   * Must be 'client_credentials'
+   */
+  grantType: GrantType;
+  /**
+   * The client ID
+   */
+  clientId: string;
+  /**
+   * The client secret
+   */
+  clientSecret: string;
+  /**
+   * Scope of the token
+   */
+  scope: string;
+};
+
+/** @internal */
+export const GrantType$inboundSchema: z.ZodNativeEnum<typeof GrantType> = z
+  .nativeEnum(GrantType);
+
+/** @internal */
+export const GrantType$outboundSchema: z.ZodNativeEnum<typeof GrantType> =
+  GrantType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GrantType$ {
+  /** @deprecated use `GrantType$inboundSchema` instead. */
+  export const inboundSchema = GrantType$inboundSchema;
+  /** @deprecated use `GrantType$outboundSchema` instead. */
+  export const outboundSchema = GrantType$outboundSchema;
+}
+
+/** @internal */
+export const TokenRequest$inboundSchema: z.ZodType<
+  TokenRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  grant_type: GrantType$inboundSchema,
+  client_id: z.string(),
+  client_secret: z.string(),
+  scope: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "grant_type": "grantType",
+    "client_id": "clientId",
+    "client_secret": "clientSecret",
+  });
+});
+
+/** @internal */
+export type TokenRequest$Outbound = {
+  grant_type: string;
+  client_id: string;
+  client_secret: string;
+  scope: string;
+};
+
+/** @internal */
+export const TokenRequest$outboundSchema: z.ZodType<
+  TokenRequest$Outbound,
+  z.ZodTypeDef,
+  TokenRequest
+> = z.object({
+  grantType: GrantType$outboundSchema,
+  clientId: z.string(),
+  clientSecret: z.string(),
+  scope: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    grantType: "grant_type",
+    clientId: "client_id",
+    clientSecret: "client_secret",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TokenRequest$ {
+  /** @deprecated use `TokenRequest$inboundSchema` instead. */
+  export const inboundSchema = TokenRequest$inboundSchema;
+  /** @deprecated use `TokenRequest$outboundSchema` instead. */
+  export const outboundSchema = TokenRequest$outboundSchema;
+  /** @deprecated use `TokenRequest$Outbound` instead. */
+  export type Outbound = TokenRequest$Outbound;
+}
+
+export function tokenRequestToJSON(tokenRequest: TokenRequest): string {
+  return JSON.stringify(TokenRequest$outboundSchema.parse(tokenRequest));
+}
+
+export function tokenRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<TokenRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TokenRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TokenRequest' from JSON`,
+  );
+}

package/src/models/components/tokenresponse.ts

@@ -0,0 +1,102 @@
+/*
+ * 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";
+
+/**
+ * Token response
+ */
+export type TokenResponse = {
+  /**
+   * The access token
+   */
+  accessToken: string;
+  /**
+   * Token type, usually 'Bearer'
+   */
+  tokenType: string;
+  /**
+   * Expiration time in seconds
+   */
+  expiresIn: number;
+  /**
+   * Scope of the token
+   */
+  scope: string;
+};
+
+/** @internal */
+export const TokenResponse$inboundSchema: z.ZodType<
+  TokenResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  access_token: z.string(),
+  token_type: z.string(),
+  expires_in: z.number().int(),
+  scope: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "access_token": "accessToken",
+    "token_type": "tokenType",
+    "expires_in": "expiresIn",
+  });
+});
+
+/** @internal */
+export type TokenResponse$Outbound = {
+  access_token: string;
+  token_type: string;
+  expires_in: number;
+  scope: string;
+};
+
+/** @internal */
+export const TokenResponse$outboundSchema: z.ZodType<
+  TokenResponse$Outbound,
+  z.ZodTypeDef,
+  TokenResponse
+> = z.object({
+  accessToken: z.string(),
+  tokenType: z.string(),
+  expiresIn: z.number().int(),
+  scope: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    accessToken: "access_token",
+    tokenType: "token_type",
+    expiresIn: "expires_in",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TokenResponse$ {
+  /** @deprecated use `TokenResponse$inboundSchema` instead. */
+  export const inboundSchema = TokenResponse$inboundSchema;
+  /** @deprecated use `TokenResponse$outboundSchema` instead. */
+  export const outboundSchema = TokenResponse$outboundSchema;
+  /** @deprecated use `TokenResponse$Outbound` instead. */
+  export type Outbound = TokenResponse$Outbound;
+}
+
+export function tokenResponseToJSON(tokenResponse: TokenResponse): string {
+  return JSON.stringify(TokenResponse$outboundSchema.parse(tokenResponse));
+}
+
+export function tokenResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<TokenResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TokenResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TokenResponse' from JSON`,
+  );
+}

package/src/sdk/sdk.ts

@@ -2,7 +2,10 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import { ClientSDK } from "../lib/sdks.js";
+import { getToken } from "../funcs/getToken.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
 import { Applications } from "./applications.js";
 
 export class Financeable extends ClientSDK {
@@ -10,4 +13,18 @@ export class Financeable extends ClientSDK {
   get applications(): Applications {
     return (this._applications ??= new Applications(this._options));
   }
+
+  /**
+   * Obtain an OAuth client_credentials token
+   */
+  async getToken(
+    request: components.TokenRequest,
+    options?: RequestOptions,
+  ): Promise<components.TokenResponse> {
+    return unwrapAsync(getToken(
+      this,
+      request,
+      options,
+    ));
+  }
 }

package/src/types/async.ts

@@ -0,0 +1,68 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export type APICall =
+  | {
+      status: "complete";
+      request: Request;
+      response: Response;
+    }
+  | {
+      status: "request-error";
+      request: Request;
+      response?: undefined;
+    }
+  | {
+      status: "invalid";
+      request?: undefined;
+      response?: undefined;
+    };
+
+export class APIPromise<T> implements Promise<T> {
+  readonly #promise: Promise<[T, APICall]>;
+  readonly #unwrapped: Promise<T>;
+
+  readonly [Symbol.toStringTag] = "APIPromise";
+
+  constructor(p: [T, APICall] | Promise<[T, APICall]>) {
+    this.#promise = p instanceof Promise ? p : Promise.resolve(p);
+    this.#unwrapped =
+      p instanceof Promise
+        ? this.#promise.then(([value]) => value)
+        : Promise.resolve(p[0]);
+  }
+
+  then<TResult1 = T, TResult2 = never>(
+    onfulfilled?:
+      | ((value: T) => TResult1 | PromiseLike<TResult1>)
+      | null
+      | undefined,
+    onrejected?:
+      | ((reason: any) => TResult2 | PromiseLike<TResult2>)
+      | null
+      | undefined,
+  ): Promise<TResult1 | TResult2> {
+    return this.#promise.then(
+      onfulfilled ? ([value]) => onfulfilled(value) : void 0,
+      onrejected,
+    );
+  }
+
+  catch<TResult = never>(
+    onrejected?:
+      | ((reason: any) => TResult | PromiseLike<TResult>)
+      | null
+      | undefined,
+  ): Promise<T | TResult> {
+    return this.#unwrapped.catch(onrejected);
+  }
+
+  finally(onfinally?: (() => void) | null | undefined): Promise<T> {
+    return this.#unwrapped.finally(onfinally);
+  }
+
+  $inspect(): Promise<[T, APICall]> {
+    return this.#promise;
+  }
+}

package/types/async.d.ts

@@ -0,0 +1,23 @@
+export type APICall = {
+    status: "complete";
+    request: Request;
+    response: Response;
+} | {
+    status: "request-error";
+    request: Request;
+    response?: undefined;
+} | {
+    status: "invalid";
+    request?: undefined;
+    response?: undefined;
+};
+export declare class APIPromise<T> implements Promise<T> {
+    #private;
+    readonly [Symbol.toStringTag] = "APIPromise";
+    constructor(p: [T, APICall] | Promise<[T, APICall]>);
+    then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null | undefined, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null | undefined): Promise<TResult1 | TResult2>;
+    catch<TResult = never>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null | undefined): Promise<T | TResult>;
+    finally(onfinally?: (() => void) | null | undefined): Promise<T>;
+    $inspect(): Promise<[T, APICall]>;
+}
+//# sourceMappingURL=async.d.ts.map

package/types/async.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"async.d.ts","sourceRoot":"","sources":["../src/types/async.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,OAAO,GACf;IACE,MAAM,EAAE,UAAU,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,QAAQ,CAAC;CACpB,GACD;IACE,MAAM,EAAE,eAAe,CAAC;IACxB,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB,GACD;IACE,MAAM,EAAE,SAAS,CAAC;IAClB,OAAO,CAAC,EAAE,SAAS,CAAC;IACpB,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB,CAAC;AAEN,qBAAa,UAAU,CAAC,CAAC,CAAE,YAAW,OAAO,CAAC,CAAC,CAAC;;IAI9C,QAAQ,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,gBAAgB;gBAEjC,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IAQnD,IAAI,CAAC,QAAQ,GAAG,CAAC,EAAE,QAAQ,GAAG,KAAK,EACjC,WAAW,CAAC,EACR,CAAC,CAAC,KAAK,EAAE,CAAC,KAAK,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,GAChD,IAAI,GACJ,SAAS,EACb,UAAU,CAAC,EACP,CAAC,CAAC,MAAM,EAAE,GAAG,KAAK,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,GACnD,IAAI,GACJ,SAAS,GACZ,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAO/B,KAAK,CAAC,OAAO,GAAG,KAAK,EACnB,UAAU,CAAC,EACP,CAAC,CAAC,MAAM,EAAE,GAAG,KAAK,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,GACjD,IAAI,GACJ,SAAS,GACZ,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC;IAIvB,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,CAAC,CAAC,CAAC;IAIhE,QAAQ,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;CAGlC"}

package/types/async.js

@@ -0,0 +1,44 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _APIPromise_promise, _APIPromise_unwrapped, _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.APIPromise = void 0;
+class APIPromise {
+    constructor(p) {
+        _APIPromise_promise.set(this, void 0);
+        _APIPromise_unwrapped.set(this, void 0);
+        this[_a] = "APIPromise";
+        __classPrivateFieldSet(this, _APIPromise_promise, p instanceof Promise ? p : Promise.resolve(p), "f");
+        __classPrivateFieldSet(this, _APIPromise_unwrapped, p instanceof Promise
+            ? __classPrivateFieldGet(this, _APIPromise_promise, "f").then(([value]) => value)
+            : Promise.resolve(p[0]), "f");
+    }
+    then(onfulfilled, onrejected) {
+        return __classPrivateFieldGet(this, _APIPromise_promise, "f").then(onfulfilled ? ([value]) => onfulfilled(value) : void 0, onrejected);
+    }
+    catch(onrejected) {
+        return __classPrivateFieldGet(this, _APIPromise_unwrapped, "f").catch(onrejected);
+    }
+    finally(onfinally) {
+        return __classPrivateFieldGet(this, _APIPromise_unwrapped, "f").finally(onfinally);
+    }
+    $inspect() {
+        return __classPrivateFieldGet(this, _APIPromise_promise, "f");
+    }
+}
+exports.APIPromise = APIPromise;
+_APIPromise_promise = new WeakMap(), _APIPromise_unwrapped = new WeakMap(), _a = Symbol.toStringTag;
+//# sourceMappingURL=async.js.map

package/types/async.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"async.js","sourceRoot":"","sources":["../src/types/async.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;AAmBH,MAAa,UAAU;IAMrB,YAAY,CAAuC;QAL1C,sCAAgC;QAChC,wCAAuB;QAEvB,QAAoB,GAAG,YAAY,CAAC;QAG3C,uBAAA,IAAI,uBAAY,CAAC,YAAY,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,MAAA,CAAC;QAC9D,uBAAA,IAAI,yBACF,CAAC,YAAY,OAAO;YAClB,CAAC,CAAC,uBAAA,IAAI,2BAAS,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC;YACxC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAA,CAAC;IAC9B,CAAC;IAED,IAAI,CACF,WAGa,EACb,UAGa;QAEb,OAAO,uBAAA,IAAI,2BAAS,CAAC,IAAI,CACvB,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EACtD,UAAU,CACX,CAAC;IACJ,CAAC;IAED,KAAK,CACH,UAGa;QAEb,OAAO,uBAAA,IAAI,6BAAW,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAC3C,CAAC;IAED,OAAO,CAAC,SAA2C;QACjD,OAAO,uBAAA,IAAI,6BAAW,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAC5C,CAAC;IAED,QAAQ;QACN,OAAO,uBAAA,IAAI,2BAAS,CAAC;IACvB,CAAC;CACF;AA9CD,gCA8CC;iFA1CW,MAAM,CAAC,WAAW"}