fulcrum-cem-client 0.0.1 → 0.0.3

package/docs/ServiceOfferingReq.md

@@ -0,0 +1,48 @@
+
+# ServiceOfferingReq
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`serviceTypeId` | string
+`providerId` | string
+`validFrom` | Date
+`validTo` | Date
+`tags` | Array<string>
+`variants` | [Array<Variant>](Variant.md)
+`priceItems` | [Array<PriceItem>](PriceItem.md)
+
+## Example
+
+```typescript
+import type { ServiceOfferingReq } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "serviceTypeId": 123e4567-e89b-12d3-a456-426614174000,
+  "providerId": 123e4567-e89b-12d3-a456-426614174000,
+  "validFrom": null,
+  "validTo": null,
+  "tags": null,
+  "variants": null,
+  "priceItems": null,
+} satisfies ServiceOfferingReq
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ServiceOfferingReq
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ServiceOfferingRes.md

@@ -0,0 +1,58 @@
+
+# ServiceOfferingRes
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`serviceTypeId` | string
+`providerId` | string
+`validFrom` | Date
+`validTo` | Date
+`tags` | Array<string>
+`variants` | [Array<Variant>](Variant.md)
+`priceItems` | [Array<PriceItem>](PriceItem.md)
+`serviceType` | [ServiceOfferingResServiceType](ServiceOfferingResServiceType.md)
+`provider` | [ParticipantRes](ParticipantRes.md)
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { ServiceOfferingRes } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": 123e4567-e89b-12d3-a456-426614174000,
+  "name": null,
+  "serviceTypeId": 123e4567-e89b-12d3-a456-426614174000,
+  "providerId": 123e4567-e89b-12d3-a456-426614174000,
+  "validFrom": null,
+  "validTo": null,
+  "tags": null,
+  "variants": null,
+  "priceItems": null,
+  "serviceType": null,
+  "provider": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies ServiceOfferingRes
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ServiceOfferingRes
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ServiceOfferingResServiceType.md

@@ -0,0 +1,36 @@
+
+# ServiceOfferingResServiceType
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+
+## Example
+
+```typescript
+import type { ServiceOfferingResServiceType } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": 123e4567-e89b-12d3-a456-426614174000,
+  "name": null,
+} satisfies ServiceOfferingResServiceType
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ServiceOfferingResServiceType
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ServiceOfferingsApi.md

