@greensecurity/javascript-sdk 0.44.0-beta.1 → 0.44.0-beta.3

package/src/funcs/companiesListCompanyCredits.ts

@@ -0,0 +1,261 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { GreenSecurityCore } from "../core.js";
+import { dlv } from "../lib/dlv.js";
+import { encodeFormQuery, encodeSimple, queryJoin } 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 { GreenSecurityError } from "../models/errors/greensecurityerror.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";
+import {
+  createPageIterator,
+  haltIterator,
+  PageIterator,
+  Paginator,
+} from "../types/operations.js";
+
+/**
+ * List credits related to a company
+ *
+ * @remarks
+ * Returns a paginated list of credits associated with the specified company, including incoming and outgoing transactions.
+ *
+ * If set, this operation will use {@link Security.bearerJwt} from the global security.
+ */
+export function companiesListCompanyCredits(
+  client: GreenSecurityCore,
+  request: operations.ListCompanyCreditsRequest,
+  options?: RequestOptions,
+): APIPromise<
+  PageIterator<
+    Result<
+      operations.ListCompanyCreditsResponse,
+      | errors.ApiErrorResponse
+      | GreenSecurityError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    { page: number }
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GreenSecurityCore,
+  request: operations.ListCompanyCreditsRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    PageIterator<
+      Result<
+        operations.ListCompanyCreditsResponse,
+        | errors.ApiErrorResponse
+        | GreenSecurityError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >,
+      { page: number }
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.ListCompanyCreditsRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [haltIterator(parsed), { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    id: encodeSimple("id", payload.id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/companies/{id}/credits")(pathParams);
+
+  const query = queryJoin(
+    encodeFormQuery({
+      "expand": payload.expand,
+    }, { explode: false }),
+    encodeFormQuery({
+      "desc": payload.desc,
+      "items_per_page": payload.items_per_page,
+      "page": payload.page,
+      "sort": payload.sort,
+    }),
+  );
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput, [1]);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "listCompanyCredits",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.security,
+    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 [haltIterator(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 [haltIterator(doResult), { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result, raw] = await M.match<
+    operations.ListCompanyCreditsResponse,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.ListCompanyCreditsResponse$inboundSchema, {
+      key: "Result",
+    }),
+    M.jsonErr([400, 401, 403, 404], errors.ApiErrorResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail([500, "5XX"]),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [haltIterator(result), {
+      status: "complete",
+      request: req,
+      response,
+    }];
+  }
+
+  const nextFunc = (
+    responseData: unknown,
+  ): {
+    next: Paginator<
+      Result<
+        operations.ListCompanyCreditsResponse,
+        | errors.ApiErrorResponse
+        | GreenSecurityError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >
+    >;
+    "~next"?: { page: number };
+  } => {
+    const page = request?.page ?? 1;
+    const nextPage = page + 1;
+
+    if (!responseData) {
+      return { next: () => null };
+    }
+    const results = dlv(responseData, "items");
+    if (!Array.isArray(results) || !results.length) {
+      return { next: () => null };
+    }
+    const limit = request?.itemsPerPage ?? 0;
+    if (results.length < limit) {
+      return { next: () => null };
+    }
+
+    const nextVal = () =>
+      companiesListCompanyCredits(
+        client,
+        {
+          ...request,
+          page: nextPage,
+        },
+        options,
+      );
+
+    return { next: nextVal, "~next": { page: nextPage } };
+  };
+
+  const page = { ...result, ...nextFunc(raw) };
+  return [{ ...page, ...createPageIterator(page, (v) => !v.ok) }, {
+    status: "complete",
+    request: req,
+    response,
+  }];
+}

package/src/funcs/usersGetCurrentUser.ts

@@ -39,6 +39,7 @@ import { Result } from "../types/fp.js";
  * Supported `expand` values:
  * - `user` — return the full user record, including all profile fields stored against the user (sensitive columns such as passwords, MFA codes, and payment-provider IDs are always omitted)
  * - `user.email_preferences` — include the user's `email_preferences` block (notification recipients and weekly email flags)
+ * - `user.payment_profile` — include the user's `payment_profile` block (card type, last four digits, validity flags) when expanded; if no payment profile is associated with the user, the response returns `payment_profile: null`
  * - `company.location`, `company.vendor_type_restrictions`, `company.vendor_fields` — only valid for Company Manager users; embed extra fields on the user's company
  *
  * Multiple values can be combined with commas, e.g.

package/src/lib/config.ts

@@ -80,8 +80,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.43.1",
-  sdkVersion: "0.44.0-beta.1",
-  genVersion: "2.884.4",
+  sdkVersion: "0.44.0-beta.3",
+  genVersion: "2.884.7",
   userAgent:
-    "speakeasy-sdk/typescript 0.44.0-beta.1 2.884.4 0.43.1 @greensecurity/javascript-sdk",
+    "speakeasy-sdk/typescript 0.44.0-beta.3 2.884.7 0.43.1 @greensecurity/javascript-sdk",
 } as const;

package/src/models/components/expand.ts

@@ -10,6 +10,8 @@ import { ClosedEnum } from "../../types/enums.js";
  */
 export const Expand = {
   User: "user",
+  UserEmailPreferences: "user.email_preferences",
+  UserPaymentProfile: "user.payment_profile",
   CompanyLocation: "company.location",
   CompanyVendorFields: "company.vendor_fields",
   CompanyVendorTypeRestrictions: "company.vendor_type_restrictions",

package/src/models/components/paymentprofile.ts

@@ -10,11 +10,11 @@ import * as types from "../../types/primitives.js";
 import { smartUnion } from "../../types/smartUnion.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-export type Two2 = {};
+export type PaymentProfile22 = {};
 
-export type PaymentProfile2 = number | Two2;
+export type PaymentProfile2 = number | PaymentProfile22;
 
-export type PaymentProfile1 = {
+export type PaymentProfile3 = {
   id?: number | undefined;
   isValid?: boolean | null | undefined;
   cardType?: string | null | undefined;
@@ -26,19 +26,22 @@ export type PaymentProfile1 = {
 /**
  * Reduced list of attributes of the Payment Profile record
  */
-export type PaymentProfile = PaymentProfile1 | number | Two2;
+export type PaymentProfile = PaymentProfile3 | number | PaymentProfile22;
 
 /** @internal */
-export const Two2$inboundSchema: z.ZodType<Two2, z.ZodTypeDef, unknown> = z
-  .object({});
+export const PaymentProfile22$inboundSchema: z.ZodType<
+  PaymentProfile22,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
 
-export function two2FromJSON(
+export function paymentProfile22FromJSON(
   jsonString: string,
-): SafeParseResult<Two2, SDKValidationError> {
+): SafeParseResult<PaymentProfile22, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Two2$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Two2' from JSON`,
+    (x) => PaymentProfile22$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PaymentProfile22' from JSON`,
   );
 }
 
@@ -47,7 +50,7 @@ export const PaymentProfile2$inboundSchema: z.ZodType<
   PaymentProfile2,
   z.ZodTypeDef,
   unknown
-> = smartUnion([types.number(), z.lazy(() => Two2$inboundSchema)]);
+> = smartUnion([types.number(), z.lazy(() => PaymentProfile22$inboundSchema)]);
 
 export function paymentProfile2FromJSON(
   jsonString: string,
@@ -60,8 +63,8 @@ export function paymentProfile2FromJSON(
 }
 
 /** @internal */
-export const PaymentProfile1$inboundSchema: z.ZodType<
-  PaymentProfile1,
+export const PaymentProfile3$inboundSchema: z.ZodType<
+  PaymentProfile3,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -81,13 +84,13 @@ export const PaymentProfile1$inboundSchema: z.ZodType<
   });
 });
 
-export function paymentProfile1FromJSON(
+export function paymentProfile3FromJSON(
   jsonString: string,
-): SafeParseResult<PaymentProfile1, SDKValidationError> {
+): SafeParseResult<PaymentProfile3, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => PaymentProfile1$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'PaymentProfile1' from JSON`,
+    (x) => PaymentProfile3$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PaymentProfile3' from JSON`,
   );
 }
 
@@ -97,8 +100,8 @@ export const PaymentProfile$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = smartUnion([
-  z.lazy(() => PaymentProfile1$inboundSchema),
-  smartUnion([types.number(), z.lazy(() => Two2$inboundSchema)]),
+  z.lazy(() => PaymentProfile3$inboundSchema),
+  smartUnion([types.number(), z.lazy(() => PaymentProfile22$inboundSchema)]),
 ]);
 
 export function paymentProfileFromJSON(

package/src/models/components/userdetails.ts

@@ -9,6 +9,7 @@ import * as openEnums from "../../types/enums.js";
 import { OpenEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import * as types from "../../types/primitives.js";
+import { smartUnion } from "../../types/smartUnion.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import {
   EmailPreferences,
@@ -36,6 +37,24 @@ export const UserType = {
  */
 export type UserType = OpenEnum<typeof UserType>;
 
+export type Two2 = {};
+
+export type Two = number | Two2;
+
+export type PaymentProfile1 = {
+  id?: number | undefined;
+  isValid?: boolean | null | undefined;
+  cardType?: string | null | undefined;
+  cardLast4?: string | null | undefined;
+  isDummy?: boolean | null | undefined;
+  profileType?: string | null | undefined;
+};
+
+/**
+ * Reduced list of attributes of the Payment Profile record
+ */
+export type UserDetailsPaymentProfile = PaymentProfile1 | number | Two2;
+
 /**
  * Core user profile fields returned by user detail and update endpoints.
  */
@@ -90,6 +109,16 @@ export type UserDetails = {
    * the migration window but are deprecated.
    */
   emailPreferences?: EmailPreferences | undefined;
+  /**
+   * The user's payment profile. Returned only when the request
+   *
+   * @remarks
+   * includes `expand=user.payment_profile` on `GET /users/me`.
+   * When expanded, this property is `null` if the user has no
+   * payment profile on file, or a populated `PaymentProfile`
+   * object if one exists. When not expanded, this property is omitted.
+   */
+  paymentProfile?: PaymentProfile1 | number | Two2 | null | undefined;
 };
 
 /** @internal */
@@ -99,6 +128,86 @@ export const UserType$inboundSchema: z.ZodType<
   unknown
 > = openEnums.inboundSchema(UserType);
 
+/** @internal */
+export const Two2$inboundSchema: z.ZodType<Two2, z.ZodTypeDef, unknown> = z
+  .object({});
+
+export function two2FromJSON(
+  jsonString: string,
+): SafeParseResult<Two2, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Two2$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Two2' from JSON`,
+  );
+}
+
+/** @internal */
+export const Two$inboundSchema: z.ZodType<Two, z.ZodTypeDef, unknown> =
+  smartUnion([types.number(), z.lazy(() => Two2$inboundSchema)]);
+
+export function twoFromJSON(
+  jsonString: string,
+): SafeParseResult<Two, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Two$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Two' from JSON`,
+  );
+}
+
+/** @internal */
+export const PaymentProfile1$inboundSchema: z.ZodType<
+  PaymentProfile1,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.optional(types.number()),
+  is_valid: z.nullable(types.boolean()).optional(),
+  card_type: z.nullable(types.string()).optional(),
+  card_last4: z.nullable(types.string()).optional(),
+  is_dummy: z.nullable(types.boolean()).optional(),
+  profile_type: z.nullable(types.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "is_valid": "isValid",
+    "card_type": "cardType",
+    "card_last4": "cardLast4",
+    "is_dummy": "isDummy",
+    "profile_type": "profileType",
+  });
+});
+
+export function paymentProfile1FromJSON(
+  jsonString: string,
+): SafeParseResult<PaymentProfile1, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PaymentProfile1$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PaymentProfile1' from JSON`,
+  );
+}
+
+/** @internal */
+export const UserDetailsPaymentProfile$inboundSchema: z.ZodType<
+  UserDetailsPaymentProfile,
+  z.ZodTypeDef,
+  unknown
+> = smartUnion([
+  z.lazy(() => PaymentProfile1$inboundSchema),
+  smartUnion([types.number(), z.lazy(() => Two2$inboundSchema)]),
+]);
+
+export function userDetailsPaymentProfileFromJSON(
+  jsonString: string,
+): SafeParseResult<UserDetailsPaymentProfile, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UserDetailsPaymentProfile$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UserDetailsPaymentProfile' from JSON`,
+  );
+}
+
 /** @internal */
 export const UserDetails$inboundSchema: z.ZodType<
   UserDetails,
