@omnibase/core-js 0.9.15 → 0.9.17

package/docs/V1PaymentsApi.md

@@ -1,22 +1,22 @@
 # V1PaymentsApi
 
-All URIs are relative to *http://api.omnibase.tech*
+All URIs are relative to *https://api.omnibase.tech*
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
-| [**createCheckout**](V1PaymentsApi.md#createcheckout) | **POST** /api/v1/payments/checkout | Create checkout session |
+| [**createCheckout**](V1PaymentsApi.md#createcheckoutoperation) | **POST** /api/v1/payments/checkout | Create checkout session |
 | [**createCustomerPortal**](V1PaymentsApi.md#createcustomerportal) | **POST** /api/v1/payments/portal | Create customer portal session |
-| [**recordUsage**](V1PaymentsApi.md#recordusage) | **POST** /api/v1/payments/usage | Record metered usage |
+| [**recordUsage**](V1PaymentsApi.md#recordusageoperation) | **POST** /api/v1/payments/usage | Record metered usage |
 
 
 
 ## createCheckout
 
-> CreateCheckout200Response createCheckout(request)
+> CreateCheckout200Response createCheckout(createCheckoutRequest)
 
 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
+Creates a Stripe Checkout Session for the specified price ID. The session URL can be used to redirect users to complete payment.  ## Authentication Optional cookie authentication. If authenticated and user has a 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
 
@@ -25,20 +25,16 @@ import {
   Configuration,
   V1PaymentsApi,
 } from '@omnibase/core-js';
-import type { CreateCheckoutRequest } from '@omnibase/core-js';
+import type { CreateCheckoutOperationRequest } 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 V1PaymentsApi(config);
+  const api = new V1PaymentsApi();
 
   const body = {
-    // V1CreateCheckoutRequest | Checkout session parameters
-    request: ...,
-  } satisfies CreateCheckoutRequest;
+    // CreateCheckoutRequest
+    createCheckoutRequest: ...,
+  } satisfies CreateCheckoutOperationRequest;
 
   try {
     const data = await api.createCheckout(body);
@@ -57,7 +53,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **request** | [V1CreateCheckoutRequest](V1CreateCheckoutRequest.md) | Checkout session parameters | |
+| **createCheckoutRequest** | [CreateCheckoutRequest](CreateCheckoutRequest.md) |  | |
 
 ### Return type
 
@@ -65,32 +61,33 @@ example().catch(console.error);
 
 ### Authorization
 
-[BearerAuth](../README.md#BearerAuth)
+No authorization required
 
 ### HTTP request headers
 
 - **Content-Type**: `application/json`
-- **Accept**: `application/json`
+- **Accept**: `application/json`, `text/plain`
 
 
 ### 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 |  -  |
+| **400** | Bad Request - Invalid request parameters |  -  |
+| **401** | Unauthorized - Authentication required |  -  |
+| **404** | Not Found - Resource not found |  -  |
+| **500** | Internal Server Error - Server encountered an error |  -  |
 
 [[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)
+> CreateCustomerPortal200Response createCustomerPortal(createPortalRequest)
 
 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
+Creates a Stripe Customer Portal session where users can manage their subscription, payment methods, and billing history.  ## Authentication Requires cookie authentication with an associated Stripe customer ID (set via payments middleware).  ## Prerequisites - User must be authenticated - Tenant must have a Stripe customer ID configured - If stripe_customer_id not found in context, returns 400: \"stripe_customer_id not found in context\"  ## Use Cases - Subscription management - Payment method updates - Invoice history viewing - Subscription cancellation 
 
 ### Example
 
@@ -103,15 +100,11 @@ 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 V1PaymentsApi(config);
+  const api = new V1PaymentsApi();
 
   const body = {
-    // V1CreatePortalRequest | Portal session parameters
-    request: ...,
+    // CreatePortalRequest
+    createPortalRequest: ...,
   } satisfies CreateCustomerPortalRequest;
 
   try {
@@ -131,7 +124,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **request** | [V1CreatePortalRequest](V1CreatePortalRequest.md) | Portal session parameters | |
+| **createPortalRequest** | [CreatePortalRequest](CreatePortalRequest.md) |  | |
 
 ### Return type
 
@@ -139,32 +132,32 @@ example().catch(console.error);
 
 ### Authorization
 
-[BearerAuth](../README.md#BearerAuth)
+No authorization required
 
 ### HTTP request headers
 
 - **Content-Type**: `application/json`
-- **Accept**: `application/json`
+- **Accept**: `application/json`, `text/plain`
 
 
 ### 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 |  -  |
+| **400** | Bad Request - Invalid request parameters |  -  |
+| **401** | Unauthorized - Authentication required |  -  |
+| **500** | Internal Server Error - Server encountered an error |  -  |
 
 [[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)
+> SuccessResponse recordUsage(recordUsageRequest)
 
 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
+Records a usage event for metered billing. The customer must have an active subscription with metered pricing.  ## Authentication Requires cookie authentication with an associated Stripe customer ID (set via payments middleware).  ## Prerequisites - User must be authenticated - Tenant must have a Stripe customer ID configured - If stripe_customer_id not found in context, returns 400: \"stripe_customer_id not found in context\"  ## Use Cases - API request metering - Compute time tracking - Storage usage recording - Any metered billing scenario 
 
 ### Example
 
@@ -173,20 +166,16 @@ import {
   Configuration,
   V1PaymentsApi,
 } from '@omnibase/core-js';
-import type { RecordUsageRequest } from '@omnibase/core-js';
+import type { RecordUsageOperationRequest } 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 V1PaymentsApi(config);
+  const api = new V1PaymentsApi();
 
   const body = {
-    // V1RecordUsageRequest | Usage event parameters
-    request: ...,
-  } satisfies RecordUsageRequest;
+    // RecordUsageRequest
+    recordUsageRequest: ...,
+  } satisfies RecordUsageOperationRequest;
 
   try {
     const data = await api.recordUsage(body);
@@ -205,29 +194,29 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **request** | [V1RecordUsageRequest](V1RecordUsageRequest.md) | Usage event parameters | |
+| **recordUsageRequest** | [RecordUsageRequest](RecordUsageRequest.md) |  | |
 
 ### Return type
 
-[**HandlersSuccessResponse**](HandlersSuccessResponse.md)
+[**SuccessResponse**](SuccessResponse.md)
 
 ### Authorization
 
-[BearerAuth](../README.md#BearerAuth)
+No authorization required
 
 ### HTTP request headers
 
 - **Content-Type**: `application/json`
-- **Accept**: `application/json`
+- **Accept**: `application/json`, `text/plain`
 
 
 ### 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 |  -  |
+| **400** | Bad Request - Invalid request parameters |  -  |
+| **401** | Unauthorized - Authentication required |  -  |
+| **500** | Internal Server Error - Server encountered an error |  -  |
 
 [[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/V1PermissionsApi.md

@@ -1,21 +1,22 @@
 # V1PermissionsApi
 
-All URIs are relative to *http://api.omnibase.tech*
+All URIs are relative to *https://api.omnibase.tech*
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
-| [**checkPermission**](V1PermissionsApi.md#checkpermission) | **POST** /api/v1/permissions/check | Check permission |
-| [**createRelationship**](V1PermissionsApi.md#createrelationship) | **POST** /api/v1/permissions/relationships | Create relationship |
+| [**checkPermission**](V1PermissionsApi.md#checkpermissionoperation) | **POST** /api/v1/permissions/check | Check permission |
+| [**createRelationship**](V1PermissionsApi.md#createrelationshipoperation) | **POST** /api/v1/permissions/relationships | Create relationship |
+| [**deleteRelationship**](V1PermissionsApi.md#deleterelationshipoperation) | **DELETE** /api/v1/permissions/relationships | Delete relationship |
 
 
 
 ## checkPermission
 
-> CheckPermission200Response checkPermission(body)
+> CheckPermission200Response checkPermission(checkPermissionRequest)
 
 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
+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). The request uses oneOf  to enforce this constraint at the schema level.  ## Use Cases - Verify user permissions before performing actions - Implement fine-grained access control - Check role-based permissions 
 
 ### Example
 
@@ -24,20 +25,24 @@ import {
   Configuration,
   V1PermissionsApi,
 } from '@omnibase/core-js';
-import type { CheckPermissionRequest } from '@omnibase/core-js';
+import type { CheckPermissionOperationRequest } from '@omnibase/core-js';
 
 async function example() {
   console.log("🚀 Testing @omnibase/core-js SDK...");
   const config = new Configuration({ 
-    // To configure API key authorization: SessionAuth
+    // To configure API key authorization: ServiceKeyAuth
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: CookieAuth
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: SessionTokenAuth
     apiKey: "YOUR API KEY",
   });
   const api = new V1PermissionsApi(config);
 
   const body = {
-    // V1CheckPermissionRequest | Permission check request
-    body: ...,
-  } satisfies CheckPermissionRequest;
+    // CheckPermissionRequest | Permission check request with either subject_id or subject_set
+    checkPermissionRequest: {"namespace":"Tenant","object":"tenant_test_123","relation":"can_invite_user","subject_id":"550e8400-e29b-41d4-a716-446655440000"},
+  } satisfies CheckPermissionOperationRequest;
 
   try {
     const data = await api.checkPermission(body);
@@ -56,7 +61,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **body** | [V1CheckPermissionRequest](V1CheckPermissionRequest.md) | Permission check request | |
+| **checkPermissionRequest** | [CheckPermissionRequest](CheckPermissionRequest.md) | Permission check request with either subject_id or subject_set | |
 
 ### Return type
 
@@ -64,7 +69,7 @@ example().catch(console.error);
 
 ### Authorization
 
-[SessionAuth](../README.md#SessionAuth)
+[ServiceKeyAuth](../README.md#ServiceKeyAuth), [CookieAuth](../README.md#CookieAuth), [SessionTokenAuth](../README.md#SessionTokenAuth)
 
 ### HTTP request headers
 
@@ -76,7 +81,7 @@ example().catch(console.error);
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** | Permission check result |  -  |
-| **400** | Invalid request body |  -  |
+| **400** | Invalid request body - namespace, object, and relation cannot be empty, or both/neither subject fields provided |  -  |
 | **401** | Not authenticated |  -  |
 | **500** | Failed to check permission |  -  |
 
@@ -85,11 +90,11 @@ example().catch(console.error);
 
 ## createRelationship
 
-> CreateRelationship200Response createRelationship(body)
+> CreateRelationship200Response createRelationship(createRelationshipRequest)
 
 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
+Creates a new relationship tuple in Ory Keto.  ## Authentication Requires session authentication.  ## Request Format Provide either `subject_id` or `subject_set` (not both). The request uses oneOf  to enforce this constraint at the schema level.  ## Use Cases - Link resources to tenants - Assign users to projects - Create permission relationships 
 
 ### Example
 
@@ -98,20 +103,24 @@ import {
   Configuration,
   V1PermissionsApi,
 } from '@omnibase/core-js';
-import type { CreateRelationshipRequest } from '@omnibase/core-js';
+import type { CreateRelationshipOperationRequest } from '@omnibase/core-js';
 
 async function example() {
   console.log("🚀 Testing @omnibase/core-js SDK...");
   const config = new Configuration({ 
-    // To configure API key authorization: SessionAuth
+    // To configure API key authorization: ServiceKeyAuth
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: CookieAuth
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: SessionTokenAuth
     apiKey: "YOUR API KEY",
   });
   const api = new V1PermissionsApi(config);
 
   const body = {
-    // V1CreateRelationshipRequest | Relationship creation request
-    body: ...,
-  } satisfies CreateRelationshipRequest;
+    // CreateRelationshipRequest | Relationship creation request with either subject_id or subject_set
+    createRelationshipRequest: {"namespace":"Tenant","object":"tenant_test_123","relation":"can_invite_user","subject_id":"550e8400-e29b-41d4-a716-446655440000"},
+  } satisfies CreateRelationshipOperationRequest;
 
   try {
     const data = await api.createRelationship(body);
@@ -130,7 +139,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **body** | [V1CreateRelationshipRequest](V1CreateRelationshipRequest.md) | Relationship creation request | |
+| **createRelationshipRequest** | [CreateRelationshipRequest](CreateRelationshipRequest.md) | Relationship creation request with either subject_id or subject_set | |
 
 ### Return type
 
@@ -138,7 +147,7 @@ example().catch(console.error);
 
 ### Authorization
 
-[SessionAuth](../README.md#SessionAuth)
+[ServiceKeyAuth](../README.md#ServiceKeyAuth), [CookieAuth](../README.md#CookieAuth), [SessionTokenAuth](../README.md#SessionTokenAuth)
 
 ### HTTP request headers
 
@@ -150,9 +159,89 @@ example().catch(console.error);
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** | Relationship created successfully |  -  |
-| **400** | Invalid request body |  -  |
+| **400** | Invalid request body - namespace, object, and relation are required, or both/neither subject fields provided |  -  |
 | **401** | Not authenticated |  -  |
+| **404** | Not Found - Resource not found |  -  |
 | **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)
 
+
+## deleteRelationship
+
+> DeleteRelationship200Response deleteRelationship(deleteRelationshipRequest)
+
+Delete relationship
+
+Deletes a relationship tuple from Ory Keto.  ## Authentication Requires session authentication.  ## Request Format Provide either `subject_id` or `subject_set` (not both). The request uses oneOf to enforce this constraint at the schema level.  ## Use Cases - Remove resource links from tenants - Revoke user assignments from projects - Delete permission relationships 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  V1PermissionsApi,
+} from '@omnibase/core-js';
+import type { DeleteRelationshipOperationRequest } from '@omnibase/core-js';
+
+async function example() {
+  console.log("🚀 Testing @omnibase/core-js SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: ServiceKeyAuth
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: CookieAuth
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: SessionTokenAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new V1PermissionsApi(config);
+
+  const body = {
+    // DeleteRelationshipRequest | Relationship deletion request with either subject_id or subject_set
+    deleteRelationshipRequest: {"namespace":"Tenant","object":"tenant_test_123","relation":"can_invite_user","subject_id":"550e8400-e29b-41d4-a716-446655440000"},
+  } satisfies DeleteRelationshipOperationRequest;
+
+  try {
+    const data = await api.deleteRelationship(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **deleteRelationshipRequest** | [DeleteRelationshipRequest](DeleteRelationshipRequest.md) | Relationship deletion request with either subject_id or subject_set | |
+
+### Return type
+
+[**DeleteRelationship200Response**](DeleteRelationship200Response.md)
+
+### Authorization
+
+[ServiceKeyAuth](../README.md#ServiceKeyAuth), [CookieAuth](../README.md#CookieAuth), [SessionTokenAuth](../README.md#SessionTokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Relationship deleted successfully |  -  |
+| **400** | Invalid request body - namespace, object, and relation are required, or both/neither subject fields provided |  -  |
+| **401** | Not authenticated |  -  |
+| **404** | Not Found - Resource not found |  -  |
+| **500** | Failed to delete relationship |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+