@orangecheck/me-client

---

@orangecheck/me-client / oc

Variable: oc

const oc: {
  config: {
     archetypes: readonly ArchetypeTemplate[];
     fromTemplate: (useCase: IntegratorArchetype, identity: ProjectIdentity) => IntegratorPriceConfig;
     getArchetype: (id: IntegratorArchetype) => ArchetypeTemplate;
     validate: (cfg: IntegratorPriceConfig) => ValidationResult;
  };
  event: {
     fire: (options: FireEventOptions) => Promise<FireEventResult>;
     fireBatch: (options: FireBatchOptions) => Promise<FireBatchResponse>;
     verify: (envelope: BillableEvent, config: IntegratorPriceConfig, payment_amount_sats?: number, opts: {
        payPeriods?: readonly PayPeriod[];
     }) => VerifyEventResult;
  };
  family: {
     scopes: (verb: FamilyVerb, options?: FamilyScopesOptions) => Promise<FamilyScopesResult>;
  };
  federations: {
     defaultLive: () => Promise<Federation | null>;
     get: (slug: string) => Promise<Federation | null>;
     list: () => Promise<Federation[]>;
     live: () => Promise<Federation[]>;
  };
  identity: {
     refreshEnvelopeJwks: (issuer: string) => Promise<void>;
     verifyActivityAttestation: (bundle: ActivityAttestationBundle, options: VerifyActivityOptions) => Promise<ActivityVerifyResult>;
  };
  payment: {
     authorize: (opts: PaymentAuthorizeOptions) => Promise<PaymentResult>;
  };
  scope: {
     granted: (options: GrantedOptions) => Promise<GrantedResult>;
     parseTrustAttestationCount: (value: string) => 
        | TrustAttestationCount
       | null;
     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 | null | undefined, kid: string | null | undefined, options: VerifyOptions) => Promise<VerifyResult>;
  };
};

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

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(), oc.family.scopes(), oc.identity.verifyActivityAttestation().

Type Declaration