package
1.0.0-beta.186
Repository: https://github.com/openmeterio/openmeter.git
Documentation: pkg.go.dev
# Functions
GetSwagger returns the Swagger specification corresponding to the generated code in this file.
Handler creates http.Handler with routing matching OpenAPI spec.
HandlerFromMux creates http.Handler with routing matching OpenAPI spec based on the provided mux.
No description provided by the author
HandlerWithOptions creates http.Handler with additional options.
Constructs a synthetic filesystem for resolving external references when loading openapi specifications.
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
Defines values for ListEntitlementGrantsParamsOrderBy.
Defines values for MeasureUsageFromEnum.
Defines values for GetEntitlementHistoryParamsWindowSize.
Defines values for SvixOperationalWebhookRequestType.
Defines values for SvixOperationalWebhookRequestType.
Defines values for SvixOperationalWebhookRequestType.
Defines values for SvixOperationalWebhookRequestType.
Defines values for EntitlementBooleanCreateInputsType.
Defines values for EntitlementBooleanType.
Defines values for EntitlementMeteredCreateInputsType.
Defines values for EntitlementMeteredType.
Defines values for NotificationEventType.
Defines values for EntitlementStaticCreateInputsType.
Defines values for EntitlementStaticType.
Defines values for ExpirationPeriodDuration.
Defines values for ExpirationPeriodDuration.
Defines values for ExpirationPeriodDuration.
Defines values for ExpirationPeriodDuration.
Defines values for ExpirationPeriodDuration.
Defines values for NotificationEventDeliveryStatusState.
Defines values for GetEntitlementHistoryParamsWindowSize.
Defines values for ListEntitlementGrantsParamsOrderBy.
Defines values for ListEntitlementsParamsOrderBy.
Defines values for ListEntitlementsParamsOrderBy.
Defines values for ListEntitlementsParamsOrder.
Defines values for ListEntitlementsParamsOrder.
Defines values for ListFeaturesParamsOrderBy.
Defines values for ListFeaturesParamsOrderBy.
Defines values for ListFeaturesParamsOrderBy.
Defines values for ListFeaturesParamsOrder.
Defines values for ListFeaturesParamsOrder.
Defines values for ListGrantsParamsOrderBy.
Defines values for ListGrantsParamsOrderBy.
Defines values for ListGrantsParamsOrderBy.
Defines values for ListGrantsParamsOrder.
Defines values for ListGrantsParamsOrder.
Defines values for ListNotificationChannelsParamsOrderBy.
Defines values for ListNotificationChannelsParamsOrderBy.
Defines values for ListNotificationChannelsParamsOrderBy.
Defines values for ListNotificationChannelsParamsOrderBy.
Defines values for ListNotificationChannelsParamsOrder.
Defines values for ListNotificationChannelsParamsOrder.
Defines values for ListNotificationEventsParamsOrderBy.
Defines values for ListNotificationEventsParamsOrderBy.
Defines values for ListNotificationEventsParamsOrder.
Defines values for ListNotificationEventsParamsOrder.
Defines values for ListNotificationRulesParamsOrderBy.
Defines values for ListNotificationRulesParamsOrderBy.
Defines values for ListNotificationRulesParamsOrderBy.
Defines values for ListNotificationRulesParamsOrderBy.
Defines values for SvixOperationalWebhookRequestType.
Defines values for SvixOperationalWebhookRequestType.
Defines values for SvixOperationalWebhookRequestType.
Defines values for GetEntitlementHistoryParamsWindowSize.
Defines values for MeasureUsageFromEnum.
Defines values for NotificationRuleBalanceThresholdValueType.
Defines values for Order.
Defines values for Order.
Defines values for NotificationEventDeliveryStatusState.
Defines values for NotificationRuleBalanceThresholdValueType.
No description provided by the author
Defines values for RecurringPeriodEnum.
Defines values for RecurringPeriodEnum.
Defines values for RecurringPeriodEnum.
Defines values for RecurringPeriodEnum.
Defines values for NotificationEventDeliveryStatusState.
Defines values for ListNotificationRulesParamsOrder.
Defines values for ListNotificationRulesParamsOrder.
Defines values for NotificationEventDeliveryStatusState.
Defines values for ListEntitlementGrantsParamsOrderBy.
Defines values for NotificationChannelType.
# Structs
Address Address.
BalanceHistoryWindow Windowed usage and balance information.
No description provided by the author
ConflictProblem Conflict.
Customer A customer object.
CustomerExternalMapping External mappings for the customer.
CustomerList A page of results.
CustomerUsageAttribution Mapping to attribute metered usage to the customer.
Entitlement defines model for Entitlement.
EntitlementBoolean defines model for EntitlementBoolean.
EntitlementBooleanCreateInputs defines model for EntitlementBooleanCreateInputs.
EntitlementCreateInputs defines model for EntitlementCreateInputs.
EntitlementCreateSharedFields defines model for EntitlementCreateSharedFields.
EntitlementGrant defines model for EntitlementGrant.
EntitlementGrantCreateInput Grants are used to increase balance of specific subjects.
EntitlementMetered defines model for EntitlementMetered.
EntitlementMeteredCalculatedFields Calculated fields for a metered entitlement.
EntitlementMeteredCreateInputs defines model for EntitlementMeteredCreateInputs.
EntitlementSharedFields defines model for EntitlementSharedFields.
EntitlementStatic defines model for EntitlementStatic.
EntitlementStaticCreateInputs defines model for EntitlementStaticCreateInputs.
EntitlementValue defines model for EntitlementValue.
ExpirationPeriod Expiration period of a grant.
Feature defines model for Feature.
FeatureCreateInputs A feature is a feature or service offered to a customer.
FeatureMeta Limited representation of a feature resource which includes only its unique identifiers (id, key).
GetEntitlementHistoryParams defines parameters for GetEntitlementHistory.
GetEntitlementValueParams defines parameters for GetEntitlementValue.
GrantBurnDownHistorySegment A segment of the grant burn down history.
GrantUsageRecord defines model for GrantUsageRecord.
IngestedEvent An ingested event with optional validation error.
InvalidatePortalTokensJSONBody defines parameters for InvalidatePortalTokens.
No description provided by the author
ListCustomersParams defines parameters for ListCustomers.
ListEntitlementGrantPaginatedResponse defines model for ListEntitlementGrantPaginatedResponse.
ListEntitlementGrantResponse defines model for ListEntitlementGrantResponse.
ListEntitlementGrantsParams defines parameters for ListEntitlementGrants.
ListEntitlementPaginatedResponse defines model for ListEntitlementPaginatedResponse.
ListEntitlementResponse defines model for ListEntitlementResponse.
ListEntitlementsParams defines parameters for ListEntitlements.
ListEventsParams defines parameters for ListEvents.
ListFeaturePaginatedResponse defines model for ListFeaturePaginatedResponse.
ListFeatureResponse defines model for ListFeatureResponse.
ListFeaturesParams defines parameters for ListFeatures.
ListGrantsParams defines parameters for ListGrants.
ListNotificationChannelsParams defines parameters for ListNotificationChannels.
ListNotificationEventsParams defines parameters for ListNotificationEvents.
ListNotificationRulesParams defines parameters for ListNotificationRules.
ListPortalTokensParams defines parameters for ListPortalTokens.
ListSubjectEntitlementsParams defines parameters for ListSubjectEntitlements.
MeasureUsageFrom The time from which usage is measured, defaults to the entitlement creation time.
MeterQueryResult The result of a meter query.
NotificationChannel defines model for NotificationChannel.
NotificationChannelCommon defines model for NotificationChannelCommon.
NotificationChannelCommonCreateRequest Common fields for create notification channel request.
NotificationChannelCreateRequest defines model for NotificationChannelCreateRequest.
NotificationChannelMeta Limited representation of notification channel which includes only the channel identifier and its type.
NotificationChannelsResponse defines model for NotificationChannelsResponse.
NotificationChannelWebhook defines model for NotificationChannelWebhook.
NotificationChannelWebhookCreateRequest defines model for NotificationChannelWebhookCreateRequest.
NotificationEvent Notification event generated by the system based on the criteria defined in the corresponding a notification rule.
NotificationEventBalanceThresholdPayload defines model for NotificationEventBalanceThresholdPayload.
NotificationEventCommonPayload Common fields for notification event payload.
NotificationEventDeliveryStatus defines model for NotificationEventDeliveryStatus.
NotificationEventPayload The actual payload sent to channel as part of the notification event.
NotificationEventsResponse defines model for NotificationEventsResponse.
NotificationRule defines model for NotificationRule.
NotificationRuleBalanceThreshold defines model for NotificationRuleBalanceThreshold.
NotificationRuleBalanceThresholdCreateRequest defines model for NotificationRuleBalanceThresholdCreateRequest.
NotificationRuleBalanceThresholdValue Threshold value with multiple supported types.
NotificationRuleCommon defines model for NotificationRuleCommon.
NotificationRuleCommonCreateRequest Defines the common fields for create notification rule request.
NotificationRuleCreateRequest defines model for NotificationRuleCreateRequest.
NotificationRuleMeta Defines the common fields of a notification rule.
NotificationRulesResponse defines model for NotificationRulesResponse.
PaginationInfo Pagination information.
Period A time period.
PortalToken A consumer portal token.
QueryMeterParams defines parameters for QueryMeter.
QueryPortalMeterParams defines parameters for QueryPortalMeter.
RecurringPeriod Recurring period of an entitlement.
RecurringPeriodCreateInput Recurring period of an entitlement.
No description provided by the author
No description provided by the author
ResetEntitlementUsageJSONBody defines parameters for ResetEntitlementUsage.
ServerInterfaceWrapper converts contexts to parameters.
SharedMetaFields Metadata fields for all resources.
Subject A subject is a unique identifier for a user or entity.
SvixOperationalWebhookRequest defines model for SvixOperationalWebhookRequest.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
WindowedBalanceHistory The windowed balance history.
# Interfaces
ServerInterface represents all server handlers.
# Type aliases
BadRequestProblemResponse A Problem Details object (RFC 7807).
ChannelId defines model for channelId.
ConflictProblemResponse Conflict.
CountryCode [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) alpha-2 country code.
CreateCustomerJSONRequestBody defines body for CreateCustomer for application/json ContentType.
CreateEntitlementJSONRequestBody defines body for CreateEntitlement for application/json ContentType.
CreateFeatureJSONRequestBody defines body for CreateFeature for application/json ContentType.
CreateGrantJSONRequestBody defines body for CreateGrant for application/json ContentType.
CreateMeterJSONRequestBody defines body for CreateMeter for application/json ContentType.
CreateNotificationChannelJSONRequestBody defines body for CreateNotificationChannel for application/json ContentType.
CreateNotificationRuleJSONRequestBody defines body for CreateNotificationRule for application/json ContentType.
CreatePortalTokenJSONRequestBody defines body for CreatePortalToken for application/json ContentType.
CurrencyCode Three-letter [ISO4217](https://www.iso.org/iso-4217-currency-codes.html) currency code.
CustomerIdentifier A unique customer identifier.
DateTime [RFC3339](https://tools.ietf.org/html/rfc3339) formatted date-time string in UTC.
EntitlementBooleanCreateInputsType defines model for EntitlementBooleanCreateInputs.Type.
EntitlementBooleanType defines model for EntitlementBoolean.Type.
EntitlementId defines model for entitlementId.
EntitlementIdOrFeatureKey defines model for entitlementIdOrFeatureKey.
EntitlementMeteredCreateInputsType defines model for EntitlementMeteredCreateInputs.Type.
EntitlementMeteredType defines model for EntitlementMetered.Type.
EntitlementStaticCreateInputsType defines model for EntitlementStaticCreateInputs.Type.
EntitlementStaticType defines model for EntitlementStatic.Type.
Event CloudEvents Specification JSON Schema.
EventId defines model for eventId.
ExpirationPeriodDuration The expiration period duration like month.
FeatureId defines model for featureId.
GetEntitlementHistoryParamsWindowSize defines parameters for GetEntitlementHistory.
GrantId defines model for grantId.
IdOrSlug A unique identifier.
IncludeDeleted defines model for includeDeleted.
IngestEventsApplicationCloudeventsBatchPlusJSONBody defines parameters for IngestEvents.
IngestEventsApplicationCloudeventsBatchPlusJSONRequestBody defines body for IngestEvents for application/cloudevents-batch+json ContentType.
IngestEventsApplicationCloudeventsPlusJSONRequestBody defines body for IngestEvents for application/cloudevents+json ContentType.
InvalidatePortalTokensJSONRequestBody defines body for InvalidatePortalTokens for application/json ContentType.
Key A key is a unique string that is used to identify a resource.
ListEntitlementGrantResponse0 defines model for .
ListEntitlementGrantsParamsOrderBy defines parameters for ListEntitlementGrants.
ListEntitlementResponse0 defines model for .
ListEntitlementsParamsOrder defines parameters for ListEntitlements.
ListEntitlementsParamsOrderBy defines parameters for ListEntitlements.
ListFeatureResponse0 defines model for .
ListFeaturesParamsOrder defines parameters for ListFeatures.
ListFeaturesParamsOrderBy defines parameters for ListFeatures.
ListGrantsParamsOrder defines parameters for ListGrants.
ListGrantsParamsOrderBy defines parameters for ListGrants.
ListNotificationChannelsParamsOrder defines parameters for ListNotificationChannels.
ListNotificationChannelsParamsOrderBy defines parameters for ListNotificationChannels.
ListNotificationEventsParamsOrder defines parameters for ListNotificationEvents.
ListNotificationEventsParamsOrderBy defines parameters for ListNotificationEvents.
ListNotificationRulesParamsOrder defines parameters for ListNotificationRules.
ListNotificationRulesParamsOrderBy defines parameters for ListNotificationRules.
MeasureUsageFromEnum defines model for MeasureUsageFromEnum.
MeasureUsageFromTime defines model for MeasureUsageFromTime.
Metadata Set of key-value pairs.
Meter A meter is a configuration that defines how to match and aggregate events.
MeterAggregation The aggregation type to use for the meter.
MeterIdOrSlug A unique identifier.
MeterQueryRow A row in the result of a meter query.
No description provided by the author
NotFoundProblemResponse A Problem Details object (RFC 7807).
NotificationChannels List of channels.
NotificationChannelType The type of the notification channel.
NotificationEventDeliveryStatusState defines model for NotificationEventDeliveryStatus.State.
NotificationEvents List of notification events.
NotificationEventType The type of the notification event.
NotificationRuleBalanceThresholdValueType defines model for NotificationRuleBalanceThresholdValue.Type.
NotificationRules List of rules.
NotImplementedProblemResponse A Problem Details object (RFC 7807).
Order defines model for order.
OverrideEntitlementJSONRequestBody defines body for OverrideEntitlement for application/json ContentType.
PaginatedQueryPage defines model for PaginatedQuery.page.
PaginatedQueryPageSize defines model for PaginatedQuery.pageSize.
Problem A Problem Details object (RFC 7807).
QueryCustomerList defines model for queryCustomerList.
QueryFilterChannel defines model for queryFilterChannel.
QueryFilterEntitlementType defines model for queryFilterEntitlementType.
QueryFilterFeature defines model for queryFilterFeature.
QueryFilterGroupBy Simple filter for group bys with exact match.
QueryFilterMeterSlug defines model for queryFilterMeterSlug.
QueryFilterSubject defines model for queryFilterSubject.
QueryFrom defines model for queryFrom.
QueryGroupBy defines model for queryGroupBy.
QueryIncludeDisabled defines model for queryIncludeDisabled.
QueryLimit defines model for queryLimit.
QueryOffset defines model for queryOffset.
QueryPage defines model for queryPage.
QueryPageSize defines model for queryPageSize.
QueryTo defines model for queryTo.
QueryWindowSize Aggregation window size.
QueryWindowTimeZone defines model for queryWindowTimeZone.
ReceiveSvixOperationalEventJSONRequestBody defines body for ReceiveSvixOperationalEvent for application/json ContentType.
RecurringPeriodEnum List of pre-defined periods that can be used for recurring & scheduling.
ResetEntitlementUsageJSONRequestBody defines body for ResetEntitlementUsage for application/json ContentType.
RuleId defines model for ruleId.
SubjectIdOrKey defines model for subjectIdOrKey.
SvixOperationalWebhookRequestType defines model for SvixOperationalWebhookRequest.Type.
ULID ULID (Universally Unique Lexicographically Sortable Identifier).
UnauthorizedProblemResponse A Problem Details object (RFC 7807).
UnexpectedProblemResponse A Problem Details object (RFC 7807).
UpdateCustomerJSONRequestBody defines body for UpdateCustomer for application/json ContentType.
UpdateNotificationChannelJSONRequestBody defines body for UpdateNotificationChannel for application/json ContentType.
UpdateNotificationRuleJSONRequestBody defines body for UpdateNotificationRule for application/json ContentType.
UpsertSubjectJSONBody defines parameters for UpsertSubject.
UpsertSubjectJSONRequestBody defines body for UpsertSubject for application/json ContentType.
WindowSize Aggregation window size.