fulcrum-cem-client

v0.0.5

Published

8 days ago

OpenAPI client for fulcrum-cem-client

0High
0Medium
0Low

testudosrl

[email protected]

A TypeScript SDK client for the api.fulcrum.testudosrl.dev API.

Usage

First, install the SDK from npm.

npm install fulcrum-cem-client --save

Next, try it out.

import {
  Configuration,
  AgentsApi,
} from 'fulcrum-cem-client';
import type { AgentTypesCreateRequest } from 'fulcrum-cem-client';

async function example() {
  console.log("🚀 Testing fulcrum-cem-client SDK...");
  const config = new Configuration({ 
    // To configure OAuth2 access token for authorization: BearerAuth implicit
    accessToken: "YOUR ACCESS TOKEN",
  });
  const api = new AgentsApi(config);

  const body = {
    // CreateAgentTypeReq
    createAgentTypeReq: ...,
  } satisfies AgentTypesCreateRequest;

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

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

Documentation

API Endpoints

All URIs are relative to https://api.fulcrum.testudosrl.dev/api/v1

| Class | Method | HTTP request | Description | ----- | ------ | ------------ | ------------- AgentsApi | agentTypesCreate | POST /agent-types | Create an agent type AgentsApi | agentTypesDelete | DELETE /agent-types/{id} | Delete an agent type AgentsApi | agentTypesGet | GET /agent-types/{id} | Get an agent type AgentsApi | agentTypesList | GET /agent-types | List agent types AgentsApi | agentTypesUpdate | PATCH /agent-types/{id} | Update an agent type AgentsApi | agentsCreate | POST /agents | Create an agent AgentsApi | agentsDelete | DELETE /agents/{id} | Delete an agent AgentsApi | agentsGet | GET /agents/{id} | Get an agent AgentsApi | agentsGetCurrent | GET /agents/me | Get current agent AgentsApi | agentsList | GET /agents | List agents AgentsApi | agentsUpdate | PATCH /agents/{id} | Update an agent AgentsApi | agentsUpdateStatus | PUT /agents/me/status | Update agent status CommitmentsApi | commitmentsCreate | POST /commitments | Create a new commitment CommitmentsApi | commitmentsDelete | DELETE /commitments/{id} | Delete a commitment CommitmentsApi | commitmentsGet | GET /commitments/{id} | Get a commitment by ID CommitmentsApi | commitmentsList | GET /commitments | List all commitments CommitmentsApi | commitmentsUpdate | PATCH /commitments/{id} | Update a commitment EventApi | eventsAck | POST /events/ack | Acknowledge processed events EventApi | eventsLease | POST /events/lease | Acquire event lease and fetch events EventApi | eventsList | GET /events | List events JobsApi | jobsClaim | POST /jobs/{id}/claim | Claim a job JobsApi | jobsComplete | POST /jobs/{id}/complete | Complete a job JobsApi | jobsFail | POST /jobs/{id}/fail | Fail a job JobsApi | jobsGet | GET /jobs/{id} | Get a job JobsApi | jobsList | GET /jobs | List jobs JobsApi | jobsPending | GET /jobs/pending | Get pending jobs MetricsApi | metricEntriesCreate | POST /metric-entries | Create a metric entry MetricsApi | metricEntriesList | GET /metric-entries | List metric entries MetricsApi | metricTypesCreate | POST /metric-types | Create a metric type MetricsApi | metricTypesDelete | DELETE /metric-types/{id} | Delete a metric type MetricsApi | metricTypesGet | GET /metric-types/{id} | Get a metric type MetricsApi | metricTypesList | GET /metric-types | List metric types MetricsApi | metricTypesUpdate | PATCH /metric-types/{id} | Update a metric type NotaryJobsApi | notaryJobsCancel | DELETE /notary-jobs/{id} | Cancel a notary job NotaryJobsApi | notaryJobsGet | GET /notary-jobs/{id} | Get a notary job by ID NotaryJobsApi | notaryJobsList | GET /notary-jobs | List all notary jobs NotaryJobsApi | notaryJobsPoll | POST /notary-jobs/{id}/poll | Poll notary job status NotaryJobsApi | notaryJobsSubmit | POST /notary-jobs | Submit a file for notarization ParticipantsApi | participantsCreate | POST /participants | Create a participant ParticipantsApi | participantsDelete | DELETE /participants/{id} | Delete a participant ParticipantsApi | participantsGet | GET /participants/{id} | Get a participant ParticipantsApi | participantsList | GET /participants | List participants ParticipantsApi | participantsUpdate | PATCH /participants/{id} | Update a participant ServiceOfferingsApi | serviceOfferingsCreate | POST /service-offerings | Create a new service offering ServiceOfferingsApi | serviceOfferingsDelete | DELETE /service-offerings/{id} | Delete a service offering ServiceOfferingsApi | serviceOfferingsGet | GET /service-offerings/{id} | Get a service offering by ID ServiceOfferingsApi | serviceOfferingsList | GET /service-offerings | List all service offerings ServiceOfferingsApi | serviceOfferingsUpdate | PATCH /service-offerings/{id} | Update a service offering ServiceOrdersApi | serviceOrdersGet | GET /service-orders/{id} | Get a service order by ID ServiceOrdersApi | serviceOrdersList | GET /service-orders | List all service orders ServiceOrdersApi | serviceOrdersUpdate | PATCH /service-orders/{id} | Update a service order ServicesApi | cemServicesCreate | POST /services | Create a new CEM service ServicesApi | cemServicesDelete | DELETE /services/{id} | Delete a CEM service ServicesApi | cemServicesGet | GET /services/{id} | Get a CEM service by ID ServicesApi | cemServicesGetActiveOrder | GET /services/{id}/active-order | Get the active service order for a CEM service ServicesApi | cemServicesList | GET /services | List all CEM services ServicesApi | cemServicesUpdate | PATCH /services/{id} | Update a CEM service ServicesApi | serviceGroupsCreate | POST /service-groups | Create a service group ServicesApi | serviceGroupsDelete | DELETE /service-groups/{id} | Delete a service group ServicesApi | serviceGroupsGet | GET /service-groups/{id} | Get a service group ServicesApi | serviceGroupsList | GET /service-groups | List service groups ServicesApi | serviceGroupsUpdate | PATCH /service-groups/{id} | Update a service group ServicesApi | serviceTypesCreate | POST /service-types | Create a service type ServicesApi | serviceTypesDelete | DELETE /service-types/{id} | Delete a service type ServicesApi | serviceTypesGet | GET /service-types/{id} | Get a service type ServicesApi | serviceTypesList | GET /service-types | List service types ServicesApi | serviceTypesUpdate | PATCH /service-types/{id} | Update a service type ServicesApi | servicesAction | POST /services/{id}/{action} | Perform a lifecycle action on a service TokensApi | tokensCreate | POST /tokens | Create a token TokensApi | tokensDelete | DELETE /tokens/{id} | Delete a token TokensApi | tokensGet | GET /tokens/{id} | Get a token TokensApi | tokensList | GET /tokens | List tokens TokensApi | tokensRegenerate | POST /tokens/{id}/regenerate | Regenerate token value TokensApi | tokensUpdate | PATCH /tokens/{id} | Update a token TransactionsApi | transactionsCreate | POST /transactions | Create a new transaction record TransactionsApi | transactionsDelete | DELETE /transactions/{id} | Delete a transaction record TransactionsApi | transactionsDeleteByPeriod | DELETE /transactions/periods | Delete transaction records by period TransactionsApi | transactionsGenerateByPeriod | POST /transactions/periods | Generate transaction records by period TransactionsApi | transactionsGet | GET /transactions/{id} | Get a transaction record by ID TransactionsApi | transactionsList | GET /transactions | List all transaction records TransactionsApi | transactionsUpdate | PATCH /transactions/{id} | Update a transaction record

Models

Authorization

Authentication schemes defined for the API:

BearerAuth implicit

Type: OAuth
Flow: implicit
Authorization URL: https://api.fulcrum.testudosrl.dev/oauth/authorize
Scopes:
- admin: System administrator with unrestricted access
- participant: Participant administrator that can act as both provider and consumer
- agent: Agent role with access to specific operations

About

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

API version: 0.0.5
Package version: 0.0.5
Generator version: 7.18.0-SNAPSHOT
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://fulcrumproject.org

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

Apache License 2.0