@maxim_mazurok/gapi.client.androidpublisher-v3 0.0.20231213 → 0.0.20240109

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://androidpublisher.googleapis.com/$discovery/rest?version=v3
-// Revision: 20231213
+// Revision: 20240109
 
 /// <reference types="gapi.client" />
 
@@ -64,6 +64,19 @@ declare namespace gapi.client {
       /** Required. The parent subscription (ID) of the offer to activate. */
       productId?: string;
     }
+    interface AddTargetingRequest {
+      /** Specifies targeting updates such as regions, android sdk versions etc. */
+      targetingUpdate?: TargetingUpdate;
+    }
+    interface AddTargetingResponse {}
+    interface AllUsers {
+      /** Required. Set to true if all set of users are needed. */
+      isAllUsersRequested?: boolean;
+    }
+    interface AndroidSdks {
+      /** Android api levels of devices targeted by recovery action. See https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels for different api levels in android. */
+      sdkLevels?: string[];
+    }
     interface Apk {
       /** Information about the binary payload of this APK. */
       binary?: ApkBinary;
@@ -140,6 +153,34 @@ declare namespace gapi.client {
       /** Output only. Identifier of the edit. Can be used in subsequent API calls. */
       id?: string;
     }
+    interface AppRecoveryAction {
+      /** ID corresponding to the app recovery action. */
+      appRecoveryId?: string;
+      /** Timestamp of when the app recovery action is canceled by the developer. Only set if the recovery action has been canceled. */
+      cancelTime?: string;
+      /** Timestamp of when the app recovery action is created by the developer. It is always set after creation of the recovery action. */
+      createTime?: string;
+      /** Timestamp of when the app recovery action is deployed to the users. Only set if the recovery action has been deployed. */
+      deployTime?: string;
+      /** Timestamp of when the developer last updated recovery action. In case the action is cancelled, it corresponds to cancellation time. It is always set after creation of the recovery action. */
+      lastUpdateTime?: string;
+      /** Data about the remote in-app update action such as such as recovered user base, recoverable user base etc. Set only if the recovery action type is Remote In-App Update. */
+      remoteInAppUpdateData?: RemoteInAppUpdateData;
+      /** The status of the recovery action. */
+      status?: string;
+      /** Specifies targeting criteria for the recovery action such as regions, android sdk versions, app versions etc. */
+      targeting?: Targeting;
+    }
+    interface AppVersionList {
+      /** List of app version codes. */
+      versionCodes?: string[];
+    }
+    interface AppVersionRange {
+      /** Highest app version in the range, inclusive. */
+      versionCodeEnd?: string;
+      /** Lowest app version in the range, inclusive. */
+      versionCodeStart?: string;
+    }
     interface ArchiveSubscriptionRequest {}
     interface AssetModuleMetadata {
       /** Indicates the delivery type for persistent install. */
@@ -254,6 +295,8 @@ declare namespace gapi.client {
       /** The kind of this response ("androidpublisher#bundlesListResponse"). */
       kind?: string;
     }
+    interface CancelAppRecoveryRequest {}
+    interface CancelAppRecoveryResponse {}
     interface CanceledStateContext {
       /** Subscription was canceled by the developer. */
       developerInitiatedCancellation?: any;
@@ -306,6 +349,12 @@ declare namespace gapi.client {
       /** Include "rest of world" as well as explicitly targeted countries. */
       includeRestOfWorld?: boolean;
     }
+    interface CreateDraftAppRecoveryRequest {
+      /** Action type is remote in-app update. As a consequence of this action, a downloadable recovery module is also created for testing purposes. */
+      remoteInAppUpdate?: RemoteInAppUpdate;
+      /** Specifies targeting criteria for the recovery action such as regions, android sdk versions, app versions etc. */
+      targeting?: Targeting;
+    }
     interface DeactivateBasePlanRequest {
       /** Required. The unique base plan ID of the base plan to deactivate. */
       basePlanId?: string;
@@ -340,6 +389,8 @@ declare namespace gapi.client {
       /** The uploaded Deobfuscation File configuration. */
       deobfuscationFile?: DeobfuscationFile;
     }
+    interface DeployAppRecoveryRequest {}
+    interface DeployAppRecoveryResponse {}
     interface DeveloperComment {
       /** The last time at which this comment was updated. */
       lastModified?: Timestamp;
@@ -538,6 +589,8 @@ declare namespace gapi.client {
       certificateSha256Hash?: string;
       /** List of asset pack slices which will be served for this app bundle, signed with a key corresponding to certificate_sha256_hash. */
       generatedAssetPackSlices?: GeneratedAssetPackSlice[];
+      /** Generated recovery apks for recovery actions signed with a key corresponding to certificate_sha256_hash. This includes all generated recovery APKs, also those in draft or cancelled state. This field is not set if no recovery actions were created for this signing key. */
+      generatedRecoveryModules?: GeneratedRecoveryApk[];
       /** List of generated split APKs, signed with a key corresponding to certificate_sha256_hash. */
       generatedSplitApks?: GeneratedSplitApk[];
       /** List of generated standalone APKs, signed with a key corresponding to certificate_sha256_hash. */
@@ -557,6 +610,16 @@ declare namespace gapi.client {
       /** Asset module version. */
       version?: string;
     }
+    interface GeneratedRecoveryApk {
+      /** Download ID, which uniquely identifies the APK to download. Should be supplied to `generatedapks.download` method. */
+      downloadId?: string;
+      /** Name of the module which recovery apk belongs to. */
+      moduleName?: string;
+      /** ID of the recovery action. */
+      recoveryId?: string;
+      /** The status of the recovery action corresponding to the recovery apk. */
+      recoveryStatus?: string;
+    }
     interface GeneratedSplitApk {
       /** Download ID, which uniquely identifies the APK to download. Should be supplied to `generatedapks.download` method. */
       downloadId?: string;
@@ -725,6 +788,10 @@ declare namespace gapi.client {
       /** ISO-639: 2 or 3 letter language code. */
       value?: string[];
     }
+    interface ListAppRecoveriesResponse {
+      /** List of recovery actions associated with the requested package name. */
+      recoveryActions?: AppRecoveryAction[];
+    }
     interface ListDeviceTierConfigsResponse {
       /** Device tier configs created by the developer. */
       deviceTierConfigs?: DeviceTierConfig[];
@@ -1002,10 +1069,30 @@ declare namespace gapi.client {
       /** Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498). */
       taxTier?: string;
     }
+    interface Regions {
+      /** Regions targeted by the recovery action. Region codes are ISO 3166 Alpha-2 country codes. For example, US stands for United States of America. See https://www.iso.org/iso-3166-country-codes.html for the complete list of country codes. */
+      regionCode?: string[];
+    }
     interface RegionsVersion {
       /** Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02. */
       version?: string;
     }
+    interface RemoteInAppUpdate {
+      /** Required. Set to true if Remote In-App Update action type is needed. */
+      isRemoteInAppUpdateRequested?: boolean;
+    }
+    interface RemoteInAppUpdateData {
+      /** Data related to the recovery action at bundle level. */
+      remoteAppUpdateDataPerBundle?: RemoteInAppUpdateDataPerBundle[];
+    }
+    interface RemoteInAppUpdateDataPerBundle {
+      /** Total number of devices which have been rescued. */
+      recoveredDeviceCount?: string;
+      /** Total number of devices affected by this recovery action associated with bundle of the app. */
+      totalDeviceCount?: string;
+      /** Version Code corresponding to the target bundle. */
+      versionCode?: string;
+    }
     interface ReplacementCancellation {}
     interface Review {
       /** The name of the user who wrote the review. */
@@ -1318,6 +1405,18 @@ declare namespace gapi.client {
       name?: string;
     }
     interface SystemInitiatedCancellation {}
+    interface Targeting {
+      /** All users are targeted. */
+      allUsers?: AllUsers;
+      /** Targeting is based on android api levels of devices. */
+      androidSdks?: AndroidSdks;
+      /** Targeting is based on the user account region. */
+      regions?: Regions;
+      /** Target version codes as a list. */
+      versionList?: AppVersionList;
+      /** Target version codes as a range. */
+      versionRange?: AppVersionRange;
+    }
     interface TargetingInfo {
       /** List of created asset slices. */
       assetSliceSet?: AssetSliceSet[];
@@ -1330,6 +1429,14 @@ declare namespace gapi.client {
       /** The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app. */
       specificSubscriptionInApp?: string;
     }
+    interface TargetingUpdate {
+      /** All users are targeted. */
+      allUsers?: AllUsers;
+      /** Additional android sdk levels are targeted by the recovery action. */
+      androidSdks?: AndroidSdks;
+      /** Additional regions are targeted by the recovery action. */
+      regions?: Regions;
+    }
     interface Testers {
       /** All testing Google Groups, as email addresses. */
       googleGroups?: string[];
@@ -1684,6 +1791,281 @@ declare namespace gapi.client {
     interface ApplicationsResource {
       deviceTierConfigs: DeviceTierConfigsResource;
     }
+    interface ApprecoveryResource {
+      /** Incrementally update targeting for a recovery action. Note that only the criteria selected during the creation of recovery action can be expanded. */
+      addTargeting(request: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** Required. ID corresponding to the app recovery action. */
+        appRecoveryId: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Required. Package name of the app for which recovery action is to be updated. */
+        packageName: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+        /** Request body */
+        resource: AddTargetingRequest;
+      }): Request<{}>;
+      addTargeting(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: string;
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: string;
+          /** Required. ID corresponding to the app recovery action. */
+          appRecoveryId: string;
+          /** JSONP */
+          callback?: string;
+          /** Selector specifying which fields to include in a partial response. */
+          fields?: string;
+          /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+          key?: string;
+          /** OAuth 2.0 token for the current user. */
+          oauth_token?: string;
+          /** Required. Package name of the app for which recovery action is to be updated. */
+          packageName: string;
+          /** Returns response with indentations and line breaks. */
+          prettyPrint?: boolean;
+          /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+          quotaUser?: string;
+          /** Upload protocol for media (e.g. "raw", "multipart"). */
+          upload_protocol?: string;
+          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+          uploadType?: string;
+        },
+        body: AddTargetingRequest
+      ): Request<{}>;
+      /** List all app recovery action resources associated with a particular package name and app version. */
+      appRecoveries(request?: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Required. Package name of the app for which list of recovery actions is requested. */
+        packageName: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+        /** Required. Version code targeted by the list of recovery actions. */
+        versionCode?: string;
+      }): Request<ListAppRecoveriesResponse>;
+      /** Cancel an already executing app recovery action. Note that this action changes status of the recovery action to CANCELED. */
+      cancel(request: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** Required. ID corresponding to the app recovery action. */
+        appRecoveryId: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Required. Package name of the app for which recovery action cancellation is requested. */
+        packageName: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+        /** Request body */
+        resource: CancelAppRecoveryRequest;
+      }): Request<{}>;
+      cancel(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: string;
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: string;
+          /** Required. ID corresponding to the app recovery action. */
+          appRecoveryId: string;
+          /** JSONP */
+          callback?: string;
+          /** Selector specifying which fields to include in a partial response. */
+          fields?: string;
+          /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+          key?: string;
+          /** OAuth 2.0 token for the current user. */
+          oauth_token?: string;
+          /** Required. Package name of the app for which recovery action cancellation is requested. */
+          packageName: string;
+          /** Returns response with indentations and line breaks. */
+          prettyPrint?: boolean;
+          /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+          quotaUser?: string;
+          /** Upload protocol for media (e.g. "raw", "multipart"). */
+          upload_protocol?: string;
+          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+          uploadType?: string;
+        },
+        body: CancelAppRecoveryRequest
+      ): Request<{}>;
+      /** Create an app recovery action with recovery status as DRAFT. Note that this action does not execute the recovery action. */
+      create(request: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Required. Package name of the app on which recovery action is performed. */
+        packageName: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+        /** Request body */
+        resource: CreateDraftAppRecoveryRequest;
+      }): Request<AppRecoveryAction>;
+      create(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: string;
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: string;
+          /** JSONP */
+          callback?: string;
+          /** Selector specifying which fields to include in a partial response. */
+          fields?: string;
+          /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+          key?: string;
+          /** OAuth 2.0 token for the current user. */
+          oauth_token?: string;
+          /** Required. Package name of the app on which recovery action is performed. */
+          packageName: string;
+          /** Returns response with indentations and line breaks. */
+          prettyPrint?: boolean;
+          /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+          quotaUser?: string;
+          /** Upload protocol for media (e.g. "raw", "multipart"). */
+          upload_protocol?: string;
+          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+          uploadType?: string;
+        },
+        body: CreateDraftAppRecoveryRequest
+      ): Request<AppRecoveryAction>;
+      /** Deploy an already created app recovery action with recovery status DRAFT. Note that this action activates the recovery action for all targeted users and changes its status to ACTIVE. */
+      deploy(request: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** Required. ID corresponding to the app recovery action to deploy. */
+        appRecoveryId: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Required. Package name of the app for which recovery action is deployed. */
+        packageName: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+        /** Request body */
+        resource: DeployAppRecoveryRequest;
+      }): Request<{}>;
+      deploy(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: string;
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: string;
+          /** Required. ID corresponding to the app recovery action to deploy. */
+          appRecoveryId: string;
+          /** JSONP */
+          callback?: string;
+          /** Selector specifying which fields to include in a partial response. */
+          fields?: string;
+          /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+          key?: string;
+          /** OAuth 2.0 token for the current user. */
+          oauth_token?: string;
+          /** Required. Package name of the app for which recovery action is deployed. */
+          packageName: string;
+          /** Returns response with indentations and line breaks. */
+          prettyPrint?: boolean;
+          /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+          quotaUser?: string;
+          /** Upload protocol for media (e.g. "raw", "multipart"). */
+          upload_protocol?: string;
+          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+          uploadType?: string;
+        },
+        body: DeployAppRecoveryRequest
+      ): Request<{}>;
+    }
     interface ApksResource {
       /** Creates a new APK without uploading the APK itself to Google Play, instead hosting the APK at a specified URL. This function is only available to organizations using Managed Play whose application is configured to restrict distribution to the organizations. */
       addexternallyhosted(request: {
@@ -6537,6 +6919,8 @@ declare namespace gapi.client {
 
     const applications: ApplicationsResource;
 
+    const apprecovery: ApprecoveryResource;
+
     const edits: EditsResource;
 
     const externaltransactions: ExternaltransactionsResource;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.androidpublisher-v3",
-  "version": "0.0.20231213",
+  "version": "0.0.20240109",
   "description": "TypeScript typings for Google Play Android Developer API v3",
   "repository": {
     "type": "git",

package/readme.md

@@ -69,6 +69,44 @@ gapi.auth.authorize(
 After that you can use Google Play Android Developer API resources: <!-- TODO: make this work for multiple namespaces -->
 
 ```typescript
+/*
+Incrementally update targeting for a recovery action. Note that only the criteria selected during the creation of recovery action can be expanded.
+*/
+await gapi.client.androidpublisher.apprecovery.addTargeting({
+  appRecoveryId: 'appRecoveryId',
+  packageName: 'packageName',
+});
+
+/*
+List all app recovery action resources associated with a particular package name and app version.
+*/
+await gapi.client.androidpublisher.apprecovery.appRecoveries({
+  packageName: 'packageName',
+});
+
+/*
+Cancel an already executing app recovery action. Note that this action changes status of the recovery action to CANCELED.
+*/
+await gapi.client.androidpublisher.apprecovery.cancel({
+  appRecoveryId: 'appRecoveryId',
+  packageName: 'packageName',
+});
+
+/*
+Create an app recovery action with recovery status as DRAFT. Note that this action does not execute the recovery action.
+*/
+await gapi.client.androidpublisher.apprecovery.create({
+  packageName: 'packageName',
+});
+
+/*
+Deploy an already created app recovery action with recovery status DRAFT. Note that this action activates the recovery action for all targeted users and changes its status to ACTIVE.
+*/
+await gapi.client.androidpublisher.apprecovery.deploy({
+  appRecoveryId: 'appRecoveryId',
+  packageName: 'packageName',
+});
+
 /*
 Commits an app edit.
 */