@omnibase/core-js 0.8.0 → 0.9.1

package/docs/PaymentsApi.md

@@ -0,0 +1,233 @@
+# PaymentsApi
+
+All URIs are relative to *http://https://api.omnibase.tech/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createCheckout**](PaymentsApi.md#createcheckout) | **POST** /payments/checkout | Create checkout session |
+| [**createCustomerPortal**](PaymentsApi.md#createcustomerportal) | **POST** /payments/portal | Create customer portal session |
+| [**recordUsage**](PaymentsApi.md#recordusage) | **POST** /payments/usage | Record metered usage |
+
+
+
+## createCheckout
+
+> CreateCheckout200Response createCheckout(request)
+
+Create checkout session
+
+Creates a Stripe Checkout Session for the specified price ID. The session URL can be used to redirect users to complete payment.  ## Authentication Requires JWT token. If the user has an existing Stripe customer ID, it will be used; otherwise, a new customer will be created.  ## Use Cases - Subscription sign-ups - One-time purchases - Trial period checkouts - Promotional code redemption
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PaymentsApi,
+} from '@omnibase/core-js';
+import type { CreateCheckoutRequest } 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 PaymentsApi(config);
+
+  const body = {
+    // V1CreateCheckoutRequest | Checkout session parameters
+    request: ...,
+  } satisfies CreateCheckoutRequest;
+
+  try {
+    const data = await api.createCheckout(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **request** | [V1CreateCheckoutRequest](V1CreateCheckoutRequest.md) | Checkout session parameters | |
+
+### Return type
+
+[**CreateCheckout200Response**](CreateCheckout200Response.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** | Checkout session created successfully |  -  |
+| **400** | Invalid request payload |  -  |
+| **401** | Invalid or missing JWT token |  -  |
+| **500** | Failed to create checkout session |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## createCustomerPortal
+
+> CreateCustomerPortal200Response createCustomerPortal(request)
+
+Create customer portal session
+
+Creates a Stripe Customer Portal session where users can manage their subscription, payment methods, and billing history.  ## Authentication Requires JWT token and an associated Stripe customer ID.  ## Use Cases - Subscription management - Payment method updates - Invoice history viewing
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PaymentsApi,
+} from '@omnibase/core-js';
+import type { CreateCustomerPortalRequest } 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 PaymentsApi(config);
+
+  const body = {
+    // V1CreatePortalRequest | Portal session parameters
+    request: ...,
+  } satisfies CreateCustomerPortalRequest;
+
+  try {
+    const data = await api.createCustomerPortal(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **request** | [V1CreatePortalRequest](V1CreatePortalRequest.md) | Portal session parameters | |
+
+### Return type
+
+[**CreateCustomerPortal200Response**](CreateCustomerPortal200Response.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** | Portal session created successfully |  -  |
+| **400** | Invalid request or missing customer ID |  -  |
+| **401** | Invalid or missing JWT token |  -  |
+| **500** | Failed to create portal session |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## recordUsage
+
+> HandlersSuccessResponse recordUsage(request)
+
+Record metered usage
+
+Records a usage event for metered billing. The customer must have an active subscription with metered pricing.  ## Authentication Requires JWT token and an associated Stripe customer ID.  ## Use Cases - API request metering - Compute time tracking - Storage usage recording - Any metered billing scenario
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PaymentsApi,
+} from '@omnibase/core-js';
+import type { RecordUsageRequest } 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 PaymentsApi(config);
+
+  const body = {
+    // V1RecordUsageRequest | Usage event parameters
+    request: ...,
+  } satisfies RecordUsageRequest;
+
+  try {
+    const data = await api.recordUsage(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **request** | [V1RecordUsageRequest](V1RecordUsageRequest.md) | Usage event parameters | |
+
+### 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** | Usage recorded successfully |  -  |
+| **400** | Invalid request or missing customer ID |  -  |
+| **401** | Invalid or missing JWT token |  -  |
+| **500** | Failed to record usage |  -  |
+
+[[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/PermissionsApi.md

@@ -0,0 +1,233 @@
+# PermissionsApi
+
+All URIs are relative to *http://https://api.omnibase.tech/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**checkPermission**](PermissionsApi.md#checkpermission) | **POST** /permissions/check | Check permission |
+| [**createRelationship**](PermissionsApi.md#createrelationship) | **POST** /permissions/relationships | Create relationship |
+| [**deployPermissionNamespaces**](PermissionsApi.md#deploypermissionnamespaces) | **POST** /permissions/namespaces | Deploy Keto namespace configurations |
+
+
+
+## checkPermission
+
+> CheckPermission200Response checkPermission(body)
+
+Check permission
+
+Checks if a subject has a specific permission on an object using Ory Keto.  ## Authentication Requires session authentication.  ## Request Format Provide either `subject_id` or `subject_set` (not both).  ## Use Cases - Verify user permissions before performing actions - Implement fine-grained access control - Check role-based permissions
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PermissionsApi,
+} from '@omnibase/core-js';
+import type { CheckPermissionRequest } from '@omnibase/core-js';
+
+async function example() {
+  console.log("🚀 Testing @omnibase/core-js SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: SessionAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new PermissionsApi(config);
+
+  const body = {
+    // V1CheckPermissionRequest | Permission check request
+    body: ...,
+  } satisfies CheckPermissionRequest;
+
+  try {
+    const data = await api.checkPermission(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **body** | [V1CheckPermissionRequest](V1CheckPermissionRequest.md) | Permission check request | |
+
+### Return type
+
+[**CheckPermission200Response**](CheckPermission200Response.md)
+
+### Authorization
+
+[SessionAuth](../README.md#SessionAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Permission check result |  -  |
+| **400** | Invalid request body |  -  |
+| **401** | Not authenticated |  -  |
+| **500** | Failed to check permission |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## createRelationship
+
+> CreateRelationship200Response createRelationship(body)
+
+Create relationship
+
+Creates a new relationship tuple in Ory Keto.  ## Authentication Requires session authentication.  ## Request Format Provide either `subject_id` or `subject_set` (not both).  ## Use Cases - Link resources to tenants - Assign users to projects - Create permission relationships
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PermissionsApi,
+} from '@omnibase/core-js';
+import type { CreateRelationshipRequest } from '@omnibase/core-js';
+
+async function example() {
+  console.log("🚀 Testing @omnibase/core-js SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: SessionAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new PermissionsApi(config);
+
+  const body = {
+    // V1CreateRelationshipRequest | Relationship creation request
+    body: ...,
+  } satisfies CreateRelationshipRequest;
+
+  try {
+    const data = await api.createRelationship(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **body** | [V1CreateRelationshipRequest](V1CreateRelationshipRequest.md) | Relationship creation request | |
+
+### Return type
+
+[**CreateRelationship200Response**](CreateRelationship200Response.md)
+
+### Authorization
+
+[SessionAuth](../README.md#SessionAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Relationship created successfully |  -  |
+| **400** | Invalid request body |  -  |
+| **401** | Not authenticated |  -  |
+| **500** | Failed to create relationship |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deployPermissionNamespaces
+
+> DeployPermissionNamespaces200Response deployPermissionNamespaces(namespaces)
+
+Deploy Keto namespace configurations
+
+Uploads and deploys permission namespace configurations as a zip file.  ## Authentication Requires JWT token with appropriate permissions.  ## File Format Upload a zip file containing namespace definition files and optionally a roles.config.json file. The namespace files are stored in S3 and parsed to extract permission definitions.  ## Managed Mode If managed hosting is enabled, this endpoint will also trigger a restart of the Keto service.  ## Use Cases - CLI namespace deployment via `omnibase permissions push` - CI/CD pipeline integrations - Programmatic permission management
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PermissionsApi,
+} from '@omnibase/core-js';
+import type { DeployPermissionNamespacesRequest } 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 PermissionsApi(config);
+
+  const body = {
+    // Blob | Zip file containing namespace configuration files
+    namespaces: BINARY_DATA_HERE,
+  } satisfies DeployPermissionNamespacesRequest;
+
+  try {
+    const data = await api.deployPermissionNamespaces(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **namespaces** | `Blob` | Zip file containing namespace configuration files | [Defaults to `undefined`] |
+
+### Return type
+
+[**DeployPermissionNamespaces200Response**](DeployPermissionNamespaces200Response.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `multipart/form-data`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Namespaces deployed successfully |  -  |
+| **400** | Invalid file or missing tenant ID |  -  |
+| **401** | Invalid or missing JWT token |  -  |
+| **500** | Failed to deploy namespaces |  -  |
+
+[[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/PullStripeConfig200Response.md

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