@encorekit/web-sdk 2.0.7 → 2.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -0
- package/dist/cjs/index.cjs +1 -1
- package/dist/cjs/index.cjs.map +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/index.js.map +1 -1
- package/dist/umd/encore.min.js +1 -1
- package/dist/umd/encore.min.js.map +1 -1
- package/package.json +1 -1
- package/types/api/APIClient.d.ts +18 -0
- package/types/api/APIClient.d.ts.map +1 -1
- package/types/api/generated/types.d.ts +177 -2
- package/types/api/generated/types.d.ts.map +1 -1
- package/types/api/models.d.ts +32 -0
- package/types/api/models.d.ts.map +1 -1
- package/types/core/Encore.d.ts.map +1 -1
- package/types/core/giftVariant.d.ts +67 -0
- package/types/core/giftVariant.d.ts.map +1 -0
- package/types/core/version.d.ts +1 -1
- package/types/types.d.ts +31 -3
- package/types/types.d.ts.map +1 -1
- package/types/ui/GiftHero.d.ts +75 -0
- package/types/ui/GiftHero.d.ts.map +1 -0
- package/types/ui/GiftList.d.ts +110 -0
- package/types/ui/GiftList.d.ts.map +1 -0
- package/types/ui/GiftReveal.d.ts +133 -0
- package/types/ui/GiftReveal.d.ts.map +1 -0
- package/types/ui/GiftSheet.d.ts +126 -0
- package/types/ui/GiftSheet.d.ts.map +1 -0
- package/types/ui/GiftUnwrap.d.ts +155 -0
- package/types/ui/GiftUnwrap.d.ts.map +1 -0
- package/types/ui/OfferCarousel.d.ts +10 -3
- package/types/ui/OfferCarousel.d.ts.map +1 -1
- package/types/ui/OfferModal.d.ts +7 -0
- package/types/ui/OfferModal.d.ts.map +1 -1
- package/types/ui/RewardActions.d.ts +88 -4
- package/types/ui/RewardActions.d.ts.map +1 -1
- package/types/ui/RewardCard.d.ts +16 -8
- package/types/ui/RewardCard.d.ts.map +1 -1
- package/types/ui/RewardConfetti.d.ts +23 -1
- package/types/ui/RewardConfetti.d.ts.map +1 -1
- package/types/ui/RewardLayout.d.ts +35 -0
- package/types/ui/RewardLayout.d.ts.map +1 -1
- package/types/ui/advertiserPreconnect.d.ts +90 -0
- package/types/ui/advertiserPreconnect.d.ts.map +1 -0
- package/types/ui/appearance.d.ts +27 -0
- package/types/ui/appearance.d.ts.map +1 -1
- package/types/ui/focusable.d.ts +41 -0
- package/types/ui/focusable.d.ts.map +1 -0
- package/types/ui/giftCategoryGroups.d.ts +21 -0
- package/types/ui/giftCategoryGroups.d.ts.map +1 -0
- package/types/ui/giftCopy.d.ts +215 -0
- package/types/ui/giftCopy.d.ts.map +1 -0
- package/types/ui/giftUnwrapArt.d.ts +55 -0
- package/types/ui/giftUnwrapArt.d.ts.map +1 -0
- package/types/ui/giftUnwrapCopy.d.ts +57 -0
- package/types/ui/giftUnwrapCopy.d.ts.map +1 -0
- package/types/ui/impressionGate.d.ts +63 -0
- package/types/ui/impressionGate.d.ts.map +1 -0
- package/types/ui/offerBadge.d.ts +56 -0
- package/types/ui/offerBadge.d.ts.map +1 -0
- package/types/ui/rewardSurface.d.ts +82 -0
- package/types/ui/rewardSurface.d.ts.map +1 -0
- package/types/ui/safeImageSrc.d.ts +10 -0
- package/types/ui/safeImageSrc.d.ts.map +1 -1
- package/types/ui/styles.d.ts +166 -0
- package/types/ui/styles.d.ts.map +1 -1
- package/types/ui/termsLine.d.ts +33 -0
- package/types/ui/termsLine.d.ts.map +1 -0
package/package.json
CHANGED
package/types/api/APIClient.d.ts
CHANGED
|
@@ -6,6 +6,24 @@
|
|
|
6
6
|
import type { UserAttributes, Entitlement, VerificationStatus, UseCase } from '../types';
|
|
7
7
|
import type { StartTransactionResponse, InitUserResponse, IdentifyUserResponse, RemoteConfigResponse, OfferModel, BackendVerificationStatus } from './models';
|
|
8
8
|
import type { ErrorContext } from '../core/errorContext';
|
|
9
|
+
/**
|
|
10
|
+
* The campaign's shelf category, read TOLERANTLY from a field the contract does not
|
|
11
|
+
* define yet.
|
|
12
|
+
*
|
|
13
|
+
* ⚠️ `campaign.category` is a PROPOSAL pending a Backend Change Report — the generated
|
|
14
|
+
* `Campaign` type has no such key, which is why this reads through `unknown` instead
|
|
15
|
+
* of a typed property. Only a non-blank string is kept (trimmed); anything else, and
|
|
16
|
+
* the field's absence, is `undefined`, so a response from today's backend maps
|
|
17
|
+
* exactly as it did before this reader existed. If the BCR lands with a different
|
|
18
|
+
* name or shape, this function is the one place to change.
|
|
19
|
+
*/
|
|
20
|
+
export declare function readProposedCategory(campaign: unknown): string | undefined;
|
|
21
|
+
/**
|
|
22
|
+
* A campaign-level URL (`heroImageUrl`, `termsUrl`), read tolerantly: a non-blank string,
|
|
23
|
+
* trimmed, that passes the SDK's https guard. Anything else, a `javascript:` or plain
|
|
24
|
+
* `http:` row included, is dropped, so a bad row can never inject a scheme.
|
|
25
|
+
*/
|
|
26
|
+
export declare function readCampaignUrl(campaign: unknown, key: 'heroImageUrl' | 'termsUrl'): string | undefined;
|
|
9
27
|
interface RequestOptions {
|
|
10
28
|
method: 'GET' | 'POST' | 'PATCH';
|
|
11
29
|
headers?: Record<string, string>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"APIClient.d.ts","sourceRoot":"","sources":["../../src/api/APIClient.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAe,cAAc,EAAE,WAAW,EAAE,kBAAkB,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;
|
|
1
|
+
{"version":3,"file":"APIClient.d.ts","sourceRoot":"","sources":["../../src/api/APIClient.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAe,cAAc,EAAE,WAAW,EAAE,kBAAkB,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAGtG,OAAO,KAAK,EAEV,wBAAwB,EAIxB,gBAAgB,EAChB,oBAAoB,EACpB,oBAAoB,EACpB,UAAU,EACV,yBAAyB,EAC1B,MAAM,UAAU,CAAC;AAalB,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAOzD;;;;;;;;;;GAUG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAM1E;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAC7B,QAAQ,EAAE,OAAO,EACjB,GAAG,EAAE,cAAc,GAAG,UAAU,GAC/B,MAAM,GAAG,SAAS,CAKpB;AAMD,UAAU,cAAc;IACtB,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,CAAC;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAQD,qBAAa,SAAS;;gBAKR,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAM3C;;OAEG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAI/B;;OAEG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAIjC;;OAEG;IACG,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAW7E;;OAEG;IACG,IAAI,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAY9F;;OAEG;IACG,KAAK,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAsP/F;;;;;;;;;;;;;;;;;OAiBG;IACG,WAAW,CACf,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,cAAc,EAC1B,WAAW,CAAC,EAAE,MAAM,EACpB,iBAAiB,CAAC,EAAE,MAAM,GACzB,OAAO,CAAC;QAAE,MAAM,EAAE,UAAU,EAAE,CAAA;KAAE,CAAC;IA4FpC;;;;;;;OAOG;IACG,gBAAgB,CACpB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,wBAAwB,CAAC;IAcpC;;OAEG;IACG,eAAe,CACnB,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,aAAa,GAAG,OAAO,GACjC,OAAO,CAAC,OAAO,CAAC;IAanB;;OAEG;IACG,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAyE/D;;OAEG;IACG,uBAAuB,CAC3B,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC;QAAE,MAAM,EAAE,kBAAkB,CAAC;QAAC,GAAG,EAAE,yBAAyB,GAAG,IAAI,CAAA;KAAE,CAAC;IAcjF;;OAEG;IACG,QAAQ,CACZ,MAAM,EAAE,MAAM,EACd,UAAU,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GAC7C,OAAO,CAAC,gBAAgB,CAAC;IAa5B;;OAEG;IACG,YAAY,CAChB,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,UAAU,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GAC7C,OAAO,CAAC,oBAAoB,CAAC;IAchC;;;;;;;;;;;;;;;;;OAiBG;IACG,WAAW,CACf,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,oBAAoB,CAAC;IAehC;;OAEG;IACG,WAAW,CAAC,MAAM,EAAE;QACxB,SAAS,EAAE,MAAM,CAAC;QAClB,OAAO,EAAE,MAAM,CAAC;QAChB,6FAA6F;QAC7F,OAAO,EAAE,YAAY,CAAC;QACtB,QAAQ,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC;QAClD,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KACnC,GAAG,OAAO,CAAC,IAAI,CAAC;IA0CjB;;OAEG;IACG,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;CAW3D"}
|
|
@@ -100,6 +100,10 @@ export interface paths {
|
|
|
100
100
|
* @enum {string|null}
|
|
101
101
|
*/
|
|
102
102
|
badgeLabel: "free_trial" | "discount" | null;
|
|
103
|
+
/** @description Fixed presentation image for gift reward surfaces. Null or absent: use the creative primaryImageUrl. */
|
|
104
|
+
heroImageUrl?: string | null;
|
|
105
|
+
/** @description https link to the advertiser offer terms. Null or absent: render terms copy as plain text. */
|
|
106
|
+
termsUrl?: string | null;
|
|
103
107
|
/** Format: date-time */
|
|
104
108
|
createdAt: string;
|
|
105
109
|
/** Format: date-time */
|
|
@@ -323,6 +327,11 @@ export interface paths {
|
|
|
323
327
|
placementId?: string;
|
|
324
328
|
/** @description Strict unlock mode: only include campaigns whose postback latency is less than or equal to this value (in milliseconds). Omit for no filtering. Bounded 1000..120000. */
|
|
325
329
|
maxPostbackTimeMs?: number;
|
|
330
|
+
/** @description Request-scoped serving context. Unknown keys are ignored. */
|
|
331
|
+
context?: {
|
|
332
|
+
/** @description Request-scoped activity the user is engaged in at serve time (what the surface is being used for, not a persisted user property). Recognized values: laundry, vending, car_wash, air_vacuum, amusement. Any other value is accepted and recorded on serve analytics, so unrecognized activities show up in reporting rather than failing the request. Does not change which offers are served today. */
|
|
333
|
+
activity?: string;
|
|
334
|
+
};
|
|
326
335
|
};
|
|
327
336
|
};
|
|
328
337
|
};
|
|
@@ -396,6 +405,10 @@ export interface paths {
|
|
|
396
405
|
* @enum {string|null}
|
|
397
406
|
*/
|
|
398
407
|
badgeLabel: "free_trial" | "discount" | null;
|
|
408
|
+
/** @description Fixed presentation image for gift reward surfaces. Null or absent: use the creative primaryImageUrl. */
|
|
409
|
+
heroImageUrl?: string | null;
|
|
410
|
+
/** @description https link to the advertiser offer terms. Null or absent: render terms copy as plain text. */
|
|
411
|
+
termsUrl?: string | null;
|
|
399
412
|
/** Format: date-time */
|
|
400
413
|
createdAt: string;
|
|
401
414
|
/** Format: date-time */
|
|
@@ -504,6 +517,8 @@ export interface paths {
|
|
|
504
517
|
/** Format: date-time */
|
|
505
518
|
updatedAt: string;
|
|
506
519
|
}[];
|
|
520
|
+
/** @description Display name of the campaign category, e.g. "Music and Audio". Free string: the taxonomy is admin-editable, so accept any value. */
|
|
521
|
+
category?: string | null;
|
|
507
522
|
}[];
|
|
508
523
|
metadata: {
|
|
509
524
|
/** @description Total offers available */
|
|
@@ -526,6 +541,18 @@ export interface paths {
|
|
|
526
541
|
};
|
|
527
542
|
};
|
|
528
543
|
/** @description Default Response */
|
|
544
|
+
400: {
|
|
545
|
+
headers: {
|
|
546
|
+
[name: string]: unknown;
|
|
547
|
+
};
|
|
548
|
+
content: {
|
|
549
|
+
"application/json": {
|
|
550
|
+
error: string;
|
|
551
|
+
details?: unknown;
|
|
552
|
+
};
|
|
553
|
+
};
|
|
554
|
+
};
|
|
555
|
+
/** @description Default Response */
|
|
529
556
|
401: {
|
|
530
557
|
headers: {
|
|
531
558
|
[name: string]: unknown;
|
|
@@ -959,6 +986,12 @@ export interface paths {
|
|
|
959
986
|
* @enum {string|null}
|
|
960
987
|
*/
|
|
961
988
|
badgeLabel: "free_trial" | "discount" | null;
|
|
989
|
+
/** @description Fixed presentation image for gift reward surfaces. Null or absent: use the creative primaryImageUrl. */
|
|
990
|
+
heroImageUrl?: string | null;
|
|
991
|
+
/** @description https link to the advertiser offer terms. Null or absent: render terms copy as plain text. */
|
|
992
|
+
termsUrl?: string | null;
|
|
993
|
+
/** @description Display name of the campaign category, e.g. "Music and Audio". Free string: the taxonomy is admin-editable, so accept any value. */
|
|
994
|
+
category?: string | null;
|
|
962
995
|
}[];
|
|
963
996
|
};
|
|
964
997
|
};
|
|
@@ -2367,7 +2400,7 @@ export interface paths {
|
|
|
2367
2400
|
};
|
|
2368
2401
|
};
|
|
2369
2402
|
};
|
|
2370
|
-
/** @description
|
|
2403
|
+
/** @description Assigned variant for every use case this app is enabled for other than the one REQUESTED, so the SDK can cache them at identify(). When the single-enabled-use-case fallback serves a different surface in `ui`, that surface also appears here under its own key, so a client that files `ui` under the requested use case still finds it. `ui` is unchanged; un-upgraded decoders ignore this key. */
|
|
2371
2404
|
useCases: {
|
|
2372
2405
|
"churn-intervention"?: {
|
|
2373
2406
|
/**
|
|
@@ -2742,6 +2775,136 @@ export interface paths {
|
|
|
2742
2775
|
};
|
|
2743
2776
|
trace?: never;
|
|
2744
2777
|
};
|
|
2778
|
+
"/publisher/sdk/v1/users/attributes": {
|
|
2779
|
+
parameters: {
|
|
2780
|
+
query?: never;
|
|
2781
|
+
header?: never;
|
|
2782
|
+
path?: never;
|
|
2783
|
+
cookie?: never;
|
|
2784
|
+
};
|
|
2785
|
+
get?: never;
|
|
2786
|
+
put?: never;
|
|
2787
|
+
/**
|
|
2788
|
+
* @description Store targeting attributes against a user, ahead of opening the hosted offer page, so the page URL carries only apiKey and userId instead of the attributes themselves. A URL is written into webview history and into hosting access logs and cannot be unwritten. Idempotent on (app, userId): each call REPLACES the previously stored set rather than merging into it. No expiry — the last set stays authoritative until a newer one arrives, and is removed by a data-subject erasure request.
|
|
2789
|
+
*
|
|
2790
|
+
* Precedence: an attribute sent on an /offers/search or /offers/feed request always WINS over the stored one. The stored set only fills an attribute the request omits.
|
|
2791
|
+
*
|
|
2792
|
+
* AGE. Send `age` as a whole-number integer. If you hold only a RANGE, send its LOWEST end — "13-17" is sent as 13, never 15 and never 17. Sending the middle of a range silently defeats the under-age check: flooring can never mask a minor, a midpoint can. An age below 18 restricts that user to age-appropriate inventory ranked by the app-level bandit, with NO per-user personalisation — offers are still served. For such a user only `age`, `countryCode` and `language` are STORED — the attributes that decide where an offer may legally appear and which creative locale renders; everything else you sent is discarded, `custom` included, and the response reports `minor`. The instant you sent the set is recorded, so a stored age is aged forward rather than frozen. `dateOfBirth` is refused: `age` carries the same targeting value with far less identifying power.
|
|
2793
|
+
*
|
|
2794
|
+
* GATED KEYS. email, firstName, lastName, mobile, phoneNumber, postcode, postalCode, latitude, longitude and gender are accepted ONLY from an app whose audience is declared adults_only (store-rated 18+). Any other status, including the default, is refused with 400. `age` is NOT gated — it is accepted from any app, because it is what restricts what a user is shown rather than something that identifies them. Unrecognised keys are refused rather than ignored. Authentication: publishable key (X-API-Key: pk_live_* / pk_test_*).
|
|
2795
|
+
*/
|
|
2796
|
+
post: {
|
|
2797
|
+
parameters: {
|
|
2798
|
+
query?: never;
|
|
2799
|
+
header?: never;
|
|
2800
|
+
path?: never;
|
|
2801
|
+
cookie?: never;
|
|
2802
|
+
};
|
|
2803
|
+
requestBody: {
|
|
2804
|
+
content: {
|
|
2805
|
+
"application/json": {
|
|
2806
|
+
/** @description User ID from SDK (anonymous UUID or identified) */
|
|
2807
|
+
userId: string;
|
|
2808
|
+
/** @description Attributes to store against this user. REPLACES any previously stored set. */
|
|
2809
|
+
attributes: {
|
|
2810
|
+
/** @description ISO 3166-1 alpha-2 country code (e.g., "US", "GB", "CA"). */
|
|
2811
|
+
countryCode?: string;
|
|
2812
|
+
language?: string;
|
|
2813
|
+
city?: string;
|
|
2814
|
+
state?: string;
|
|
2815
|
+
region?: string;
|
|
2816
|
+
subscriptionTier?: string;
|
|
2817
|
+
monthsSubscribed?: string;
|
|
2818
|
+
billingCycle?: string;
|
|
2819
|
+
lastPaymentAmount?: string;
|
|
2820
|
+
lastActiveDate?: string;
|
|
2821
|
+
totalSessions?: string;
|
|
2822
|
+
custom?: {
|
|
2823
|
+
[key: string]: string;
|
|
2824
|
+
};
|
|
2825
|
+
/** @description Whole years, as an integer. Accepted from ANY app. If you hold only a RANGE, send its LOWEST end: "13-17" is sent as 13, never 15 or 17. Flooring can never mask a minor and a midpoint can. Offers are STILL SERVED to a user under 18 — sending a real age never switches anyone's offers off. It restricts them to inventory appropriate to their age, ranked by the app-level bandit, with no per-user personalisation. Do not send a date of birth — it is refused. Stored with the time you sent it, so the age we act on is aged forward rather than frozen. */
|
|
2826
|
+
age?: number;
|
|
2827
|
+
email?: string;
|
|
2828
|
+
firstName?: string;
|
|
2829
|
+
lastName?: string;
|
|
2830
|
+
mobile?: string;
|
|
2831
|
+
phoneNumber?: string;
|
|
2832
|
+
postcode?: string;
|
|
2833
|
+
postalCode?: string;
|
|
2834
|
+
/** @description Decimal degrees as string (e.g., "37.7749") */
|
|
2835
|
+
latitude?: string;
|
|
2836
|
+
/** @description Decimal degrees as string (e.g., "-122.4194") */
|
|
2837
|
+
longitude?: string;
|
|
2838
|
+
gender?: string;
|
|
2839
|
+
};
|
|
2840
|
+
};
|
|
2841
|
+
};
|
|
2842
|
+
};
|
|
2843
|
+
responses: {
|
|
2844
|
+
/** @description Default Response */
|
|
2845
|
+
200: {
|
|
2846
|
+
headers: {
|
|
2847
|
+
[name: string]: unknown;
|
|
2848
|
+
};
|
|
2849
|
+
content: {
|
|
2850
|
+
"application/json": {
|
|
2851
|
+
success: boolean;
|
|
2852
|
+
/**
|
|
2853
|
+
* Format: uuid
|
|
2854
|
+
* @description Canonical user UUID
|
|
2855
|
+
*/
|
|
2856
|
+
userId: string;
|
|
2857
|
+
/** @description ISO 8601 instant the set was recorded; what a stored age is aged forward from */
|
|
2858
|
+
storedAt: string;
|
|
2859
|
+
/** @description True when the supplied age was under 18. Offers are STILL served to this user — from age-appropriate inventory only, ranked by the app-level bandit, with no per-user personalisation. Only `age`, `countryCode` and `language` are kept for this user. Everything else you sent is DISCARDED, including `custom`, `city`, `state`, `region` and the subscription and billing fields — a profile that may not be targeted on has no purpose. Re-send the set once they are 18 and it is stored in full. */
|
|
2860
|
+
minor: boolean;
|
|
2861
|
+
};
|
|
2862
|
+
};
|
|
2863
|
+
};
|
|
2864
|
+
/** @description Default Response */
|
|
2865
|
+
400: {
|
|
2866
|
+
headers: {
|
|
2867
|
+
[name: string]: unknown;
|
|
2868
|
+
};
|
|
2869
|
+
content: {
|
|
2870
|
+
"application/json": {
|
|
2871
|
+
error: string;
|
|
2872
|
+
details?: unknown;
|
|
2873
|
+
};
|
|
2874
|
+
};
|
|
2875
|
+
};
|
|
2876
|
+
/** @description Default Response */
|
|
2877
|
+
401: {
|
|
2878
|
+
headers: {
|
|
2879
|
+
[name: string]: unknown;
|
|
2880
|
+
};
|
|
2881
|
+
content: {
|
|
2882
|
+
"application/json": {
|
|
2883
|
+
error: string;
|
|
2884
|
+
details?: unknown;
|
|
2885
|
+
};
|
|
2886
|
+
};
|
|
2887
|
+
};
|
|
2888
|
+
/** @description Default Response */
|
|
2889
|
+
500: {
|
|
2890
|
+
headers: {
|
|
2891
|
+
[name: string]: unknown;
|
|
2892
|
+
};
|
|
2893
|
+
content: {
|
|
2894
|
+
"application/json": {
|
|
2895
|
+
error: string;
|
|
2896
|
+
details?: unknown;
|
|
2897
|
+
};
|
|
2898
|
+
};
|
|
2899
|
+
};
|
|
2900
|
+
};
|
|
2901
|
+
};
|
|
2902
|
+
delete?: never;
|
|
2903
|
+
options?: never;
|
|
2904
|
+
head?: never;
|
|
2905
|
+
patch?: never;
|
|
2906
|
+
trace?: never;
|
|
2907
|
+
};
|
|
2745
2908
|
"/publisher/sdk/v1/iap-links": {
|
|
2746
2909
|
parameters: {
|
|
2747
2910
|
query?: never;
|
|
@@ -4291,7 +4454,7 @@ export interface components {
|
|
|
4291
4454
|
};
|
|
4292
4455
|
};
|
|
4293
4456
|
};
|
|
4294
|
-
/** @description
|
|
4457
|
+
/** @description Assigned variant for every use case this app is enabled for other than the one REQUESTED, so the SDK can cache them at identify(). When the single-enabled-use-case fallback serves a different surface in `ui`, that surface also appears here under its own key, so a client that files `ui` under the requested use case still finds it. `ui` is unchanged; un-upgraded decoders ignore this key. */
|
|
4295
4458
|
useCases: {
|
|
4296
4459
|
"churn-intervention"?: {
|
|
4297
4460
|
/**
|
|
@@ -4529,6 +4692,10 @@ export interface components {
|
|
|
4529
4692
|
* @enum {string|null}
|
|
4530
4693
|
*/
|
|
4531
4694
|
badgeLabel: "free_trial" | "discount" | null;
|
|
4695
|
+
/** @description Fixed presentation image for gift reward surfaces. Null or absent: use the creative primaryImageUrl. */
|
|
4696
|
+
heroImageUrl?: string | null;
|
|
4697
|
+
/** @description https link to the advertiser offer terms. Null or absent: render terms copy as plain text. */
|
|
4698
|
+
termsUrl?: string | null;
|
|
4532
4699
|
/** Format: date-time */
|
|
4533
4700
|
createdAt: string;
|
|
4534
4701
|
/** Format: date-time */
|
|
@@ -4637,6 +4804,8 @@ export interface components {
|
|
|
4637
4804
|
/** Format: date-time */
|
|
4638
4805
|
updatedAt: string;
|
|
4639
4806
|
}[];
|
|
4807
|
+
/** @description Display name of the campaign category, e.g. "Music and Audio". Free string: the taxonomy is admin-editable, so accept any value. */
|
|
4808
|
+
category?: string | null;
|
|
4640
4809
|
}[];
|
|
4641
4810
|
metadata: {
|
|
4642
4811
|
/** @description Total offers available */
|
|
@@ -4717,6 +4886,10 @@ export interface components {
|
|
|
4717
4886
|
* @enum {string|null}
|
|
4718
4887
|
*/
|
|
4719
4888
|
badgeLabel: "free_trial" | "discount" | null;
|
|
4889
|
+
/** @description Fixed presentation image for gift reward surfaces. Null or absent: use the creative primaryImageUrl. */
|
|
4890
|
+
heroImageUrl?: string | null;
|
|
4891
|
+
/** @description https link to the advertiser offer terms. Null or absent: render terms copy as plain text. */
|
|
4892
|
+
termsUrl?: string | null;
|
|
4720
4893
|
/** Format: date-time */
|
|
4721
4894
|
createdAt: string;
|
|
4722
4895
|
/** Format: date-time */
|
|
@@ -4825,6 +4998,8 @@ export interface components {
|
|
|
4825
4998
|
/** Format: date-time */
|
|
4826
4999
|
updatedAt: string;
|
|
4827
5000
|
}[];
|
|
5001
|
+
/** @description Display name of the campaign category, e.g. "Music and Audio". Free string: the taxonomy is admin-editable, so accept any value. */
|
|
5002
|
+
category?: string | null;
|
|
4828
5003
|
};
|
|
4829
5004
|
Creative: {
|
|
4830
5005
|
/** Format: uuid */
|