RazorpayEx.Entity (razorpay_ex v0.1.3)

Base entity module for all Razorpay resources.

This module provides the foundation for all Razorpay resource structs, similar to how Ruby SDK uses inheritance for entities.

Summary

t()

Lists entities for a given resource type.

Dynamically creates a struct for a given entity type.

Fetches an entity by ID for a given resource type.

from_map(map)

Creates an entity struct from a map.

to_map(entity)

Converts an entity to a map, filtering out nil values.

@type t() :: %RazorpayEx.Entity{
  created_at: integer() | nil,
  entity: String.t() | nil,
  id: String.t() | nil
}

@spec all(atom(), map()) :: {:ok, [struct()]} | {:error, RazorpayEx.Error.t()}

Lists entities for a given resource type.

Similar to Ruby SDK's class.all method.

@spec build(String.t(), map()) :: struct()

Dynamically creates a struct for a given entity type.

This mimics Ruby SDK's dynamic class creation based on entity names.

RazorpayEx.Entity.build("payment", %{"id" => "pay_123", "amount" => 5000})

@spec fetch(String.t(), atom()) :: {:ok, struct()} | {:error, RazorpayEx.Error.t()}

Fetches an entity by ID for a given resource type.

Similar to Ruby SDK's instance.fetch method.

@spec from_map(map()) :: t()

Creates an entity struct from a map.

RazorpayEx.Entity.from_map(%{"id" => "pay_123", "entity" => "payment"})

@spec to_map(t()) :: map()

Converts an entity to a map, filtering out nil values.