@omnibase/core-js 0.8.0 → 0.9.1

package/docs/StripeApi.md

@@ -0,0 +1,553 @@
+# StripeApi
+
+All URIs are relative to *http://https://api.omnibase.tech/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**archiveAllStripeConfig**](StripeApi.md#archiveallstripeconfig) | **POST** /stripe/config/archive-all | Archive all Stripe config |
+| [**getStripeConfig**](StripeApi.md#getstripeconfig) | **GET** /stripe/config | Get public Stripe config |
+| [**getStripeConfigAdmin**](StripeApi.md#getstripeconfigadmin) | **GET** /stripe/config/admin | Get full Stripe config (admin) |
+| [**getStripeConfigHistory**](StripeApi.md#getstripeconfighistory) | **GET** /stripe/config/history | Get config history |
+| [**getStripeConfigSchema**](StripeApi.md#getstripeconfigschema) | **GET** /stripe/schema | Get Stripe config schema |
+| [**pullStripeConfig**](StripeApi.md#pullstripeconfig) | **GET** /stripe/config/pull | Pull config from Stripe |
+| [**updateStripeConfig**](StripeApi.md#updatestripeconfig) | **POST** /stripe/config | Update Stripe config |
+| [**validateStripeConfig**](StripeApi.md#validatestripeconfig) | **POST** /stripe/config/validate | Validate Stripe config |
+
+
+
+## archiveAllStripeConfig
+
+> ArchiveAllStripeConfig200Response archiveAllStripeConfig()
+
+Archive all Stripe config
+
+Archives all active products, prices, and meters in Stripe and clears the local configuration.  ## Authentication Requires admin JWT token.  ## Warning This is a destructive operation that will archive ALL active Stripe resources.  ## Use Cases - Clean slate for new configuration - Remove all test data - Reset Stripe account
+
+### Example
+
+```ts
+import {
+  Configuration,
+  StripeApi,
+} from '@omnibase/core-js';
+import type { ArchiveAllStripeConfigRequest } from '@omnibase/core-js';
+
+async function example() {
+  console.log("🚀 Testing @omnibase/core-js SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: BearerAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new StripeApi(config);
+
+  try {
+    const data = await api.archiveAllStripeConfig();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ArchiveAllStripeConfig200Response**](ArchiveAllStripeConfig200Response.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Archive operation completed |  -  |
+| **401** | Invalid or missing admin token |  -  |
+| **500** | Failed to archive resources |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getStripeConfig
+
+> GetStripeConfig200Response getStripeConfig()
+
+Get public Stripe config
+
+Returns the current Stripe configuration with public prices only (filters out enterprise prices).  ## Authentication No authentication required for public endpoint.  ## Use Cases - Display pricing to users - Build subscription selection UI - Public pricing pages
+
+### Example
+
+```ts
+import {
+  Configuration,
+  StripeApi,
+} from '@omnibase/core-js';
+import type { GetStripeConfigRequest } from '@omnibase/core-js';
+
+async function example() {
+  console.log("🚀 Testing @omnibase/core-js SDK...");
+  const api = new StripeApi();
+
+  try {
+    const data = await api.getStripeConfig();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetStripeConfig200Response**](GetStripeConfig200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Stripe configuration retrieved successfully |  -  |
+| **500** | Failed to retrieve configuration |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getStripeConfigAdmin
+
+> GetStripeConfig200Response getStripeConfigAdmin()
+
+Get full Stripe config (admin)
+
+Returns the complete Stripe configuration including all prices (both public and enterprise).  ## Authentication Requires admin JWT token.  ## Use Cases - Admin configuration management - Enterprise pricing display - Configuration auditing
+
+### Example
+
+```ts
+import {
+  Configuration,
+  StripeApi,
+} from '@omnibase/core-js';
+import type { GetStripeConfigAdminRequest } from '@omnibase/core-js';
+
+async function example() {
+  console.log("🚀 Testing @omnibase/core-js SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: BearerAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new StripeApi(config);
+
+  try {
+    const data = await api.getStripeConfigAdmin();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetStripeConfig200Response**](GetStripeConfig200Response.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Full Stripe configuration retrieved successfully |  -  |
+| **401** | Invalid or missing admin token |  -  |
+| **500** | Failed to retrieve configuration |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getStripeConfigHistory
+
+> GetStripeConfigHistory200Response getStripeConfigHistory(limit, offset)
+
+Get config history
+
+Returns paginated history of all Stripe configurations.  ## Authentication Requires admin JWT token.  ## Query Parameters - limit: Items per page (default: 10, max: 100) - offset: Number of items to skip (default: 0)
+
+### Example
+
+```ts
+import {
+  Configuration,
+  StripeApi,
+} from '@omnibase/core-js';
+import type { GetStripeConfigHistoryRequest } from '@omnibase/core-js';
+
+async function example() {
+  console.log("🚀 Testing @omnibase/core-js SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: BearerAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new StripeApi(config);
+
+  const body = {
+    // number | Items per page (optional)
+    limit: 56,
+    // number | Items to skip (optional)
+    offset: 56,
+  } satisfies GetStripeConfigHistoryRequest;
+
+  try {
+    const data = await api.getStripeConfigHistory(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **limit** | `number` | Items per page | [Optional] [Defaults to `10`] |
+| **offset** | `number` | Items to skip | [Optional] [Defaults to `0`] |
+
+### Return type
+
+[**GetStripeConfigHistory200Response**](GetStripeConfigHistory200Response.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Configuration history retrieved successfully |  -  |
+| **401** | Invalid or missing admin token |  -  |
+| **500** | Failed to retrieve history |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getStripeConfigSchema
+
+> object getStripeConfigSchema()
+
+Get Stripe config schema
+
+Returns the JSON schema definition for validating Stripe configuration files.  ## Use Cases - Validate configuration before upload - IDE autocomplete support - Generate configuration templates
+
+### Example
+
+```ts
+import {
+  Configuration,
+  StripeApi,
+} from '@omnibase/core-js';
+import type { GetStripeConfigSchemaRequest } from '@omnibase/core-js';
+
+async function example() {
+  console.log("🚀 Testing @omnibase/core-js SDK...");
+  const api = new StripeApi();
+
+  try {
+    const data = await api.getStripeConfigSchema();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | JSON schema for Stripe configuration |  -  |
+| **500** | Failed to load schema |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## pullStripeConfig
+
+> PullStripeConfig200Response pullStripeConfig()
+
+Pull config from Stripe
+
+Fetches all active products, prices, and meters from Stripe API and converts them to the local configuration format.  ## Authentication Requires admin JWT token.  ## Use Cases - Sync remote Stripe config to local - Import existing Stripe setup - Configuration backup
+
+### Example
+
+```ts
+import {
+  Configuration,
+  StripeApi,
+} from '@omnibase/core-js';
+import type { PullStripeConfigRequest } from '@omnibase/core-js';
+
+async function example() {
+  console.log("🚀 Testing @omnibase/core-js SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: BearerAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new StripeApi(config);
+
+  try {
+    const data = await api.pullStripeConfig();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**PullStripeConfig200Response**](PullStripeConfig200Response.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Stripe configuration pulled successfully |  -  |
+| **401** | Invalid or missing admin token |  -  |
+| **500** | Failed to pull configuration from Stripe |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## updateStripeConfig
+
+> HandlersSuccessResponse updateStripeConfig(config)
+
+Update Stripe config
+
+Updates the Stripe configuration and syncs with Stripe API to create/update products, prices, and meters.  ## Authentication Requires admin JWT token.  ## Use Cases - Deploy new pricing - Update product definitions - Modify metered billing settings
+
+### Example
+
+```ts
+import {
+  Configuration,
+  StripeApi,
+} from '@omnibase/core-js';
+import type { UpdateStripeConfigRequest } from '@omnibase/core-js';
+
+async function example() {
+  console.log("🚀 Testing @omnibase/core-js SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: BearerAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new StripeApi(config);
+
+  const body = {
+    // { [key: string]: any; } | Stripe configuration data
+    config: Object,
+  } satisfies UpdateStripeConfigRequest;
+
+  try {
+    const data = await api.updateStripeConfig(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **config** | `{ [key: string]: any; }` | Stripe configuration data | |
+
+### Return type
+
+[**HandlersSuccessResponse**](HandlersSuccessResponse.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Configuration updated successfully |  -  |
+| **400** | Invalid configuration or validation errors |  -  |
+| **401** | Invalid or missing admin token |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## validateStripeConfig
+
+> HandlersSuccessResponse validateStripeConfig(config)
+
+Validate Stripe config
+
+Validates a Stripe configuration against the schema without saving or deploying it.  ## Authentication Requires admin JWT token.  ## Use Cases - Pre-deployment validation - Configuration testing - Schema compliance checking
+
+### Example
+
+```ts
+import {
+  Configuration,
+  StripeApi,
+} from '@omnibase/core-js';
+import type { ValidateStripeConfigRequest } from '@omnibase/core-js';
+
+async function example() {
+  console.log("🚀 Testing @omnibase/core-js SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: BearerAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new StripeApi(config);
+
+  const body = {
+    // { [key: string]: any; } | Stripe configuration to validate
+    config: Object,
+  } satisfies ValidateStripeConfigRequest;
+
+  try {
+    const data = await api.validateStripeConfig(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **config** | `{ [key: string]: any; }` | Stripe configuration to validate | |
+
+### Return type
+
+[**HandlersSuccessResponse**](HandlersSuccessResponse.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Configuration is valid |  -  |
+| **400** | Configuration validation failed |  -  |
+| **401** | Invalid or missing admin token |  -  |
+
+[[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/StripeConfigArchiveAllPost200Response.md

@@ -0,0 +1,36 @@
+
+# StripeConfigArchiveAllPost200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [V1ArchiveAllResponse](V1ArchiveAllResponse.md)
+`status` | number
+
+## Example
+
+```typescript
+import type { StripeConfigArchiveAllPost200Response } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "status": 200,
+} satisfies StripeConfigArchiveAllPost200Response
+
+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 StripeConfigArchiveAllPost200Response
+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/StripeConfigGet200Response.md

@@ -0,0 +1,36 @@
+
+# StripeConfigGet200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [V1StripeConfigResponse](V1StripeConfigResponse.md)
+`status` | number
+
+## Example
+
+```typescript
+import type { StripeConfigGet200Response } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "status": 200,
+} satisfies StripeConfigGet200Response
+
+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 StripeConfigGet200Response
+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/StripeConfigHistoryGet200Response.md

@@ -0,0 +1,36 @@
+
+# StripeConfigHistoryGet200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [V1ConfigHistoryResponse](V1ConfigHistoryResponse.md)
+`status` | number
+
+## Example
+
+```typescript
+import type { StripeConfigHistoryGet200Response } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "status": 200,
+} satisfies StripeConfigHistoryGet200Response
+
+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 StripeConfigHistoryGet200Response
+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/StripeConfigPullGet200Response.md

@@ -0,0 +1,36 @@
+
+# StripeConfigPullGet200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [ModelsStripeConfiguration](ModelsStripeConfiguration.md)
+`status` | number
+
+## Example
+
+```typescript
+import type { StripeConfigPullGet200Response } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "status": 200,
+} satisfies StripeConfigPullGet200Response
+
+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 StripeConfigPullGet200Response
+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)
+
+