@gr4vy/sdk 2.4.8 → 2.4.10

package/src/models/components/collectionrole.ts

@@ -0,0 +1,56 @@
+/*
+ * 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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { Role, Role$inboundSchema } from "./role.js";
+
+export type CollectionRole = {
+  /**
+   * A list of items returned for this request.
+   */
+  items: Array<Role>;
+  /**
+   * The number of items for this page.
+   */
+  limit: number;
+  /**
+   * The cursor pointing at the next page of items.
+   */
+  nextCursor?: string | null | undefined;
+  /**
+   * The cursor pointing at the previous page of items.
+   */
+  previousCursor?: string | null | undefined;
+};
+
+/** @internal */
+export const CollectionRole$inboundSchema: z.ZodType<
+  CollectionRole,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  items: z.array(Role$inboundSchema),
+  limit: z.number().int().default(20),
+  next_cursor: z.nullable(z.string()).optional(),
+  previous_cursor: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "next_cursor": "nextCursor",
+    "previous_cursor": "previousCursor",
+  });
+});
+
+export function collectionRoleFromJSON(
+  jsonString: string,
+): SafeParseResult<CollectionRole, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CollectionRole$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CollectionRole' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -75,6 +75,7 @@ export * from "./clicktopaypaymentmethodcreate.js";
 export * from "./clicktopaysession.js";
 export * from "./clicktopaysessionrequest.js";
 export * from "./collectionapikeypair.js";
+export * from "./collectionrole.js";
 export * from "./createsession.js";
 export * from "./createsessionstatus.js";
 export * from "./cryptogram.js";
@@ -282,6 +283,7 @@ export * from "./requiredcheckoutfields.js";
 export * from "./riskifiedantifraudoptions.js";
 export * from "./riskifiedantifraudoptionslineitem.js";
 export * from "./role.js";
+export * from "./roleassigneetype.js";
 export * from "./security.js";
 export * from "./sepabankpaymentmethodcreate.js";
 export * from "./settlement.js";

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/role.ts

@@ -3,17 +3,53 @@
  */
 
 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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import { PermissionSet, PermissionSet$inboundSchema } from "./permissionset.js";
+import {
+  RoleAssigneeType,
+  RoleAssigneeType$inboundSchema,
+} 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.
+   */
+  assignableTo: Array<RoleAssigneeType>;
+  /**
+   * The slugs of the roles this role is an add-on of. Empty when this role is not an add-on.
+   */
+  appliesTo: Array<string>;
+  /**
+   * Whether this role can be assigned on its own, without being combined with another role.
+   */
+  isStandaloneAssignable: boolean;
 };
 
 /** @internal */
@@ -22,8 +58,18 @@ export const Role$inboundSchema: z.ZodType<Role, z.ZodTypeDef, unknown> = z
     type: z.literal("role").default("role"),
     id: z.string(),
     name: z.string(),
+    slug: z.string(),
     description: z.string(),
     permissions: PermissionSet$inboundSchema,
+    assignable_to: z.array(RoleAssigneeType$inboundSchema),
+    applies_to: z.array(z.string()),
+    is_standalone_assignable: z.boolean(),
+  }).transform((v) => {
+    return remap$(v, {
+      "assignable_to": "assignableTo",
+      "applies_to": "appliesTo",
+      "is_standalone_assignable": "isStandaloneAssignable",
+    });
   });
 
 export function roleFromJSON(

package/src/models/components/roleassigneetype.ts

@@ -0,0 +1,20 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+export const RoleAssigneeType = {
+  User: "user",
+  ApiKeyPair: "api-key-pair",
+} as const;
+export type RoleAssigneeType = OpenEnum<typeof RoleAssigneeType>;
+
+/** @internal */
+export const RoleAssigneeType$inboundSchema: z.ZodType<
+  RoleAssigneeType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(RoleAssigneeType);

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/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));