@orangecheck/me-client

---

@orangecheck/me-client / oc

Variable: oc

const oc: {
  config: {
     validate: (cfg: IntegratorPriceConfig) => ValidationResult;
  };
  event: {
     fire: (options: FireEventOptions) => Promise<BillableEvent>;
     fireBatch: (options: FireBatchOptions) => Promise<FireBatchResponse>;
     verify: (envelope: BillableEvent, config: IntegratorPriceConfig, payment_amount_sats?: number) => VerifyEventResult;
  };
  federations: {
     defaultLive: () => Promise<Federation | null>;
     get: (slug: string) => Promise<Federation | null>;
     list: () => Promise<Federation[]>;
     live: () => Promise<Federation[]>;
  };
  payment: {
     authorize: (opts: PaymentAuthorizeOptions) => Promise<PaymentResult>;
  };
  scope: {
     granted: (options: GrantedOptions) => Promise<GrantedResult>;
     request: (scopes: Scope[], options: RequestOptions) => never;
  };
  session: {
     create: (opts: SignInOptions) => Promise<Session>;
     invalidate: (sessionId: string) => Promise<void>;
     refresh: (sessionId: string) => Promise<Session>;
  };
  webhook: {
     fetchJwks: (issuer: string) => Promise<void>;
     verify: (rawBody: string | Uint8Array<ArrayBufferLike>, sigHex: string, kid: string, options: VerifyOptions) => Promise<VerifyResult>;
  };
};

Defined in: me-client/src/index.ts:107

Convenience namespace mirroring the public API surface in /integrate code samples — oc.session.create(), oc.payment.authorize(), oc.event.fire(), oc.config.validate(), oc.webhook.verify(), oc.federations.live(), oc.scope.granted() / oc.scope.request().

Type Declaration

Name	Type	Default value	Defined in
<a id="property-config"></a> config	&#123; validate: (cfg: IntegratorPriceConfig) => ValidationResult; &#125;	-	me-client/src/index.ts:107
config.validate()	(cfg: IntegratorPriceConfig) => ValidationResult	-	me-client/src/config.ts:25
<a id="property-event"></a> event	&#123; fire: (options: FireEventOptions) => Promise&lt;BillableEvent>; fireBatch: (options: FireBatchOptions) => Promise&lt;FireBatchResponse>; verify: (envelope: BillableEvent, config: IntegratorPriceConfig, payment_amount_sats?: number) => VerifyEventResult; &#125;	-	me-client/src/index.ts:107
event.fire()	(options: FireEventOptions) => Promise&lt;BillableEvent>	-	me-client/src/event.ts:329
event.fireBatch()	(options: FireBatchOptions) => Promise&lt;FireBatchResponse>	-	me-client/src/event.ts:329
event.verify()	(envelope: BillableEvent, config: IntegratorPriceConfig, payment_amount_sats?: number) => VerifyEventResult	-	me-client/src/event.ts:329
<a id="property-federations"></a> federations	&#123; defaultLive: () => Promise&lt;Federation | null>; get: (slug: string) => Promise&lt;Federation | null>; list: () => Promise&lt;Federation[]>; live: () => Promise&lt;Federation[]>; &#125;	-	me-client/src/index.ts:107
federations.defaultLive()	() => Promise&lt;Federation | null>	-	me-client/src/federations.ts:51
federations.get()	(slug: string) => Promise&lt;Federation | null>	-	me-client/src/federations.ts:51
federations.list()	() => Promise&lt;Federation[]>	-	me-client/src/federations.ts:51
federations.live()	() => Promise&lt;Federation[]>	-	me-client/src/federations.ts:51
<a id="property-payment"></a> payment	&#123; authorize: (opts: PaymentAuthorizeOptions) => Promise&lt;PaymentResult>; &#125;	-	me-client/src/index.ts:107
payment.authorize()	(opts: PaymentAuthorizeOptions) => Promise&lt;PaymentResult>	-	me-client/src/payment.ts:25
<a id="property-scope"></a> scope	&#123; granted: (options: GrantedOptions) => Promise&lt;GrantedResult>; request: (scopes: Scope[], options: RequestOptions) => never; &#125;	-	me-client/src/index.ts:107
scope.granted()	(options: GrantedOptions) => Promise&lt;GrantedResult>	-	me-client/src/scope.ts:144
scope.request()	(scopes: Scope[], options: RequestOptions) => never	-	me-client/src/scope.ts:144
<a id="property-session"></a> session	&#123; create: (opts: SignInOptions) => Promise&lt;Session>; invalidate: (sessionId: string) => Promise&lt;void>; refresh: (sessionId: string) => Promise&lt;Session>; &#125;	-	me-client/src/index.ts:107
session.create()	(opts: SignInOptions) => Promise&lt;Session>	-	me-client/src/session.ts:77
session.invalidate()	(sessionId: string) => Promise&lt;void>	-	me-client/src/session.ts:77
session.refresh()	(sessionId: string) => Promise&lt;Session>	-	me-client/src/session.ts:77
<a id="property-webhook"></a> webhook	&#123; fetchJwks: (issuer: string) => Promise&lt;void>; verify: (rawBody: string | Uint8Array&lt;ArrayBufferLike>, sigHex: string, kid: string, options: VerifyOptions) => Promise&lt;VerifyResult>; &#125;	-	me-client/src/index.ts:107
webhook.fetchJwks()	(issuer: string) => Promise&lt;void>	fetchJwksForce	me-client/src/webhook.ts:221
webhook.verify()	(rawBody: string | Uint8Array&lt;ArrayBufferLike>, sigHex: string, kid: string, options: VerifyOptions) => Promise&lt;VerifyResult>	-	me-client/src/webhook.ts:221