@@ -119,6 +228,12 @@ export const UserDetails$inboundSchema: z.ZodType<
   image_urls: z.nullable(ImageSet$inboundSchema).optional(),
   location: z.nullable(UserLocation$inboundSchema).optional(),
   email_preferences: types.optional(EmailPreferences$inboundSchema),
+  payment_profile: z.nullable(
+    smartUnion([
+      z.lazy(() => PaymentProfile1$inboundSchema),
+      smartUnion([types.number(), z.lazy(() => Two2$inboundSchema)]),
+    ]),
+  ).optional(),
 }).transform((v) => {
   return remap$(v, {
     "first_name": "firstName",
@@ -129,6 +244,7 @@ export const UserDetails$inboundSchema: z.ZodType<
     "user_type": "userType",
     "image_urls": "imageUrls",
     "email_preferences": "emailPreferences",
+    "payment_profile": "paymentProfile",
   });
 });
 

package/src/models/components/zone.ts

@@ -13,12 +13,12 @@ import { Department, Department$inboundSchema } from "./department.js";
 import { Facility, Facility$inboundSchema } from "./facility.js";
 import { ZoneConfig, ZoneConfig$inboundSchema } from "./zoneconfig.js";
 
-export type Two = {
+export type Facility2 = {
   id?: number | undefined;
   name?: string | undefined;
 };
 
-export type ZoneFacility = Facility | Two;
+export type ZoneFacility = Facility | Facility2;
 
 export type ZoneDepartment = Department | number;
 
@@ -91,7 +91,7 @@ export type GpsCheckinPolicy = {
  */
 export type Zone = {
   id?: number | undefined;
-  facility?: Facility | Two | null | undefined;
+  facility?: Facility | Facility2 | null | undefined;
   department?: Department | number | null | undefined;
   name?: string | null | undefined;
   shortName?: string | null | undefined;
@@ -109,19 +109,22 @@ export type Zone = {
 };
 
 /** @internal */
-export const Two$inboundSchema: z.ZodType<Two, z.ZodTypeDef, unknown> = z
-  .object({
-    id: types.optional(types.number()),
-    name: types.optional(types.string()),
-  });
+export const Facility2$inboundSchema: z.ZodType<
+  Facility2,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.optional(types.number()),
+  name: types.optional(types.string()),
+});
 
-export function twoFromJSON(
+export function facility2FromJSON(
   jsonString: string,
-): SafeParseResult<Two, SDKValidationError> {
+): SafeParseResult<Facility2, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Two$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Two' from JSON`,
+    (x) => Facility2$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Facility2' from JSON`,
   );
 }
 
