package
1.0.0-beta.186
Repository: https://github.com/openmeterio/openmeter.git
Documentation: pkg.go.dev

# README

OpenMeter Go SDK

Install

go get github.com/openmeterio/openmeter/api/client/[email protected]

Usage

Initialize client.

import (
  cloudevents "github.com/cloudevents/sdk-go/v2/event"
  om "github.com/openmeterio/openmeter/api/client/go"
)

func main() {
  // Initialize OpenMeter client
  om, err := openmeter.NewClientWithResponses("http://localhost:8888")
  if err != nil {
      panic(err.Error())
  }

  // Use OpenMeter client
  // ...
}

Ingest Event

Report usage to OpenMeter.

e := cloudevents.New()
e.SetID("00001")
e.SetSource("my-app")
e.SetType("tokens")
e.SetSubject("user-id")
e.SetTime(time.Now())
e.SetData("application/json", map[string]string{
  "tokens": "15",
  "model": "gpt-4",
})

_, err := client.IngestEventWithResponse(ctx, e)

Query Meter

Retreive usage from OpenMeter.

slug := "token-usage"
subject := []string{"user-id"}
from, _ := time.Parse(time.RFC3339, "2023-01-01T00:00:00Z")
to, _ := time.Parse(time.RFC3339, "2023-01-02T00:00:00Z")
resp, _ := client.QueryMeterWithResponse(ctx, slug, &om.QueryMeterParams{
    Subject: &subject,
    From:    &from,
    To:      &to,
})
// resp.JSON200.Data

# Functions

