Add Webhook Simulation resources

[danbillson]

Simulation resources

Simulation Types

Relevant docs: https://developer.paddle.com/api-reference/simulation-types/overview

Retrieve a list of available simulation types

await paddle.simulationTypes.list();

Simulations

Relevant docs: https://developer.paddle.com/api-reference/simulations/overview

Retrieve a list of simulations

const collection = paddle.simulations.list();
const list = await collection.next();

Create a new simulation

const newSim = await paddle.simulations.create({
  notificationSettingId: "ntfset_01j964zn80sgz3vnnfxbakj0np",
  type: "subscription.created",
  name: "Test Simulation",
});

Fetch a single simulation

const sim = await paddle.simulations.get("ntfsim_01j990fgdbjyfqw28f19kvcgf2");

Update a simulation

const updatedSim = await paddle.simulations.update(
  "ntfsim_01j990fgdbjyfqw28f19kvcgf2",
  {
    name: "Updated Test Simulation",
  }
);

Simulation Runs

Relevant docs: https://developer.paddle.com/api-reference/simulation-runs/overview

Retrieve a list of simulation runs

const collection = paddle.simulationRuns.list();
const list = await collection.next();

Create a new simulation run

const simRun = await paddle.simulationRuns.create("ntfsim_01j990fgdbjyfqw28f19kvcgf2");

Fetch a single simulation run

const sim = await paddle.simulationRuns.get(
  "ntfsim_01j990fgdbjyfqw28f19kvcgf2", 
  "ntfsimrun_01j9c4x8kv6q6657rkbhc9a98f"
);

Simulation Run Event

https://developer.paddle.com/api-reference/simulation-events/overview

Retrieve a list of simulation runs

const collection = paddle.simulationRunEvents.list();
const list = await collection.next();

Fetch a single simulation run event

const simRunEvent = await paddle.simulationRunEvents.get(
  "ntfsim_01j990fgdbjyfqw28f19kvcgf2", 
  "ntfsimrun_01j9c4x8kv6q6657rkbhc9a98f",
  "ntfsimevt_01j9c4x8mqp3wydvqk1g2t6263
);

Replay a simulation run event

const simRunEvent = await paddle.simulationRunEvents.replay(
  "ntfsim_01j990fgdbjyfqw28f19kvcgf2", 
  "ntfsimrun_01j9c4x8kv6q6657rkbhc9a98f",
  "ntfsimevt_01j9c4x8mqp3wydvqk1g2t6263
);

[davidgrayston-paddle]

Would it be possible to map directly to the notification entity? e.g. something like this:

Suggested change

	payload?: K extends IEventName ? Partial<SimulationEventPayloadMap[K]['data']> | null : null;
	payload?: K extends IEventName ? Partial<SimulationEventPayloadMap[K]> | null : null;

e.g. AddressNotification

interface SimulationEventPayloadMap {
  'address.created': AddressNotification;
  'address.updated': AddressNotification;
  'address.imported': AddressNotification;
.......

[danbillson]

I had this conversation with Sam as well, essentially the event often changes the type i.e.
public override readonly data: Omit<SubscriptionNotification, 'transactionId'>
so it uses that instead of the raw Notification

[davidgrayston-paddle]

Should we also create a notification entity here?

[danbillson]

The Notification follows this pattern

this.payload = Webhooks.fromJson(notificationResponse.payload);

could apply that here as well

[danbillson]

It seems like the notification payload is a little different though and only cares about the data

[vifer]

🚀