@@ -130,7 +133,7 @@ export const ZoneFacility$inboundSchema: z.ZodType<
   ZoneFacility,
   z.ZodTypeDef,
   unknown
-> = smartUnion([Facility$inboundSchema, z.lazy(() => Two$inboundSchema)]);
+> = smartUnion([Facility$inboundSchema, z.lazy(() => Facility2$inboundSchema)]);
 
 export function zoneFacilityFromJSON(
   jsonString: string,
@@ -383,7 +386,10 @@ export const Zone$inboundSchema: z.ZodType<Zone, z.ZodTypeDef, unknown> = z
   .object({
     id: types.optional(types.number()),
     facility: z.nullable(
-      smartUnion([Facility$inboundSchema, z.lazy(() => Two$inboundSchema)]),
+      smartUnion([
+        Facility$inboundSchema,
+        z.lazy(() => Facility2$inboundSchema),
+      ]),
     ).optional(),
     department: z.nullable(
       smartUnion([Department$inboundSchema, types.number()]),

package/src/models/operations/index.ts

@@ -59,6 +59,7 @@ export * from "./getwebhookendpoint.js";
 export * from "./invoicesexport.js";
 export * from "./listalerts.js";
 export * from "./listallwebhookendpoints.js";
+export * from "./listcompanycredits.js";
 export * from "./listcompanymanagers.js";
 export * from "./listfeed.js";
 export * from "./listinvoices.js";