@everfur/sdk 0.12.1 → 0.14.0

package/dist/server/index.d.cts

@@ -1,10 +1,10 @@
-import { E as EverfurResult } from '../EverfurResult-COlXj1wq.cjs';
-import { j as FetchLike } from '../config-C9zhanL-.cjs';
-import { a as PartnerServerClient } from '../pets-CfutxNs9.cjs';
-export { b as PartnerPet, P as PartnerPetProfile, c as PartnerPetTarget, d as PartnerPetWithProfile, e as deletePartnerPet, g as getPartnerPet, u as updatePartnerPet, f as upsertPartnerPet } from '../pets-CfutxNs9.cjs';
-export { b as PetActivityLevel, c as PetAllergy, d as PetAllergySeverity, e as PetBirthDatePrecision, f as PetCondition, a as PetHealthProfile, P as PetHealthProfileInput, g as PetIndoorOutdoor, h as PetMedication, i as PetSex } from '../profile-CSs1wlXT.cjs';
-export { C as CanonicalPetSpecies, c as canonicalPetSpecies } from '../species-BXAIMh7I.cjs';
-import '../EverfurError-DeBqRpQV.cjs';
+import { E as EverfurResult } from '../EverfurResult.d-BFH-3s6E.cjs';
+import { j as FetchLike } from '../config.d-DJ4mvf_w.cjs';
+import { a as PartnerServerClient } from '../pets.d-nNAVnw7f.cjs';
+export { b as PartnerPet, P as PartnerPetProfile, c as PartnerPetTarget, d as PartnerPetWithProfile, e as deletePartnerPet, g as getPartnerPet, u as updatePartnerPet, f as upsertPartnerPet } from '../pets.d-nNAVnw7f.cjs';
+export { b as PetActivityLevel, c as PetAllergy, d as PetAllergySeverity, e as PetBirthDatePrecision, f as PetCondition, a as PetHealthProfile, P as PetHealthProfileInput, g as PetIndoorOutdoor, h as PetMedication, i as PetSex } from '../profile.d-CSs1wlXT.cjs';
+export { C as CanonicalPetSpecies, c as canonicalPetSpecies } from '../species.d-BXAIMh7I.cjs';
+import '../EverfurError.d-8NHtlgzA.cjs';
 
 /**
  * Validate a partner user_ref at the SDK boundary (server re-validates). SPEC-21 section 1.1.
@@ -95,6 +95,150 @@ interface PartnerMemberNotificationProfile {
  */
 declare function setPartnerMemberNotificationProfile(client: PartnerServerClient, input: SetPartnerMemberNotificationProfileInput): Promise<EverfurResult<PartnerMemberNotificationProfile>>;
 
