@omnibase/core-js 0.9.18 → 0.10.1

package/docs/V1PaymentsApi.md

@@ -4,12 +4,99 @@ All URIs are relative to *https://api.omnibase.tech*
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
+| [**addInvoiceLineItem**](V1PaymentsApi.md#addinvoicelineitemoperation) | **POST** /api/v1/payments/invoices/{invoice_id}/items | Add invoice line item |
 | [**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 |
+| [**createInvoice**](V1PaymentsApi.md#createinvoiceoperation) | **POST** /api/v1/payments/invoices | Create invoice |
+| [**finalizeInvoice**](V1PaymentsApi.md#finalizeinvoiceoperation) | **POST** /api/v1/payments/invoices/{invoice_id}/finalize | Finalize invoice |
+| [**getInvoice**](V1PaymentsApi.md#getinvoice) | **GET** /api/v1/payments/invoices/{invoice_id} | Get invoice |
 | [**recordUsage**](V1PaymentsApi.md#recordusageoperation) | **POST** /api/v1/payments/usage | Record metered usage |
+| [**updateInvoice**](V1PaymentsApi.md#updateinvoiceoperation) | **PATCH** /api/v1/payments/invoices/{invoice_id} | Update invoice |
 
 
 
+## addInvoiceLineItem
+
+> AddInvoiceLineItem200Response addInvoiceLineItem(xServiceKey, invoiceId, addInvoiceLineItemRequest, xTenantId, xStripeCustomerId)
+
+Add invoice line item
+
+Adds a new line item to a draft invoice.  ## Authentication Requires service key authentication via `X-Service-Key` header.  ## Customer Identification You must provide the Stripe customer ID using ONE of: - `X-Stripe-Customer-Id` header: Directly specify the Stripe customer ID - `X-Tenant-Id` header: Look up the Stripe customer ID from the tenant\'s configuration  ## Prerequisites - Invoice must be in draft status  ## Use Cases - Adding platform fees - Adding additional charges - Custom billing line items 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  V1PaymentsApi,
+} from '@omnibase/core-js';
+import type { AddInvoiceLineItemOperationRequest } from '@omnibase/core-js';
+
+async function example() {
+  console.log("🚀 Testing @omnibase/core-js SDK...");
+  const api = new V1PaymentsApi();
+
+  const body = {
+    // string | Service key for authentication
+    xServiceKey: xServiceKey_example,
+    // string | Stripe Invoice ID
+    invoiceId: invoiceId_example,
+    // AddInvoiceLineItemRequest
+    addInvoiceLineItemRequest: ...,
+    // string | Tenant ID (UUID) - Used to look up the Stripe customer ID from tenant configuration. Required if X-Stripe-Customer-Id is not provided. (optional)
+    xTenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string | Stripe Customer ID (e.g., cus_xxx) - Directly specify the customer. Required if X-Tenant-Id is not provided. (optional)
+    xStripeCustomerId: xStripeCustomerId_example,
+  } satisfies AddInvoiceLineItemOperationRequest;
+
+  try {
+    const data = await api.addInvoiceLineItem(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **xServiceKey** | `string` | Service key for authentication | [Defaults to `undefined`] |
+| **invoiceId** | `string` | Stripe Invoice ID | [Defaults to `undefined`] |
+| **addInvoiceLineItemRequest** | [AddInvoiceLineItemRequest](AddInvoiceLineItemRequest.md) |  | |
+| **xTenantId** | `string` | Tenant ID (UUID) - Used to look up the Stripe customer ID from tenant configuration. Required if X-Stripe-Customer-Id is not provided. | [Optional] [Defaults to `undefined`] |
+| **xStripeCustomerId** | `string` | Stripe Customer ID (e.g., cus_xxx) - Directly specify the customer. Required if X-Tenant-Id is not provided. | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**AddInvoiceLineItem200Response**](AddInvoiceLineItem200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`, `text/plain`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Line item added successfully |  -  |
+| **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)
+
+
 ## createCheckout
 
 > CreateCheckout200Response createCheckout(createCheckoutRequest)
@@ -151,6 +238,234 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## createInvoice
+
+> CreateInvoice200Response createInvoice(xServiceKey, createInvoiceRequest, xTenantId, xStripeCustomerId)
+
+Create invoice
+
+Creates a new draft invoice for the specified customer.  ## Authentication Requires service key authentication via `X-Service-Key` header.  ## Customer Identification You must provide the Stripe customer ID using ONE of: - `X-Stripe-Customer-Id` header: Directly specify the Stripe customer ID - `X-Tenant-Id` header: Look up the Stripe customer ID from the tenant\'s configuration  ## Use Cases - Creating invoices for platform fees - Manual billing scenarios - Custom invoice generation 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  V1PaymentsApi,
+} from '@omnibase/core-js';
+import type { CreateInvoiceOperationRequest } from '@omnibase/core-js';
+
+async function example() {
+  console.log("🚀 Testing @omnibase/core-js SDK...");
+  const api = new V1PaymentsApi();
+
+  const body = {
+    // string | Service key for authentication
+    xServiceKey: xServiceKey_example,
+    // CreateInvoiceRequest
+    createInvoiceRequest: ...,
+    // string | Tenant ID (UUID) - Used to look up the Stripe customer ID from tenant configuration. Required if X-Stripe-Customer-Id is not provided. (optional)
+    xTenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string | Stripe Customer ID (e.g., cus_xxx) - Directly specify the customer. Required if X-Tenant-Id is not provided. (optional)
+    xStripeCustomerId: xStripeCustomerId_example,
+  } satisfies CreateInvoiceOperationRequest;
+
+  try {
+    const data = await api.createInvoice(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **xServiceKey** | `string` | Service key for authentication | [Defaults to `undefined`] |
+| **createInvoiceRequest** | [CreateInvoiceRequest](CreateInvoiceRequest.md) |  | |
+| **xTenantId** | `string` | Tenant ID (UUID) - Used to look up the Stripe customer ID from tenant configuration. Required if X-Stripe-Customer-Id is not provided. | [Optional] [Defaults to `undefined`] |
+| **xStripeCustomerId** | `string` | Stripe Customer ID (e.g., cus_xxx) - Directly specify the customer. Required if X-Tenant-Id is not provided. | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**CreateInvoice200Response**](CreateInvoice200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`, `text/plain`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Invoice created successfully |  -  |
+| **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)
+
+
+## finalizeInvoice
+
+> CreateInvoice200Response finalizeInvoice(xServiceKey, invoiceId, finalizeInvoiceRequest)
+
+Finalize invoice
+
+Finalizes a draft invoice, optionally auto-advancing to send it immediately.  ## Authentication Requires service key authentication via `X-Service-Key` header.  ## Prerequisites - Invoice must be in draft status  ## Use Cases - Approving invoices for sending - Completing invoice preparation - Triggering invoice emails 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  V1PaymentsApi,
+} from '@omnibase/core-js';
+import type { FinalizeInvoiceOperationRequest } from '@omnibase/core-js';
+
+async function example() {
+  console.log("🚀 Testing @omnibase/core-js SDK...");
+  const api = new V1PaymentsApi();
+
+  const body = {
+    // string | Service key for authentication
+    xServiceKey: xServiceKey_example,
+    // string | Stripe Invoice ID
+    invoiceId: invoiceId_example,
+    // FinalizeInvoiceRequest
+    finalizeInvoiceRequest: ...,
+  } satisfies FinalizeInvoiceOperationRequest;
+
+  try {
+    const data = await api.finalizeInvoice(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **xServiceKey** | `string` | Service key for authentication | [Defaults to `undefined`] |
+| **invoiceId** | `string` | Stripe Invoice ID | [Defaults to `undefined`] |
+| **finalizeInvoiceRequest** | [FinalizeInvoiceRequest](FinalizeInvoiceRequest.md) |  | |
+
+### Return type
+
+[**CreateInvoice200Response**](CreateInvoice200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`, `text/plain`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Invoice finalized successfully |  -  |
+| **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)
+
+
+## getInvoice
+
+> CreateInvoice200Response getInvoice(xServiceKey, invoiceId)
+
+Get invoice
+
+Retrieves a Stripe invoice by its ID.  ## Authentication Requires service key authentication via `X-Service-Key` header.  ## Use Cases - Webhook processing - Invoice status checking - Invoice data retrieval 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  V1PaymentsApi,
+} from '@omnibase/core-js';
+import type { GetInvoiceRequest } from '@omnibase/core-js';
+
+async function example() {
+  console.log("🚀 Testing @omnibase/core-js SDK...");
+  const api = new V1PaymentsApi();
+
+  const body = {
+    // string | Service key for authentication
+    xServiceKey: xServiceKey_example,
+    // string | Stripe Invoice ID
+    invoiceId: invoiceId_example,
+  } satisfies GetInvoiceRequest;
+
+  try {
+    const data = await api.getInvoice(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **xServiceKey** | `string` | Service key for authentication | [Defaults to `undefined`] |
+| **invoiceId** | `string` | Stripe Invoice ID | [Defaults to `undefined`] |
+
+### Return type
+
+[**CreateInvoice200Response**](CreateInvoice200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`, `text/plain`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Invoice retrieved successfully |  -  |
+| **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
 
 > SuccessResponse recordUsage(recordUsageRequest)
@@ -220,3 +535,79 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
+
+## updateInvoice
+
+> CreateInvoice200Response updateInvoice(xServiceKey, invoiceId, updateInvoiceRequest)
+
+Update invoice
+
+Updates a draft invoice\'s description and metadata.  ## Authentication Requires service key authentication via `X-Service-Key` header.  ## Prerequisites - Invoice must be in draft status  ## Use Cases - Adding custom descriptions - Adding metadata for tracking - Customizing invoice before sending 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  V1PaymentsApi,
+} from '@omnibase/core-js';
+import type { UpdateInvoiceOperationRequest } from '@omnibase/core-js';
+
+async function example() {
+  console.log("🚀 Testing @omnibase/core-js SDK...");
+  const api = new V1PaymentsApi();
+
+  const body = {
+    // string | Service key for authentication
+    xServiceKey: xServiceKey_example,
+    // string | Stripe Invoice ID
+    invoiceId: invoiceId_example,
+    // UpdateInvoiceRequest
+    updateInvoiceRequest: ...,
+  } satisfies UpdateInvoiceOperationRequest;
+
+  try {
+    const data = await api.updateInvoice(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **xServiceKey** | `string` | Service key for authentication | [Defaults to `undefined`] |
+| **invoiceId** | `string` | Stripe Invoice ID | [Defaults to `undefined`] |
+| **updateInvoiceRequest** | [UpdateInvoiceRequest](UpdateInvoiceRequest.md) |  | |
+
+### Return type
+
+[**CreateInvoice200Response**](CreateInvoice200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`, `text/plain`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Invoice updated successfully |  -  |
+| **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/V1StripeApi.md

@@ -5,6 +5,9 @@ All URIs are relative to *https://api.omnibase.tech*
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
 | [**convertStripeIDToConfigID**](V1StripeApi.md#convertstripeidtoconfigid) | **GET** /api/v1/stripe/convert/stripe-id/{stripe_id} | Convert Stripe ID to config ID |
+| [**getMeterByID**](V1StripeApi.md#getmeterbyid) | **GET** /api/v1/stripe/config/meters/{meter_id} | Get meter by ID |
+| [**getPriceByID**](V1StripeApi.md#getpricebyid) | **GET** /api/v1/stripe/config/prices/{price_id} | Get price by ID |
+| [**getProductByID**](V1StripeApi.md#getproductbyid) | **GET** /api/v1/stripe/config/products/{product_id} | Get product by ID |
 | [**getStripeConfig**](V1StripeApi.md#getstripeconfig) | **GET** /api/v1/stripe/config | Get public Stripe config |
 | [**getStripeConfigAdmin**](V1StripeApi.md#getstripeconfigadmin) | **GET** /api/v1/stripe/admin/config | Get full Stripe config (admin) |
 
@@ -80,6 +83,216 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## getMeterByID
+
+> GetMeterByID200Response getMeterByID(meterId)
+
+Get meter by ID
+
+Returns a specific billing meter from the Stripe configuration by its config ID.  ## Authentication No authentication required for public endpoint.  ## Use Cases - Fetch meter details for usage tracking - Display metered billing information - Usage reporting configuration 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  V1StripeApi,
+} from '@omnibase/core-js';
+import type { GetMeterByIDRequest } from '@omnibase/core-js';
+
+async function example() {
+  console.log("🚀 Testing @omnibase/core-js SDK...");
+  const api = new V1StripeApi();
+
+  const body = {
+    // string | Meter config ID
+    meterId: api_requests,
+  } satisfies GetMeterByIDRequest;
+
+  try {
+    const data = await api.getMeterByID(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **meterId** | `string` | Meter config ID | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetMeterByID200Response**](GetMeterByID200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Meter found |  -  |
+| **400** | Missing meter_id |  -  |
+| **404** | Meter not found |  -  |
+| **500** | Failed to retrieve meter |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getPriceByID
+
+> GetPriceByID200Response getPriceByID(priceId)
+
+Get price by ID
+
+Returns a specific price from the Stripe configuration by its config ID, along with its parent product.  ## Authentication No authentication required for public endpoint.  ## Use Cases - Fetch price details for checkout - Display specific pricing information - Subscription management 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  V1StripeApi,
+} from '@omnibase/core-js';
+import type { GetPriceByIDRequest } from '@omnibase/core-js';
+
+async function example() {
+  console.log("🚀 Testing @omnibase/core-js SDK...");
+  const api = new V1StripeApi();
+
+  const body = {
+    // string | Price config ID
+    priceId: basic_monthly,
+  } satisfies GetPriceByIDRequest;
+
+  try {
+    const data = await api.getPriceByID(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **priceId** | `string` | Price config ID | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetPriceByID200Response**](GetPriceByID200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Price found |  -  |
+| **400** | Missing price_id |  -  |
+| **404** | Price not found |  -  |
+| **500** | Failed to retrieve price |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getProductByID
+
+> GetProductByID200Response getProductByID(productId)
+
+Get product by ID
+
+Returns a specific product from the Stripe configuration by its config ID, including all its prices.  ## Authentication No authentication required for public endpoint.  ## Use Cases - Fetch product details - Display product information with all price options - Product catalog pages 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  V1StripeApi,
+} from '@omnibase/core-js';
+import type { GetProductByIDRequest } from '@omnibase/core-js';
+
+async function example() {
+  console.log("🚀 Testing @omnibase/core-js SDK...");
+  const api = new V1StripeApi();
+
+  const body = {
+    // string | Product config ID
+    productId: basic_plan,
+  } satisfies GetProductByIDRequest;
+
+  try {
+    const data = await api.getProductByID(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **productId** | `string` | Product config ID | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetProductByID200Response**](GetProductByID200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Product found |  -  |
+| **400** | Missing product_id |  -  |
+| **404** | Product not found |  -  |
+| **500** | Failed to retrieve product |  -  |
+
+[[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()