GetSwagger returns the Swagger specification corresponding to the generated code in this file.
No description provided by the author
No description provided by the author
Creates a new Client, with reasonable defaults.
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling.
NewCreateCustomerRequest calls the generic CreateCustomer builder with application/json body.
NewCreateCustomerRequestWithBody generates requests for CreateCustomer with any type of body.
NewCreateEntitlementRequest calls the generic CreateEntitlement builder with application/json body.
NewCreateEntitlementRequestWithBody generates requests for CreateEntitlement with any type of body.
NewCreateFeatureRequest calls the generic CreateFeature builder with application/json body.
NewCreateFeatureRequestWithBody generates requests for CreateFeature with any type of body.
NewCreateGrantRequest calls the generic CreateGrant builder with application/json body.
NewCreateGrantRequestWithBody generates requests for CreateGrant with any type of body.
NewCreateMeterRequest calls the generic CreateMeter builder with application/json body.
NewCreateMeterRequestWithBody generates requests for CreateMeter with any type of body.
NewCreateNotificationChannelRequest calls the generic CreateNotificationChannel builder with application/json body.
NewCreateNotificationChannelRequestWithBody generates requests for CreateNotificationChannel with any type of body.
NewCreateNotificationRuleRequest calls the generic CreateNotificationRule builder with application/json body.
NewCreateNotificationRuleRequestWithBody generates requests for CreateNotificationRule with any type of body.
NewCreatePortalTokenRequest calls the generic CreatePortalToken builder with application/json body.
NewCreatePortalTokenRequestWithBody generates requests for CreatePortalToken with any type of body.
NewDeleteCustomerRequest generates requests for DeleteCustomer.
NewDeleteEntitlementRequest generates requests for DeleteEntitlement.
NewDeleteFeatureRequest generates requests for DeleteFeature.
NewDeleteMeterRequest generates requests for DeleteMeter.
NewDeleteNotificationChannelRequest generates requests for DeleteNotificationChannel.
NewDeleteNotificationRuleRequest generates requests for DeleteNotificationRule.
NewDeleteSubjectRequest generates requests for DeleteSubject.
NewGetCustomerRequest generates requests for GetCustomer.
NewGetDebugMetricsRequest generates requests for GetDebugMetrics.
NewGetEntitlementByIdRequest generates requests for GetEntitlementById.
NewGetEntitlementHistoryRequest generates requests for GetEntitlementHistory.
NewGetEntitlementRequest generates requests for GetEntitlement.
NewGetEntitlementValueRequest generates requests for GetEntitlementValue.
NewGetFeatureRequest generates requests for GetFeature.
NewGetMeterRequest generates requests for GetMeter.
NewGetNotificationChannelRequest generates requests for GetNotificationChannel.
NewGetNotificationEventRequest generates requests for GetNotificationEvent.
NewGetNotificationRuleRequest generates requests for GetNotificationRule.
NewGetSubjectRequest generates requests for GetSubject.
NewIngestEventsRequestWithApplicationCloudeventsBatchPlusJSONBody calls the generic IngestEvents builder with application/cloudevents-batch+json body.
NewIngestEventsRequestWithApplicationCloudeventsPlusJSONBody calls the generic IngestEvents builder with application/cloudevents+json body.
NewIngestEventsRequestWithBody generates requests for IngestEvents with any type of body.
NewInvalidatePortalTokensRequest calls the generic InvalidatePortalTokens builder with application/json body.
NewInvalidatePortalTokensRequestWithBody generates requests for InvalidatePortalTokens with any type of body.
NewListCustomersRequest generates requests for ListCustomers.
NewListEntitlementGrantsRequest generates requests for ListEntitlementGrants.
NewListEntitlementsRequest generates requests for ListEntitlements.
NewListEventsRequest generates requests for ListEvents.
NewListFeaturesRequest generates requests for ListFeatures.
NewListGrantsRequest generates requests for ListGrants.
NewListMetersRequest generates requests for ListMeters.
NewListMeterSubjectsRequest generates requests for ListMeterSubjects.
NewListNotificationChannelsRequest generates requests for ListNotificationChannels.
NewListNotificationEventsRequest generates requests for ListNotificationEvents.
NewListNotificationRulesRequest generates requests for ListNotificationRules.
NewListPortalTokensRequest generates requests for ListPortalTokens.
NewListSubjectEntitlementsRequest generates requests for ListSubjectEntitlements.
NewListSubjectsRequest generates requests for ListSubjects.
NewOverrideEntitlementRequest calls the generic OverrideEntitlement builder with application/json body.
NewOverrideEntitlementRequestWithBody generates requests for OverrideEntitlement with any type of body.
NewQueryMeterRequest generates requests for QueryMeter.
NewQueryPortalMeterRequest generates requests for QueryPortalMeter.
NewReceiveSvixOperationalEventRequest calls the generic ReceiveSvixOperationalEvent builder with application/json body.
NewReceiveSvixOperationalEventRequestWithBody generates requests for ReceiveSvixOperationalEvent with any type of body.
NewResetEntitlementUsageRequest calls the generic ResetEntitlementUsage builder with application/json body.
NewResetEntitlementUsageRequestWithBody generates requests for ResetEntitlementUsage with any type of body.
NewTestNotificationRuleRequest generates requests for TestNotificationRule.
NewUpdateCustomerRequest calls the generic UpdateCustomer builder with application/json body.
NewUpdateCustomerRequestWithBody generates requests for UpdateCustomer with any type of body.
NewUpdateNotificationChannelRequest calls the generic UpdateNotificationChannel builder with application/json body.
NewUpdateNotificationChannelRequestWithBody generates requests for UpdateNotificationChannel with any type of body.
NewUpdateNotificationRuleRequest calls the generic UpdateNotificationRule builder with application/json body.
NewUpdateNotificationRuleRequestWithBody generates requests for UpdateNotificationRule with any type of body.
NewUpsertSubjectRequest calls the generic UpsertSubject builder with application/json body.
NewUpsertSubjectRequestWithBody generates requests for UpsertSubject with any type of body.
NewVoidGrantRequest generates requests for VoidGrant.
ParseCreateCustomerResponse parses an HTTP response from a CreateCustomerWithResponse call.
ParseCreateEntitlementResponse parses an HTTP response from a CreateEntitlementWithResponse call.
ParseCreateFeatureResponse parses an HTTP response from a CreateFeatureWithResponse call.
ParseCreateGrantResponse parses an HTTP response from a CreateGrantWithResponse call.
ParseCreateMeterResponse parses an HTTP response from a CreateMeterWithResponse call.
ParseCreateNotificationChannelResponse parses an HTTP response from a CreateNotificationChannelWithResponse call.
ParseCreateNotificationRuleResponse parses an HTTP response from a CreateNotificationRuleWithResponse call.
ParseCreatePortalTokenResponse parses an HTTP response from a CreatePortalTokenWithResponse call.
ParseDeleteCustomerResponse parses an HTTP response from a DeleteCustomerWithResponse call.
ParseDeleteEntitlementResponse parses an HTTP response from a DeleteEntitlementWithResponse call.
ParseDeleteFeatureResponse parses an HTTP response from a DeleteFeatureWithResponse call.
ParseDeleteMeterResponse parses an HTTP response from a DeleteMeterWithResponse call.
ParseDeleteNotificationChannelResponse parses an HTTP response from a DeleteNotificationChannelWithResponse call.
ParseDeleteNotificationRuleResponse parses an HTTP response from a DeleteNotificationRuleWithResponse call.
ParseDeleteSubjectResponse parses an HTTP response from a DeleteSubjectWithResponse call.
ParseGetCustomerResponse parses an HTTP response from a GetCustomerWithResponse call.
ParseGetDebugMetricsResponse parses an HTTP response from a GetDebugMetricsWithResponse call.
ParseGetEntitlementByIdResponse parses an HTTP response from a GetEntitlementByIdWithResponse call.
ParseGetEntitlementHistoryResponse parses an HTTP response from a GetEntitlementHistoryWithResponse call.
ParseGetEntitlementResponse parses an HTTP response from a GetEntitlementWithResponse call.
ParseGetEntitlementValueResponse parses an HTTP response from a GetEntitlementValueWithResponse call.
ParseGetFeatureResponse parses an HTTP response from a GetFeatureWithResponse call.
ParseGetMeterResponse parses an HTTP response from a GetMeterWithResponse call.
ParseGetNotificationChannelResponse parses an HTTP response from a GetNotificationChannelWithResponse call.
ParseGetNotificationEventResponse parses an HTTP response from a GetNotificationEventWithResponse call.
ParseGetNotificationRuleResponse parses an HTTP response from a GetNotificationRuleWithResponse call.
ParseGetSubjectResponse parses an HTTP response from a GetSubjectWithResponse call.
ParseIngestEventsResponse parses an HTTP response from a IngestEventsWithResponse call.
ParseInvalidatePortalTokensResponse parses an HTTP response from a InvalidatePortalTokensWithResponse call.
ParseListCustomersResponse parses an HTTP response from a ListCustomersWithResponse call.
ParseListEntitlementGrantsResponse parses an HTTP response from a ListEntitlementGrantsWithResponse call.
ParseListEntitlementsResponse parses an HTTP response from a ListEntitlementsWithResponse call.
ParseListEventsResponse parses an HTTP response from a ListEventsWithResponse call.
ParseListFeaturesResponse parses an HTTP response from a ListFeaturesWithResponse call.
ParseListGrantsResponse parses an HTTP response from a ListGrantsWithResponse call.
ParseListMetersResponse parses an HTTP response from a ListMetersWithResponse call.
ParseListMeterSubjectsResponse parses an HTTP response from a ListMeterSubjectsWithResponse call.
ParseListNotificationChannelsResponse parses an HTTP response from a ListNotificationChannelsWithResponse call.
ParseListNotificationEventsResponse parses an HTTP response from a ListNotificationEventsWithResponse call.
ParseListNotificationRulesResponse parses an HTTP response from a ListNotificationRulesWithResponse call.
ParseListPortalTokensResponse parses an HTTP response from a ListPortalTokensWithResponse call.
ParseListSubjectEntitlementsResponse parses an HTTP response from a ListSubjectEntitlementsWithResponse call.
ParseListSubjectsResponse parses an HTTP response from a ListSubjectsWithResponse call.
ParseOverrideEntitlementResponse parses an HTTP response from a OverrideEntitlementWithResponse call.
ParseQueryMeterResponse parses an HTTP response from a QueryMeterWithResponse call.
ParseQueryPortalMeterResponse parses an HTTP response from a QueryPortalMeterWithResponse call.
ParseReceiveSvixOperationalEventResponse parses an HTTP response from a ReceiveSvixOperationalEventWithResponse call.
ParseResetEntitlementUsageResponse parses an HTTP response from a ResetEntitlementUsageWithResponse call.
ParseTestNotificationRuleResponse parses an HTTP response from a TestNotificationRuleWithResponse call.
ParseUpdateCustomerResponse parses an HTTP response from a UpdateCustomerWithResponse call.
ParseUpdateNotificationChannelResponse parses an HTTP response from a UpdateNotificationChannelWithResponse call.
ParseUpdateNotificationRuleResponse parses an HTTP response from a UpdateNotificationRuleWithResponse call.
ParseUpsertSubjectResponse parses an HTTP response from a UpsertSubjectWithResponse call.
ParseVoidGrantResponse parses an HTTP response from a VoidGrantWithResponse call.
Constructs a synthetic filesystem for resolving external references when loading openapi specifications.
WithBaseURL overrides the baseURL.
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client.
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request.

