Fulfillment

External fulfillment benefit schema and validated constructor; no callbacks run during construction or replay.

Declaration

const Fulfillment: Schema.Union<readonly [Schema.Struct<{
  entitlement: Schema.brand<Schema.String, "EntitlementKey">;
  validity: Schema.Literal<"while_entitled">;
  type: Schema.tag<"external_fulfillment">;
  binding: Schema.Struct<{
     key: Schema.brand<Schema.String, "FulfillmentBindingKey">;
     revision: Schema.brand<Schema.Int, "DefinitionRevision">;
  }>;
}>]> & {
  discriminants: readonly ["external_fulfillment"];
  cases: {
     external_fulfillment: Schema.Struct<{
        entitlement: Schema.brand<Schema.String, "EntitlementKey">;
        validity: Schema.Literal<"while_entitled">;
        type: Schema.tag<"external_fulfillment">;
        binding: Schema.Struct<{
           key: Schema.brand<Schema.String, "FulfillmentBindingKey">;
           revision: Schema.brand<Schema.Int, "DefinitionRevision">;
        }>;
     }>;
  };
  isAnyOf: <Keys>(keys) => (value) => value is Extract<{ entitlement: string & any; validity: "while_entitled"; type: "external_fulfillment"; binding: { key: string & any; revision: number & any } }, { type: Keys }>;
  guards: {
     external_fulfillment: (u) => u is { entitlement: string & any; validity: "while_entitled"; type: "external_fulfillment"; binding: { key: string & any; revision: number & any } };
  };
  match: {
   <Cases>  (value, cases): Cases[keyof Cases] extends (value) => R ? any : never;
   <Cases>  (cases): (value) => Cases[keyof Cases] extends (value) => R ? any : never;
  };
} & {
  external: (input) => Effect.Effect<typeof FulfillmentBenefit.Type, Schema.SchemaError>;
};

Type Declaration

discriminants

readonly discriminants: readonly ["external_fulfillment"];

cases

readonly cases: {
  external_fulfillment: Schema.Struct<{
     entitlement: Schema.brand<Schema.String, "EntitlementKey">;
     validity: Schema.Literal<"while_entitled">;
     type: Schema.tag<"external_fulfillment">;
     binding: Schema.Struct<{
        key: Schema.brand<Schema.String, "FulfillmentBindingKey">;
        revision: Schema.brand<Schema.Int, "DefinitionRevision">;
     }>;
  }>;
};

cases.external_fulfillment

external_fulfillment: Schema.Struct<{
  entitlement: Schema.brand<Schema.String, "EntitlementKey">;
  validity: Schema.Literal<"while_entitled">;
  type: Schema.tag<"external_fulfillment">;
  binding: Schema.Struct<{
     key: Schema.brand<Schema.String, "FulfillmentBindingKey">;
     revision: Schema.brand<Schema.Int, "DefinitionRevision">;
  }>;
}>;

isAnyOf

readonly isAnyOf: <Keys>(keys) => (value) => value is Extract<{ entitlement: string & any; validity: "while_entitled"; type: "external_fulfillment"; binding: { key: string & any; revision: number & any } }, { type: Keys }>;

Type Parameters

Keys

Keys

Parameters

keys

readonly Keys[]

Returns

(value) => value is Extract<{ entitlement: string & any; validity: "while_entitled"; type: "external_fulfillment"; binding: { key: string & any; revision: number & any } }, { type: Keys }>

guards

readonly guards: {
  external_fulfillment: (u) => u is { entitlement: string & any; validity: "while_entitled"; type: "external_fulfillment"; binding: { key: string & any; revision: number & any } };
};

guards.external_fulfillment

external_fulfillment: (u) => u is { entitlement: string & any; validity: "while_entitled"; type: "external_fulfillment"; binding: { key: string & any; revision: number & any } };

Parameters

u

unknown

Returns

u is { entitlement: string & any; validity: "while_entitled"; type: "external_fulfillment"; binding: { key: string & any; revision: number & any } }

match

readonly match: {
<Cases>  (value, cases): Cases[keyof Cases] extends (value) => R ? any : never;
<Cases>  (cases): (value) => Cases[keyof Cases] extends (value) => R ? any : never;
};

Call Signature

<Cases>(value, cases): Cases[keyof Cases] extends (value) => R ? any : never;

Type Parameters

Cases

Cases extends { [key: string]: (value) => any; }

Parameters

value

entitlement

string & any

validity

"while_entitled"

type

"external_fulfillment"

binding

{ key: string & any; revision: number & any; }

binding.key

string & any

binding.revision

number & any

cases

Cases

Returns

Cases[keyof Cases] extends (value) => R ? any : never

Call Signature

<Cases>(cases): (value) => Cases[keyof Cases] extends (value) => R ? any : never;

Type Parameters

Cases

Cases extends { [key: string]: (value) => any; }

Parameters

cases

Cases

Returns

(value) => Cases[keyof Cases] extends (value) => R ? any : never

Type Declaration

external

external: (input) => Effect.Effect<typeof FulfillmentBenefit.Type, Schema.SchemaError>;

Parses desired external fulfillment associated with a same-purchase entitlement.

Parameters

input

Omit<typeof FulfillmentBenefit.Encoded, "type" | "validity">

Returns

Effect.Effect<typeof FulfillmentBenefit.Type, Schema.SchemaError>