Common SDK Methods

Use this page for quick, high-usage examples.

For full signatures and detailed type definitions, see /developers/sdk.

Most Used Calls

// 1) Read a calendar by id
await scrims.calendars.fetch(calendarId);

// 2) Read one event
await scrims.events.fetch(eventId);

// 3) Create an event
await scrims.events.create(eventPayload, etag);

// 4) Update an event
await scrims.events.update(eventId, patchPayload, etag);

// 5) Add a member as guest to an event
await scrims.guests.create(memberId, eventId, { status: 1 });

// 6) Update guest status/notes
await scrims.guests.update(memberId, eventId, { status: 2, notes: "Running late" });

// 7) Update guest ticket specs
await scrims.guestTickets.update(guestTicketId, { ticketSpecs: [] });

// 8) Add member to calendar with role(s)
await scrims.calendarMembers.create({
  calendar: calendarId,
  member: memberId,
  roles: [roleId]
});

// 9) Find a member by id or email
await scrims.members.fetch(memberIdOrEmail);

// 10) Create a role
await scrims.roles.create({ name: "Host", calendar: calendarId, permissions: 8 });