@@ -0,0 +1,379 @@
+# ServiceOfferingsApi
+
+All URIs are relative to *https://api.fulcrum.testudosrl.dev/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**serviceOfferingsCreate**](ServiceOfferingsApi.md#serviceofferingscreate) | **POST** /service-offerings | Create a new service offering |
+| [**serviceOfferingsDelete**](ServiceOfferingsApi.md#serviceofferingsdelete) | **DELETE** /service-offerings/{id} | Delete a service offering |
+| [**serviceOfferingsGet**](ServiceOfferingsApi.md#serviceofferingsget) | **GET** /service-offerings/{id} | Get a service offering by ID |
+| [**serviceOfferingsList**](ServiceOfferingsApi.md#serviceofferingslist) | **GET** /service-offerings | List all service offerings |
+| [**serviceOfferingsUpdate**](ServiceOfferingsApi.md#serviceofferingsupdate) | **PATCH** /service-offerings/{id} | Update a service offering |
+
+
+
+## serviceOfferingsCreate
+
+> ServiceOfferingRes serviceOfferingsCreate(serviceOfferingReq)
+
+Create a new service offering
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServiceOfferingsApi,
+} from 'fulcrum-cem-client';
+import type { ServiceOfferingsCreateRequest } 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 ServiceOfferingsApi(config);
+
+  const body = {
+    // ServiceOfferingReq
+    serviceOfferingReq: ...,
+  } satisfies ServiceOfferingsCreateRequest;
+
+  try {
+    const data = await api.serviceOfferingsCreate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **serviceOfferingReq** | [ServiceOfferingReq](ServiceOfferingReq.md) |  | |
+
+### Return type
+
+[**ServiceOfferingRes**](ServiceOfferingRes.md)
+
+### Authorization
+
+[BearerAuth implicit](../README.md#BearerAuth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Service offering created |  -  |
+| **400** | Bad Request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## serviceOfferingsDelete
+
+> serviceOfferingsDelete(id)
+
+Delete a service offering
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServiceOfferingsApi,
+} from 'fulcrum-cem-client';
+import type { ServiceOfferingsDeleteRequest } 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 ServiceOfferingsApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies ServiceOfferingsDeleteRequest;
+
+  try {
+    const data = await api.serviceOfferingsDelete(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[BearerAuth implicit](../README.md#BearerAuth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Service offering deleted |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Service offering not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## serviceOfferingsGet
+
+> ServiceOfferingRes serviceOfferingsGet(id)
+
+Get a service offering by ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServiceOfferingsApi,
+} from 'fulcrum-cem-client';
+import type { ServiceOfferingsGetRequest } 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 ServiceOfferingsApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies ServiceOfferingsGetRequest;
+
+  try {
+    const data = await api.serviceOfferingsGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**ServiceOfferingRes**](ServiceOfferingRes.md)
+
+### Authorization
+
+[BearerAuth implicit](../README.md#BearerAuth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Service offering details |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Service offering not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## serviceOfferingsList
+
+> Array<ServiceOfferingRes> serviceOfferingsList(page, pageSize)
+
+List all service offerings
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServiceOfferingsApi,
+} from 'fulcrum-cem-client';
+import type { ServiceOfferingsListRequest } 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 ServiceOfferingsApi(config);
+
+  const body = {
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
+  } satisfies ServiceOfferingsListRequest;
+
+  try {
+    const data = await api.serviceOfferingsList(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` |  | [Optional] [Defaults to `20`] |
+
+### Return type
+
+[**Array<ServiceOfferingRes>**](ServiceOfferingRes.md)
+
+### Authorization
+
+[BearerAuth implicit](../README.md#BearerAuth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | A list of service offerings |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## serviceOfferingsUpdate
+
+> ServiceOfferingRes serviceOfferingsUpdate(id, serviceOfferingReq)
+
+Update a service offering
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ServiceOfferingsApi,
+} from 'fulcrum-cem-client';
+import type { ServiceOfferingsUpdateRequest } 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 ServiceOfferingsApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // ServiceOfferingReq
+    serviceOfferingReq: ...,
+  } satisfies ServiceOfferingsUpdateRequest;
+
+  try {
+    const data = await api.serviceOfferingsUpdate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+| **serviceOfferingReq** | [ServiceOfferingReq](ServiceOfferingReq.md) |  | |
+
+### Return type
+
+[**ServiceOfferingRes**](ServiceOfferingRes.md)
+
+### Authorization
+
+[BearerAuth implicit](../README.md#BearerAuth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Service offering updated |  -  |
+| **400** | Bad Request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Service offering not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/ServiceOrderReq.md

@@ -0,0 +1,36 @@
+
+# ServiceOrderReq
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`autoRenew` | boolean
+`notes` | string
+
+## Example
+
+```typescript
+import type { ServiceOrderReq } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "autoRenew": null,
+  "notes": null,
+} satisfies ServiceOrderReq
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ServiceOrderReq
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ServiceOrderRes.md

@@ -0,0 +1,70 @@
+
+# ServiceOrderRes
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`status` | [ServiceOrderStatus](ServiceOrderStatus.md)
+`prevServiceOrderId` | string
+`serviceOfferingId` | string
+`providerId` | string
+`variantId` | string
+`commitmentId` | string
+`consumerId` | string
+`serviceId` | string
+`terminateAt` | Date
+`autoRenew` | boolean
+`billingProperties` | { [key: string]: any; }
+`priceItems` | [Array<PriceItem>](PriceItem.md)
+`serviceOffering` | [ServiceOfferingRes](ServiceOfferingRes.md)
+`commitment` | [CommitmentRes](CommitmentRes.md)
+`consumer` | [ParticipantRes](ParticipantRes.md)
+`service` | [ServiceRes](ServiceRes.md)
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { ServiceOrderRes } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": 123e4567-e89b-12d3-a456-426614174000,
+  "status": null,
+  "prevServiceOrderId": 123e4567-e89b-12d3-a456-426614174000,
+  "serviceOfferingId": 123e4567-e89b-12d3-a456-426614174000,
+  "providerId": 123e4567-e89b-12d3-a456-426614174000,
+  "variantId": null,
+  "commitmentId": 123e4567-e89b-12d3-a456-426614174000,
+  "consumerId": 123e4567-e89b-12d3-a456-426614174000,
+  "serviceId": 123e4567-e89b-12d3-a456-426614174000,
+  "terminateAt": null,
+  "autoRenew": null,
+  "billingProperties": null,
+  "priceItems": null,
+  "serviceOffering": null,
+  "commitment": null,
+  "consumer": null,
+  "service": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies ServiceOrderRes
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ServiceOrderRes
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ServiceOrderStatus.md

@@ -0,0 +1,32 @@
+
+# ServiceOrderStatus
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { ServiceOrderStatus } from 'fulcrum-cem-client'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies ServiceOrderStatus
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ServiceOrderStatus
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+