+interface SendMemberTextInput {
+    /** Your stable member id (the session mint's user_ref rule). */
+    readonly userRef: string;
+    /** An approved template on your texting profile. */
+    readonly templateKey: string;
+    /** Values for the template's `{placeholders}`, exactly the template's own. Strings only, one line each. */
+    readonly vars?: Readonly<Record<string, string>>;
+    /** Required. Your key for this text (1 to 120 of `A-Z a-z 0-9 . _ : -`). A retry with the same key never texts twice. */
+    readonly idempotencyKey: string;
+}
+/** What Everfur accepted. Delivery is asynchronous; this is the acceptance, not the handset's receipt. */
+interface MemberTextReceipt {
+    /** Everfur's id for the text, or null when the answer carried none. */
+    readonly textId: string | null;
+    /** The text's state as Everfur reported it (`queued`, `sending`, `sent`, `withheld`, `failed`), or null. */
+    readonly status: string | null;
+    /** True when `idempotencyKey` matched an earlier text and this is that text; null when the answer did not say. */
+    readonly duplicate: boolean | null;
+}
+/**
+ * Text a member one of your approved templates. Settles an `EverfurResult`; throws `EverfurConfigError` only for a
+ * request that can never be accepted (a malformed or missing secret key or `idempotencyKey`, `userRef`, template key
+ * or vars).
+ */
+declare function sendMemberText(client: PartnerServerClient, input: SendMemberTextInput): Promise<EverfurResult<MemberTextReceipt>>;
+
+/** The species a product can be for. */
+type PartnerCatalogSpecies = 'dog' | 'cat';
+/** Why a product suits a pet: a fact the pet can have, and your words shown when it does. */
+interface PartnerCatalogReasonTag {
+    /** `species:dog|cat`, `life_stage:young|adult|senior`, `size:small|medium|large` or `breed:<slug>`. */
+    readonly tag: string;
+    /** Your words, shown as the reason (1 to 120 characters). */
+    readonly text: string;
+}
+/** Units a day for a pet up to `maxWeightKg`. */
+interface PartnerCatalogDoseBand {
+    /** Above 0, at most 200. Null or absent means no upper bound, and only the last band may leave it out. */
+    readonly maxWeightKg?: number | null;
+    /** Above 0, at most 50. */
+    readonly unitsPerDay: number;
+}
+/** A product's Health Plan subscription terms. A product without them is not subscribable. */
+interface PartnerCatalogSubscription {
+    /** Whole units in one box, 1 to 10,000. */
+    readonly unitsPerBox: number;
+    /** What a unit is called (`chew`, `soft chew`), 1 to 30 letters, spaces or hyphens, starting with a letter. */
+    readonly unitLabel: string;
+    /** 1 to 10 bands, sorted by `maxWeightKg`, ascending and distinct. */
+    readonly doseBands: readonly PartnerCatalogDoseBand[];
+    /** Whole percent off the first box, 0 to 90. Default 0. */
+    readonly firstBoxDiscountPercent?: number;
+    /** Whole percent off a one-time box (no renewal), 0 to 90. Default 0. */
+    readonly oneBoxDiscountPercent?: number;
+}
+/** One review you quote for a product, shown as you wrote it. */
+interface PartnerCatalogReview {
+    /** Whole stars, 1 to 5. */
+    readonly stars: number;
+    /** 1 to 300 characters. */
+    readonly text: string;
+    /** Who wrote it, 1 to 80 characters. */
+    readonly by: string;
+}
+/** One product as you sell it. */
+interface PartnerCatalogProduct {
+    /** Your own id for the product; unique within your catalog (1 to 120 characters). */
+    readonly partnerSku: string;
+    /** 1 to 200 characters. */
+    readonly title: string;
+    /** Up to 600 characters. */
+    readonly description?: string | null;
+    /** The product form as you name it (for example `chew`, `tablet`), up to 60 characters. */
+    readonly form?: string | null;
+    /** The species it is for. Empty means any. */
+    readonly species?: readonly PartnerCatalogSpecies[];
+    /** The price in `currency`, or null when you do not publish one. 0 to 1,000,000. */
+    readonly price?: number | null;
+    /** ISO 4217 (`USD`). Everfur reads a product without one as USD. */
+    readonly currency?: string | null;
+    /** Your product page. https only. */
+    readonly url?: string | null;
+    /** The product picture. https only. */
+    readonly imageUrl?: string | null;
+    /** Up to 60 characters. */
+    readonly category?: string | null;
+    /** Up to 20 reasons the plan can show for this product. */
+    readonly reasonTags?: readonly PartnerCatalogReasonTag[];
+    /** Mark a demo product: the plan labels it as a sample (when your tenant's sample label is on). */
+    readonly sample?: boolean;
+    /** Subscription terms; needs a `price` above 0. Absent (or null) means the product is not subscribable. */
+    readonly subscription?: PartnerCatalogSubscription | null;
+    /** The star rating, 0 to 5 (Everfur keeps one decimal). */
+    readonly rating?: number | null;
+    /** How many reviews the rating rests on, a whole number from 0 to 100,000,000. */
+    readonly reviewCount?: number | null;
+    /** Up to 5 reviews. */
+    readonly reviews?: readonly PartnerCatalogReview[];
+    /** Up to 12 ingredients, each 1 to 60 characters (trimmed). */
+    readonly ingredients?: readonly string[];
+}
+interface ReplaceCatalogInput {
+    readonly products: readonly PartnerCatalogProduct[];
+    /**
+     * An EMPTY `products` really means "withdraw every product". Without it Everfur refuses an empty list while you
+     * still have an active product that is not a sample (409, `reasonCode` `catalog_empty_refused`), so a feed that
+     * failed to read never wipes the catalog. Sent only when true.
+     */
+    readonly confirmEmpty?: boolean;
+    /**
+     * Leaving out most of a large catalog is meant. Without it Everfur refuses a list that would deactivate at least 20
+     * active real products and more than half of them (409, `reasonCode` `catalog_shrink_refused`). Sent only when true.
+     */
+    readonly confirmShrink?: boolean;
+}
+interface MergeCatalogInput {
+    /** Products to add or change. An existing SKU is changed field by field (the header says how). */
+    readonly products?: readonly PartnerCatalogProduct[];
+    /** SKUs to deactivate (never delete). A SKU that is not active is a no-op; none may also be in `products`. */
+    readonly remove?: readonly string[];
+}
+/** What the replace changed, as Everfur counted it. A value the answer did not carry is null. */
+interface CatalogReplaceResult {
+    /** Products written (new or updated) by this replace. */
+    readonly active: number | null;
+    /** Products this replace deactivated because the list left them out. */
+    readonly deactivated: number | null;
+    /** Everfur's id for this sync run, for a support conversation. */
+    readonly syncRunId: string | null;
+    /** The SKUs this call deactivated, as Everfur stored them; null when the answer did not list them. */
+    readonly deactivatedSkus: readonly string[] | null;
+}
+/**
+ * Replace your whole product catalog. Settles an `EverfurResult`; throws `EverfurConfigError` only for a request that
+ * can never be accepted (a malformed key, a duplicate SKU, a product without a title, a field over its limit).
+ */
+declare function replaceCatalog(client: PartnerServerClient, input: ReplaceCatalogInput): Promise<EverfurResult<CatalogReplaceResult>>;
+/**
+ * Add, change or withdraw some products without resending the catalog (`mode: "merge"`). Every product you do not
+ * name is left as it is. Settles an `EverfurResult`; throws `EverfurConfigError` only for a request that can never be
+ * accepted (nothing to do, a SKU both listed and removed, a field over its limit).
+ */
+declare function mergeCatalog(client: PartnerServerClient, input: MergeCatalogInput): Promise<EverfurResult<CatalogReplaceResult>>;
+
 interface MintSessionParams {
     /** env-derived base URL (resolveApiBaseUrl output), no trailing slash. */
     readonly apiBaseUrl: string;
@@ -125,4 +269,4 @@ interface SessionMint {
  */
 declare function mintPartnerSession(params: MintSessionParams): Promise<EverfurResult<SessionMint>>;
 
-export { type MintSessionParams, type PartnerMemberEmailConsent, type PartnerMemberEmailConsentRecord, type PartnerMemberNotificationProfile, type PartnerMemberSessionsRevocation, PartnerServerClient, type RevokePartnerMemberSessionsInput, type SessionMint, type SetPartnerMemberNotificationProfileInput, assertValidUserRef, mintPartnerSession, revokePartnerMemberSessions, setPartnerMemberNotificationProfile };
+export { type CatalogReplaceResult, type MemberTextReceipt, type MergeCatalogInput, type MintSessionParams, type PartnerCatalogDoseBand, type PartnerCatalogProduct, type PartnerCatalogReasonTag, type PartnerCatalogReview, type PartnerCatalogSpecies, type PartnerCatalogSubscription, type PartnerMemberEmailConsent, type PartnerMemberEmailConsentRecord, type PartnerMemberNotificationProfile, type PartnerMemberSessionsRevocation, PartnerServerClient, type ReplaceCatalogInput, type RevokePartnerMemberSessionsInput, type SendMemberTextInput, type SessionMint, type SetPartnerMemberNotificationProfileInput, assertValidUserRef, mergeCatalog, mintPartnerSession, replaceCatalog, revokePartnerMemberSessions, sendMemberText, setPartnerMemberNotificationProfile };

package/dist/server/index.d.ts

@@ -1,10 +1,10 @@
-import { E as EverfurResult } from '../EverfurResult-ClPTS0P2.js';
-import { j as FetchLike } from '../config-C5iPNKDj.js';
-import { a as PartnerServerClient } from '../pets-LIGadUtr.js';
-export { b as PartnerPet, P as PartnerPetProfile, c as PartnerPetTarget, d as PartnerPetWithProfile, e as deletePartnerPet, g as getPartnerPet, u as updatePartnerPet, f as upsertPartnerPet } from '../pets-LIGadUtr.js';
-export { b as PetActivityLevel, c as PetAllergy, d as PetAllergySeverity, e as PetBirthDatePrecision, f as PetCondition, a as PetHealthProfile, P as PetHealthProfileInput, g as PetIndoorOutdoor, h as PetMedication, i as PetSex } from '../profile-CSs1wlXT.js';
-export { C as CanonicalPetSpecies, c as canonicalPetSpecies } from '../species-BXAIMh7I.js';
-import '../EverfurError-DeBqRpQV.js';
+import { E as EverfurResult } from '../EverfurResult.d-D_-254ZY.js';
+import { j as FetchLike } from '../config.d-MX7IKP2f.js';
+import { a as PartnerServerClient } from '../pets.d-BFT_b53y.js';
+export { b as PartnerPet, P as PartnerPetProfile, c as PartnerPetTarget, d as PartnerPetWithProfile, e as deletePartnerPet, g as getPartnerPet, u as updatePartnerPet, f as upsertPartnerPet } from '../pets.d-BFT_b53y.js';
+export { b as PetActivityLevel, c as PetAllergy, d as PetAllergySeverity, e as PetBirthDatePrecision, f as PetCondition, a as PetHealthProfile, P as PetHealthProfileInput, g as PetIndoorOutdoor, h as PetMedication, i as PetSex } from '../profile.d-CSs1wlXT.js';
+export { C as CanonicalPetSpecies, c as canonicalPetSpecies } from '../species.d-BXAIMh7I.js';
+import '../EverfurError.d-8NHtlgzA.js';
 
 /**
  * Validate a partner user_ref at the SDK boundary (server re-validates). SPEC-21 section 1.1.
@@ -95,6 +95,150 @@ interface PartnerMemberNotificationProfile {
  */
 declare function setPartnerMemberNotificationProfile(client: PartnerServerClient, input: SetPartnerMemberNotificationProfileInput): Promise<EverfurResult<PartnerMemberNotificationProfile>>;
 
+interface SendMemberTextInput {
+    /** Your stable member id (the session mint's user_ref rule). */
+    readonly userRef: string;
+    /** An approved template on your texting profile. */
+    readonly templateKey: string;
+    /** Values for the template's `{placeholders}`, exactly the template's own. Strings only, one line each. */
+    readonly vars?: Readonly<Record<string, string>>;
+    /** Required. Your key for this text (1 to 120 of `A-Z a-z 0-9 . _ : -`). A retry with the same key never texts twice. */
+    readonly idempotencyKey: string;
+}
+/** What Everfur accepted. Delivery is asynchronous; this is the acceptance, not the handset's receipt. */
+interface MemberTextReceipt {
+    /** Everfur's id for the text, or null when the answer carried none. */
+    readonly textId: string | null;
+    /** The text's state as Everfur reported it (`queued`, `sending`, `sent`, `withheld`, `failed`), or null. */
+    readonly status: string | null;
+    /** True when `idempotencyKey` matched an earlier text and this is that text; null when the answer did not say. */
+    readonly duplicate: boolean | null;
+}
+/**
+ * Text a member one of your approved templates. Settles an `EverfurResult`; throws `EverfurConfigError` only for a
+ * request that can never be accepted (a malformed or missing secret key or `idempotencyKey`, `userRef`, template key
+ * or vars).
+ */
+declare function sendMemberText(client: PartnerServerClient, input: SendMemberTextInput): Promise<EverfurResult<MemberTextReceipt>>;
+
+/** The species a product can be for. */
+type PartnerCatalogSpecies = 'dog' | 'cat';
+/** Why a product suits a pet: a fact the pet can have, and your words shown when it does. */
+interface PartnerCatalogReasonTag {
+    /** `species:dog|cat`, `life_stage:young|adult|senior`, `size:small|medium|large` or `breed:<slug>`. */
+    readonly tag: string;
+    /** Your words, shown as the reason (1 to 120 characters). */
+    readonly text: string;
+}
+/** Units a day for a pet up to `maxWeightKg`. */
+interface PartnerCatalogDoseBand {
+    /** Above 0, at most 200. Null or absent means no upper bound, and only the last band may leave it out. */
+    readonly maxWeightKg?: number | null;
+    /** Above 0, at most 50. */
+    readonly unitsPerDay: number;
+}
+/** A product's Health Plan subscription terms. A product without them is not subscribable. */
+interface PartnerCatalogSubscription {
+    /** Whole units in one box, 1 to 10,000. */
+    readonly unitsPerBox: number;
+    /** What a unit is called (`chew`, `soft chew`), 1 to 30 letters, spaces or hyphens, starting with a letter. */
+    readonly unitLabel: string;
+    /** 1 to 10 bands, sorted by `maxWeightKg`, ascending and distinct. */
+    readonly doseBands: readonly PartnerCatalogDoseBand[];
+    /** Whole percent off the first box, 0 to 90. Default 0. */
+    readonly firstBoxDiscountPercent?: number;
+    /** Whole percent off a one-time box (no renewal), 0 to 90. Default 0. */
+    readonly oneBoxDiscountPercent?: number;
+}
+/** One review you quote for a product, shown as you wrote it. */
+interface PartnerCatalogReview {
+    /** Whole stars, 1 to 5. */
+    readonly stars: number;
+    /** 1 to 300 characters. */
+    readonly text: string;
+    /** Who wrote it, 1 to 80 characters. */
+    readonly by: string;
+}
+/** One product as you sell it. */
+interface PartnerCatalogProduct {
+    /** Your own id for the product; unique within your catalog (1 to 120 characters). */
+    readonly partnerSku: string;
+    /** 1 to 200 characters. */
+    readonly title: string;
+    /** Up to 600 characters. */
+    readonly description?: string | null;
+    /** The product form as you name it (for example `chew`, `tablet`), up to 60 characters. */
+    readonly form?: string | null;
+    /** The species it is for. Empty means any. */
+    readonly species?: readonly PartnerCatalogSpecies[];
+    /** The price in `currency`, or null when you do not publish one. 0 to 1,000,000. */
+    readonly price?: number | null;
+    /** ISO 4217 (`USD`). Everfur reads a product without one as USD. */
+    readonly currency?: string | null;
+    /** Your product page. https only. */
+    readonly url?: string | null;
+    /** The product picture. https only. */
+    readonly imageUrl?: string | null;
+    /** Up to 60 characters. */
+    readonly category?: string | null;
+    /** Up to 20 reasons the plan can show for this product. */
+    readonly reasonTags?: readonly PartnerCatalogReasonTag[];
+    /** Mark a demo product: the plan labels it as a sample (when your tenant's sample label is on). */
+    readonly sample?: boolean;
+    /** Subscription terms; needs a `price` above 0. Absent (or null) means the product is not subscribable. */
+    readonly subscription?: PartnerCatalogSubscription | null;
+    /** The star rating, 0 to 5 (Everfur keeps one decimal). */
+    readonly rating?: number | null;
+    /** How many reviews the rating rests on, a whole number from 0 to 100,000,000. */
+    readonly reviewCount?: number | null;
+    /** Up to 5 reviews. */
+    readonly reviews?: readonly PartnerCatalogReview[];
+    /** Up to 12 ingredients, each 1 to 60 characters (trimmed). */
+    readonly ingredients?: readonly string[];
+}
+interface ReplaceCatalogInput {
+    readonly products: readonly PartnerCatalogProduct[];
+    /**
+     * An EMPTY `products` really means "withdraw every product". Without it Everfur refuses an empty list while you
+     * still have an active product that is not a sample (409, `reasonCode` `catalog_empty_refused`), so a feed that
+     * failed to read never wipes the catalog. Sent only when true.
+     */
+    readonly confirmEmpty?: boolean;
+    /**
+     * Leaving out most of a large catalog is meant. Without it Everfur refuses a list that would deactivate at least 20
+     * active real products and more than half of them (409, `reasonCode` `catalog_shrink_refused`). Sent only when true.
+     */
+    readonly confirmShrink?: boolean;
+}
+interface MergeCatalogInput {
+    /** Products to add or change. An existing SKU is changed field by field (the header says how). */
+    readonly products?: readonly PartnerCatalogProduct[];
+    /** SKUs to deactivate (never delete). A SKU that is not active is a no-op; none may also be in `products`. */
+    readonly remove?: readonly string[];
+}
+/** What the replace changed, as Everfur counted it. A value the answer did not carry is null. */
+interface CatalogReplaceResult {
+    /** Products written (new or updated) by this replace. */
+    readonly active: number | null;
+    /** Products this replace deactivated because the list left them out. */
+    readonly deactivated: number | null;
+    /** Everfur's id for this sync run, for a support conversation. */
+    readonly syncRunId: string | null;
+    /** The SKUs this call deactivated, as Everfur stored them; null when the answer did not list them. */
+    readonly deactivatedSkus: readonly string[] | null;
+}
+/**
+ * Replace your whole product catalog. Settles an `EverfurResult`; throws `EverfurConfigError` only for a request that
+ * can never be accepted (a malformed key, a duplicate SKU, a product without a title, a field over its limit).
+ */
+declare function replaceCatalog(client: PartnerServerClient, input: ReplaceCatalogInput): Promise<EverfurResult<CatalogReplaceResult>>;
+/**
+ * Add, change or withdraw some products without resending the catalog (`mode: "merge"`). Every product you do not
+ * name is left as it is. Settles an `EverfurResult`; throws `EverfurConfigError` only for a request that can never be
+ * accepted (nothing to do, a SKU both listed and removed, a field over its limit).
+ */
+declare function mergeCatalog(client: PartnerServerClient, input: MergeCatalogInput): Promise<EverfurResult<CatalogReplaceResult>>;
+
 interface MintSessionParams {
     /** env-derived base URL (resolveApiBaseUrl output), no trailing slash. */
     readonly apiBaseUrl: string;
@@ -125,4 +269,4 @@ interface SessionMint {
  */
 declare function mintPartnerSession(params: MintSessionParams): Promise<EverfurResult<SessionMint>>;
 
-export { type MintSessionParams, type PartnerMemberEmailConsent, type PartnerMemberEmailConsentRecord, type PartnerMemberNotificationProfile, type PartnerMemberSessionsRevocation, PartnerServerClient, type RevokePartnerMemberSessionsInput, type SessionMint, type SetPartnerMemberNotificationProfileInput, assertValidUserRef, mintPartnerSession, revokePartnerMemberSessions, setPartnerMemberNotificationProfile };
+export { type CatalogReplaceResult, type MemberTextReceipt, type MergeCatalogInput, type MintSessionParams, type PartnerCatalogDoseBand, type PartnerCatalogProduct, type PartnerCatalogReasonTag, type PartnerCatalogReview, type PartnerCatalogSpecies, type PartnerCatalogSubscription, type PartnerMemberEmailConsent, type PartnerMemberEmailConsentRecord, type PartnerMemberNotificationProfile, type PartnerMemberSessionsRevocation, PartnerServerClient, type ReplaceCatalogInput, type RevokePartnerMemberSessionsInput, type SendMemberTextInput, type SessionMint, type SetPartnerMemberNotificationProfileInput, assertValidUserRef, mergeCatalog, mintPartnerSession, replaceCatalog, revokePartnerMemberSessions, sendMemberText, setPartnerMemberNotificationProfile };