@gr4vy/sdk 2.4.9 → 2.4.12

package/src/models/components/permissionset.ts

@@ -7,7 +7,13 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * The permissions granted by a role.
+ */
 export type PermissionSet = {
+  /**
+   * The scopes granted by this role.
+   */
   allow: Array<string>;
 };
 

package/src/models/components/redirectpaymentmethodcreate.ts

@@ -37,6 +37,7 @@ export const RedirectPaymentMethodCreateMethod = {
   Dana: "dana",
   Dcb: "dcb",
   Dlocal: "dlocal",
+  Duitnow: "duitnow",
   Ebanx: "ebanx",
   Eckoh: "eckoh",
   Efecty: "efecty",

package/src/models/components/role.ts

@@ -14,14 +14,29 @@ import {
 } from "./roleassigneetype.js";
 
 export type Role = {
+  /**
+   * Always `role`.
+   */
   type: "role";
+  /**
+   * The unique ID for the role.
+   */
   id: string;
+  /**
+   * The human-readable name of the role.
+   */
   name: string;
   /**
    * The unique, human-readable identifier for the role.
    */
   slug: string;
+  /**
+   * A description of the access this role grants.
+   */
   description: string;
+  /**
+   * The permissions granted by a role.
+   */
   permissions: PermissionSet;
   /**
    * The types of resource this role can be assigned to.

package/src/models/operations/index.ts

@@ -91,6 +91,7 @@ export * from "./listpaymentservices.js";
 export * from "./listpayouts.js";
 export * from "./listreportexecutions.js";
 export * from "./listreports.js";
+export * from "./listroles.js";
 export * from "./listthreedsconfigurations.js";
 export * from "./listtransactionactions.js";
 export * from "./listtransactioncaptures.js";

package/src/models/operations/listpaymentservices.ts

@@ -30,6 +30,10 @@ export type ListPaymentServicesRequest = {
    * Return any deleted payment service.
    */
   deleted?: boolean | null | undefined;
+  /**
+   * Include the non-secret credential and reporting fields for each payment service. Disable this to reduce response time if you don't need them.
+   */
+  includeFields?: boolean | undefined;
   /**
    * The ID of the merchant account to use for this request.
    */
@@ -46,6 +50,7 @@ export type ListPaymentServicesRequest$Outbound = {
   cursor?: string | null | undefined;
   limit: number;
   deleted?: boolean | null | undefined;
+  include_fields: boolean;
   merchantAccountId?: string | null | undefined;
 };
 
@@ -59,7 +64,12 @@ export const ListPaymentServicesRequest$outboundSchema: z.ZodType<
   cursor: z.nullable(z.string()).optional(),
   limit: z.number().int().default(20),
   deleted: z.nullable(z.boolean()).optional(),
+  includeFields: z.boolean().default(true),
   merchantAccountId: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    includeFields: "include_fields",
+  });
 });
 
 export function listPaymentServicesRequestToJSON(

package/src/models/operations/listroles.ts

@@ -0,0 +1,72 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 ListRolesRequest = {
+  /**
+   * A pointer to the page of results to return.
+   */
+  cursor?: string | null | undefined;
+  /**
+   * The maximum number of items that are returned.
+   */
+  limit?: number | undefined;
+};
+
+export type ListRolesResponse = {
+  result: components.CollectionRole;
+};
+
+/** @internal */
+export type ListRolesRequest$Outbound = {
+  cursor?: string | null | undefined;
+  limit: number;
+};
+
+/** @internal */
+export const ListRolesRequest$outboundSchema: z.ZodType<
+  ListRolesRequest$Outbound,
+  z.ZodTypeDef,
+  ListRolesRequest
+> = z.object({
+  cursor: z.nullable(z.string()).optional(),
+  limit: z.number().int().default(20),
+});
+
+export function listRolesRequestToJSON(
+  listRolesRequest: ListRolesRequest,
+): string {
+  return JSON.stringify(
+    ListRolesRequest$outboundSchema.parse(listRolesRequest),
+  );
+}
+
+/** @internal */
+export const ListRolesResponse$inboundSchema: z.ZodType<
+  ListRolesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Result: components.CollectionRole$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Result": "result",
+  });
+});
+
+export function listRolesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListRolesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListRolesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListRolesResponse' from JSON`,
+  );
+}

package/src/sdk/roles.ts

@@ -0,0 +1,29 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { rolesList } from "../funcs/rolesList.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { PageIterator, unwrapResultIterator } from "../types/operations.js";
+
+export class Roles extends ClientSDK {
+  /**
+   * List all roles
+   *
+   * @remarks
+   * List all roles available in the instance.
+   */
+  async list(
+    cursor?: string | null | undefined,
+    limit?: number | undefined,
+    options?: RequestOptions,
+  ): Promise<PageIterator<operations.ListRolesResponse, { cursor: string }>> {
+    return unwrapResultIterator(rolesList(
+      this,
+      cursor,
+      limit,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -21,6 +21,7 @@ import { Payouts } from "./payouts.js";
 import { Refunds } from "./refunds.js";
 import { ReportExecutions } from "./reportexecutions.js";
 import { Reports } from "./reports.js";
+import { Roles } from "./roles.js";
 import { ThreeDsScenarios } from "./threedsscenarios.js";
 import { Transactions } from "./transactions.js";
 
@@ -109,6 +110,11 @@ export class Gr4vy extends ClientSDK {
     return (this._checkoutSessions ??= new CheckoutSessions(this._options));
   }
 
+  private _roles?: Roles;
+  get roles(): Roles {
+    return (this._roles ??= new Roles(this._options));
+  }
+
   private _merchantAccounts?: MerchantAccounts;
   get merchantAccounts(): MerchantAccounts {
     return (this._merchantAccounts ??= new MerchantAccounts(this._options));