Struct MeterClient

Source
pub struct MeterClient { /* private fields */ }
Expand description

A convenient client to interact with the Meter esndpoints.

Implementations§

Source§

impl MeterClient

Source

pub fn new(base_url: String, token: String) -> Self

Create a new client with the given base URL and an auth token.

Source

pub async fn create_meter( &self, body: &CreateMeterRequest, ) -> Result<Meter, Error>

Create a new meter.

POST /api/v1/meters

Source

pub async fn delete_meter(&self, meter_id_or_slug: &str) -> Result<(), Error>

Delete a meter by ID or slug.

DELETE /api/v1/meters/{meterIdOrSlug}

Source

pub async fn get_meter(&self, meter_id_or_slug: &str) -> Result<Meter, Error>

Get a meter by ID or slug.

GET /api/v1/meters/{meterIdOrSlug}

Source

pub async fn list_meters(&self) -> Result<Vec<Meter>, Error>

List all meters.

GET /api/v1/meters

Source

pub async fn list_meter_subjects( &self, meter_id_or_slug: &str, ) -> Result<Vec<String>, Error>

List subjects for a meter.

GET /api/v1/meters/{meterIdOrSlug}/subjects

Source

pub async fn query_meter( &self, meter_id_or_slug: &str, params: &QueryParams, ) -> Result<QueryResponse, Error>

Query meter usage.

GET /api/v1/meters/{meterIdOrSlug}/query

Supports optional query parameters:

  • from
  • to
  • windowSize
  • windowTimeZone
  • subject (repeated)
  • filterGroupBy[…] (etc.)
Source

pub async fn update_meter( &self, meter_id_or_slug: &str, body: &UpdateMeterRequest, ) -> Result<Meter, Error>

Update a meter by ID or slug.

PUT /api/v1/meters/{meterIdOrSlug}

Source

pub async fn ingest_events(&self, events: &[CloudEvent]) -> Result<(), Error>

Ingest a single or batch of CloudEvents.

POST /api/v1/events

Source

pub async fn list_events( &self, params: &ListEventsParams, ) -> Result<Vec<IngestedEvent>, Error>

List ingested events within a time range or by other filters.

GET /api/v1/events

For example:

  • from / to
  • ingestedAtFrom / ingestedAtTo
  • subject (partial match)
  • id (partial match)
  • limit
Source

pub async fn create_entitlement( &self, subject_id_or_key: &str, req: CreateEntitlementRequest, ) -> Result<Entitlement, Error>

Source

pub async fn create_feature( &self, req: CreateFeatureRequest, ) -> Result<Feature, Error>

Source

pub async fn create_grant( &self, subject_id_or_key: &str, entitlement_id_or_feature_key: &str, req: GrantRequest, ) -> Result<Grant, Error>

Source

pub async fn delete_entitlement( &self, subject_id_or_key: &str, entitlement_id: &str, ) -> Result<(), Error>

Source

pub async fn delete_feature(&self, feature_id: &str) -> Result<(), Error>

Source

pub async fn get_entitlement( &self, subject_id_or_key: &str, entitlement_id: &str, ) -> Result<Entitlement, Error>

Source

pub async fn get_entitlement_by_id( &self, entitlement_id: &str, ) -> Result<Entitlement, Error>

Source

pub async fn get_entitlement_history( &self, subject_id_or_key: &str, entitlement_id: &str, from: Option<String>, to: Option<String>, window_size: String, window_time_zone: Option<String>, ) -> Result<Value, Error>

Source

pub async fn get_entitlement_value( &self, subject_id_or_key: &str, entitlement_id_or_feature_key: &str, time: Option<String>, ) -> Result<Value, Error>

Source

pub async fn get_feature(&self, feature_id: &str) -> Result<Feature, Error>

Source

pub async fn list_all_entitlements(&self) -> Result<Vec<Entitlement>, Error>

Source

pub async fn list_entitlement_grants( &self, subject_id_or_key: &str, entitlement_id_or_feature_key: &str, ) -> Result<Vec<Grant>, Error>

Source

pub async fn list_entitlements( &self, subject_id_or_key: &str, ) -> Result<Vec<Entitlement>, Error>

Source

pub async fn list_features(&self) -> Result<Vec<Feature>, Error>

Source

pub async fn list_grants(&self) -> Result<Vec<Grant>, Error>

Source

pub async fn override_entitlement( &self, subject_id_or_key: &str, entitlement_id_or_feature_key: &str, req: CreateEntitlementRequest, ) -> Result<Entitlement, Error>

Source

pub async fn reset_entitlement( &self, subject_id_or_key: &str, entitlement_id: &str, req: ResetEntitlementRequest, ) -> Result<(), Error>

Source

pub async fn void_grant(&self, grant_id: &str) -> Result<(), Error>

Trait Implementations§

Source§

impl Clone for MeterClient

Source§

fn clone(&self) -> MeterClient

Returns a copy of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for MeterClient

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T