# 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.
Client which conforms to the OpenAPI3 specification for this service.
ClientWithResponses builds on ClientInterface to offer response payloads.
ConflictProblem Conflict.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Customer A customer object.
CustomerExternalMapping External mappings for the customer.
CustomerList A page of results.
CustomerUsageAttribution Mapping to attribute metered usage to the customer.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
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.
ErrResponse renderer type for handling all sorts of errors.
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).
No description provided by the author
No description provided by the author
No description provided by the author
GetEntitlementHistoryParams defines parameters for GetEntitlementHistory.
No description provided by the author
No description provided by the author
GetEntitlementValueParams defines parameters for GetEntitlementValue.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GrantBurnDownHistorySegment A segment of the grant burn down history.
GrantUsageRecord defines model for GrantUsageRecord.
IngestedEvent An ingested event with optional validation error.
No description provided by the author
InvalidatePortalTokensJSONBody defines parameters for InvalidatePortalTokens.
No description provided by the author
ListCustomersParams defines parameters for ListCustomers.
No description provided by the author
ListEntitlementGrantPaginatedResponse defines model for ListEntitlementGrantPaginatedResponse.
ListEntitlementGrantResponse defines model for ListEntitlementGrantResponse.
ListEntitlementGrantsParams defines parameters for ListEntitlementGrants.
No description provided by the author
ListEntitlementPaginatedResponse defines model for ListEntitlementPaginatedResponse.
ListEntitlementResponse defines model for ListEntitlementResponse.
ListEntitlementsParams defines parameters for ListEntitlements.
No description provided by the author
ListEventsParams defines parameters for ListEvents.
No description provided by the author
ListFeaturePaginatedResponse defines model for ListFeaturePaginatedResponse.
ListFeatureResponse defines model for ListFeatureResponse.
ListFeaturesParams defines parameters for ListFeatures.
No description provided by the author
ListGrantsParams defines parameters for ListGrants.
No description provided by the author
No description provided by the author
No description provided by the author
ListNotificationChannelsParams defines parameters for ListNotificationChannels.
No description provided by the author
ListNotificationEventsParams defines parameters for ListNotificationEvents.
No description provided by the author
ListNotificationRulesParams defines parameters for ListNotificationRules.
No description provided by the author
ListPortalTokensParams defines parameters for ListPortalTokens.
No description provided by the author
ListSubjectEntitlementsParams defines parameters for ListSubjectEntitlements.
No description provided by the author
No description provided by the author
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.
No description provided by the author
PaginationInfo Pagination information.
Period A time period.
PortalToken A consumer portal token.
QueryMeterParams defines parameters for QueryMeter.
No description provided by the author
QueryPortalMeterParams defines parameters for QueryPortalMeter.
No description provided by the author
No description provided by the author
RecurringPeriod Recurring period of an entitlement.
RecurringPeriodCreateInput Recurring period of an entitlement.
ResetEntitlementUsageJSONBody defines parameters for ResetEntitlementUsage.
No description provided by the author
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
No description provided by the author
No description provided by the author
WindowedBalanceHistory The windowed balance history.

# Interfaces

The interface specification for the client above.
ClientWithResponsesInterface is the interface specification for the client with responses above.
Doer performs HTTP requests.

# Type aliases

BadRequestProblemResponse A Problem Details object (RFC 7807).
ChannelId defines model for channelId.
ClientOption allows setting custom parameters during construction.
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.
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.
RequestEditorFn is the function signature for the RequestEditor callback function.
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.