@maxim_mazurok/gapi.client.androidpublisher-v3 0.1.20251118 → 0.1.20251119
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/index.d.ts +51 -2
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://androidpublisher.googleapis.com/$discovery/rest?version=v3
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20251119
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -244,6 +244,7 @@ declare namespace gapi.client {
|
|
|
244
244
|
/** The current recurring price of the auto renewing plan. Note that the price does not take into account discounts and does not include taxes for tax-exclusive pricing, please call orders.get API instead if transaction details are needed. */
|
|
245
245
|
recurringPrice?: Money;
|
|
246
246
|
}
|
|
247
|
+
interface BaseDetails {}
|
|
247
248
|
interface BasePlan {
|
|
248
249
|
/** Set when the base plan automatically renews at a regular interval. */
|
|
249
250
|
autoRenewingBasePlanType?: AutoRenewingBasePlanType;
|
|
@@ -692,6 +693,12 @@ declare namespace gapi.client {
|
|
|
692
693
|
/** An obfuscated version of the id that is uniquely associated with the user's profile in your app. Only present if specified using https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid when the purchase was made. */
|
|
693
694
|
obfuscatedExternalProfileId?: string;
|
|
694
695
|
}
|
|
696
|
+
interface ExternalAccountIds {
|
|
697
|
+
/** Optional. Specifies an optional obfuscated string that is uniquely associated with the purchaser's user account in your app. If you pass this value, Google Play can use it to detect irregular activity. Do not use this field to store any Personally Identifiable Information (PII) such as emails in cleartext. Attempting to store PII in this field will result in purchases being blocked. Google Play recommends that you use either encryption or a one-way hash to generate an obfuscated identifier to send to Google Play. This identifier is limited to 64 characters. This field can only be set for resubscription purchases. See https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid to set this field for purchases made using the standard in-app billing flow. */
|
|
698
|
+
obfuscatedAccountId?: string;
|
|
699
|
+
/** Optional. Specifies an optional obfuscated string that is uniquely associated with the purchaser's user profile in your app. If you pass this value, Google Play can use it to detect irregular activity. Do not use this field to store any Personally Identifiable Information (PII) such as emails in cleartext. Attempting to store PII in this field will result in purchases being blocked. Google Play recommends that you use either encryption or a one-way hash to generate an obfuscated identifier to send to Google Play. This identifier is limited to 64 characters. This field can only be set for resubscription purchases. See https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid to set this field for purchases made using the standard in-app billing flow. */
|
|
700
|
+
obfuscatedProfileId?: string;
|
|
701
|
+
}
|
|
695
702
|
interface ExternallyHostedApk {
|
|
696
703
|
/** The application label. */
|
|
697
704
|
applicationLabel?: string;
|
|
@@ -765,6 +772,7 @@ declare namespace gapi.client {
|
|
|
765
772
|
regionCode?: string;
|
|
766
773
|
}
|
|
767
774
|
interface ExternalTransactionTestPurchase {}
|
|
775
|
+
interface FreeTrialDetails {}
|
|
768
776
|
interface FullRefund {}
|
|
769
777
|
interface GeneratedApksListResponse {
|
|
770
778
|
/** All generated APKs, grouped by the APK signing key. */
|
|
@@ -994,6 +1002,7 @@ declare namespace gapi.client {
|
|
|
994
1002
|
/** The sha256 hash of the artifact represented as a lowercase hexadecimal number, matching the output of the sha256sum command. */
|
|
995
1003
|
sha256?: string;
|
|
996
1004
|
}
|
|
1005
|
+
interface IntroductoryPriceDetails {}
|
|
997
1006
|
interface IntroductoryPriceInfo {
|
|
998
1007
|
/** Introductory price of the subscription, not including tax. The currency is the same as price_currency_code. Price is expressed in micro-units, where 1,000,000 micro-units represents one unit of the currency. For example, if the subscription price is €1.99, price_amount_micros is 1990000. */
|
|
999
1008
|
introductoryPriceAmountMicros?: string;
|
|
@@ -1004,6 +1013,16 @@ declare namespace gapi.client {
|
|
|
1004
1013
|
/** Introductory price period, specified in ISO 8601 format. Common values are (but not limited to) "P1W" (one week), "P1M" (one month), "P3M" (three months), "P6M" (six months), and "P1Y" (one year). */
|
|
1005
1014
|
introductoryPricePeriod?: string;
|
|
1006
1015
|
}
|
|
1016
|
+
interface ItemReplacement {
|
|
1017
|
+
/** The base plan ID of the subscription line item being replaced. */
|
|
1018
|
+
basePlanId?: string;
|
|
1019
|
+
/** The offer ID of the subscription line item being replaced, if applicable. */
|
|
1020
|
+
offerId?: string;
|
|
1021
|
+
/** The product ID of the subscription line item being replaced. */
|
|
1022
|
+
productId?: string;
|
|
1023
|
+
/** The replacement mode applied during the purchase. */
|
|
1024
|
+
replacementMode?: string;
|
|
1025
|
+
}
|
|
1007
1026
|
interface LanguageTargeting {
|
|
1008
1027
|
/** Alternative languages. */
|
|
1009
1028
|
alternatives?: string[];
|
|
@@ -1161,6 +1180,16 @@ declare namespace gapi.client {
|
|
|
1161
1180
|
/** The latest offer tags associated with the offer. It includes tags inherited from the base plan. */
|
|
1162
1181
|
offerTags?: string[];
|
|
1163
1182
|
}
|
|
1183
|
+
interface OfferPhaseDetails {
|
|
1184
|
+
/** The order funds a base price period. */
|
|
1185
|
+
baseDetails?: any;
|
|
1186
|
+
/** The order funds a free trial period. */
|
|
1187
|
+
freeTrialDetails?: any;
|
|
1188
|
+
/** The order funds an introductory pricing period. */
|
|
1189
|
+
introductoryPriceDetails?: any;
|
|
1190
|
+
/** The order funds a proration period. */
|
|
1191
|
+
prorationPeriodDetails?: ProrationPeriodDetails;
|
|
1192
|
+
}
|
|
1164
1193
|
interface OfferTag {
|
|
1165
1194
|
/** Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters. */
|
|
1166
1195
|
tag?: string;
|
|
@@ -1385,6 +1414,12 @@ declare namespace gapi.client {
|
|
|
1385
1414
|
/** Required. Price in USD to use for any new locations Play may launch in. */
|
|
1386
1415
|
usdPrice?: Money;
|
|
1387
1416
|
}
|
|
1417
|
+
interface OutOfAppPurchaseContext {
|
|
1418
|
+
/** User account identifier from the last expired subscription for this SKU. */
|
|
1419
|
+
expiredExternalAccountIdentifiers?: ExternalAccountIdentifiers;
|
|
1420
|
+
/** The purchase token of the last expired subscription. This purchase token must only be used to help identify the user if the link between the purchaseToken and user is stored in your database. This cannot be used to call the Google Developer API if it has been more than 60 days since expiry. */
|
|
1421
|
+
expiredPurchaseToken?: string;
|
|
1422
|
+
}
|
|
1388
1423
|
interface PageInfo {
|
|
1389
1424
|
/** Maximum number of results returned in one page. ! The number of results included in the API response. */
|
|
1390
1425
|
resultPerPage?: number;
|
|
@@ -1542,6 +1577,12 @@ declare namespace gapi.client {
|
|
|
1542
1577
|
/** Information related to test purchases. This will only be set for test purchases. */
|
|
1543
1578
|
testPurchaseContext?: TestPurchaseContext;
|
|
1544
1579
|
}
|
|
1580
|
+
interface ProrationPeriodDetails {
|
|
1581
|
+
/** The last order id of the original subscription purchase prior to the plan change. This is only populated if this proration period is from an ugrade/downgrade from a previous subscription and carries the remaining offer phase from the linked order of the previous subscription. */
|
|
1582
|
+
linkedOrderId?: string;
|
|
1583
|
+
/** Represent the original offer phase from the purchased the line item if the proration period contains any of them. For example, a proration period from CHARGE_FULL_PRICE plan change may merge the 1st offer phase of the subscription offer of the new product user purchased. In this case, the original offer phase will be set here. */
|
|
1584
|
+
originalOfferPhase?: string;
|
|
1585
|
+
}
|
|
1545
1586
|
interface PurchaseOptionTaxAndComplianceSettings {
|
|
1546
1587
|
/** Optional. Digital content or service classification for products distributed to users in eligible regions. If unset, it defaults to `WITHDRAWAL_RIGHT_DIGITAL_CONTENT`. Refer to the [Help Center article](https://support.google.com/googleplay/android-developer/answer/10463498) for more information. */
|
|
1547
1588
|
withdrawalRightType?: string;
|
|
@@ -1813,8 +1854,10 @@ declare namespace gapi.client {
|
|
|
1813
1854
|
basePlanId?: string;
|
|
1814
1855
|
/** The offer ID for the current subscription offer. */
|
|
1815
1856
|
offerId?: string;
|
|
1816
|
-
/** The pricing phase for the billing period funded by this order. */
|
|
1857
|
+
/** The pricing phase for the billing period funded by this order. Deprecated. Use offer_phase_details instead. */
|
|
1817
1858
|
offerPhase?: string;
|
|
1859
|
+
/** The pricing phase details for the entitlement period funded by this order. */
|
|
1860
|
+
offerPhaseDetails?: OfferPhaseDetails;
|
|
1818
1861
|
/** The end of the billing period funded by this order. This is a snapshot of the billing/service period end time at the moment the order was processed, and should be used only for accounting. To get the current end time of the subscription service period, use purchases.subscriptionsv2.get. */
|
|
1819
1862
|
servicePeriodEndTime?: string;
|
|
1820
1863
|
/** The start of the billing period funded by this order. This is a snapshot of the billing/service period start time at the moment the order was processed, and should be used only for accounting. */
|
|
@@ -1953,6 +1996,8 @@ declare namespace gapi.client {
|
|
|
1953
1996
|
deferredItemReplacement?: DeferredItemReplacement;
|
|
1954
1997
|
/** Time at which the subscription expired or will expire unless the access is extended (ex. renews). */
|
|
1955
1998
|
expiryTime?: string;
|
|
1999
|
+
/** Details of the item being replaced. This field is only populated if this item replaced another item in a previous subscription and is only available for 60 days after the purchase time. */
|
|
2000
|
+
itemReplacement?: ItemReplacement;
|
|
1956
2001
|
/** The order id of the latest successful order associated with this item. Not present if the item is not owned by the user yet (e.g. the item being deferred replaced to). */
|
|
1957
2002
|
latestSuccessfulOrderId?: string;
|
|
1958
2003
|
/** The offer details for this item. */
|
|
@@ -1967,6 +2012,8 @@ declare namespace gapi.client {
|
|
|
1967
2012
|
interface SubscriptionPurchasesAcknowledgeRequest {
|
|
1968
2013
|
/** Payload to attach to the purchase. */
|
|
1969
2014
|
developerPayload?: string;
|
|
2015
|
+
/** Optional. User account identifier in your app. */
|
|
2016
|
+
externalAccountIds?: ExternalAccountIds;
|
|
1970
2017
|
}
|
|
1971
2018
|
interface SubscriptionPurchasesDeferRequest {
|
|
1972
2019
|
/** The information about the new desired expiry time for the subscription. */
|
|
@@ -1991,6 +2038,8 @@ declare namespace gapi.client {
|
|
|
1991
2038
|
lineItems?: SubscriptionPurchaseLineItem[];
|
|
1992
2039
|
/** The purchase token of the old subscription if this subscription is one of the following: * Re-signup of a canceled but non-lapsed subscription * Upgrade/downgrade from a previous subscription. * Convert from prepaid to auto renewing subscription. * Convert from an auto renewing subscription to prepaid. * Topup a prepaid subscription. */
|
|
1993
2040
|
linkedPurchaseToken?: string;
|
|
2041
|
+
/** Additional context for out of app purchases. This information is only present for re-subscription purchases (subscription purchases made after the previous subscription of the same product has expired) made through the Google Play subscriptions center. This field will be removed after you acknowledge the subscription. */
|
|
2042
|
+
outOfAppPurchaseContext?: OutOfAppPurchaseContext;
|
|
1994
2043
|
/** Additional context around paused subscriptions. Only present if the subscription currently has subscription_state SUBSCRIPTION_STATE_PAUSED. */
|
|
1995
2044
|
pausedStateContext?: PausedStateContext;
|
|
1996
2045
|
/** ISO 3166-1 alpha-2 billing country/region code of the user at the time the subscription was granted. */
|