@acm-uiuc/core-client

v4.6.2

Published

2 days ago

OpenAPI client for the ACM @ UIUC Core API

0High
0Medium
0Low

acminfra

@acm-uiuc/[email protected]

A TypeScript SDK client for the core.acm.illinois.edu API.

Usage

First, install the SDK from npm.

npm install @acm-uiuc/core-client --save

Next, try it out.

import {
  Configuration,
  APIKeysApi,
} from '@acm-uiuc/core-client';
import type { ApiV1ApiKeyOrgGetRequest } from '@acm-uiuc/core-client';

async function example() {
  console.log("🚀 Testing @acm-uiuc/core-client SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: httpBearer
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new APIKeysApi(config);

  try {
    const data = await api.apiV1ApiKeyOrgGet();
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Documentation

API Endpoints

All URIs are relative to https://core.acm.illinois.edu

| Class | Method | HTTP request | Description | ----- | ------ | ------------ | ------------- APIKeysApi | apiV1ApiKeyOrgGet | GET /api/v1/apiKey/org | Get all organization API keys. APIKeysApi | apiV1ApiKeyOrgKeyIdDelete | DELETE /api/v1/apiKey/org/{keyId} | Delete an organization API key. APIKeysApi | apiV1ApiKeyOrgPost | POST /api/v1/apiKey/org | Create an organization API key. EventsApi | apiV1EventsGet | GET /api/v1/events | Retrieve calendar events with applied filters. EventsApi | apiV1EventsIdDelete | DELETE /api/v1/events/{id} | Delete a calendar event. EventsApi | apiV1EventsIdGet | GET /api/v1/events/{id} | Retrieve a calendar event. EventsApi | apiV1EventsIdPatch | PATCH /api/v1/events/{id} | Modify a calendar event. EventsApi | apiV1EventsPost | POST /api/v1/events | Create a calendar event. GenericApi | apiV1HealthzGet | GET /api/v1/healthz | Verify that the API server is healthy. GenericApi | apiV1ProtectedGet | GET /api/v1/protected | Get a user's username and roles. GenericApi | apiV1SyncIdentityIsRequiredGet | GET /api/v1/syncIdentity/isRequired | Check if a user needs a full user identity sync. GenericApi | apiV1SyncIdentityPost | POST /api/v1/syncIdentity | Sync the Illinois NetID account with the ACM @ UIUC account. GenericApi | apiV1UsersBatchResolveInfoPost | POST /api/v1/users/batchResolveInfo | Resolve user emails to user info. GenericApi | apiV1UsersFindUserByUinPost | POST /api/v1/users/findUserByUin | Find a user by UIN. IAMApi | apiV1IamGroupsGet | GET /api/v1/iam/groups | Get all manageable groups. IAMApi | apiV1IamGroupsGroupIdGet | GET /api/v1/iam/groups/{groupId} | Get the members of a group. IAMApi | apiV1IamGroupsGroupIdPatch | PATCH /api/v1/iam/groups/{groupId} | Update the members of a group. IAMApi | apiV1IamGroupsGroupIdRolesGet | GET /api/v1/iam/groups/{groupId}/roles | Get a group's application role mappings. IAMApi | apiV1IamGroupsGroupIdRolesPost | POST /api/v1/iam/groups/{groupId}/roles | Update a group's application role mappings. IAMApi | apiV1IamInviteUsersPost | POST /api/v1/iam/inviteUsers | Invite a user to the ACM @ UIUC Entra ID tenant. IAMApi | apiV1IamProfilePatch | PATCH /api/v1/iam/profile | Update user's profile. ICalendarIntegrationApi | apiV1IcalHostGet | GET /api/v1/ical/{host}? | Retrieve the calendar for ACM @ UIUC or a specific sub-organization. LinkryApi | apiV1LinkryOrgsOrgIdRedirGet | GET /api/v1/linkry/orgs/{orgId}/redir | Retrieve short links for a specific org LinkryApi | apiV1LinkryOrgsOrgIdRedirPost | POST /api/v1/linkry/orgs/{orgId}/redir | Create a short link for a specific org LinkryApi | apiV1LinkryOrgsOrgIdRedirSlugDelete | DELETE /api/v1/linkry/orgs/{orgId}/redir/{slug}? | Delete a short link for a specific org LinkryApi | apiV1LinkryRedirGet | GET /api/v1/linkry/redir | LinkryApi | apiV1LinkryRedirPost | POST /api/v1/linkry/redir | LinkryApi | apiV1LinkryRedirSlugDelete | DELETE /api/v1/linkry/redir/{slug} | LinkryApi | apiV1LinkryRedirSlugGet | GET /api/v1/linkry/redir/{slug} | LoggingApi | apiV1LogsModuleGet | GET /api/v1/logs/{module} | Retrieve audit logs for a module. MembershipApi | apiV1MembershipExternalListGet | GET /api/v1/membership/externalList | Get all member list IDs MembershipApi | apiV1MembershipExternalListListIdGet | GET /api/v1/membership/externalList/{listId} | Get all members of an external organization MembershipApi | apiV1MembershipExternalListListIdPatch | PATCH /api/v1/membership/externalList/{listId} | Modify members of an external organization MembershipApi | apiV1MembershipGet | GET /api/v1/membership | Check self membership in any of specified lists. MembershipApi | apiV2MembershipCheckoutGet | GET /api/v2/membership/checkout | Create a checkout session to purchase an ACM @ UIUC membership. MembershipApi | apiV2MembershipNetIdGet | GET /api/v2/membership/{netId} | Check ACM @ UIUC paid membership (or partner organization membership) status. MembershipApi | apiV2MembershipVerifyBatchOfMembersPost | POST /api/v2/membership/verifyBatchOfMembers | Check a batch of NetIDs for ACM @ UIUC paid membership (or partner organization membership) status. MobileWalletApi | apiV2MobileWalletMembershipGet | GET /api/v2/mobileWallet/membership | Retrieve mobile wallet pass for ACM member. OrganizationsApi | apiV1OrganizationsGet | GET /api/v1/organizations | Get info for all of ACM @ UIUC's sub-organizations. OrganizationsApi | apiV1OrganizationsOrgIdGet | GET /api/v1/organizations/{orgId} | Get information about a specific ACM @ UIUC sub-organization. OrganizationsApi | apiV1OrganizationsOrgIdLeadsPatch | PATCH /api/v1/organizations/{orgId}/leads | Set leads for an ACM @ UIUC sub-organization. OrganizationsApi | apiV1OrganizationsOrgIdMetaPost | POST /api/v1/organizations/{orgId}/meta | Set metadata for an ACM @ UIUC sub-organization. RSVPApi | apiV1RsvpEventEventIdAttendeeMeDelete | DELETE /api/v1/rsvp/event/{eventId}/attendee/me | Withdraw your RSVP for an event. RSVPApi | apiV1RsvpEventEventIdAttendeeUserIdDelete | DELETE /api/v1/rsvp/event/{eventId}/attendee/{userId} | Delete an RSVP for an event. RSVPApi | apiV1RsvpEventEventIdConfigGet | GET /api/v1/rsvp/event/{eventId}/config | Get RSVP configuration for an event. RSVPApi | apiV1RsvpEventEventIdConfigPost | POST /api/v1/rsvp/event/{eventId}/config | Configure RSVP settings for an event. RSVPApi | apiV1RsvpEventEventIdGet | GET /api/v1/rsvp/event/{eventId} | Get all RSVPs for an event. RSVPApi | apiV1RsvpEventEventIdPost | POST /api/v1/rsvp/event/{eventId} | Submit an RSVP for an event. RSVPApi | apiV1RsvpMeGet | GET /api/v1/rsvp/me | Get your RSVPs across all events. RoomRequestsApi | apiV1RoomRequestsPost | POST /api/v1/roomRequests | Create a room request. RoomRequestsApi | apiV1RoomRequestsSemesterIdGet | GET /api/v1/roomRequests/{semesterId} | Get room requests for a specific semester. RoomRequestsApi | apiV1RoomRequestsSemesterIdRequestIdAttachmentDownloadUrlCreatedAtStatusGet | GET /api/v1/roomRequests/{semesterId}/{requestId}/attachmentDownloadUrl/{createdAt}/{status} | Get attachment download URL for a specific room request update. RoomRequestsApi | apiV1RoomRequestsSemesterIdRequestIdGet | GET /api/v1/roomRequests/{semesterId}/{requestId} | Get specific room request data. RoomRequestsApi | apiV1RoomRequestsSemesterIdRequestIdStatusPost | POST /api/v1/roomRequests/{semesterId}/{requestId}/status | Create status update for a room request. StoreApi | apiV1StoreAdminOrderOrderIdGet | GET /api/v1/store/admin/order/{orderId} | Get order details for management. StoreApi | apiV1StoreAdminOrdersFetchUserOrdersPost | POST /api/v1/store/admin/orders/fetchUserOrders | Fetch a user's orders. StoreApi | apiV1StoreAdminOrdersOrderIdFulfillPost | POST /api/v1/store/admin/orders/{orderId}/fulfill | Fulfill an order's line items. StoreApi | apiV1StoreAdminOrdersOrderIdRefundPost | POST /api/v1/store/admin/orders/{orderId}/refund | Refund an order. StoreApi | apiV1StoreAdminOrdersProductIdGet | GET /api/v1/store/admin/orders/{productId} | List all orders/line items for a given product. StoreApi | apiV1StoreAdminProductsGet | GET /api/v1/store/admin/products | List all products (including inactive) for management. StoreApi | apiV1StoreAdminProductsPost | POST /api/v1/store/admin/products | Create a new product with variants. StoreApi | apiV1StoreAdminProductsProductIdGet | GET /api/v1/store/admin/products/{productId} | Get details of a specific product for management. StoreApi | apiV1StoreAdminProductsProductIdPatch | PATCH /api/v1/store/admin/products/{productId} | Modify the metadata for a given product. StoreApi | apiV1StoreCheckoutPost | POST /api/v1/store/checkout | Create a checkout session for purchasing items. StoreApi | apiV1StoreProductsGet | GET /api/v1/store/products | List all available products in the store. StoreApi | apiV1StoreProductsProductIdGet | GET /api/v1/store/products/{productId} | Get details of a specific product. StripeApi | apiV1StripePaymentLinksGet | GET /api/v1/stripe/paymentLinks | Get available Stripe payment links. StripeApi | apiV1StripePaymentLinksLinkIdDelete | DELETE /api/v1/stripe/paymentLinks/{linkId} | Deactivate a Stripe payment link. StripeApi | apiV1StripePaymentLinksPost | POST /api/v1/stripe/paymentLinks | Create a Stripe payment link.

Models

Authorization

Authentication schemes defined for the API:

httpBearer

Type: HTTP Bearer Token authentication (JWT)

apiKeyHeader

Type: API key
API key parameter name: X-Api-Key
Location: HTTP header

About

This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator project:

API version: 4.6.2
Package version: 4.6.2
Generator version: 7.20.0
Build package: org.openapitools.codegen.languages.TypeScriptFetchClientCodegen

The generated npm module supports the following:

Environments
- Node.js
- Webpack
- Browserify
Language levels
- ES5 - you must have a Promises/A+ library installed
- ES6
Module systems
- CommonJS
- ES6 module system

For more information, please visit https://github.com/acm-uiuc/core/issues

Development

Building

To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:

npm install
npm run build

Publishing

Once you've built the package, you can publish it to npm:

npm publish

License

BSD 3-Clause