@omnibase/core-js 0.9.18 → 0.10.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +44 -0
- package/README.md +34 -3
- package/docs/AddInvoiceLineItem200Response.md +36 -0
- package/docs/AddInvoiceLineItemRequest.md +38 -0
- package/docs/ConfigureWebhooks200Response.md +36 -0
- package/docs/CreateInvoice200Response.md +36 -0
- package/docs/CreateInvoiceRequest.md +40 -0
- package/docs/FinalizeInvoiceRequest.md +34 -0
- package/docs/GetMeterByID200Response.md +36 -0
- package/docs/GetPriceByID200Response.md +36 -0
- package/docs/GetProductByID200Response.md +36 -0
- package/docs/GetWebhookSecret200Response.md +36 -0
- package/docs/InvoiceLineItemResponse.md +38 -0
- package/docs/InvoiceResponse.md +46 -0
- package/docs/MeterResponse.md +34 -0
- package/docs/PerUnitPrice.md +1 -1
- package/docs/Price.md +1 -1
- package/docs/PriceResponse.md +36 -0
- package/docs/PriceWithStripeID.md +1 -1
- package/docs/ProductResponse.md +34 -0
- package/docs/UpdateInvoiceRequest.md +36 -0
- package/docs/V1PaymentsApi.md +391 -0
- package/docs/V1StripeApi.md +213 -0
- package/docs/V1WebhooksApi.md +150 -0
- package/docs/WebhookEndpointConfig.md +40 -0
- package/docs/WebhookResult.md +46 -0
- package/docs/WebhookSecretResponse.md +48 -0
- package/docs/WebhooksConfigRequest.md +34 -0
- package/docs/WebhooksConfigResponse.md +34 -0
- package/package.json +1 -1
- package/src/apis/V1AuthApi.ts +2 -2
- package/src/apis/V1ConfigurationApi.ts +2 -2
- package/src/apis/V1EventsApi.ts +2 -2
- package/src/apis/V1PaymentsApi.ts +350 -2
- package/src/apis/V1PermissionsApi.ts +2 -2
- package/src/apis/V1StorageApi.ts +2 -2
- package/src/apis/V1StripeApi.ts +140 -2
- package/src/apis/V1TenantsApi.ts +2 -2
- package/src/apis/V1WebhooksApi.ts +132 -0
- package/src/apis/index.ts +1 -0
- package/src/models/AcceptInvite200Response.ts +2 -2
- package/src/models/AcceptInviteRequest.ts +2 -2
- package/src/models/AcceptInviteResponse.ts +2 -2
- package/src/models/ActiveTenantResponse.ts +2 -2
- package/src/models/AddInvoiceLineItem200Response.ts +82 -0
- package/src/models/AddInvoiceLineItemRequest.ts +94 -0
- package/src/models/AddSubscription200Response.ts +2 -2
- package/src/models/AddSubscriptionRequest.ts +2 -2
- package/src/models/AddSubscriptionResponse.ts +2 -2
- package/src/models/ArchiveAllResponse.ts +2 -2
- package/src/models/ArchiveAllStripeConfig200Response.ts +2 -2
- package/src/models/BadRequest.ts +2 -2
- package/src/models/BadRequestResponse.ts +2 -2
- package/src/models/BillingInterval.ts +2 -2
- package/src/models/BillingStatusResponse.ts +2 -2
- package/src/models/CheckPermission200Response.ts +2 -2
- package/src/models/CheckPermissionRequest.ts +2 -2
- package/src/models/CheckPermissionRequestWithSubjectId.ts +2 -2
- package/src/models/CheckPermissionRequestWithSubjectSet.ts +2 -2
- package/src/models/CheckPermissionResponse.ts +2 -2
- package/src/models/ConfigHistoryItem.ts +2 -2
- package/src/models/ConfigHistoryPagination.ts +2 -2
- package/src/models/ConfigHistoryResponse.ts +2 -2
- package/src/models/ConfigureWebhooks200Response.ts +82 -0
- package/src/models/ConflictResponse.ts +2 -2
- package/src/models/ConvertStripeIDToConfigID200Response.ts +2 -2
- package/src/models/CreateCheckout200Response.ts +2 -2
- package/src/models/CreateCheckoutRequest.ts +2 -2
- package/src/models/CreateCheckoutResponse.ts +2 -2
- package/src/models/CreateCustomerPortal200Response.ts +2 -2
- package/src/models/CreateEmailTemplateRequest.ts +2 -2
- package/src/models/CreateInvite200Response.ts +2 -2
- package/src/models/CreateInvoice200Response.ts +82 -0
- package/src/models/CreateInvoiceRequest.ts +100 -0
- package/src/models/CreateOrUpdateEmailTemplate200Response.ts +2 -2
- package/src/models/CreateOrUpdateEmailTemplate200ResponseAllOfData.ts +2 -2
- package/src/models/CreatePortalRequest.ts +2 -2
- package/src/models/CreatePortalResponse.ts +2 -2
- package/src/models/CreateRelationship200Response.ts +2 -2
- package/src/models/CreateRelationshipRequest.ts +2 -2
- package/src/models/CreateRelationshipRequestWithSubjectId.ts +2 -2
- package/src/models/CreateRelationshipRequestWithSubjectSet.ts +2 -2
- package/src/models/CreateRelationshipResponse.ts +2 -2
- package/src/models/CreateRole200Response.ts +2 -2
- package/src/models/CreateRoleRequest.ts +2 -2
- package/src/models/CreateTenant200Response.ts +2 -2
- package/src/models/CreateTenantRequest.ts +2 -2
- package/src/models/CreateTenantResponse.ts +2 -2
- package/src/models/CreateTenantUserInviteRequest.ts +2 -2
- package/src/models/CreateTenantUserInviteResponse.ts +2 -2
- package/src/models/CreateUser200Response.ts +2 -2
- package/src/models/CreateUserRequest.ts +2 -2
- package/src/models/CreateUserRequestName.ts +2 -2
- package/src/models/CurrencyCode.ts +2 -2
- package/src/models/DeleteEmailTemplate200Response.ts +2 -2
- package/src/models/DeleteEmailTemplate200ResponseAllOfData.ts +2 -2
- package/src/models/DeleteObject200Response.ts +2 -2
- package/src/models/DeleteObjectRequest.ts +2 -2
- package/src/models/DeleteRelationship200Response.ts +2 -2
- package/src/models/DeleteRelationshipRequest.ts +2 -2
- package/src/models/DeleteRelationshipRequestWithSubjectId.ts +2 -2
- package/src/models/DeleteRelationshipRequestWithSubjectSet.ts +2 -2
- package/src/models/DeleteRelationshipResponse.ts +2 -2
- package/src/models/DeleteRole200Response.ts +2 -2
- package/src/models/DeleteRoleResponse.ts +2 -2
- package/src/models/DeleteTenant200Response.ts +2 -2
- package/src/models/DeleteTenantResponse.ts +2 -2
- package/src/models/DeleteTenantUserRequest.ts +2 -2
- package/src/models/DeployPermissionNamespaces200Response.ts +2 -2
- package/src/models/DownloadFile200Response.ts +2 -2
- package/src/models/DownloadRequest.ts +2 -2
- package/src/models/DownloadResponse.ts +2 -2
- package/src/models/EmailTemplate.ts +2 -2
- package/src/models/ErrorResponse.ts +2 -2
- package/src/models/FinalizeInvoiceRequest.ts +65 -0
- package/src/models/ForbiddenResponse.ts +2 -2
- package/src/models/GetActiveTenant200Response.ts +2 -2
- package/src/models/GetEmailTemplates200Response.ts +2 -2
- package/src/models/GetEmailTemplates200ResponseAllOfData.ts +2 -2
- package/src/models/GetIdentity200Response.ts +2 -2
- package/src/models/GetMeterByID200Response.ts +82 -0
- package/src/models/GetPriceByID200Response.ts +82 -0
- package/src/models/GetProductByID200Response.ts +82 -0
- package/src/models/GetRoleDefinitions200Response.ts +2 -2
- package/src/models/GetSession200Response.ts +2 -2
- package/src/models/GetStripeConfig200Response.ts +2 -2
- package/src/models/GetStripeConfigHistory200Response.ts +2 -2
- package/src/models/GetTenantBillingStatus200Response.ts +2 -2
- package/src/models/GetTenantJWT200Response.ts +2 -2
- package/src/models/GetWebhookSecret200Response.ts +82 -0
- package/src/models/InternalServerError.ts +2 -2
- package/src/models/InternalServerErrorResponse.ts +2 -2
- package/src/models/InvoiceLineItemResponse.ts +82 -0
- package/src/models/InvoiceResponse.ts +115 -0
- package/src/models/JWTTokenResponse.ts +2 -2
- package/src/models/KratosIdentity.ts +2 -2
- package/src/models/KratosIdentityCredentials.ts +2 -2
- package/src/models/KratosIdentityCredentialsPassword.ts +2 -2
- package/src/models/KratosIdentityRecoveryAddressesInner.ts +2 -2
- package/src/models/KratosIdentityTraits.ts +2 -2
- package/src/models/KratosIdentityTraitsName.ts +2 -2
- package/src/models/KratosIdentityVerifiableAddressesInner.ts +2 -2
- package/src/models/ListRoles200Response.ts +2 -2
- package/src/models/ListTenantSubscriptions200Response.ts +2 -2
- package/src/models/ListTenantUsers200Response.ts +2 -2
- package/src/models/ListTenants200Response.ts +2 -2
- package/src/models/ListTenantsResponse.ts +2 -2
- package/src/models/Logout200Response.ts +2 -2
- package/src/models/LogoutResponse.ts +2 -2
- package/src/models/MessageResponse.ts +2 -2
- package/src/models/Meter.ts +2 -2
- package/src/models/MeterCustomerMapping.ts +2 -2
- package/src/models/MeterDefaultAggregation.ts +2 -2
- package/src/models/MeterResponse.ts +74 -0
- package/src/models/MeterValueSettings.ts +2 -2
- package/src/models/MeterWithStripeID.ts +2 -2
- package/src/models/MigrationErrorResponse.ts +2 -2
- package/src/models/MigrationSuccessResponse.ts +2 -2
- package/src/models/NamespaceDefinition.ts +2 -2
- package/src/models/NamespaceDefinitionsResponse.ts +2 -2
- package/src/models/NamespaceDeploymentResponse.ts +2 -2
- package/src/models/NotFound.ts +2 -2
- package/src/models/NotFoundResponse.ts +2 -2
- package/src/models/PerUnitBillingScheme.ts +2 -2
- package/src/models/PerUnitPrice.ts +3 -3
- package/src/models/Price.ts +2 -2
- package/src/models/PriceDisplay.ts +2 -2
- package/src/models/PriceLimit.ts +2 -2
- package/src/models/PriceResponse.ts +90 -0
- package/src/models/PriceUI.ts +2 -2
- package/src/models/PriceWithStripeID.ts +3 -3
- package/src/models/Product.ts +2 -2
- package/src/models/ProductResponse.ts +74 -0
- package/src/models/ProductUI.ts +2 -2
- package/src/models/ProductWithStripeIDs.ts +2 -2
- package/src/models/PullStripeConfig200Response.ts +2 -2
- package/src/models/RecordUsageRequest.ts +2 -2
- package/src/models/Relationship.ts +2 -2
- package/src/models/RemoveSubscription200Response.ts +2 -2
- package/src/models/RemoveSubscriptionRequest.ts +2 -2
- package/src/models/RemoveSubscriptionResponse.ts +2 -2
- package/src/models/Role.ts +2 -2
- package/src/models/RolesListResponse.ts +2 -2
- package/src/models/SchemasConflictResponse.ts +2 -2
- package/src/models/SessionResponse.ts +2 -2
- package/src/models/StripeConfigResponse.ts +2 -2
- package/src/models/StripeConfigUpdateRequest.ts +2 -2
- package/src/models/StripeConfigValidateRequest.ts +2 -2
- package/src/models/StripeConfiguration.ts +2 -2
- package/src/models/StripeConfigurationWithIDs.ts +2 -2
- package/src/models/StripeIDConversionResponse.ts +2 -2
- package/src/models/SubjectSet.ts +2 -2
- package/src/models/SubjectSetRequest.ts +2 -2
- package/src/models/SubscriptionResponse.ts +2 -2
- package/src/models/SuccessResponse.ts +2 -2
- package/src/models/SuccessResponseData.ts +2 -2
- package/src/models/SwitchActiveTenant200Response.ts +2 -2
- package/src/models/SwitchTenantRequest.ts +2 -2
- package/src/models/SwitchTenantResponse.ts +2 -2
- package/src/models/Tenant.ts +2 -2
- package/src/models/TenantInvite.ts +2 -2
- package/src/models/TenantSettings.ts +2 -2
- package/src/models/TenantUserResponse.ts +2 -2
- package/src/models/Tier.ts +2 -2
- package/src/models/TierUpTo.ts +2 -2
- package/src/models/TieredBillingScheme.ts +2 -2
- package/src/models/TieredPrice.ts +2 -2
- package/src/models/TiersMode.ts +2 -2
- package/src/models/Unauthorized.ts +2 -2
- package/src/models/UnauthorizedResponse.ts +2 -2
- package/src/models/UpdateInvoiceRequest.ts +73 -0
- package/src/models/UpdateRoleRequest.ts +2 -2
- package/src/models/UpdateTenantUserRole200Response.ts +2 -2
- package/src/models/UpdateTenantUserRoleRequest.ts +2 -2
- package/src/models/UpdateTenantUserRoleResponse.ts +2 -2
- package/src/models/UploadFile200Response.ts +2 -2
- package/src/models/UploadRequest.ts +2 -2
- package/src/models/UploadResponse.ts +2 -2
- package/src/models/UsageType.ts +2 -2
- package/src/models/UserTenantListItem.ts +2 -2
- package/src/models/WebhookEndpointConfig.ts +91 -0
- package/src/models/WebhookResult.ts +131 -0
- package/src/models/WebhookSecretResponse.ts +127 -0
- package/src/models/WebhooksConfigRequest.ts +74 -0
- package/src/models/WebhooksConfigResponse.ts +74 -0
- package/src/models/WhoAmI200Response.ts +2 -2
- package/src/models/WhoAmIResponse.ts +2 -2
- package/src/models/index.ts +21 -0
- package/src/runtime.ts +2 -2
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
# V1WebhooksApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.omnibase.tech*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
| [**configureWebhooks**](V1WebhooksApi.md#configurewebhooks) | **POST** /api/v1/stripe/config/webhooks | Configure multiple webhook endpoints |
|
|
8
|
+
| [**getWebhookSecret**](V1WebhooksApi.md#getwebhooksecret) | **GET** /api/v1/stripe/config/webhook | Get webhook secret |
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
## configureWebhooks
|
|
13
|
+
|
|
14
|
+
> ConfigureWebhooks200Response configureWebhooks(webhooksConfigRequest)
|
|
15
|
+
|
|
16
|
+
Configure multiple webhook endpoints
|
|
17
|
+
|
|
18
|
+
Creates, updates, or removes multiple webhook endpoints to match the desired configuration. Webhooks not in the request will be deleted. ## Authentication Requires service key authentication. ## Connect Webhooks Each webhook can have `connect: true` to listen to events from connected accounts. ## URL Interpolation URLs support `${VAR}` environment variable interpolation when using the CLI. The CLI resolves these before sending to the API. ## Use Cases - Configure multiple webhooks for different environments - Set up both account and Connect webhooks - Declarative webhook configuration management
|
|
19
|
+
|
|
20
|
+
### Example
|
|
21
|
+
|
|
22
|
+
```ts
|
|
23
|
+
import {
|
|
24
|
+
Configuration,
|
|
25
|
+
V1WebhooksApi,
|
|
26
|
+
} from '@omnibase/core-js';
|
|
27
|
+
import type { ConfigureWebhooksRequest } from '@omnibase/core-js';
|
|
28
|
+
|
|
29
|
+
async function example() {
|
|
30
|
+
console.log("🚀 Testing @omnibase/core-js SDK...");
|
|
31
|
+
const config = new Configuration({
|
|
32
|
+
// To configure API key authorization: ServiceKeyAuth
|
|
33
|
+
apiKey: "YOUR API KEY",
|
|
34
|
+
});
|
|
35
|
+
const api = new V1WebhooksApi(config);
|
|
36
|
+
|
|
37
|
+
const body = {
|
|
38
|
+
// WebhooksConfigRequest
|
|
39
|
+
webhooksConfigRequest: ...,
|
|
40
|
+
} satisfies ConfigureWebhooksRequest;
|
|
41
|
+
|
|
42
|
+
try {
|
|
43
|
+
const data = await api.configureWebhooks(body);
|
|
44
|
+
console.log(data);
|
|
45
|
+
} catch (error) {
|
|
46
|
+
console.error(error);
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
// Run the test
|
|
51
|
+
example().catch(console.error);
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### Parameters
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
| Name | Type | Description | Notes |
|
|
58
|
+
|------------- | ------------- | ------------- | -------------|
|
|
59
|
+
| **webhooksConfigRequest** | [WebhooksConfigRequest](WebhooksConfigRequest.md) | | |
|
|
60
|
+
|
|
61
|
+
### Return type
|
|
62
|
+
|
|
63
|
+
[**ConfigureWebhooks200Response**](ConfigureWebhooks200Response.md)
|
|
64
|
+
|
|
65
|
+
### Authorization
|
|
66
|
+
|
|
67
|
+
[ServiceKeyAuth](../README.md#ServiceKeyAuth)
|
|
68
|
+
|
|
69
|
+
### HTTP request headers
|
|
70
|
+
|
|
71
|
+
- **Content-Type**: `application/json`
|
|
72
|
+
- **Accept**: `application/json`
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
### HTTP response details
|
|
76
|
+
| Status code | Description | Response headers |
|
|
77
|
+
|-------------|-------------|------------------|
|
|
78
|
+
| **200** | Webhooks configured successfully | - |
|
|
79
|
+
| **400** | Invalid request - validation errors | - |
|
|
80
|
+
| **401** | Invalid or missing service key | - |
|
|
81
|
+
| **500** | Failed to configure webhooks | - |
|
|
82
|
+
|
|
83
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
## getWebhookSecret
|
|
87
|
+
|
|
88
|
+
> GetWebhookSecret200Response getWebhookSecret()
|
|
89
|
+
|
|
90
|
+
Get webhook secret
|
|
91
|
+
|
|
92
|
+
Retrieves the webhook signing secret for the most recent webhook configuration. ## Authentication Requires service key authentication. ## Use Cases - Retrieve signing secret for webhook signature verification - Debug webhook configuration
|
|
93
|
+
|
|
94
|
+
### Example
|
|
95
|
+
|
|
96
|
+
```ts
|
|
97
|
+
import {
|
|
98
|
+
Configuration,
|
|
99
|
+
V1WebhooksApi,
|
|
100
|
+
} from '@omnibase/core-js';
|
|
101
|
+
import type { GetWebhookSecretRequest } from '@omnibase/core-js';
|
|
102
|
+
|
|
103
|
+
async function example() {
|
|
104
|
+
console.log("🚀 Testing @omnibase/core-js SDK...");
|
|
105
|
+
const config = new Configuration({
|
|
106
|
+
// To configure API key authorization: ServiceKeyAuth
|
|
107
|
+
apiKey: "YOUR API KEY",
|
|
108
|
+
});
|
|
109
|
+
const api = new V1WebhooksApi(config);
|
|
110
|
+
|
|
111
|
+
try {
|
|
112
|
+
const data = await api.getWebhookSecret();
|
|
113
|
+
console.log(data);
|
|
114
|
+
} catch (error) {
|
|
115
|
+
console.error(error);
|
|
116
|
+
}
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
// Run the test
|
|
120
|
+
example().catch(console.error);
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
### Parameters
|
|
124
|
+
|
|
125
|
+
This endpoint does not need any parameter.
|
|
126
|
+
|
|
127
|
+
### Return type
|
|
128
|
+
|
|
129
|
+
[**GetWebhookSecret200Response**](GetWebhookSecret200Response.md)
|
|
130
|
+
|
|
131
|
+
### Authorization
|
|
132
|
+
|
|
133
|
+
[ServiceKeyAuth](../README.md#ServiceKeyAuth)
|
|
134
|
+
|
|
135
|
+
### HTTP request headers
|
|
136
|
+
|
|
137
|
+
- **Content-Type**: Not defined
|
|
138
|
+
- **Accept**: `application/json`
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
### HTTP response details
|
|
142
|
+
| Status code | Description | Response headers |
|
|
143
|
+
|-------------|-------------|------------------|
|
|
144
|
+
| **200** | Webhook secret retrieved successfully | - |
|
|
145
|
+
| **401** | Invalid or missing service key | - |
|
|
146
|
+
| **404** | No webhook configured | - |
|
|
147
|
+
| **500** | Failed to retrieve webhook secret | - |
|
|
148
|
+
|
|
149
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
150
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
|
|
2
|
+
# WebhookEndpointConfig
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | string
|
|
10
|
+
`url` | string
|
|
11
|
+
`events` | Array<string>
|
|
12
|
+
`connect` | boolean
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { WebhookEndpointConfig } from '@omnibase/core-js'
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"id": account_events,
|
|
22
|
+
"url": https://example.com/webhooks/stripe,
|
|
23
|
+
"events": [invoice.paid, customer.subscription.created],
|
|
24
|
+
"connect": false,
|
|
25
|
+
} satisfies WebhookEndpointConfig
|
|
26
|
+
|
|
27
|
+
console.log(example)
|
|
28
|
+
|
|
29
|
+
// Convert the instance to a JSON string
|
|
30
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
31
|
+
console.log(exampleJSON)
|
|
32
|
+
|
|
33
|
+
// Parse the JSON string back to an object
|
|
34
|
+
const exampleParsed = JSON.parse(exampleJSON) as WebhookEndpointConfig
|
|
35
|
+
console.log(exampleParsed)
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
39
|
+
|
|
40
|
+
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
|
|
2
|
+
# WebhookResult
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | string
|
|
10
|
+
`stripeId` | string
|
|
11
|
+
`url` | string
|
|
12
|
+
`events` | Array<string>
|
|
13
|
+
`connect` | boolean
|
|
14
|
+
`secret` | string
|
|
15
|
+
`action` | string
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import type { WebhookResult } from '@omnibase/core-js'
|
|
21
|
+
|
|
22
|
+
// TODO: Update the object below with actual values
|
|
23
|
+
const example = {
|
|
24
|
+
"id": e056fa27-151d-4d25-b237-97e9de8d8dbf,
|
|
25
|
+
"stripeId": we_1SRiyyCJIZaBlhY1,
|
|
26
|
+
"url": https://example.com/webhooks/stripe,
|
|
27
|
+
"events": [invoice.paid],
|
|
28
|
+
"connect": false,
|
|
29
|
+
"secret": whsec_xxx,
|
|
30
|
+
"action": created,
|
|
31
|
+
} satisfies WebhookResult
|
|
32
|
+
|
|
33
|
+
console.log(example)
|
|
34
|
+
|
|
35
|
+
// Convert the instance to a JSON string
|
|
36
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
37
|
+
console.log(exampleJSON)
|
|
38
|
+
|
|
39
|
+
// Parse the JSON string back to an object
|
|
40
|
+
const exampleParsed = JSON.parse(exampleJSON) as WebhookResult
|
|
41
|
+
console.log(exampleParsed)
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
45
|
+
|
|
46
|
+
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
|
|
2
|
+
# WebhookSecretResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | string
|
|
10
|
+
`stripeId` | string
|
|
11
|
+
`url` | string
|
|
12
|
+
`secret` | string
|
|
13
|
+
`events` | Array<string>
|
|
14
|
+
`connect` | boolean
|
|
15
|
+
`createdAt` | Date
|
|
16
|
+
`updatedAt` | Date
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import type { WebhookSecretResponse } from '@omnibase/core-js'
|
|
22
|
+
|
|
23
|
+
// TODO: Update the object below with actual values
|
|
24
|
+
const example = {
|
|
25
|
+
"id": e056fa27-151d-4d25-b237-97e9de8d8dbf,
|
|
26
|
+
"stripeId": we_1SRiyyCJIZaBlhY1,
|
|
27
|
+
"url": https://example.com/webhooks/stripe,
|
|
28
|
+
"secret": whsec_xxx,
|
|
29
|
+
"events": null,
|
|
30
|
+
"connect": false,
|
|
31
|
+
"createdAt": null,
|
|
32
|
+
"updatedAt": null,
|
|
33
|
+
} satisfies WebhookSecretResponse
|
|
34
|
+
|
|
35
|
+
console.log(example)
|
|
36
|
+
|
|
37
|
+
// Convert the instance to a JSON string
|
|
38
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
39
|
+
console.log(exampleJSON)
|
|
40
|
+
|
|
41
|
+
// Parse the JSON string back to an object
|
|
42
|
+
const exampleParsed = JSON.parse(exampleJSON) as WebhookSecretResponse
|
|
43
|
+
console.log(exampleParsed)
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
47
|
+
|
|
48
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# WebhooksConfigRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`webhooks` | [Array<WebhookEndpointConfig>](WebhookEndpointConfig.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { WebhooksConfigRequest } from '@omnibase/core-js'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"webhooks": null,
|
|
19
|
+
} satisfies WebhooksConfigRequest
|
|
20
|
+
|
|
21
|
+
console.log(example)
|
|
22
|
+
|
|
23
|
+
// Convert the instance to a JSON string
|
|
24
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
25
|
+
console.log(exampleJSON)
|
|
26
|
+
|
|
27
|
+
// Parse the JSON string back to an object
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as WebhooksConfigRequest
|
|
29
|
+
console.log(exampleParsed)
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
33
|
+
|
|
34
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# WebhooksConfigResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`webhooks` | [Array<WebhookResult>](WebhookResult.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { WebhooksConfigResponse } from '@omnibase/core-js'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"webhooks": null,
|
|
19
|
+
} satisfies WebhooksConfigResponse
|
|
20
|
+
|
|
21
|
+
console.log(example)
|
|
22
|
+
|
|
23
|
+
// Convert the instance to a JSON string
|
|
24
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
25
|
+
console.log(exampleJSON)
|
|
26
|
+
|
|
27
|
+
// Parse the JSON string back to an object
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as WebhooksConfigResponse
|
|
29
|
+
console.log(exampleParsed)
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
33
|
+
|
|
34
|
+
|
package/package.json
CHANGED
package/src/apis/V1AuthApi.ts
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Omnibase REST API
|
|
5
|
-
* Self-hostable Backend-as-a-Service providing database management, authentication, payments, storage, and email services. ## Features - **Database**: PostgreSQL with RLS and migrations - **Authentication**: Ory Kratos integration with session management - **Payments**: Stripe integration with version-controlled billing configs - **Storage**: S3-compatible object storage with RLS - **Email**: Transactional email service - **Permissions**: Fine-grained access control
|
|
5
|
+
* Self-hostable Backend-as-a-Service providing database management, authentication, payments, storage, and email services. ## Features - **Database**: PostgreSQL with RLS and migrations - **Authentication**: Ory Kratos integration with session management - **Payments**: Stripe integration with version-controlled billing configs - **Storage**: S3-compatible object storage with RLS - **Email**: Transactional email service - **Permissions**: Fine-grained access control ## Authentication Most endpoints require authentication via session cookies or JWT tokens. Use the appropriate security scheme based on the endpoint requirements.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.
|
|
7
|
+
* The version of the OpenAPI document: 0.10.1
|
|
8
8
|
* Contact: support@omnibase.dev
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Omnibase REST API
|
|
5
|
-
* Self-hostable Backend-as-a-Service providing database management, authentication, payments, storage, and email services. ## Features - **Database**: PostgreSQL with RLS and migrations - **Authentication**: Ory Kratos integration with session management - **Payments**: Stripe integration with version-controlled billing configs - **Storage**: S3-compatible object storage with RLS - **Email**: Transactional email service - **Permissions**: Fine-grained access control
|
|
5
|
+
* Self-hostable Backend-as-a-Service providing database management, authentication, payments, storage, and email services. ## Features - **Database**: PostgreSQL with RLS and migrations - **Authentication**: Ory Kratos integration with session management - **Payments**: Stripe integration with version-controlled billing configs - **Storage**: S3-compatible object storage with RLS - **Email**: Transactional email service - **Permissions**: Fine-grained access control ## Authentication Most endpoints require authentication via session cookies or JWT tokens. Use the appropriate security scheme based on the endpoint requirements.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.
|
|
7
|
+
* The version of the OpenAPI document: 0.10.1
|
|
8
8
|
* Contact: support@omnibase.dev
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/src/apis/V1EventsApi.ts
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Omnibase REST API
|
|
5
|
-
* Self-hostable Backend-as-a-Service providing database management, authentication, payments, storage, and email services. ## Features - **Database**: PostgreSQL with RLS and migrations - **Authentication**: Ory Kratos integration with session management - **Payments**: Stripe integration with version-controlled billing configs - **Storage**: S3-compatible object storage with RLS - **Email**: Transactional email service - **Permissions**: Fine-grained access control
|
|
5
|
+
* Self-hostable Backend-as-a-Service providing database management, authentication, payments, storage, and email services. ## Features - **Database**: PostgreSQL with RLS and migrations - **Authentication**: Ory Kratos integration with session management - **Payments**: Stripe integration with version-controlled billing configs - **Storage**: S3-compatible object storage with RLS - **Email**: Transactional email service - **Permissions**: Fine-grained access control ## Authentication Most endpoints require authentication via session cookies or JWT tokens. Use the appropriate security scheme based on the endpoint requirements.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.
|
|
7
|
+
* The version of the OpenAPI document: 0.10.1
|
|
8
8
|
* Contact: support@omnibase.dev
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|