fulcrum-cem-client 0.0.1 → 0.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +136 -30
- package/.openapi-generator/VERSION +1 -1
- package/README.md +273 -28
- package/dist/apis/AgentsApi.d.ts +203 -120
- package/dist/apis/AgentsApi.js +200 -106
- package/dist/apis/CommitmentsApi.d.ts +31 -31
- package/dist/apis/CommitmentsApi.js +21 -21
- package/dist/apis/EventApi.d.ts +43 -58
- package/dist/apis/EventApi.js +30 -59
- package/dist/apis/JobsApi.d.ts +92 -129
- package/dist/apis/JobsApi.js +65 -132
- package/dist/apis/MetricsApi.d.ts +105 -84
- package/dist/apis/MetricsApi.js +86 -72
- package/dist/apis/NotaryJobsApi.d.ts +31 -31
- package/dist/apis/NotaryJobsApi.js +20 -20
- package/dist/apis/ParticipantsApi.d.ts +66 -51
- package/dist/apis/ParticipantsApi.js +40 -30
- package/dist/apis/ServiceOfferingsApi.d.ts +31 -31
- package/dist/apis/ServiceOfferingsApi.js +21 -21
- package/dist/apis/ServiceOrdersApi.d.ts +20 -20
- package/dist/apis/ServiceOrdersApi.js +13 -13
- package/dist/apis/ServicesApi.d.ts +219 -256
- package/dist/apis/ServicesApi.js +192 -268
- package/dist/apis/TokensApi.d.ts +80 -62
- package/dist/apis/TokensApi.js +48 -36
- package/dist/apis/TransactionsApi.d.ts +44 -44
- package/dist/apis/TransactionsApi.js +31 -31
- package/dist/esm/apis/AgentsApi.d.ts +203 -120
- package/dist/esm/apis/AgentsApi.js +201 -107
- package/dist/esm/apis/CommitmentsApi.d.ts +31 -31
- package/dist/esm/apis/CommitmentsApi.js +21 -21
- package/dist/esm/apis/EventApi.d.ts +43 -58
- package/dist/esm/apis/EventApi.js +31 -60
- package/dist/esm/apis/JobsApi.d.ts +92 -129
- package/dist/esm/apis/JobsApi.js +66 -133
- package/dist/esm/apis/MetricsApi.d.ts +105 -84
- package/dist/esm/apis/MetricsApi.js +87 -73
- package/dist/esm/apis/NotaryJobsApi.d.ts +31 -31
- package/dist/esm/apis/NotaryJobsApi.js +20 -20
- package/dist/esm/apis/ParticipantsApi.d.ts +66 -51
- package/dist/esm/apis/ParticipantsApi.js +41 -31
- package/dist/esm/apis/ServiceOfferingsApi.d.ts +31 -31
- package/dist/esm/apis/ServiceOfferingsApi.js +21 -21
- package/dist/esm/apis/ServiceOrdersApi.d.ts +20 -20
- package/dist/esm/apis/ServiceOrdersApi.js +13 -13
- package/dist/esm/apis/ServicesApi.d.ts +219 -256
- package/dist/esm/apis/ServicesApi.js +193 -269
- package/dist/esm/apis/TokensApi.d.ts +80 -62
- package/dist/esm/apis/TokensApi.js +49 -37
- package/dist/esm/apis/TransactionsApi.d.ts +44 -44
- package/dist/esm/apis/TransactionsApi.js +32 -32
- package/dist/esm/models/AcknowledgeEvents200Response.d.ts +1 -1
- package/dist/esm/models/AcknowledgeEvents200Response.js +1 -1
- package/dist/esm/models/AcknowledgeEventsRequest.d.ts +1 -1
- package/dist/esm/models/AcknowledgeEventsRequest.js +1 -1
- package/dist/esm/models/AgentCreateRes.d.ts +15 -1
- package/dist/esm/models/AgentCreateRes.js +5 -1
- package/dist/esm/models/AgentRes.d.ts +15 -1
- package/dist/esm/models/AgentRes.js +5 -1
- package/dist/esm/models/AgentStatus.d.ts +1 -1
- package/dist/esm/models/AgentStatus.js +1 -1
- package/dist/esm/models/AgentTypeReq.d.ts +1 -1
- package/dist/esm/models/AgentTypeReq.js +1 -1
- package/dist/esm/models/AgentTypeRes.d.ts +13 -5
- package/dist/esm/models/AgentTypeRes.js +7 -4
- package/dist/esm/models/AgentTypesGet200Response.d.ts +57 -0
- package/dist/esm/models/AgentTypesGet200Response.js +50 -0
- package/dist/esm/models/AgentTypesList200Response.d.ts +63 -0
- package/dist/esm/models/AgentTypesList200Response.js +52 -0
- package/dist/esm/models/AgentsList200Response.d.ts +63 -0
- package/dist/esm/models/AgentsList200Response.js +52 -0
- package/dist/esm/models/AgentsUpdateStatusRequest.d.ts +33 -0
- package/dist/esm/models/AgentsUpdateStatusRequest.js +44 -0
- package/dist/esm/models/AuthRole.d.ts +1 -1
- package/dist/esm/models/AuthRole.js +1 -1
- package/dist/esm/models/AuthorizerDefinition.d.ts +48 -0
- package/dist/esm/models/AuthorizerDefinition.js +54 -0
- package/dist/esm/models/ByPeriodReq.d.ts +1 -1
- package/dist/esm/models/ByPeriodReq.js +1 -1
- package/dist/esm/models/ByPeriodReqFrom.d.ts +1 -1
- package/dist/esm/models/ByPeriodReqFrom.js +1 -1
- package/dist/esm/models/CommitmentReq.d.ts +1 -1
- package/dist/esm/models/CommitmentReq.js +1 -1
- package/dist/esm/models/CommitmentRes.d.ts +1 -1
- package/dist/esm/models/CommitmentRes.js +1 -1
- package/dist/esm/models/CompleteJobReq.d.ts +48 -0
- package/dist/esm/models/CompleteJobReq.js +45 -0
- package/dist/esm/models/CompleteJobRequest.d.ts +1 -1
- package/dist/esm/models/CompleteJobRequest.js +1 -1
- package/dist/esm/models/CreateAgentReq.d.ts +7 -1
- package/dist/esm/models/CreateAgentReq.js +3 -1
- package/dist/esm/models/CreateAgentTypeReq.d.ts +47 -0
- package/dist/esm/models/CreateAgentTypeReq.js +51 -0
- package/dist/esm/models/CreateCEMServiceReq.d.ts +1 -1
- package/dist/esm/models/CreateCEMServiceReq.js +1 -1
- package/dist/esm/models/CreateEventRequest.d.ts +1 -1
- package/dist/esm/models/CreateEventRequest.js +1 -1
- package/dist/esm/models/CreateMetricEntryRequest.d.ts +1 -1
- package/dist/esm/models/CreateMetricEntryRequest.js +1 -1
- package/dist/esm/models/CreateMetricTypeRequest.d.ts +1 -1
- package/dist/esm/models/CreateMetricTypeRequest.js +1 -1
- package/dist/esm/models/CreateServiceTypeReq.d.ts +48 -0
- package/dist/esm/models/CreateServiceTypeReq.js +50 -0
- package/dist/esm/models/ErrorRes.d.ts +5 -11
- package/dist/esm/models/ErrorRes.js +1 -3
- package/dist/esm/models/EventAckReq.d.ts +44 -0
- package/dist/esm/models/EventAckReq.js +51 -0
- package/dist/esm/models/EventAckRes.d.ts +32 -0
- package/dist/esm/models/EventAckRes.js +41 -0
- package/dist/esm/models/EventLeaseReq.d.ts +50 -0
- package/dist/esm/models/EventLeaseReq.js +51 -0
- package/dist/esm/models/EventLeaseRes.d.ts +45 -0
- package/dist/esm/models/EventLeaseRes.js +46 -0
- package/dist/esm/models/EventRes.d.ts +94 -0
- package/dist/esm/models/EventRes.js +61 -0
- package/dist/esm/models/EventsList200Response.d.ts +63 -0
- package/dist/esm/models/EventsList200Response.js +52 -0
- package/dist/esm/models/FailJobReq.d.ts +34 -0
- package/dist/esm/models/FailJobReq.js +43 -0
- package/dist/esm/models/FailJobRequest.d.ts +1 -1
- package/dist/esm/models/FailJobRequest.js +1 -1
- package/dist/esm/models/GeneratorDefinition.d.ts +47 -0
- package/dist/esm/models/GeneratorDefinition.js +53 -0
- package/dist/esm/models/JobRes.d.ts +21 -25
- package/dist/esm/models/JobRes.js +11 -13
- package/dist/esm/models/JobStatus.d.ts +6 -2
- package/dist/esm/models/JobStatus.js +7 -3
- package/dist/esm/models/JobsList200Response.d.ts +63 -0
- package/dist/esm/models/JobsList200Response.js +52 -0
- package/dist/esm/models/LeaseEvents200Response.d.ts +1 -1
- package/dist/esm/models/LeaseEvents200Response.js +1 -1
- package/dist/esm/models/LeaseEventsRequest.d.ts +1 -1
- package/dist/esm/models/LeaseEventsRequest.js +1 -1
- package/dist/esm/models/LifecycleAction.d.ts +55 -0
- package/dist/esm/models/LifecycleAction.js +56 -0
- package/dist/esm/models/LifecycleSchema.d.ts +60 -0
- package/dist/esm/models/LifecycleSchema.js +57 -0
- package/dist/esm/models/LifecycleState.d.ts +32 -0
- package/dist/esm/models/LifecycleState.js +43 -0
- package/dist/esm/models/LifecycleTransition.d.ts +53 -0
- package/dist/esm/models/LifecycleTransition.js +51 -0
- package/dist/esm/models/ListEvents200ResponseInner.d.ts +1 -1
- package/dist/esm/models/ListEvents200ResponseInner.js +1 -1
- package/dist/esm/models/ListMetricEntries200ResponseInner.d.ts +1 -1
- package/dist/esm/models/ListMetricEntries200ResponseInner.js +1 -1
- package/dist/esm/models/ListMetricTypes200ResponseInner.d.ts +1 -1
- package/dist/esm/models/ListMetricTypes200ResponseInner.js +1 -1
- package/dist/esm/models/MarkJobUnsupportedRequest.d.ts +1 -1
- package/dist/esm/models/MarkJobUnsupportedRequest.js +1 -1
- package/dist/esm/models/MetricEntityType.d.ts +26 -0
- package/dist/esm/models/MetricEntityType.js +44 -0
- package/dist/esm/models/MetricEntriesList200Response.d.ts +63 -0
- package/dist/esm/models/MetricEntriesList200Response.js +52 -0
- package/dist/esm/models/MetricEntryReq.d.ts +56 -0
- package/dist/esm/models/MetricEntryReq.js +55 -0
- package/dist/esm/models/MetricEntryRes.d.ts +86 -0
- package/dist/esm/models/MetricEntryRes.js +59 -0
- package/dist/esm/models/MetricTypeReq.d.ts +39 -0
- package/dist/esm/models/MetricTypeReq.js +48 -0
- package/dist/esm/models/MetricTypeRes.d.ts +57 -0
- package/dist/esm/models/MetricTypeRes.js +50 -0
- package/dist/esm/models/MetricTypesList200Response.d.ts +63 -0
- package/dist/esm/models/MetricTypesList200Response.js +52 -0
- package/dist/esm/models/MetricTypesUpdateRequest.d.ts +32 -0
- package/dist/esm/models/MetricTypesUpdateRequest.js +41 -0
- package/dist/esm/models/NotaryJobRes.d.ts +1 -1
- package/dist/esm/models/NotaryJobRes.js +1 -1
- package/dist/esm/models/NotaryJobStatus.d.ts +1 -1
- package/dist/esm/models/NotaryJobStatus.js +1 -1
- package/dist/esm/models/PageRes.d.ts +14 -8
- package/dist/esm/models/PageRes.js +7 -5
- package/dist/esm/models/PaginationParams.d.ts +1 -1
- package/dist/esm/models/PaginationParams.js +1 -1
- package/dist/esm/models/ParticipantReq.d.ts +1 -1
- package/dist/esm/models/ParticipantReq.js +1 -1
- package/dist/esm/models/ParticipantRes.d.ts +1 -1
- package/dist/esm/models/ParticipantRes.js +1 -1
- package/dist/esm/models/ParticipantStatus.d.ts +1 -1
- package/dist/esm/models/ParticipantStatus.js +1 -1
- package/dist/esm/models/ParticipantsList200Response.d.ts +63 -0
- package/dist/esm/models/ParticipantsList200Response.js +52 -0
- package/dist/esm/models/PriceItem.d.ts +1 -1
- package/dist/esm/models/PriceItem.js +1 -1
- package/dist/esm/models/PropertyDefinition.d.ts +31 -2
- package/dist/esm/models/PropertyDefinition.js +15 -2
- package/dist/esm/models/SecretDefinition.d.ts +43 -0
- package/dist/esm/models/SecretDefinition.js +50 -0
- package/dist/esm/models/ServiceAction.d.ts +1 -1
- package/dist/esm/models/ServiceAction.js +1 -1
- package/dist/esm/models/ServiceGroupReq.d.ts +1 -1
- package/dist/esm/models/ServiceGroupReq.js +1 -1
- package/dist/esm/models/ServiceGroupRes.d.ts +1 -1
- package/dist/esm/models/ServiceGroupRes.js +1 -1
- package/dist/esm/models/ServiceGroupsList200Response.d.ts +63 -0
- package/dist/esm/models/ServiceGroupsList200Response.js +52 -0
- package/dist/esm/models/ServiceOfferingReq.d.ts +1 -1
- package/dist/esm/models/ServiceOfferingReq.js +1 -1
- package/dist/esm/models/ServiceOfferingRes.d.ts +1 -1
- package/dist/esm/models/ServiceOfferingRes.js +1 -1
- package/dist/esm/models/ServiceOfferingResServiceType.d.ts +1 -1
- package/dist/esm/models/ServiceOfferingResServiceType.js +1 -1
- package/dist/esm/models/ServiceOrderReq.d.ts +1 -1
- package/dist/esm/models/ServiceOrderReq.js +1 -1
- package/dist/esm/models/ServiceOrderRes.d.ts +9 -2
- package/dist/esm/models/ServiceOrderRes.js +6 -3
- package/dist/esm/models/ServiceOrderStatus.d.ts +26 -0
- package/dist/esm/models/ServiceOrderStatus.js +44 -0
- package/dist/esm/models/ServiceReq.d.ts +64 -0
- package/dist/esm/models/ServiceReq.js +57 -0
- package/dist/esm/models/ServiceRes.d.ts +10 -72
- package/dist/esm/models/ServiceRes.js +13 -37
- package/dist/esm/models/ServiceStatus.d.ts +2 -8
- package/dist/esm/models/ServiceStatus.js +2 -8
- package/dist/esm/models/ServiceTypeReq.d.ts +5 -6
- package/dist/esm/models/ServiceTypeReq.js +3 -5
- package/dist/esm/models/ServiceTypeRes.d.ts +9 -2
- package/dist/esm/models/ServiceTypeRes.js +4 -1
- package/dist/esm/models/ServiceTypesGet200Response.d.ts +57 -0
- package/dist/esm/models/ServiceTypesGet200Response.js +50 -0
- package/dist/esm/models/ServiceTypesList200Response.d.ts +63 -0
- package/dist/esm/models/ServiceTypesList200Response.js +52 -0
- package/dist/esm/models/ServicesActionRequest.d.ts +34 -0
- package/dist/esm/models/ServicesActionRequest.js +41 -0
- package/dist/esm/models/SubmitNotaryJobReq.d.ts +1 -1
- package/dist/esm/models/SubmitNotaryJobReq.js +1 -1
- package/dist/esm/models/TokenReq.d.ts +1 -1
- package/dist/esm/models/TokenReq.js +1 -1
- package/dist/esm/models/TokenRes.d.ts +2 -8
- package/dist/esm/models/TokenRes.js +3 -5
- package/dist/esm/models/TokensList200Response.d.ts +63 -0
- package/dist/esm/models/TokensList200Response.js +52 -0
- package/dist/esm/models/TokensUpdateRequest.d.ts +51 -0
- package/dist/esm/models/TokensUpdateRequest.js +48 -0
- package/dist/esm/models/TransactionEntityType.d.ts +1 -1
- package/dist/esm/models/TransactionEntityType.js +1 -1
- package/dist/esm/models/TransactionRecordReq.d.ts +1 -1
- package/dist/esm/models/TransactionRecordReq.js +1 -1
- package/dist/esm/models/TransactionRecordRes.d.ts +1 -1
- package/dist/esm/models/TransactionRecordRes.js +1 -1
- package/dist/esm/models/TransactionStatus.d.ts +1 -1
- package/dist/esm/models/TransactionStatus.js +1 -1
- package/dist/esm/models/TransactionType.d.ts +1 -1
- package/dist/esm/models/TransactionType.js +1 -1
- package/dist/esm/models/TransactionsUpdateRequest.d.ts +45 -0
- package/dist/esm/models/TransactionsUpdateRequest.js +46 -0
- package/dist/esm/models/UnsupportedJobReq.d.ts +32 -0
- package/dist/esm/models/UnsupportedJobReq.js +43 -0
- package/dist/esm/models/UpdateAgentReq.d.ts +7 -1
- package/dist/esm/models/UpdateAgentReq.js +3 -1
- package/dist/esm/models/UpdateAgentTypeReq.d.ts +47 -0
- package/dist/esm/models/UpdateAgentTypeReq.js +47 -0
- package/dist/esm/models/UpdateCEMServiceReq.d.ts +1 -1
- package/dist/esm/models/UpdateCEMServiceReq.js +1 -1
- package/dist/esm/models/UpdateJobRequest.d.ts +1 -1
- package/dist/esm/models/UpdateJobRequest.js +1 -1
- package/dist/esm/models/UpdateMetricTypeRequest.d.ts +1 -1
- package/dist/esm/models/UpdateMetricTypeRequest.js +1 -1
- package/dist/esm/models/UpdateMyAgentStatusRequest.d.ts +1 -1
- package/dist/esm/models/UpdateMyAgentStatusRequest.js +1 -1
- package/dist/esm/models/UpdateParticipantRequest.d.ts +1 -1
- package/dist/esm/models/UpdateParticipantRequest.js +1 -1
- package/dist/esm/models/UpdateServiceGroupRequest.d.ts +1 -1
- package/dist/esm/models/UpdateServiceGroupRequest.js +1 -1
- package/dist/esm/models/UpdateServiceTypeReq.d.ts +48 -0
- package/dist/esm/models/UpdateServiceTypeReq.js +48 -0
- package/dist/esm/models/UpdateServiceTypeRequest.d.ts +1 -1
- package/dist/esm/models/UpdateServiceTypeRequest.js +1 -1
- package/dist/esm/models/UpdateTokenRequest.d.ts +1 -1
- package/dist/esm/models/UpdateTokenRequest.js +1 -1
- package/dist/esm/models/UpdateTransactionRecordRequest.d.ts +1 -1
- package/dist/esm/models/UpdateTransactionRecordRequest.js +1 -1
- package/dist/esm/models/ValidatePropertiesReq.d.ts +1 -1
- package/dist/esm/models/ValidatePropertiesReq.js +1 -1
- package/dist/esm/models/ValidatePropertiesRes.d.ts +1 -1
- package/dist/esm/models/ValidatePropertiesRes.js +1 -1
- package/dist/esm/models/ValidateServiceTypeProperties200Response.d.ts +1 -1
- package/dist/esm/models/ValidateServiceTypeProperties200Response.js +1 -1
- package/dist/esm/models/ValidateServiceTypePropertiesRequest.d.ts +1 -1
- package/dist/esm/models/ValidateServiceTypePropertiesRequest.js +1 -1
- package/dist/esm/models/ValidationError.d.ts +1 -1
- package/dist/esm/models/ValidationError.js +1 -1
- package/dist/esm/models/ValidatorDefinition.d.ts +8 -4
- package/dist/esm/models/ValidatorDefinition.js +7 -5
- package/dist/esm/models/Variant.d.ts +1 -1
- package/dist/esm/models/Variant.js +1 -1
- package/dist/esm/models/index.d.ts +40 -30
- package/dist/esm/models/index.js +40 -30
- package/dist/esm/runtime.d.ts +1 -1
- package/dist/esm/runtime.js +1 -1
- package/dist/models/AcknowledgeEvents200Response.d.ts +1 -1
- package/dist/models/AcknowledgeEvents200Response.js +1 -1
- package/dist/models/AcknowledgeEventsRequest.d.ts +1 -1
- package/dist/models/AcknowledgeEventsRequest.js +1 -1
- package/dist/models/AgentCreateRes.d.ts +15 -1
- package/dist/models/AgentCreateRes.js +5 -1
- package/dist/models/AgentRes.d.ts +15 -1
- package/dist/models/AgentRes.js +5 -1
- package/dist/models/AgentStatus.d.ts +1 -1
- package/dist/models/AgentStatus.js +1 -1
- package/dist/models/AgentTypeReq.d.ts +1 -1
- package/dist/models/AgentTypeReq.js +1 -1
- package/dist/models/AgentTypeRes.d.ts +13 -5
- package/dist/models/AgentTypeRes.js +7 -4
- package/dist/models/AgentTypesGet200Response.d.ts +57 -0
- package/dist/models/AgentTypesGet200Response.js +57 -0
- package/dist/models/AgentTypesList200Response.d.ts +63 -0
- package/dist/models/AgentTypesList200Response.js +59 -0
- package/dist/models/AgentsList200Response.d.ts +63 -0
- package/dist/models/AgentsList200Response.js +59 -0
- package/dist/models/AgentsUpdateStatusRequest.d.ts +33 -0
- package/dist/models/AgentsUpdateStatusRequest.js +51 -0
- package/dist/models/AuthRole.d.ts +1 -1
- package/dist/models/AuthRole.js +1 -1
- package/dist/models/AuthorizerDefinition.d.ts +48 -0
- package/dist/models/AuthorizerDefinition.js +62 -0
- package/dist/models/ByPeriodReq.d.ts +1 -1
- package/dist/models/ByPeriodReq.js +1 -1
- package/dist/models/ByPeriodReqFrom.d.ts +1 -1
- package/dist/models/ByPeriodReqFrom.js +1 -1
- package/dist/models/CommitmentReq.d.ts +1 -1
- package/dist/models/CommitmentReq.js +1 -1
- package/dist/models/CommitmentRes.d.ts +1 -1
- package/dist/models/CommitmentRes.js +1 -1
- package/dist/models/CompleteJobReq.d.ts +48 -0
- package/dist/models/CompleteJobReq.js +52 -0
- package/dist/models/CompleteJobRequest.d.ts +1 -1
- package/dist/models/CompleteJobRequest.js +1 -1
- package/dist/models/CreateAgentReq.d.ts +7 -1
- package/dist/models/CreateAgentReq.js +3 -1
- package/dist/models/CreateAgentTypeReq.d.ts +47 -0
- package/dist/models/CreateAgentTypeReq.js +58 -0
- package/dist/models/CreateCEMServiceReq.d.ts +1 -1
- package/dist/models/CreateCEMServiceReq.js +1 -1
- package/dist/models/CreateEventRequest.d.ts +1 -1
- package/dist/models/CreateEventRequest.js +1 -1
- package/dist/models/CreateMetricEntryRequest.d.ts +1 -1
- package/dist/models/CreateMetricEntryRequest.js +1 -1
- package/dist/models/CreateMetricTypeRequest.d.ts +1 -1
- package/dist/models/CreateMetricTypeRequest.js +1 -1
- package/dist/models/CreateServiceTypeReq.d.ts +48 -0
- package/dist/models/CreateServiceTypeReq.js +57 -0
- package/dist/models/ErrorRes.d.ts +5 -11
- package/dist/models/ErrorRes.js +1 -3
- package/dist/models/EventAckReq.d.ts +44 -0
- package/dist/models/EventAckReq.js +58 -0
- package/dist/models/EventAckRes.d.ts +32 -0
- package/dist/models/EventAckRes.js +48 -0
- package/dist/models/EventLeaseReq.d.ts +50 -0
- package/dist/models/EventLeaseReq.js +58 -0
- package/dist/models/EventLeaseRes.d.ts +45 -0
- package/dist/models/EventLeaseRes.js +53 -0
- package/dist/models/EventRes.d.ts +94 -0
- package/dist/models/EventRes.js +68 -0
- package/dist/models/EventsList200Response.d.ts +63 -0
- package/dist/models/EventsList200Response.js +59 -0
- package/dist/models/FailJobReq.d.ts +34 -0
- package/dist/models/FailJobReq.js +50 -0
- package/dist/models/FailJobRequest.d.ts +1 -1
- package/dist/models/FailJobRequest.js +1 -1
- package/dist/models/GeneratorDefinition.d.ts +47 -0
- package/dist/models/GeneratorDefinition.js +61 -0
- package/dist/models/JobRes.d.ts +21 -25
- package/dist/models/JobRes.js +11 -13
- package/dist/models/JobStatus.d.ts +6 -2
- package/dist/models/JobStatus.js +7 -3
- package/dist/models/JobsList200Response.d.ts +63 -0
- package/dist/models/JobsList200Response.js +59 -0
- package/dist/models/LeaseEvents200Response.d.ts +1 -1
- package/dist/models/LeaseEvents200Response.js +1 -1
- package/dist/models/LeaseEventsRequest.d.ts +1 -1
- package/dist/models/LeaseEventsRequest.js +1 -1
- package/dist/models/LifecycleAction.d.ts +55 -0
- package/dist/models/LifecycleAction.js +64 -0
- package/dist/models/LifecycleSchema.d.ts +60 -0
- package/dist/models/LifecycleSchema.js +64 -0
- package/dist/models/LifecycleState.d.ts +32 -0
- package/dist/models/LifecycleState.js +50 -0
- package/dist/models/LifecycleTransition.d.ts +53 -0
- package/dist/models/LifecycleTransition.js +58 -0
- package/dist/models/ListEvents200ResponseInner.d.ts +1 -1
- package/dist/models/ListEvents200ResponseInner.js +1 -1
- package/dist/models/ListMetricEntries200ResponseInner.d.ts +1 -1
- package/dist/models/ListMetricEntries200ResponseInner.js +1 -1
- package/dist/models/ListMetricTypes200ResponseInner.d.ts +1 -1
- package/dist/models/ListMetricTypes200ResponseInner.js +1 -1
- package/dist/models/MarkJobUnsupportedRequest.d.ts +1 -1
- package/dist/models/MarkJobUnsupportedRequest.js +1 -1
- package/dist/models/MetricEntityType.d.ts +26 -0
- package/dist/models/MetricEntityType.js +52 -0
- package/dist/models/MetricEntriesList200Response.d.ts +63 -0
- package/dist/models/MetricEntriesList200Response.js +59 -0
- package/dist/models/MetricEntryReq.d.ts +56 -0
- package/dist/models/MetricEntryReq.js +62 -0
- package/dist/models/MetricEntryRes.d.ts +86 -0
- package/dist/models/MetricEntryRes.js +66 -0
- package/dist/models/MetricTypeReq.d.ts +39 -0
- package/dist/models/MetricTypeReq.js +55 -0
- package/dist/models/MetricTypeRes.d.ts +57 -0
- package/dist/models/MetricTypeRes.js +57 -0
- package/dist/models/MetricTypesList200Response.d.ts +63 -0
- package/dist/models/MetricTypesList200Response.js +59 -0
- package/dist/models/MetricTypesUpdateRequest.d.ts +32 -0
- package/dist/models/MetricTypesUpdateRequest.js +48 -0
- package/dist/models/NotaryJobRes.d.ts +1 -1
- package/dist/models/NotaryJobRes.js +1 -1
- package/dist/models/NotaryJobStatus.d.ts +1 -1
- package/dist/models/NotaryJobStatus.js +1 -1
- package/dist/models/PageRes.d.ts +14 -8
- package/dist/models/PageRes.js +7 -5
- package/dist/models/PaginationParams.d.ts +1 -1
- package/dist/models/PaginationParams.js +1 -1
- package/dist/models/ParticipantReq.d.ts +1 -1
- package/dist/models/ParticipantReq.js +1 -1
- package/dist/models/ParticipantRes.d.ts +1 -1
- package/dist/models/ParticipantRes.js +1 -1
- package/dist/models/ParticipantStatus.d.ts +1 -1
- package/dist/models/ParticipantStatus.js +1 -1
- package/dist/models/ParticipantsList200Response.d.ts +63 -0
- package/dist/models/ParticipantsList200Response.js +59 -0
- package/dist/models/PriceItem.d.ts +1 -1
- package/dist/models/PriceItem.js +1 -1
- package/dist/models/PropertyDefinition.d.ts +31 -2
- package/dist/models/PropertyDefinition.js +15 -2
- package/dist/models/SecretDefinition.d.ts +43 -0
- package/dist/models/SecretDefinition.js +58 -0
- package/dist/models/ServiceAction.d.ts +1 -1
- package/dist/models/ServiceAction.js +1 -1
- package/dist/models/ServiceGroupReq.d.ts +1 -1
- package/dist/models/ServiceGroupReq.js +1 -1
- package/dist/models/ServiceGroupRes.d.ts +1 -1
- package/dist/models/ServiceGroupRes.js +1 -1
- package/dist/models/ServiceGroupsList200Response.d.ts +63 -0
- package/dist/models/ServiceGroupsList200Response.js +59 -0
- package/dist/models/ServiceOfferingReq.d.ts +1 -1
- package/dist/models/ServiceOfferingReq.js +1 -1
- package/dist/models/ServiceOfferingRes.d.ts +1 -1
- package/dist/models/ServiceOfferingRes.js +1 -1
- package/dist/models/ServiceOfferingResServiceType.d.ts +1 -1
- package/dist/models/ServiceOfferingResServiceType.js +1 -1
- package/dist/models/ServiceOrderReq.d.ts +1 -1
- package/dist/models/ServiceOrderReq.js +1 -1
- package/dist/models/ServiceOrderRes.d.ts +9 -2
- package/dist/models/ServiceOrderRes.js +6 -3
- package/dist/models/ServiceOrderStatus.d.ts +26 -0
- package/dist/models/ServiceOrderStatus.js +52 -0
- package/dist/models/ServiceReq.d.ts +64 -0
- package/dist/models/ServiceReq.js +64 -0
- package/dist/models/ServiceRes.d.ts +10 -72
- package/dist/models/ServiceRes.js +13 -37
- package/dist/models/ServiceStatus.d.ts +2 -8
- package/dist/models/ServiceStatus.js +2 -8
- package/dist/models/ServiceTypeReq.d.ts +5 -6
- package/dist/models/ServiceTypeReq.js +3 -5
- package/dist/models/ServiceTypeRes.d.ts +9 -2
- package/dist/models/ServiceTypeRes.js +4 -1
- package/dist/models/ServiceTypesGet200Response.d.ts +57 -0
- package/dist/models/ServiceTypesGet200Response.js +57 -0
- package/dist/models/ServiceTypesList200Response.d.ts +63 -0
- package/dist/models/ServiceTypesList200Response.js +59 -0
- package/dist/models/ServicesActionRequest.d.ts +34 -0
- package/dist/models/ServicesActionRequest.js +48 -0
- package/dist/models/SubmitNotaryJobReq.d.ts +1 -1
- package/dist/models/SubmitNotaryJobReq.js +1 -1
- package/dist/models/TokenReq.d.ts +1 -1
- package/dist/models/TokenReq.js +1 -1
- package/dist/models/TokenRes.d.ts +2 -8
- package/dist/models/TokenRes.js +3 -5
- package/dist/models/TokensList200Response.d.ts +63 -0
- package/dist/models/TokensList200Response.js +59 -0
- package/dist/models/TokensUpdateRequest.d.ts +51 -0
- package/dist/models/TokensUpdateRequest.js +55 -0
- package/dist/models/TransactionEntityType.d.ts +1 -1
- package/dist/models/TransactionEntityType.js +1 -1
- package/dist/models/TransactionRecordReq.d.ts +1 -1
- package/dist/models/TransactionRecordReq.js +1 -1
- package/dist/models/TransactionRecordRes.d.ts +1 -1
- package/dist/models/TransactionRecordRes.js +1 -1
- package/dist/models/TransactionStatus.d.ts +1 -1
- package/dist/models/TransactionStatus.js +1 -1
- package/dist/models/TransactionType.d.ts +1 -1
- package/dist/models/TransactionType.js +1 -1
- package/dist/models/TransactionsUpdateRequest.d.ts +45 -0
- package/dist/models/TransactionsUpdateRequest.js +53 -0
- package/dist/models/UnsupportedJobReq.d.ts +32 -0
- package/dist/models/UnsupportedJobReq.js +50 -0
- package/dist/models/UpdateAgentReq.d.ts +7 -1
- package/dist/models/UpdateAgentReq.js +3 -1
- package/dist/models/UpdateAgentTypeReq.d.ts +47 -0
- package/dist/models/UpdateAgentTypeReq.js +54 -0
- package/dist/models/UpdateCEMServiceReq.d.ts +1 -1
- package/dist/models/UpdateCEMServiceReq.js +1 -1
- package/dist/models/UpdateJobRequest.d.ts +1 -1
- package/dist/models/UpdateJobRequest.js +1 -1
- package/dist/models/UpdateMetricTypeRequest.d.ts +1 -1
- package/dist/models/UpdateMetricTypeRequest.js +1 -1
- package/dist/models/UpdateMyAgentStatusRequest.d.ts +1 -1
- package/dist/models/UpdateMyAgentStatusRequest.js +1 -1
- package/dist/models/UpdateParticipantRequest.d.ts +1 -1
- package/dist/models/UpdateParticipantRequest.js +1 -1
- package/dist/models/UpdateServiceGroupRequest.d.ts +1 -1
- package/dist/models/UpdateServiceGroupRequest.js +1 -1
- package/dist/models/UpdateServiceTypeReq.d.ts +48 -0
- package/dist/models/UpdateServiceTypeReq.js +55 -0
- package/dist/models/UpdateServiceTypeRequest.d.ts +1 -1
- package/dist/models/UpdateServiceTypeRequest.js +1 -1
- package/dist/models/UpdateTokenRequest.d.ts +1 -1
- package/dist/models/UpdateTokenRequest.js +1 -1
- package/dist/models/UpdateTransactionRecordRequest.d.ts +1 -1
- package/dist/models/UpdateTransactionRecordRequest.js +1 -1
- package/dist/models/ValidatePropertiesReq.d.ts +1 -1
- package/dist/models/ValidatePropertiesReq.js +1 -1
- package/dist/models/ValidatePropertiesRes.d.ts +1 -1
- package/dist/models/ValidatePropertiesRes.js +1 -1
- package/dist/models/ValidateServiceTypeProperties200Response.d.ts +1 -1
- package/dist/models/ValidateServiceTypeProperties200Response.js +1 -1
- package/dist/models/ValidateServiceTypePropertiesRequest.d.ts +1 -1
- package/dist/models/ValidateServiceTypePropertiesRequest.js +1 -1
- package/dist/models/ValidationError.d.ts +1 -1
- package/dist/models/ValidationError.js +1 -1
- package/dist/models/ValidatorDefinition.d.ts +8 -4
- package/dist/models/ValidatorDefinition.js +7 -5
- package/dist/models/Variant.d.ts +1 -1
- package/dist/models/Variant.js +1 -1
- package/dist/models/index.d.ts +40 -30
- package/dist/models/index.js +40 -30
- package/dist/runtime.d.ts +1 -1
- package/dist/runtime.js +1 -1
- package/docs/AgentCreateRes.md +58 -0
- package/docs/AgentRes.md +56 -0
- package/docs/AgentStatus.md +32 -0
- package/docs/AgentTypeRes.md +44 -0
- package/docs/AgentTypesList200Response.md +44 -0
- package/docs/AgentsApi.md +901 -0
- package/docs/AgentsList200Response.md +44 -0
- package/docs/AgentsUpdateStatusRequest.md +34 -0
- package/docs/AuthRole.md +33 -0
- package/docs/AuthorizerDefinition.md +36 -0
- package/docs/ByPeriodReq.md +36 -0
- package/docs/ByPeriodReqFrom.md +36 -0
- package/docs/CommitmentReq.md +40 -0
- package/docs/CommitmentRes.md +46 -0
- package/docs/CommitmentsApi.md +379 -0
- package/docs/CompleteJobReq.md +38 -0
- package/docs/CreateAgentReq.md +44 -0
- package/docs/CreateAgentTypeReq.md +38 -0
- package/docs/CreateCEMServiceReq.md +46 -0
- package/docs/CreateServiceTypeReq.md +38 -0
- package/docs/ErrorRes.md +36 -0
- package/docs/EventAckReq.md +38 -0
- package/docs/EventAckRes.md +34 -0
- package/docs/EventApi.md +241 -0
- package/docs/EventLeaseReq.md +40 -0
- package/docs/EventLeaseRes.md +38 -0
- package/docs/EventRes.md +54 -0
- package/docs/EventsList200Response.md +44 -0
- package/docs/FailJobReq.md +34 -0
- package/docs/GeneratorDefinition.md +36 -0
- package/docs/JobRes.md +62 -0
- package/docs/JobStatus.md +33 -0
- package/docs/JobsApi.md +459 -0
- package/docs/JobsList200Response.md +44 -0
- package/docs/LifecycleAction.md +38 -0
- package/docs/LifecycleSchema.md +43 -0
- package/docs/LifecycleState.md +34 -0
- package/docs/LifecycleTransition.md +40 -0
- package/docs/MetricEntityType.md +32 -0
- package/docs/MetricEntriesList200Response.md +44 -0
- package/docs/MetricEntryReq.md +42 -0
- package/docs/MetricEntryRes.md +52 -0
- package/docs/MetricTypeReq.md +36 -0
- package/docs/MetricTypeRes.md +42 -0
- package/docs/MetricTypesList200Response.md +44 -0
- package/docs/MetricTypesUpdateRequest.md +34 -0
- package/docs/MetricsApi.md +531 -0
- package/docs/NotaryJobRes.md +54 -0
- package/docs/NotaryJobStatus.md +32 -0
- package/docs/NotaryJobsApi.md +381 -0
- package/docs/PageRes.md +44 -0
- package/docs/ParticipantReq.md +36 -0
- package/docs/ParticipantRes.md +42 -0
- package/docs/ParticipantStatus.md +32 -0
- package/docs/ParticipantsApi.md +380 -0
- package/docs/ParticipantsList200Response.md +44 -0
- package/docs/PriceItem.md +46 -0
- package/docs/PropertyDefinition.md +54 -0
- package/docs/SecretDefinition.md +34 -0
- package/docs/ServiceGroupReq.md +36 -0
- package/docs/ServiceGroupRes.md +42 -0
- package/docs/ServiceGroupsList200Response.md +44 -0
- package/docs/ServiceOfferingReq.md +48 -0
- package/docs/ServiceOfferingRes.md +58 -0
- package/docs/ServiceOfferingResServiceType.md +36 -0
- package/docs/ServiceOfferingsApi.md +379 -0
- package/docs/ServiceOrderReq.md +36 -0
- package/docs/ServiceOrderRes.md +70 -0
- package/docs/ServiceOrderStatus.md +32 -0
- package/docs/ServiceOrdersApi.md +233 -0
- package/docs/ServiceReq.md +44 -0
- package/docs/ServiceRes.md +58 -0
- package/docs/ServiceTypeRes.md +44 -0
- package/docs/ServiceTypesList200Response.md +44 -0
- package/docs/ServicesActionRequest.md +34 -0
- package/docs/ServicesApi.md +1283 -0
- package/docs/SubmitNotaryJobReq.md +38 -0
- package/docs/TokenReq.md +40 -0
- package/docs/TokenRes.md +50 -0
- package/docs/TokensApi.md +453 -0
- package/docs/TokensList200Response.md +44 -0
- package/docs/TokensUpdateRequest.md +40 -0
- package/docs/TransactionEntityType.md +32 -0
- package/docs/TransactionRecordReq.md +56 -0
- package/docs/TransactionRecordRes.md +74 -0
- package/docs/TransactionStatus.md +32 -0
- package/docs/TransactionType.md +32 -0
- package/docs/TransactionsApi.md +525 -0
- package/docs/TransactionsUpdateRequest.md +38 -0
- package/docs/UpdateAgentReq.md +42 -0
- package/docs/UpdateAgentTypeReq.md +38 -0
- package/docs/UpdateCEMServiceReq.md +38 -0
- package/docs/UpdateServiceTypeReq.md +38 -0
- package/docs/ValidationError.md +36 -0
- package/docs/ValidatorDefinition.md +36 -0
- package/docs/Variant.md +40 -0
- package/package.json +2 -2
- package/src/apis/AgentsApi.ts +376 -198
- package/src/apis/CommitmentsApi.ts +41 -41
- package/src/apis/EventApi.ts +72 -129
- package/src/apis/JobsApi.ts +129 -262
- package/src/apis/MetricsApi.ts +176 -149
- package/src/apis/NotaryJobsApi.ts +40 -40
- package/src/apis/ParticipantsApi.ts +82 -67
- package/src/apis/ServiceOfferingsApi.ts +41 -41
- package/src/apis/ServiceOrdersApi.ts +26 -26
- package/src/apis/ServicesApi.ts +360 -504
- package/src/apis/TokensApi.ts +101 -80
- package/src/apis/TransactionsApi.ts +63 -63
- package/src/models/AcknowledgeEvents200Response.ts +1 -1
- package/src/models/AcknowledgeEventsRequest.ts +1 -1
- package/src/models/AgentCreateRes.ts +17 -1
- package/src/models/AgentRes.ts +17 -1
- package/src/models/AgentStatus.ts +1 -1
- package/src/models/AgentTypeReq.ts +1 -1
- package/src/models/AgentTypeRes.ts +20 -12
- package/src/models/AgentTypesGet200Response.ts +105 -0
- package/src/models/AgentTypesList200Response.ts +113 -0
- package/src/models/AgentsList200Response.ts +113 -0
- package/src/models/AgentsUpdateStatusRequest.ts +76 -0
- package/src/models/AuthRole.ts +1 -1
- package/src/models/AuthorizerDefinition.ts +86 -0
- package/src/models/ByPeriodReq.ts +1 -1
- package/src/models/ByPeriodReqFrom.ts +1 -1
- package/src/models/CommitmentReq.ts +1 -1
- package/src/models/CommitmentRes.ts +1 -1
- package/src/models/CompleteJobReq.ts +81 -0
- package/src/models/CompleteJobRequest.ts +1 -1
- package/src/models/CreateAgentReq.ts +9 -1
- package/src/models/CreateAgentTypeReq.ts +91 -0
- package/src/models/CreateCEMServiceReq.ts +1 -1
- package/src/models/CreateEventRequest.ts +1 -1
- package/src/models/CreateMetricEntryRequest.ts +1 -1
- package/src/models/CreateMetricTypeRequest.ts +1 -1
- package/src/models/CreateServiceTypeReq.ts +97 -0
- package/src/models/ErrorRes.ts +5 -13
- package/src/models/EventAckReq.ts +84 -0
- package/src/models/EventAckRes.ts +65 -0
- package/src/models/EventLeaseReq.ts +91 -0
- package/src/models/EventLeaseRes.ts +89 -0
- package/src/models/EventRes.ts +145 -0
- package/src/models/EventsList200Response.ts +113 -0
- package/src/models/FailJobReq.ts +68 -0
- package/src/models/FailJobRequest.ts +1 -1
- package/src/models/GeneratorDefinition.ts +85 -0
- package/src/models/JobRes.ts +31 -45
- package/src/models/JobStatus.ts +7 -3
- package/src/models/JobsList200Response.ts +113 -0
- package/src/models/LeaseEvents200Response.ts +1 -1
- package/src/models/LeaseEventsRequest.ts +1 -1
- package/src/models/LifecycleAction.ts +104 -0
- package/src/models/LifecycleSchema.ts +117 -0
- package/src/models/LifecycleState.ts +66 -0
- package/src/models/LifecycleTransition.ts +94 -0
- package/src/models/ListEvents200ResponseInner.ts +1 -1
- package/src/models/ListMetricEntries200ResponseInner.ts +1 -1
- package/src/models/ListMetricTypes200ResponseInner.ts +1 -1
- package/src/models/MarkJobUnsupportedRequest.ts +1 -1
- package/src/models/MetricEntityType.ts +54 -0
- package/src/models/MetricEntriesList200Response.ts +113 -0
- package/src/models/MetricEntryReq.ts +100 -0
- package/src/models/MetricEntryRes.ts +137 -0
- package/src/models/MetricTypeReq.ts +85 -0
- package/src/models/MetricTypeRes.ts +107 -0
- package/src/models/MetricTypesList200Response.ts +113 -0
- package/src/models/MetricTypesUpdateRequest.ts +65 -0
- package/src/models/NotaryJobRes.ts +1 -1
- package/src/models/NotaryJobStatus.ts +1 -1
- package/src/models/PageRes.ts +20 -12
- package/src/models/PaginationParams.ts +1 -1
- package/src/models/ParticipantReq.ts +1 -1
- package/src/models/ParticipantRes.ts +1 -1
- package/src/models/ParticipantStatus.ts +1 -1
- package/src/models/ParticipantsList200Response.ts +113 -0
- package/src/models/PriceItem.ts +1 -1
- package/src/models/PropertyDefinition.ts +58 -3
- package/src/models/SecretDefinition.ts +80 -0
- package/src/models/ServiceAction.ts +1 -1
- package/src/models/ServiceGroupReq.ts +1 -1
- package/src/models/ServiceGroupRes.ts +1 -1
- package/src/models/ServiceGroupsList200Response.ts +113 -0
- package/src/models/ServiceOfferingReq.ts +1 -1
- package/src/models/ServiceOfferingRes.ts +1 -1
- package/src/models/ServiceOfferingResServiceType.ts +1 -1
- package/src/models/ServiceOrderReq.ts +1 -1
- package/src/models/ServiceOrderRes.ts +21 -4
- package/src/models/ServiceOrderStatus.ts +54 -0
- package/src/models/ServiceReq.ts +108 -0
- package/src/models/ServiceRes.ts +22 -139
- package/src/models/ServiceStatus.ts +2 -8
- package/src/models/ServiceTypeReq.ts +6 -14
- package/src/models/ServiceTypeRes.ts +17 -2
- package/src/models/ServiceTypesGet200Response.ts +105 -0
- package/src/models/ServiceTypesList200Response.ts +113 -0
- package/src/models/ServicesActionRequest.ts +65 -0
- package/src/models/SubmitNotaryJobReq.ts +1 -1
- package/src/models/TokenReq.ts +1 -1
- package/src/models/TokenRes.ts +4 -12
- package/src/models/TokensList200Response.ts +113 -0
- package/src/models/TokensUpdateRequest.ts +99 -0
- package/src/models/TransactionEntityType.ts +1 -1
- package/src/models/TransactionRecordReq.ts +1 -1
- package/src/models/TransactionRecordRes.ts +1 -1
- package/src/models/TransactionStatus.ts +1 -1
- package/src/models/TransactionType.ts +1 -1
- package/src/models/TransactionsUpdateRequest.ts +91 -0
- package/src/models/UnsupportedJobReq.ts +66 -0
- package/src/models/UpdateAgentReq.ts +9 -1
- package/src/models/UpdateAgentTypeReq.ts +89 -0
- package/src/models/UpdateCEMServiceReq.ts +1 -1
- package/src/models/UpdateJobRequest.ts +1 -1
- package/src/models/UpdateMetricTypeRequest.ts +1 -1
- package/src/models/UpdateMyAgentStatusRequest.ts +1 -1
- package/src/models/UpdateParticipantRequest.ts +1 -1
- package/src/models/UpdateServiceGroupRequest.ts +1 -1
- package/src/models/UpdateServiceTypeReq.ts +96 -0
- package/src/models/UpdateServiceTypeRequest.ts +1 -1
- package/src/models/UpdateTokenRequest.ts +1 -1
- package/src/models/UpdateTransactionRecordRequest.ts +1 -1
- package/src/models/ValidatePropertiesReq.ts +1 -1
- package/src/models/ValidatePropertiesRes.ts +1 -1
- package/src/models/ValidateServiceTypeProperties200Response.ts +1 -1
- package/src/models/ValidateServiceTypePropertiesRequest.ts +1 -1
- package/src/models/ValidationError.ts +1 -1
- package/src/models/ValidatorDefinition.ts +10 -8
- package/src/models/Variant.ts +1 -1
- package/src/models/index.ts +40 -30
- package/src/runtime.ts +1 -1
|
@@ -0,0 +1,1283 @@
|
|
|
1
|
+
# ServicesApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.fulcrum.testudosrl.dev/api/v1*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
| [**cemServicesCreate**](ServicesApi.md#cemservicescreate) | **POST** /services | Create a new CEM service |
|
|
8
|
+
| [**cemServicesDelete**](ServicesApi.md#cemservicesdelete) | **DELETE** /services/{id} | Delete a CEM service |
|
|
9
|
+
| [**cemServicesGet**](ServicesApi.md#cemservicesget) | **GET** /services/{id} | Get a CEM service by ID |
|
|
10
|
+
| [**cemServicesGetActiveOrder**](ServicesApi.md#cemservicesgetactiveorder) | **GET** /services/{id}/active-order | Get the active service order for a CEM service |
|
|
11
|
+
| [**cemServicesList**](ServicesApi.md#cemserviceslist) | **GET** /services | List all CEM services |
|
|
12
|
+
| [**cemServicesUpdate**](ServicesApi.md#cemservicesupdate) | **PATCH** /services/{id} | Update a CEM service |
|
|
13
|
+
| [**serviceGroupsCreate**](ServicesApi.md#servicegroupscreate) | **POST** /service-groups | Create a service group |
|
|
14
|
+
| [**serviceGroupsDelete**](ServicesApi.md#servicegroupsdelete) | **DELETE** /service-groups/{id} | Delete a service group |
|
|
15
|
+
| [**serviceGroupsGet**](ServicesApi.md#servicegroupsget) | **GET** /service-groups/{id} | Get a service group |
|
|
16
|
+
| [**serviceGroupsList**](ServicesApi.md#servicegroupslist) | **GET** /service-groups | List service groups |
|
|
17
|
+
| [**serviceGroupsUpdate**](ServicesApi.md#servicegroupsupdate) | **PATCH** /service-groups/{id} | Update a service group |
|
|
18
|
+
| [**serviceTypesCreate**](ServicesApi.md#servicetypescreate) | **POST** /service-types | Create a service type |
|
|
19
|
+
| [**serviceTypesDelete**](ServicesApi.md#servicetypesdelete) | **DELETE** /service-types/{id} | Delete a service type |
|
|
20
|
+
| [**serviceTypesGet**](ServicesApi.md#servicetypesget) | **GET** /service-types/{id} | Get a service type |
|
|
21
|
+
| [**serviceTypesList**](ServicesApi.md#servicetypeslist) | **GET** /service-types | List service types |
|
|
22
|
+
| [**serviceTypesUpdate**](ServicesApi.md#servicetypesupdate) | **PATCH** /service-types/{id} | Update a service type |
|
|
23
|
+
| [**servicesAction**](ServicesApi.md#servicesactionoperation) | **POST** /services/{id}/{action} | Perform a lifecycle action on a service |
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
## cemServicesCreate
|
|
28
|
+
|
|
29
|
+
> ServiceRes cemServicesCreate(createCEMServiceReq)
|
|
30
|
+
|
|
31
|
+
Create a new CEM service
|
|
32
|
+
|
|
33
|
+
### Example
|
|
34
|
+
|
|
35
|
+
```ts
|
|
36
|
+
import {
|
|
37
|
+
Configuration,
|
|
38
|
+
ServicesApi,
|
|
39
|
+
} from 'fulcrum-cem-client';
|
|
40
|
+
import type { CemServicesCreateRequest } from 'fulcrum-cem-client';
|
|
41
|
+
|
|
42
|
+
async function example() {
|
|
43
|
+
console.log("🚀 Testing fulcrum-cem-client SDK...");
|
|
44
|
+
const config = new Configuration({
|
|
45
|
+
// To configure OAuth2 access token for authorization: BearerAuth implicit
|
|
46
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
47
|
+
});
|
|
48
|
+
const api = new ServicesApi(config);
|
|
49
|
+
|
|
50
|
+
const body = {
|
|
51
|
+
// CreateCEMServiceReq
|
|
52
|
+
createCEMServiceReq: ...,
|
|
53
|
+
} satisfies CemServicesCreateRequest;
|
|
54
|
+
|
|
55
|
+
try {
|
|
56
|
+
const data = await api.cemServicesCreate(body);
|
|
57
|
+
console.log(data);
|
|
58
|
+
} catch (error) {
|
|
59
|
+
console.error(error);
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
// Run the test
|
|
64
|
+
example().catch(console.error);
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### Parameters
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
| Name | Type | Description | Notes |
|
|
71
|
+
|------------- | ------------- | ------------- | -------------|
|
|
72
|
+
| **createCEMServiceReq** | [CreateCEMServiceReq](CreateCEMServiceReq.md) | | |
|
|
73
|
+
|
|
74
|
+
### Return type
|
|
75
|
+
|
|
76
|
+
[**ServiceRes**](ServiceRes.md)
|
|
77
|
+
|
|
78
|
+
### Authorization
|
|
79
|
+
|
|
80
|
+
[BearerAuth implicit](../README.md#BearerAuth-implicit)
|
|
81
|
+
|
|
82
|
+
### HTTP request headers
|
|
83
|
+
|
|
84
|
+
- **Content-Type**: `application/json`
|
|
85
|
+
- **Accept**: `application/json`
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
### HTTP response details
|
|
89
|
+
| Status code | Description | Response headers |
|
|
90
|
+
|-------------|-------------|------------------|
|
|
91
|
+
| **201** | CEM service created | - |
|
|
92
|
+
| **400** | Bad Request | - |
|
|
93
|
+
| **401** | Unauthorized | - |
|
|
94
|
+
| **403** | Forbidden | - |
|
|
95
|
+
|
|
96
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
## cemServicesDelete
|
|
100
|
+
|
|
101
|
+
> cemServicesDelete(id)
|
|
102
|
+
|
|
103
|
+
Delete a CEM service
|
|
104
|
+
|
|
105
|
+
### Example
|
|
106
|
+
|
|
107
|
+
```ts
|
|
108
|
+
import {
|
|
109
|
+
Configuration,
|
|
110
|
+
ServicesApi,
|
|
111
|
+
} from 'fulcrum-cem-client';
|
|
112
|
+
import type { CemServicesDeleteRequest } from 'fulcrum-cem-client';
|
|
113
|
+
|
|
114
|
+
async function example() {
|
|
115
|
+
console.log("🚀 Testing fulcrum-cem-client SDK...");
|
|
116
|
+
const config = new Configuration({
|
|
117
|
+
// To configure OAuth2 access token for authorization: BearerAuth implicit
|
|
118
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
119
|
+
});
|
|
120
|
+
const api = new ServicesApi(config);
|
|
121
|
+
|
|
122
|
+
const body = {
|
|
123
|
+
// string
|
|
124
|
+
id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
125
|
+
} satisfies CemServicesDeleteRequest;
|
|
126
|
+
|
|
127
|
+
try {
|
|
128
|
+
const data = await api.cemServicesDelete(body);
|
|
129
|
+
console.log(data);
|
|
130
|
+
} catch (error) {
|
|
131
|
+
console.error(error);
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
// Run the test
|
|
136
|
+
example().catch(console.error);
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
### Parameters
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
| Name | Type | Description | Notes |
|
|
143
|
+
|------------- | ------------- | ------------- | -------------|
|
|
144
|
+
| **id** | `string` | | [Defaults to `undefined`] |
|
|
145
|
+
|
|
146
|
+
### Return type
|
|
147
|
+
|
|
148
|
+
`void` (Empty response body)
|
|
149
|
+
|
|
150
|
+
### Authorization
|
|
151
|
+
|
|
152
|
+
[BearerAuth implicit](../README.md#BearerAuth-implicit)
|
|
153
|
+
|
|
154
|
+
### HTTP request headers
|
|
155
|
+
|
|
156
|
+
- **Content-Type**: Not defined
|
|
157
|
+
- **Accept**: `application/json`
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
### HTTP response details
|
|
161
|
+
| Status code | Description | Response headers |
|
|
162
|
+
|-------------|-------------|------------------|
|
|
163
|
+
| **204** | CEM service deleted | - |
|
|
164
|
+
| **401** | Unauthorized | - |
|
|
165
|
+
| **403** | Forbidden | - |
|
|
166
|
+
| **404** | CEM service not found | - |
|
|
167
|
+
|
|
168
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
## cemServicesGet
|
|
172
|
+
|
|
173
|
+
> ServiceRes cemServicesGet(id)
|
|
174
|
+
|
|
175
|
+
Get a CEM service by ID
|
|
176
|
+
|
|
177
|
+
### Example
|
|
178
|
+
|
|
179
|
+
```ts
|
|
180
|
+
import {
|
|
181
|
+
Configuration,
|
|
182
|
+
ServicesApi,
|
|
183
|
+
} from 'fulcrum-cem-client';
|
|
184
|
+
import type { CemServicesGetRequest } from 'fulcrum-cem-client';
|
|
185
|
+
|
|
186
|
+
async function example() {
|
|
187
|
+
console.log("🚀 Testing fulcrum-cem-client SDK...");
|
|
188
|
+
const config = new Configuration({
|
|
189
|
+
// To configure OAuth2 access token for authorization: BearerAuth implicit
|
|
190
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
191
|
+
});
|
|
192
|
+
const api = new ServicesApi(config);
|
|
193
|
+
|
|
194
|
+
const body = {
|
|
195
|
+
// string
|
|
196
|
+
id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
197
|
+
} satisfies CemServicesGetRequest;
|
|
198
|
+
|
|
199
|
+
try {
|
|
200
|
+
const data = await api.cemServicesGet(body);
|
|
201
|
+
console.log(data);
|
|
202
|
+
} catch (error) {
|
|
203
|
+
console.error(error);
|
|
204
|
+
}
|
|
205
|
+
}
|
|
206
|
+
|
|
207
|
+
// Run the test
|
|
208
|
+
example().catch(console.error);
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
### Parameters
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
| Name | Type | Description | Notes |
|
|
215
|
+
|------------- | ------------- | ------------- | -------------|
|
|
216
|
+
| **id** | `string` | | [Defaults to `undefined`] |
|
|
217
|
+
|
|
218
|
+
### Return type
|
|
219
|
+
|
|
220
|
+
[**ServiceRes**](ServiceRes.md)
|
|
221
|
+
|
|
222
|
+
### Authorization
|
|
223
|
+
|
|
224
|
+
[BearerAuth implicit](../README.md#BearerAuth-implicit)
|
|
225
|
+
|
|
226
|
+
### HTTP request headers
|
|
227
|
+
|
|
228
|
+
- **Content-Type**: Not defined
|
|
229
|
+
- **Accept**: `application/json`
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
### HTTP response details
|
|
233
|
+
| Status code | Description | Response headers |
|
|
234
|
+
|-------------|-------------|------------------|
|
|
235
|
+
| **200** | CEM service details | - |
|
|
236
|
+
| **401** | Unauthorized | - |
|
|
237
|
+
| **403** | Forbidden | - |
|
|
238
|
+
| **404** | CEM service not found | - |
|
|
239
|
+
|
|
240
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
## cemServicesGetActiveOrder
|
|
244
|
+
|
|
245
|
+
> ServiceOrderRes cemServicesGetActiveOrder(id)
|
|
246
|
+
|
|
247
|
+
Get the active service order for a CEM service
|
|
248
|
+
|
|
249
|
+
### Example
|
|
250
|
+
|
|
251
|
+
```ts
|
|
252
|
+
import {
|
|
253
|
+
Configuration,
|
|
254
|
+
ServicesApi,
|
|
255
|
+
} from 'fulcrum-cem-client';
|
|
256
|
+
import type { CemServicesGetActiveOrderRequest } from 'fulcrum-cem-client';
|
|
257
|
+
|
|
258
|
+
async function example() {
|
|
259
|
+
console.log("🚀 Testing fulcrum-cem-client SDK...");
|
|
260
|
+
const config = new Configuration({
|
|
261
|
+
// To configure OAuth2 access token for authorization: BearerAuth implicit
|
|
262
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
263
|
+
});
|
|
264
|
+
const api = new ServicesApi(config);
|
|
265
|
+
|
|
266
|
+
const body = {
|
|
267
|
+
// string
|
|
268
|
+
id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
269
|
+
} satisfies CemServicesGetActiveOrderRequest;
|
|
270
|
+
|
|
271
|
+
try {
|
|
272
|
+
const data = await api.cemServicesGetActiveOrder(body);
|
|
273
|
+
console.log(data);
|
|
274
|
+
} catch (error) {
|
|
275
|
+
console.error(error);
|
|
276
|
+
}
|
|
277
|
+
}
|
|
278
|
+
|
|
279
|
+
// Run the test
|
|
280
|
+
example().catch(console.error);
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
### Parameters
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
| Name | Type | Description | Notes |
|
|
287
|
+
|------------- | ------------- | ------------- | -------------|
|
|
288
|
+
| **id** | `string` | | [Defaults to `undefined`] |
|
|
289
|
+
|
|
290
|
+
### Return type
|
|
291
|
+
|
|
292
|
+
[**ServiceOrderRes**](ServiceOrderRes.md)
|
|
293
|
+
|
|
294
|
+
### Authorization
|
|
295
|
+
|
|
296
|
+
[BearerAuth implicit](../README.md#BearerAuth-implicit)
|
|
297
|
+
|
|
298
|
+
### HTTP request headers
|
|
299
|
+
|
|
300
|
+
- **Content-Type**: Not defined
|
|
301
|
+
- **Accept**: `application/json`
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
### HTTP response details
|
|
305
|
+
| Status code | Description | Response headers |
|
|
306
|
+
|-------------|-------------|------------------|
|
|
307
|
+
| **200** | Active service order details | - |
|
|
308
|
+
| **401** | Unauthorized | - |
|
|
309
|
+
| **403** | Forbidden | - |
|
|
310
|
+
| **404** | CEM service or active order not found | - |
|
|
311
|
+
|
|
312
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
## cemServicesList
|
|
316
|
+
|
|
317
|
+
> Array<ServiceRes> cemServicesList(page, pageSize)
|
|
318
|
+
|
|
319
|
+
List all CEM services
|
|
320
|
+
|
|
321
|
+
### Example
|
|
322
|
+
|
|
323
|
+
```ts
|
|
324
|
+
import {
|
|
325
|
+
Configuration,
|
|
326
|
+
ServicesApi,
|
|
327
|
+
} from 'fulcrum-cem-client';
|
|
328
|
+
import type { CemServicesListRequest } from 'fulcrum-cem-client';
|
|
329
|
+
|
|
330
|
+
async function example() {
|
|
331
|
+
console.log("🚀 Testing fulcrum-cem-client SDK...");
|
|
332
|
+
const config = new Configuration({
|
|
333
|
+
// To configure OAuth2 access token for authorization: BearerAuth implicit
|
|
334
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
335
|
+
});
|
|
336
|
+
const api = new ServicesApi(config);
|
|
337
|
+
|
|
338
|
+
const body = {
|
|
339
|
+
// number (optional)
|
|
340
|
+
page: 56,
|
|
341
|
+
// number (optional)
|
|
342
|
+
pageSize: 56,
|
|
343
|
+
} satisfies CemServicesListRequest;
|
|
344
|
+
|
|
345
|
+
try {
|
|
346
|
+
const data = await api.cemServicesList(body);
|
|
347
|
+
console.log(data);
|
|
348
|
+
} catch (error) {
|
|
349
|
+
console.error(error);
|
|
350
|
+
}
|
|
351
|
+
}
|
|
352
|
+
|
|
353
|
+
// Run the test
|
|
354
|
+
example().catch(console.error);
|
|
355
|
+
```
|
|
356
|
+
|
|
357
|
+
### Parameters
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
| Name | Type | Description | Notes |
|
|
361
|
+
|------------- | ------------- | ------------- | -------------|
|
|
362
|
+
| **page** | `number` | | [Optional] [Defaults to `1`] |
|
|
363
|
+
| **pageSize** | `number` | | [Optional] [Defaults to `20`] |
|
|
364
|
+
|
|
365
|
+
### Return type
|
|
366
|
+
|
|
367
|
+
[**Array<ServiceRes>**](ServiceRes.md)
|
|
368
|
+
|
|
369
|
+
### Authorization
|
|
370
|
+
|
|
371
|
+
[BearerAuth implicit](../README.md#BearerAuth-implicit)
|
|
372
|
+
|
|
373
|
+
### HTTP request headers
|
|
374
|
+
|
|
375
|
+
- **Content-Type**: Not defined
|
|
376
|
+
- **Accept**: `application/json`
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
### HTTP response details
|
|
380
|
+
| Status code | Description | Response headers |
|
|
381
|
+
|-------------|-------------|------------------|
|
|
382
|
+
| **200** | A list of CEM services | - |
|
|
383
|
+
| **401** | Unauthorized | - |
|
|
384
|
+
| **403** | Forbidden | - |
|
|
385
|
+
|
|
386
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
## cemServicesUpdate
|
|
390
|
+
|
|
391
|
+
> ServiceRes cemServicesUpdate(id, updateCEMServiceReq)
|
|
392
|
+
|
|
393
|
+
Update a CEM service
|
|
394
|
+
|
|
395
|
+
### Example
|
|
396
|
+
|
|
397
|
+
```ts
|
|
398
|
+
import {
|
|
399
|
+
Configuration,
|
|
400
|
+
ServicesApi,
|
|
401
|
+
} from 'fulcrum-cem-client';
|
|
402
|
+
import type { CemServicesUpdateRequest } from 'fulcrum-cem-client';
|
|
403
|
+
|
|
404
|
+
async function example() {
|
|
405
|
+
console.log("🚀 Testing fulcrum-cem-client SDK...");
|
|
406
|
+
const config = new Configuration({
|
|
407
|
+
// To configure OAuth2 access token for authorization: BearerAuth implicit
|
|
408
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
409
|
+
});
|
|
410
|
+
const api = new ServicesApi(config);
|
|
411
|
+
|
|
412
|
+
const body = {
|
|
413
|
+
// string
|
|
414
|
+
id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
415
|
+
// UpdateCEMServiceReq
|
|
416
|
+
updateCEMServiceReq: ...,
|
|
417
|
+
} satisfies CemServicesUpdateRequest;
|
|
418
|
+
|
|
419
|
+
try {
|
|
420
|
+
const data = await api.cemServicesUpdate(body);
|
|
421
|
+
console.log(data);
|
|
422
|
+
} catch (error) {
|
|
423
|
+
console.error(error);
|
|
424
|
+
}
|
|
425
|
+
}
|
|
426
|
+
|
|
427
|
+
// Run the test
|
|
428
|
+
example().catch(console.error);
|
|
429
|
+
```
|
|
430
|
+
|
|
431
|
+
### Parameters
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
| Name | Type | Description | Notes |
|
|
435
|
+
|------------- | ------------- | ------------- | -------------|
|
|
436
|
+
| **id** | `string` | | [Defaults to `undefined`] |
|
|
437
|
+
| **updateCEMServiceReq** | [UpdateCEMServiceReq](UpdateCEMServiceReq.md) | | |
|
|
438
|
+
|
|
439
|
+
### Return type
|
|
440
|
+
|
|
441
|
+
[**ServiceRes**](ServiceRes.md)
|
|
442
|
+
|
|
443
|
+
### Authorization
|
|
444
|
+
|
|
445
|
+
[BearerAuth implicit](../README.md#BearerAuth-implicit)
|
|
446
|
+
|
|
447
|
+
### HTTP request headers
|
|
448
|
+
|
|
449
|
+
- **Content-Type**: `application/json`
|
|
450
|
+
- **Accept**: `application/json`
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
### HTTP response details
|
|
454
|
+
| Status code | Description | Response headers |
|
|
455
|
+
|-------------|-------------|------------------|
|
|
456
|
+
| **200** | CEM service updated | - |
|
|
457
|
+
| **400** | Bad Request | - |
|
|
458
|
+
| **401** | Unauthorized | - |
|
|
459
|
+
| **403** | Forbidden | - |
|
|
460
|
+
| **404** | CEM service not found | - |
|
|
461
|
+
|
|
462
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
## serviceGroupsCreate
|
|
466
|
+
|
|
467
|
+
> ServiceGroupRes serviceGroupsCreate(serviceGroupReq)
|
|
468
|
+
|
|
469
|
+
Create a service group
|
|
470
|
+
|
|
471
|
+
Creates a new service group
|
|
472
|
+
|
|
473
|
+
### Example
|
|
474
|
+
|
|
475
|
+
```ts
|
|
476
|
+
import {
|
|
477
|
+
Configuration,
|
|
478
|
+
ServicesApi,
|
|
479
|
+
} from 'fulcrum-cem-client';
|
|
480
|
+
import type { ServiceGroupsCreateRequest } from 'fulcrum-cem-client';
|
|
481
|
+
|
|
482
|
+
async function example() {
|
|
483
|
+
console.log("🚀 Testing fulcrum-cem-client SDK...");
|
|
484
|
+
const config = new Configuration({
|
|
485
|
+
// To configure OAuth2 access token for authorization: BearerAuth implicit
|
|
486
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
487
|
+
});
|
|
488
|
+
const api = new ServicesApi(config);
|
|
489
|
+
|
|
490
|
+
const body = {
|
|
491
|
+
// ServiceGroupReq
|
|
492
|
+
serviceGroupReq: ...,
|
|
493
|
+
} satisfies ServiceGroupsCreateRequest;
|
|
494
|
+
|
|
495
|
+
try {
|
|
496
|
+
const data = await api.serviceGroupsCreate(body);
|
|
497
|
+
console.log(data);
|
|
498
|
+
} catch (error) {
|
|
499
|
+
console.error(error);
|
|
500
|
+
}
|
|
501
|
+
}
|
|
502
|
+
|
|
503
|
+
// Run the test
|
|
504
|
+
example().catch(console.error);
|
|
505
|
+
```
|
|
506
|
+
|
|
507
|
+
### Parameters
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
| Name | Type | Description | Notes |
|
|
511
|
+
|------------- | ------------- | ------------- | -------------|
|
|
512
|
+
| **serviceGroupReq** | [ServiceGroupReq](ServiceGroupReq.md) | | |
|
|
513
|
+
|
|
514
|
+
### Return type
|
|
515
|
+
|
|
516
|
+
[**ServiceGroupRes**](ServiceGroupRes.md)
|
|
517
|
+
|
|
518
|
+
### Authorization
|
|
519
|
+
|
|
520
|
+
[BearerAuth implicit](../README.md#BearerAuth-implicit)
|
|
521
|
+
|
|
522
|
+
### HTTP request headers
|
|
523
|
+
|
|
524
|
+
- **Content-Type**: `application/json`
|
|
525
|
+
- **Accept**: `application/json`
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
### HTTP response details
|
|
529
|
+
| Status code | Description | Response headers |
|
|
530
|
+
|-------------|-------------|------------------|
|
|
531
|
+
| **201** | Service group created successfully | - |
|
|
532
|
+
| **400** | Invalid request | - |
|
|
533
|
+
|
|
534
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
## serviceGroupsDelete
|
|
538
|
+
|
|
539
|
+
> serviceGroupsDelete(id)
|
|
540
|
+
|
|
541
|
+
Delete a service group
|
|
542
|
+
|
|
543
|
+
Deletes a service group by ID
|
|
544
|
+
|
|
545
|
+
### Example
|
|
546
|
+
|
|
547
|
+
```ts
|
|
548
|
+
import {
|
|
549
|
+
Configuration,
|
|
550
|
+
ServicesApi,
|
|
551
|
+
} from 'fulcrum-cem-client';
|
|
552
|
+
import type { ServiceGroupsDeleteRequest } from 'fulcrum-cem-client';
|
|
553
|
+
|
|
554
|
+
async function example() {
|
|
555
|
+
console.log("🚀 Testing fulcrum-cem-client SDK...");
|
|
556
|
+
const config = new Configuration({
|
|
557
|
+
// To configure OAuth2 access token for authorization: BearerAuth implicit
|
|
558
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
559
|
+
});
|
|
560
|
+
const api = new ServicesApi(config);
|
|
561
|
+
|
|
562
|
+
const body = {
|
|
563
|
+
// string
|
|
564
|
+
id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
565
|
+
} satisfies ServiceGroupsDeleteRequest;
|
|
566
|
+
|
|
567
|
+
try {
|
|
568
|
+
const data = await api.serviceGroupsDelete(body);
|
|
569
|
+
console.log(data);
|
|
570
|
+
} catch (error) {
|
|
571
|
+
console.error(error);
|
|
572
|
+
}
|
|
573
|
+
}
|
|
574
|
+
|
|
575
|
+
// Run the test
|
|
576
|
+
example().catch(console.error);
|
|
577
|
+
```
|
|
578
|
+
|
|
579
|
+
### Parameters
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
| Name | Type | Description | Notes |
|
|
583
|
+
|------------- | ------------- | ------------- | -------------|
|
|
584
|
+
| **id** | `string` | | [Defaults to `undefined`] |
|
|
585
|
+
|
|
586
|
+
### Return type
|
|
587
|
+
|
|
588
|
+
`void` (Empty response body)
|
|
589
|
+
|
|
590
|
+
### Authorization
|
|
591
|
+
|
|
592
|
+
[BearerAuth implicit](../README.md#BearerAuth-implicit)
|
|
593
|
+
|
|
594
|
+
### HTTP request headers
|
|
595
|
+
|
|
596
|
+
- **Content-Type**: Not defined
|
|
597
|
+
- **Accept**: `application/json`
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
### HTTP response details
|
|
601
|
+
| Status code | Description | Response headers |
|
|
602
|
+
|-------------|-------------|------------------|
|
|
603
|
+
| **204** | Service group deleted successfully | - |
|
|
604
|
+
| **404** | Service group not found | - |
|
|
605
|
+
|
|
606
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
607
|
+
|
|
608
|
+
|
|
609
|
+
## serviceGroupsGet
|
|
610
|
+
|
|
611
|
+
> ServiceGroupRes serviceGroupsGet(id)
|
|
612
|
+
|
|
613
|
+
Get a service group
|
|
614
|
+
|
|
615
|
+
Retrieves a specific service group by ID
|
|
616
|
+
|
|
617
|
+
### Example
|
|
618
|
+
|
|
619
|
+
```ts
|
|
620
|
+
import {
|
|
621
|
+
Configuration,
|
|
622
|
+
ServicesApi,
|
|
623
|
+
} from 'fulcrum-cem-client';
|
|
624
|
+
import type { ServiceGroupsGetRequest } from 'fulcrum-cem-client';
|
|
625
|
+
|
|
626
|
+
async function example() {
|
|
627
|
+
console.log("🚀 Testing fulcrum-cem-client SDK...");
|
|
628
|
+
const config = new Configuration({
|
|
629
|
+
// To configure OAuth2 access token for authorization: BearerAuth implicit
|
|
630
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
631
|
+
});
|
|
632
|
+
const api = new ServicesApi(config);
|
|
633
|
+
|
|
634
|
+
const body = {
|
|
635
|
+
// string
|
|
636
|
+
id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
637
|
+
} satisfies ServiceGroupsGetRequest;
|
|
638
|
+
|
|
639
|
+
try {
|
|
640
|
+
const data = await api.serviceGroupsGet(body);
|
|
641
|
+
console.log(data);
|
|
642
|
+
} catch (error) {
|
|
643
|
+
console.error(error);
|
|
644
|
+
}
|
|
645
|
+
}
|
|
646
|
+
|
|
647
|
+
// Run the test
|
|
648
|
+
example().catch(console.error);
|
|
649
|
+
```
|
|
650
|
+
|
|
651
|
+
### Parameters
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
| Name | Type | Description | Notes |
|
|
655
|
+
|------------- | ------------- | ------------- | -------------|
|
|
656
|
+
| **id** | `string` | | [Defaults to `undefined`] |
|
|
657
|
+
|
|
658
|
+
### Return type
|
|
659
|
+
|
|
660
|
+
[**ServiceGroupRes**](ServiceGroupRes.md)
|
|
661
|
+
|
|
662
|
+
### Authorization
|
|
663
|
+
|
|
664
|
+
[BearerAuth implicit](../README.md#BearerAuth-implicit)
|
|
665
|
+
|
|
666
|
+
### HTTP request headers
|
|
667
|
+
|
|
668
|
+
- **Content-Type**: Not defined
|
|
669
|
+
- **Accept**: `application/json`
|
|
670
|
+
|
|
671
|
+
|
|
672
|
+
### HTTP response details
|
|
673
|
+
| Status code | Description | Response headers |
|
|
674
|
+
|-------------|-------------|------------------|
|
|
675
|
+
| **200** | The service group details | - |
|
|
676
|
+
| **404** | Service group not found | - |
|
|
677
|
+
|
|
678
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
## serviceGroupsList
|
|
682
|
+
|
|
683
|
+
> ServiceGroupsList200Response serviceGroupsList(page, pageSize)
|
|
684
|
+
|
|
685
|
+
List service groups
|
|
686
|
+
|
|
687
|
+
Retrieves a paginated list of service groups
|
|
688
|
+
|
|
689
|
+
### Example
|
|
690
|
+
|
|
691
|
+
```ts
|
|
692
|
+
import {
|
|
693
|
+
Configuration,
|
|
694
|
+
ServicesApi,
|
|
695
|
+
} from 'fulcrum-cem-client';
|
|
696
|
+
import type { ServiceGroupsListRequest } from 'fulcrum-cem-client';
|
|
697
|
+
|
|
698
|
+
async function example() {
|
|
699
|
+
console.log("🚀 Testing fulcrum-cem-client SDK...");
|
|
700
|
+
const config = new Configuration({
|
|
701
|
+
// To configure OAuth2 access token for authorization: BearerAuth implicit
|
|
702
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
703
|
+
});
|
|
704
|
+
const api = new ServicesApi(config);
|
|
705
|
+
|
|
706
|
+
const body = {
|
|
707
|
+
// number (optional)
|
|
708
|
+
page: 56,
|
|
709
|
+
// number (optional)
|
|
710
|
+
pageSize: 56,
|
|
711
|
+
} satisfies ServiceGroupsListRequest;
|
|
712
|
+
|
|
713
|
+
try {
|
|
714
|
+
const data = await api.serviceGroupsList(body);
|
|
715
|
+
console.log(data);
|
|
716
|
+
} catch (error) {
|
|
717
|
+
console.error(error);
|
|
718
|
+
}
|
|
719
|
+
}
|
|
720
|
+
|
|
721
|
+
// Run the test
|
|
722
|
+
example().catch(console.error);
|
|
723
|
+
```
|
|
724
|
+
|
|
725
|
+
### Parameters
|
|
726
|
+
|
|
727
|
+
|
|
728
|
+
| Name | Type | Description | Notes |
|
|
729
|
+
|------------- | ------------- | ------------- | -------------|
|
|
730
|
+
| **page** | `number` | | [Optional] [Defaults to `1`] |
|
|
731
|
+
| **pageSize** | `number` | | [Optional] [Defaults to `20`] |
|
|
732
|
+
|
|
733
|
+
### Return type
|
|
734
|
+
|
|
735
|
+
[**ServiceGroupsList200Response**](ServiceGroupsList200Response.md)
|
|
736
|
+
|
|
737
|
+
### Authorization
|
|
738
|
+
|
|
739
|
+
[BearerAuth implicit](../README.md#BearerAuth-implicit)
|
|
740
|
+
|
|
741
|
+
### HTTP request headers
|
|
742
|
+
|
|
743
|
+
- **Content-Type**: Not defined
|
|
744
|
+
- **Accept**: `application/json`
|
|
745
|
+
|
|
746
|
+
|
|
747
|
+
### HTTP response details
|
|
748
|
+
| Status code | Description | Response headers |
|
|
749
|
+
|-------------|-------------|------------------|
|
|
750
|
+
| **200** | A paginated list of service groups | - |
|
|
751
|
+
| **401** | Unauthorized | - |
|
|
752
|
+
| **403** | Forbidden | - |
|
|
753
|
+
|
|
754
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
755
|
+
|
|
756
|
+
|
|
757
|
+
## serviceGroupsUpdate
|
|
758
|
+
|
|
759
|
+
> ServiceGroupRes serviceGroupsUpdate(id, serviceGroupReq)
|
|
760
|
+
|
|
761
|
+
Update a service group
|
|
762
|
+
|
|
763
|
+
Updates an existing service group
|
|
764
|
+
|
|
765
|
+
### Example
|
|
766
|
+
|
|
767
|
+
```ts
|
|
768
|
+
import {
|
|
769
|
+
Configuration,
|
|
770
|
+
ServicesApi,
|
|
771
|
+
} from 'fulcrum-cem-client';
|
|
772
|
+
import type { ServiceGroupsUpdateRequest } from 'fulcrum-cem-client';
|
|
773
|
+
|
|
774
|
+
async function example() {
|
|
775
|
+
console.log("🚀 Testing fulcrum-cem-client SDK...");
|
|
776
|
+
const config = new Configuration({
|
|
777
|
+
// To configure OAuth2 access token for authorization: BearerAuth implicit
|
|
778
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
779
|
+
});
|
|
780
|
+
const api = new ServicesApi(config);
|
|
781
|
+
|
|
782
|
+
const body = {
|
|
783
|
+
// string
|
|
784
|
+
id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
785
|
+
// ServiceGroupReq
|
|
786
|
+
serviceGroupReq: ...,
|
|
787
|
+
} satisfies ServiceGroupsUpdateRequest;
|
|
788
|
+
|
|
789
|
+
try {
|
|
790
|
+
const data = await api.serviceGroupsUpdate(body);
|
|
791
|
+
console.log(data);
|
|
792
|
+
} catch (error) {
|
|
793
|
+
console.error(error);
|
|
794
|
+
}
|
|
795
|
+
}
|
|
796
|
+
|
|
797
|
+
// Run the test
|
|
798
|
+
example().catch(console.error);
|
|
799
|
+
```
|
|
800
|
+
|
|
801
|
+
### Parameters
|
|
802
|
+
|
|
803
|
+
|
|
804
|
+
| Name | Type | Description | Notes |
|
|
805
|
+
|------------- | ------------- | ------------- | -------------|
|
|
806
|
+
| **id** | `string` | | [Defaults to `undefined`] |
|
|
807
|
+
| **serviceGroupReq** | [ServiceGroupReq](ServiceGroupReq.md) | | |
|
|
808
|
+
|
|
809
|
+
### Return type
|
|
810
|
+
|
|
811
|
+
[**ServiceGroupRes**](ServiceGroupRes.md)
|
|
812
|
+
|
|
813
|
+
### Authorization
|
|
814
|
+
|
|
815
|
+
[BearerAuth implicit](../README.md#BearerAuth-implicit)
|
|
816
|
+
|
|
817
|
+
### HTTP request headers
|
|
818
|
+
|
|
819
|
+
- **Content-Type**: `application/json`
|
|
820
|
+
- **Accept**: `application/json`
|
|
821
|
+
|
|
822
|
+
|
|
823
|
+
### HTTP response details
|
|
824
|
+
| Status code | Description | Response headers |
|
|
825
|
+
|-------------|-------------|------------------|
|
|
826
|
+
| **200** | Service group updated successfully | - |
|
|
827
|
+
| **404** | Service group not found | - |
|
|
828
|
+
|
|
829
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
830
|
+
|
|
831
|
+
|
|
832
|
+
## serviceTypesCreate
|
|
833
|
+
|
|
834
|
+
> ServiceTypeRes serviceTypesCreate(createServiceTypeReq)
|
|
835
|
+
|
|
836
|
+
Create a service type
|
|
837
|
+
|
|
838
|
+
Creates a new service type with optional property schema
|
|
839
|
+
|
|
840
|
+
### Example
|
|
841
|
+
|
|
842
|
+
```ts
|
|
843
|
+
import {
|
|
844
|
+
Configuration,
|
|
845
|
+
ServicesApi,
|
|
846
|
+
} from 'fulcrum-cem-client';
|
|
847
|
+
import type { ServiceTypesCreateRequest } from 'fulcrum-cem-client';
|
|
848
|
+
|
|
849
|
+
async function example() {
|
|
850
|
+
console.log("🚀 Testing fulcrum-cem-client SDK...");
|
|
851
|
+
const config = new Configuration({
|
|
852
|
+
// To configure OAuth2 access token for authorization: BearerAuth implicit
|
|
853
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
854
|
+
});
|
|
855
|
+
const api = new ServicesApi(config);
|
|
856
|
+
|
|
857
|
+
const body = {
|
|
858
|
+
// CreateServiceTypeReq
|
|
859
|
+
createServiceTypeReq: ...,
|
|
860
|
+
} satisfies ServiceTypesCreateRequest;
|
|
861
|
+
|
|
862
|
+
try {
|
|
863
|
+
const data = await api.serviceTypesCreate(body);
|
|
864
|
+
console.log(data);
|
|
865
|
+
} catch (error) {
|
|
866
|
+
console.error(error);
|
|
867
|
+
}
|
|
868
|
+
}
|
|
869
|
+
|
|
870
|
+
// Run the test
|
|
871
|
+
example().catch(console.error);
|
|
872
|
+
```
|
|
873
|
+
|
|
874
|
+
### Parameters
|
|
875
|
+
|
|
876
|
+
|
|
877
|
+
| Name | Type | Description | Notes |
|
|
878
|
+
|------------- | ------------- | ------------- | -------------|
|
|
879
|
+
| **createServiceTypeReq** | [CreateServiceTypeReq](CreateServiceTypeReq.md) | | |
|
|
880
|
+
|
|
881
|
+
### Return type
|
|
882
|
+
|
|
883
|
+
[**ServiceTypeRes**](ServiceTypeRes.md)
|
|
884
|
+
|
|
885
|
+
### Authorization
|
|
886
|
+
|
|
887
|
+
[BearerAuth implicit](../README.md#BearerAuth-implicit)
|
|
888
|
+
|
|
889
|
+
### HTTP request headers
|
|
890
|
+
|
|
891
|
+
- **Content-Type**: `application/json`
|
|
892
|
+
- **Accept**: `application/json`
|
|
893
|
+
|
|
894
|
+
|
|
895
|
+
### HTTP response details
|
|
896
|
+
| Status code | Description | Response headers |
|
|
897
|
+
|-------------|-------------|------------------|
|
|
898
|
+
| **201** | Service type created successfully | - |
|
|
899
|
+
| **400** | Invalid request body or validation errors | - |
|
|
900
|
+
| **403** | Insufficient permissions (admin required) | - |
|
|
901
|
+
| **409** | Service type with this name already exists | - |
|
|
902
|
+
|
|
903
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
904
|
+
|
|
905
|
+
|
|
906
|
+
## serviceTypesDelete
|
|
907
|
+
|
|
908
|
+
> serviceTypesDelete(id)
|
|
909
|
+
|
|
910
|
+
Delete a service type
|
|
911
|
+
|
|
912
|
+
Deletes a service type if no services depend on it
|
|
913
|
+
|
|
914
|
+
### Example
|
|
915
|
+
|
|
916
|
+
```ts
|
|
917
|
+
import {
|
|
918
|
+
Configuration,
|
|
919
|
+
ServicesApi,
|
|
920
|
+
} from 'fulcrum-cem-client';
|
|
921
|
+
import type { ServiceTypesDeleteRequest } from 'fulcrum-cem-client';
|
|
922
|
+
|
|
923
|
+
async function example() {
|
|
924
|
+
console.log("🚀 Testing fulcrum-cem-client SDK...");
|
|
925
|
+
const config = new Configuration({
|
|
926
|
+
// To configure OAuth2 access token for authorization: BearerAuth implicit
|
|
927
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
928
|
+
});
|
|
929
|
+
const api = new ServicesApi(config);
|
|
930
|
+
|
|
931
|
+
const body = {
|
|
932
|
+
// string
|
|
933
|
+
id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
934
|
+
} satisfies ServiceTypesDeleteRequest;
|
|
935
|
+
|
|
936
|
+
try {
|
|
937
|
+
const data = await api.serviceTypesDelete(body);
|
|
938
|
+
console.log(data);
|
|
939
|
+
} catch (error) {
|
|
940
|
+
console.error(error);
|
|
941
|
+
}
|
|
942
|
+
}
|
|
943
|
+
|
|
944
|
+
// Run the test
|
|
945
|
+
example().catch(console.error);
|
|
946
|
+
```
|
|
947
|
+
|
|
948
|
+
### Parameters
|
|
949
|
+
|
|
950
|
+
|
|
951
|
+
| Name | Type | Description | Notes |
|
|
952
|
+
|------------- | ------------- | ------------- | -------------|
|
|
953
|
+
| **id** | `string` | | [Defaults to `undefined`] |
|
|
954
|
+
|
|
955
|
+
### Return type
|
|
956
|
+
|
|
957
|
+
`void` (Empty response body)
|
|
958
|
+
|
|
959
|
+
### Authorization
|
|
960
|
+
|
|
961
|
+
[BearerAuth implicit](../README.md#BearerAuth-implicit)
|
|
962
|
+
|
|
963
|
+
### HTTP request headers
|
|
964
|
+
|
|
965
|
+
- **Content-Type**: Not defined
|
|
966
|
+
- **Accept**: `application/json`
|
|
967
|
+
|
|
968
|
+
|
|
969
|
+
### HTTP response details
|
|
970
|
+
| Status code | Description | Response headers |
|
|
971
|
+
|-------------|-------------|------------------|
|
|
972
|
+
| **204** | Service type deleted successfully | - |
|
|
973
|
+
| **403** | Insufficient permissions (admin required) | - |
|
|
974
|
+
| **404** | Service type not found | - |
|
|
975
|
+
| **409** | Cannot delete service type with dependent services | - |
|
|
976
|
+
|
|
977
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
978
|
+
|
|
979
|
+
|
|
980
|
+
## serviceTypesGet
|
|
981
|
+
|
|
982
|
+
> ServiceTypeRes serviceTypesGet(id)
|
|
983
|
+
|
|
984
|
+
Get a service type
|
|
985
|
+
|
|
986
|
+
Retrieves a specific service type by ID
|
|
987
|
+
|
|
988
|
+
### Example
|
|
989
|
+
|
|
990
|
+
```ts
|
|
991
|
+
import {
|
|
992
|
+
Configuration,
|
|
993
|
+
ServicesApi,
|
|
994
|
+
} from 'fulcrum-cem-client';
|
|
995
|
+
import type { ServiceTypesGetRequest } from 'fulcrum-cem-client';
|
|
996
|
+
|
|
997
|
+
async function example() {
|
|
998
|
+
console.log("🚀 Testing fulcrum-cem-client SDK...");
|
|
999
|
+
const config = new Configuration({
|
|
1000
|
+
// To configure OAuth2 access token for authorization: BearerAuth implicit
|
|
1001
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
1002
|
+
});
|
|
1003
|
+
const api = new ServicesApi(config);
|
|
1004
|
+
|
|
1005
|
+
const body = {
|
|
1006
|
+
// string
|
|
1007
|
+
id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1008
|
+
} satisfies ServiceTypesGetRequest;
|
|
1009
|
+
|
|
1010
|
+
try {
|
|
1011
|
+
const data = await api.serviceTypesGet(body);
|
|
1012
|
+
console.log(data);
|
|
1013
|
+
} catch (error) {
|
|
1014
|
+
console.error(error);
|
|
1015
|
+
}
|
|
1016
|
+
}
|
|
1017
|
+
|
|
1018
|
+
// Run the test
|
|
1019
|
+
example().catch(console.error);
|
|
1020
|
+
```
|
|
1021
|
+
|
|
1022
|
+
### Parameters
|
|
1023
|
+
|
|
1024
|
+
|
|
1025
|
+
| Name | Type | Description | Notes |
|
|
1026
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1027
|
+
| **id** | `string` | | [Defaults to `undefined`] |
|
|
1028
|
+
|
|
1029
|
+
### Return type
|
|
1030
|
+
|
|
1031
|
+
[**ServiceTypeRes**](ServiceTypeRes.md)
|
|
1032
|
+
|
|
1033
|
+
### Authorization
|
|
1034
|
+
|
|
1035
|
+
[BearerAuth implicit](../README.md#BearerAuth-implicit)
|
|
1036
|
+
|
|
1037
|
+
### HTTP request headers
|
|
1038
|
+
|
|
1039
|
+
- **Content-Type**: Not defined
|
|
1040
|
+
- **Accept**: `application/json`
|
|
1041
|
+
|
|
1042
|
+
|
|
1043
|
+
### HTTP response details
|
|
1044
|
+
| Status code | Description | Response headers |
|
|
1045
|
+
|-------------|-------------|------------------|
|
|
1046
|
+
| **200** | The service type details | - |
|
|
1047
|
+
| **404** | Service type not found | - |
|
|
1048
|
+
|
|
1049
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1050
|
+
|
|
1051
|
+
|
|
1052
|
+
## serviceTypesList
|
|
1053
|
+
|
|
1054
|
+
> ServiceTypesList200Response serviceTypesList(page, pageSize)
|
|
1055
|
+
|
|
1056
|
+
List service types
|
|
1057
|
+
|
|
1058
|
+
Retrieves a paginated list of service types
|
|
1059
|
+
|
|
1060
|
+
### Example
|
|
1061
|
+
|
|
1062
|
+
```ts
|
|
1063
|
+
import {
|
|
1064
|
+
Configuration,
|
|
1065
|
+
ServicesApi,
|
|
1066
|
+
} from 'fulcrum-cem-client';
|
|
1067
|
+
import type { ServiceTypesListRequest } from 'fulcrum-cem-client';
|
|
1068
|
+
|
|
1069
|
+
async function example() {
|
|
1070
|
+
console.log("🚀 Testing fulcrum-cem-client SDK...");
|
|
1071
|
+
const config = new Configuration({
|
|
1072
|
+
// To configure OAuth2 access token for authorization: BearerAuth implicit
|
|
1073
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
1074
|
+
});
|
|
1075
|
+
const api = new ServicesApi(config);
|
|
1076
|
+
|
|
1077
|
+
const body = {
|
|
1078
|
+
// number (optional)
|
|
1079
|
+
page: 56,
|
|
1080
|
+
// number (optional)
|
|
1081
|
+
pageSize: 56,
|
|
1082
|
+
} satisfies ServiceTypesListRequest;
|
|
1083
|
+
|
|
1084
|
+
try {
|
|
1085
|
+
const data = await api.serviceTypesList(body);
|
|
1086
|
+
console.log(data);
|
|
1087
|
+
} catch (error) {
|
|
1088
|
+
console.error(error);
|
|
1089
|
+
}
|
|
1090
|
+
}
|
|
1091
|
+
|
|
1092
|
+
// Run the test
|
|
1093
|
+
example().catch(console.error);
|
|
1094
|
+
```
|
|
1095
|
+
|
|
1096
|
+
### Parameters
|
|
1097
|
+
|
|
1098
|
+
|
|
1099
|
+
| Name | Type | Description | Notes |
|
|
1100
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1101
|
+
| **page** | `number` | | [Optional] [Defaults to `1`] |
|
|
1102
|
+
| **pageSize** | `number` | | [Optional] [Defaults to `20`] |
|
|
1103
|
+
|
|
1104
|
+
### Return type
|
|
1105
|
+
|
|
1106
|
+
[**ServiceTypesList200Response**](ServiceTypesList200Response.md)
|
|
1107
|
+
|
|
1108
|
+
### Authorization
|
|
1109
|
+
|
|
1110
|
+
[BearerAuth implicit](../README.md#BearerAuth-implicit)
|
|
1111
|
+
|
|
1112
|
+
### HTTP request headers
|
|
1113
|
+
|
|
1114
|
+
- **Content-Type**: Not defined
|
|
1115
|
+
- **Accept**: `application/json`
|
|
1116
|
+
|
|
1117
|
+
|
|
1118
|
+
### HTTP response details
|
|
1119
|
+
| Status code | Description | Response headers |
|
|
1120
|
+
|-------------|-------------|------------------|
|
|
1121
|
+
| **200** | A paginated list of service types | - |
|
|
1122
|
+
| **401** | Unauthorized | - |
|
|
1123
|
+
| **403** | Forbidden | - |
|
|
1124
|
+
|
|
1125
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1126
|
+
|
|
1127
|
+
|
|
1128
|
+
## serviceTypesUpdate
|
|
1129
|
+
|
|
1130
|
+
> ServiceTypeRes serviceTypesUpdate(id, updateServiceTypeReq)
|
|
1131
|
+
|
|
1132
|
+
Update a service type
|
|
1133
|
+
|
|
1134
|
+
Partially updates a service type (PATCH semantics)
|
|
1135
|
+
|
|
1136
|
+
### Example
|
|
1137
|
+
|
|
1138
|
+
```ts
|
|
1139
|
+
import {
|
|
1140
|
+
Configuration,
|
|
1141
|
+
ServicesApi,
|
|
1142
|
+
} from 'fulcrum-cem-client';
|
|
1143
|
+
import type { ServiceTypesUpdateRequest } from 'fulcrum-cem-client';
|
|
1144
|
+
|
|
1145
|
+
async function example() {
|
|
1146
|
+
console.log("🚀 Testing fulcrum-cem-client SDK...");
|
|
1147
|
+
const config = new Configuration({
|
|
1148
|
+
// To configure OAuth2 access token for authorization: BearerAuth implicit
|
|
1149
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
1150
|
+
});
|
|
1151
|
+
const api = new ServicesApi(config);
|
|
1152
|
+
|
|
1153
|
+
const body = {
|
|
1154
|
+
// string
|
|
1155
|
+
id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1156
|
+
// UpdateServiceTypeReq
|
|
1157
|
+
updateServiceTypeReq: ...,
|
|
1158
|
+
} satisfies ServiceTypesUpdateRequest;
|
|
1159
|
+
|
|
1160
|
+
try {
|
|
1161
|
+
const data = await api.serviceTypesUpdate(body);
|
|
1162
|
+
console.log(data);
|
|
1163
|
+
} catch (error) {
|
|
1164
|
+
console.error(error);
|
|
1165
|
+
}
|
|
1166
|
+
}
|
|
1167
|
+
|
|
1168
|
+
// Run the test
|
|
1169
|
+
example().catch(console.error);
|
|
1170
|
+
```
|
|
1171
|
+
|
|
1172
|
+
### Parameters
|
|
1173
|
+
|
|
1174
|
+
|
|
1175
|
+
| Name | Type | Description | Notes |
|
|
1176
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1177
|
+
| **id** | `string` | | [Defaults to `undefined`] |
|
|
1178
|
+
| **updateServiceTypeReq** | [UpdateServiceTypeReq](UpdateServiceTypeReq.md) | | |
|
|
1179
|
+
|
|
1180
|
+
### Return type
|
|
1181
|
+
|
|
1182
|
+
[**ServiceTypeRes**](ServiceTypeRes.md)
|
|
1183
|
+
|
|
1184
|
+
### Authorization
|
|
1185
|
+
|
|
1186
|
+
[BearerAuth implicit](../README.md#BearerAuth-implicit)
|
|
1187
|
+
|
|
1188
|
+
### HTTP request headers
|
|
1189
|
+
|
|
1190
|
+
- **Content-Type**: `application/json`
|
|
1191
|
+
- **Accept**: `application/json`
|
|
1192
|
+
|
|
1193
|
+
|
|
1194
|
+
### HTTP response details
|
|
1195
|
+
| Status code | Description | Response headers |
|
|
1196
|
+
|-------------|-------------|------------------|
|
|
1197
|
+
| **200** | Service type updated successfully | - |
|
|
1198
|
+
| **400** | Invalid request body or validation errors | - |
|
|
1199
|
+
| **403** | Insufficient permissions (admin required) | - |
|
|
1200
|
+
| **404** | Service type not found | - |
|
|
1201
|
+
| **409** | Service type name already exists | - |
|
|
1202
|
+
|
|
1203
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1204
|
+
|
|
1205
|
+
|
|
1206
|
+
## servicesAction
|
|
1207
|
+
|
|
1208
|
+
> ServiceRes servicesAction(id, action, servicesActionRequest)
|
|
1209
|
+
|
|
1210
|
+
Perform a lifecycle action on a service
|
|
1211
|
+
|
|
1212
|
+
Performs a generic lifecycle action on a service. The action name is specified in the URL path and must be defined in the service type\'s lifecycle schema. Common actions include: start, stop, restart, pause, resume, etc. Note: Use DELETE /services/{id} for delete actions and PATCH /services/{id} for update actions.
|
|
1213
|
+
|
|
1214
|
+
### Example
|
|
1215
|
+
|
|
1216
|
+
```ts
|
|
1217
|
+
import {
|
|
1218
|
+
Configuration,
|
|
1219
|
+
ServicesApi,
|
|
1220
|
+
} from 'fulcrum-cem-client';
|
|
1221
|
+
import type { ServicesActionOperationRequest } from 'fulcrum-cem-client';
|
|
1222
|
+
|
|
1223
|
+
async function example() {
|
|
1224
|
+
console.log("🚀 Testing fulcrum-cem-client SDK...");
|
|
1225
|
+
const config = new Configuration({
|
|
1226
|
+
// To configure OAuth2 access token for authorization: BearerAuth implicit
|
|
1227
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
1228
|
+
});
|
|
1229
|
+
const api = new ServicesApi(config);
|
|
1230
|
+
|
|
1231
|
+
const body = {
|
|
1232
|
+
// string
|
|
1233
|
+
id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1234
|
+
// string | The lifecycle action to perform (e.g., start, stop, restart). Available actions are defined in the service type\'s lifecycle schema.
|
|
1235
|
+
action: start,
|
|
1236
|
+
// ServicesActionRequest | Optional properties for actions that require additional parameters (based on lifecycle schema requestSchemaType) (optional)
|
|
1237
|
+
servicesActionRequest: ...,
|
|
1238
|
+
} satisfies ServicesActionOperationRequest;
|
|
1239
|
+
|
|
1240
|
+
try {
|
|
1241
|
+
const data = await api.servicesAction(body);
|
|
1242
|
+
console.log(data);
|
|
1243
|
+
} catch (error) {
|
|
1244
|
+
console.error(error);
|
|
1245
|
+
}
|
|
1246
|
+
}
|
|
1247
|
+
|
|
1248
|
+
// Run the test
|
|
1249
|
+
example().catch(console.error);
|
|
1250
|
+
```
|
|
1251
|
+
|
|
1252
|
+
### Parameters
|
|
1253
|
+
|
|
1254
|
+
|
|
1255
|
+
| Name | Type | Description | Notes |
|
|
1256
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1257
|
+
| **id** | `string` | | [Defaults to `undefined`] |
|
|
1258
|
+
| **action** | `string` | The lifecycle action to perform (e.g., start, stop, restart). Available actions are defined in the service type\'s lifecycle schema. | [Defaults to `undefined`] |
|
|
1259
|
+
| **servicesActionRequest** | [ServicesActionRequest](ServicesActionRequest.md) | Optional properties for actions that require additional parameters (based on lifecycle schema requestSchemaType) | [Optional] |
|
|
1260
|
+
|
|
1261
|
+
### Return type
|
|
1262
|
+
|
|
1263
|
+
[**ServiceRes**](ServiceRes.md)
|
|
1264
|
+
|
|
1265
|
+
### Authorization
|
|
1266
|
+
|
|
1267
|
+
[BearerAuth implicit](../README.md#BearerAuth-implicit)
|
|
1268
|
+
|
|
1269
|
+
### HTTP request headers
|
|
1270
|
+
|
|
1271
|
+
- **Content-Type**: `application/json`
|
|
1272
|
+
- **Accept**: `application/json`
|
|
1273
|
+
|
|
1274
|
+
|
|
1275
|
+
### HTTP response details
|
|
1276
|
+
| Status code | Description | Response headers |
|
|
1277
|
+
|-------------|-------------|------------------|
|
|
1278
|
+
| **200** | Service action initiated successfully | - |
|
|
1279
|
+
| **400** | Invalid action or service state does not allow this action | - |
|
|
1280
|
+
| **404** | Service not found | - |
|
|
1281
|
+
|
|
1282
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1283
|
+
|