@omnibase/core-js 0.9.18 → 0.10.0

package/docs/GetWebhookSecret200Response.md

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

@@ -0,0 +1,38 @@
+
+# InvoiceLineItemResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`amount` | number
+`description` | string
+
+## Example
+
+```typescript
+import type { InvoiceLineItemResponse } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": ii_1234567890,
+  "amount": 1000,
+  "description": Platform fee,
+} satisfies InvoiceLineItemResponse
+
+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 InvoiceLineItemResponse
+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/InvoiceResponse.md

@@ -0,0 +1,46 @@
+
+# InvoiceResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`status` | string
+`amountDue` | number
+`currency` | string
+`customerId` | string
+`invoicePdf` | string
+`hostedInvoiceUrl` | string
+
+## Example
+
+```typescript
+import type { InvoiceResponse } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": in_1234567890,
+  "status": draft,
+  "amountDue": 2000,
+  "currency": usd,
+  "customerId": cus_1234567890,
+  "invoicePdf": https://pay.stripe.com/invoice/...,
+  "hostedInvoiceUrl": https://invoice.stripe.com/i/...,
+} satisfies InvoiceResponse
+
+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 InvoiceResponse
+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/MeterResponse.md

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

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

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

@@ -0,0 +1,36 @@
+
+# UpdateInvoiceRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`description` | string
+`metadata` | { [key: string]: string; }
+
+## Example
+
+```typescript
+import type { UpdateInvoiceRequest } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "description": Monthly subscription - January 2025,
+  "metadata": null,
+} satisfies UpdateInvoiceRequest
+
+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 UpdateInvoiceRequest
+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/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)
+