@rage-against-the-pixel/app-store-connect-api 4.3.1 → 4.4.0

package/dist/app_store_connect_api/schemas.gen.d.ts

@@ -6779,10 +6779,6 @@ export declare const AppInfoSchema: {
                     readonly deprecated: true;
                     readonly enum: readonly ["ALL", "TWELVE", "FIFTEEN", "NINETEEN", "NOT_APPLICABLE"];
                 };
-                readonly kidsAgeBand: {
-                    readonly deprecated: true;
-                    readonly $ref: "#/components/schemas/KidsAgeBand";
-                };
             };
         };
         readonly relationships: {
@@ -13339,6 +13335,9 @@ export declare const BackgroundAssetVersionSchema: {
                 readonly version: {
                     readonly type: "string";
                 };
+                readonly locale: {
+                    readonly type: "string";
+                };
             };
         };
         readonly relationships: {
@@ -37632,7 +37631,7 @@ export declare const PerfPowerMetricSchema: {
                 };
                 readonly metricType: {
                     readonly type: "string";
-                    readonly enum: readonly ["DISK", "HANG", "BATTERY", "LAUNCH", "MEMORY", "ANIMATION", "TERMINATION"];
+                    readonly enum: readonly ["DISK", "HANG", "BATTERY", "LAUNCH", "MEMORY", "ANIMATION", "TERMINATION", "STORAGE"];
                 };
                 readonly deviceType: {
                     readonly type: "string";
@@ -40327,6 +40326,7 @@ export declare const SubscriptionAvailabilitySchema: {
         };
     };
     readonly required: readonly ["id", "type"];
+    readonly deprecated: true;
 };
 export declare const SubscriptionAvailabilityResponseSchema: {
     readonly type: "object";
@@ -40346,6 +40346,7 @@ export declare const SubscriptionAvailabilityResponseSchema: {
         };
     };
     readonly required: readonly ["data", "links"];
+    readonly deprecated: true;
 };
 export declare const SubscriptionAvailabilityCreateRequestSchema: {
     readonly type: "object";
@@ -40419,6 +40420,7 @@ export declare const SubscriptionAvailabilityCreateRequestSchema: {
         };
     };
     readonly required: readonly ["data"];
+    readonly deprecated: true;
 };
 export declare const SubscriptionGracePeriodSchema: {
     readonly type: "object";
@@ -41237,6 +41239,9 @@ export declare const SubscriptionIntroductoryOfferSchema: {
                 readonly numberOfPeriods: {
                     readonly type: "integer";
                 };
+                readonly targetSubscriptionPlanType: {
+                    readonly $ref: "#/components/schemas/SubscriptionPlanType";
+                };
             };
         };
         readonly relationships: {
@@ -41336,6 +41341,10 @@ export declare const SubscriptionIntroductoryOfferInlineCreateSchema: {
                 readonly numberOfPeriods: {
                     readonly type: "integer";
                 };
+                readonly targetSubscriptionPlanType: {
+                    readonly nullable: true;
+                    readonly $ref: "#/components/schemas/SubscriptionPlanType";
+                };
             };
             readonly required: readonly ["duration", "numberOfPeriods", "offerMode"];
         };
@@ -41506,6 +41515,10 @@ export declare const SubscriptionIntroductoryOfferCreateRequestSchema: {
                         readonly numberOfPeriods: {
                             readonly type: "integer";
                         };
+                        readonly targetSubscriptionPlanType: {
+                            readonly nullable: true;
+                            readonly $ref: "#/components/schemas/SubscriptionPlanType";
+                        };
                     };
                     readonly required: readonly ["duration", "numberOfPeriods", "offerMode"];
                 };
@@ -42416,6 +42429,9 @@ export declare const SubscriptionOfferCodeSchema: {
                 readonly autoRenewEnabled: {
                     readonly type: "boolean";
                 };
+                readonly targetSubscriptionPlanType: {
+                    readonly $ref: "#/components/schemas/SubscriptionPlanType";
+                };
             };
         };
         readonly relationships: {
@@ -42645,6 +42661,10 @@ export declare const SubscriptionOfferCodeCreateRequestSchema: {
                             readonly type: "boolean";
                             readonly nullable: true;
                         };
+                        readonly targetSubscriptionPlanType: {
+                            readonly nullable: true;
+                            readonly $ref: "#/components/schemas/SubscriptionPlanType";
+                        };
                     };
                     readonly required: readonly ["duration", "offerEligibility", "name", "numberOfPeriods", "offerMode", "customerEligibilities"];
                 };
@@ -42736,6 +42756,242 @@ export declare const SubscriptionOfferCodeUpdateRequestSchema: {
     };
     readonly required: readonly ["data"];
 };
+export declare const SubscriptionPlanAvailabilitySchema: {
+    readonly type: "object";
+    readonly title: "SubscriptionPlanAvailability";
+    readonly properties: {
+        readonly type: {
+            readonly type: "string";
+            readonly enum: readonly ["subscriptionPlanAvailabilities"];
+        };
+        readonly id: {
+            readonly type: "string";
+        };
+        readonly attributes: {
+            readonly type: "object";
+            readonly properties: {
+                readonly availableInNewTerritories: {
+                    readonly type: "boolean";
+                };
+                readonly planType: {
+                    readonly $ref: "#/components/schemas/SubscriptionPlanType";
+                };
+            };
+        };
+        readonly relationships: {
+            readonly type: "object";
+            readonly properties: {
+                readonly availableTerritories: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly links: {
+                            readonly $ref: "#/components/schemas/RelationshipLinks";
+                        };
+                        readonly meta: {
+                            readonly $ref: "#/components/schemas/PagingInformation";
+                        };
+                        readonly data: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly type: "object";
+                                readonly properties: {
+                                    readonly type: {
+                                        readonly type: "string";
+                                        readonly enum: readonly ["territories"];
+                                    };
+                                    readonly id: {
+                                        readonly type: "string";
+                                    };
+                                };
+                                readonly required: readonly ["id", "type"];
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        readonly links: {
+            readonly $ref: "#/components/schemas/ResourceLinks";
+        };
+    };
+    readonly required: readonly ["id", "type"];
+};
+export declare const SubscriptionPlanAvailabilitiesResponseSchema: {
+    readonly type: "object";
+    readonly title: "SubscriptionPlanAvailabilitiesResponse";
+    readonly properties: {
+        readonly data: {
+            readonly type: "array";
+            readonly items: {
+                readonly $ref: "#/components/schemas/SubscriptionPlanAvailability";
+            };
+        };
+        readonly included: {
+            readonly type: "array";
+            readonly items: {
+                readonly $ref: "#/components/schemas/Territory";
+            };
+        };
+        readonly links: {
+            readonly $ref: "#/components/schemas/PagedDocumentLinks";
+        };
+        readonly meta: {
+            readonly $ref: "#/components/schemas/PagingInformation";
+        };
+    };
+    readonly required: readonly ["data", "links"];
+};
+export declare const SubscriptionPlanAvailabilityResponseSchema: {
+    readonly type: "object";
+    readonly title: "SubscriptionPlanAvailabilityResponse";
+    readonly properties: {
+        readonly data: {
+            readonly $ref: "#/components/schemas/SubscriptionPlanAvailability";
+        };
+        readonly included: {
+            readonly type: "array";
+            readonly items: {
+                readonly $ref: "#/components/schemas/Territory";
+            };
+        };
+        readonly links: {
+            readonly $ref: "#/components/schemas/DocumentLinks";
+        };
+    };
+    readonly required: readonly ["data", "links"];
+};
+export declare const SubscriptionPlanAvailabilityCreateRequestSchema: {
+    readonly type: "object";
+    readonly title: "SubscriptionPlanAvailabilityCreateRequest";
+    readonly properties: {
+        readonly data: {
+            readonly type: "object";
+            readonly properties: {
+                readonly type: {
+                    readonly type: "string";
+                    readonly enum: readonly ["subscriptionPlanAvailabilities"];
+                };
+                readonly attributes: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly availableInNewTerritories: {
+                            readonly type: "boolean";
+                            readonly nullable: true;
+                        };
+                        readonly planType: {
+                            readonly $ref: "#/components/schemas/SubscriptionPlanType";
+                        };
+                    };
+                    readonly required: readonly ["planType"];
+                };
+                readonly relationships: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly availableTerritories: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly data: {
+                                    readonly type: "array";
+                                    readonly items: {
+                                        readonly type: "object";
+                                        readonly properties: {
+                                            readonly type: {
+                                                readonly type: "string";
+                                                readonly enum: readonly ["territories"];
+                                            };
+                                            readonly id: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                        readonly required: readonly ["id", "type"];
+                                    };
+                                };
+                            };
+                            readonly required: readonly ["data"];
+                        };
+                        readonly subscription: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly data: {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly type: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["subscriptions"];
+                                        };
+                                        readonly id: {
+                                            readonly type: "string";
+                                        };
+                                    };
+                                    readonly required: readonly ["id", "type"];
+                                };
+                            };
+                            readonly required: readonly ["data"];
+                        };
+                    };
+                    readonly required: readonly ["availableTerritories", "subscription"];
+                };
+            };
+            readonly required: readonly ["relationships", "attributes", "type"];
+        };
+    };
+    readonly required: readonly ["data"];
+};
+export declare const SubscriptionPlanAvailabilityUpdateRequestSchema: {
+    readonly type: "object";
+    readonly title: "SubscriptionPlanAvailabilityUpdateRequest";
+    readonly properties: {
+        readonly data: {
+            readonly type: "object";
+            readonly properties: {
+                readonly type: {
+                    readonly type: "string";
+                    readonly enum: readonly ["subscriptionPlanAvailabilities"];
+                };
+                readonly id: {
+                    readonly type: "string";
+                };
+                readonly attributes: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly availableInNewTerritories: {
+                            readonly type: "boolean";
+                            readonly nullable: true;
+                        };
+                    };
+                };
+                readonly relationships: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly availableTerritories: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly data: {
+                                    readonly type: "array";
+                                    readonly items: {
+                                        readonly type: "object";
+                                        readonly properties: {
+                                            readonly type: {
+                                                readonly type: "string";
+                                                readonly enum: readonly ["territories"];
+                                            };
+                                            readonly id: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                        readonly required: readonly ["id", "type"];
+                                    };
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+            readonly required: readonly ["id", "type"];
+        };
+    };
+    readonly required: readonly ["data"];
+};
 export declare const SubscriptionPricePointSchema: {
     readonly type: "object";
     readonly title: "SubscriptionPricePoint";
@@ -42876,6 +43132,9 @@ export declare const SubscriptionPriceSchema: {
                 readonly preserved: {
                     readonly type: "boolean";
                 };
+                readonly planType: {
+                    readonly $ref: "#/components/schemas/SubscriptionPlanType";
+                };
             };
         };
         readonly relationships: {
@@ -42947,6 +43206,10 @@ export declare const SubscriptionPriceInlineCreateSchema: {
                     readonly type: "boolean";
                     readonly nullable: true;
                 };
+                readonly planType: {
+                    readonly nullable: true;
+                    readonly $ref: "#/components/schemas/SubscriptionPlanType";
+                };
             };
         };
         readonly relationships: {
@@ -43100,6 +43363,10 @@ export declare const SubscriptionPriceCreateRequestSchema: {
                             readonly type: "boolean";
                             readonly nullable: true;
                         };
+                        readonly planType: {
+                            readonly nullable: true;
+                            readonly $ref: "#/components/schemas/SubscriptionPlanType";
+                        };
                     };
                 };
                 readonly relationships: {
@@ -43347,6 +43614,9 @@ export declare const SubscriptionPromotionalOfferSchema: {
                 readonly offerMode: {
                     readonly $ref: "#/components/schemas/SubscriptionOfferMode";
                 };
+                readonly targetSubscriptionPlanType: {
+                    readonly $ref: "#/components/schemas/SubscriptionPlanType";
+                };
             };
         };
         readonly relationships: {
@@ -43433,6 +43703,10 @@ export declare const SubscriptionPromotionalOfferInlineCreateSchema: {
                 readonly offerMode: {
                     readonly $ref: "#/components/schemas/SubscriptionOfferMode";
                 };
+                readonly targetSubscriptionPlanType: {
+                    readonly nullable: true;
+                    readonly $ref: "#/components/schemas/SubscriptionPlanType";
+                };
             };
             readonly required: readonly ["duration", "offerCode", "name", "numberOfPeriods", "offerMode"];
         };
@@ -43578,6 +43852,10 @@ export declare const SubscriptionPromotionalOfferCreateRequestSchema: {
                         readonly offerMode: {
                             readonly $ref: "#/components/schemas/SubscriptionOfferMode";
                         };
+                        readonly targetSubscriptionPlanType: {
+                            readonly nullable: true;
+                            readonly $ref: "#/components/schemas/SubscriptionPlanType";
+                        };
                     };
                     readonly required: readonly ["duration", "offerCode", "name", "numberOfPeriods", "offerMode"];
                 };
@@ -44058,6 +44336,7 @@ export declare const SubscriptionSchema: {
                             readonly required: readonly ["id", "type"];
                         };
                     };
+                    readonly deprecated: true;
                 };
                 readonly winBackOffers: {
                     readonly type: "object";
@@ -44113,6 +44392,33 @@ export declare const SubscriptionSchema: {
                         };
                     };
                 };
+                readonly planAvailabilities: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly links: {
+                            readonly $ref: "#/components/schemas/RelationshipLinks";
+                        };
+                        readonly meta: {
+                            readonly $ref: "#/components/schemas/PagingInformation";
+                        };
+                        readonly data: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly type: "object";
+                                readonly properties: {
+                                    readonly type: {
+                                        readonly type: "string";
+                                        readonly enum: readonly ["subscriptionPlanAvailabilities"];
+                                    };
+                                    readonly id: {
+                                        readonly type: "string";
+                                    };
+                                };
+                                readonly required: readonly ["id", "type"];
+                            };
+                        };
+                    };
+                };
             };
         };
         readonly links: {
@@ -44150,6 +44456,8 @@ export declare const SubscriptionsResponseSchema: {
                     readonly $ref: "#/components/schemas/SubscriptionLocalization";
                 }, {
                     readonly $ref: "#/components/schemas/SubscriptionOfferCode";
+                }, {
+                    readonly $ref: "#/components/schemas/SubscriptionPlanAvailability";
                 }, {
                     readonly $ref: "#/components/schemas/SubscriptionPrice";
                 }, {
@@ -44170,6 +44478,7 @@ export declare const SubscriptionsResponseSchema: {
                         readonly subscriptionOfferCodes: "#/components/schemas/SubscriptionOfferCode";
                         readonly subscriptionPromotionalOffers: "#/components/schemas/SubscriptionPromotionalOffer";
                         readonly subscriptionLocalizations: "#/components/schemas/SubscriptionLocalization";
+                        readonly subscriptionPlanAvailabilities: "#/components/schemas/SubscriptionPlanAvailability";
                         readonly subscriptionAvailabilities: "#/components/schemas/SubscriptionAvailability";
                     };
                 };
@@ -44210,6 +44519,8 @@ export declare const SubscriptionResponseSchema: {
                     readonly $ref: "#/components/schemas/SubscriptionLocalization";
                 }, {
                     readonly $ref: "#/components/schemas/SubscriptionOfferCode";
+                }, {
+                    readonly $ref: "#/components/schemas/SubscriptionPlanAvailability";
                 }, {
                     readonly $ref: "#/components/schemas/SubscriptionPrice";
                 }, {
@@ -44230,6 +44541,7 @@ export declare const SubscriptionResponseSchema: {
                         readonly subscriptionOfferCodes: "#/components/schemas/SubscriptionOfferCode";
                         readonly subscriptionPromotionalOffers: "#/components/schemas/SubscriptionPromotionalOffer";
                         readonly subscriptionLocalizations: "#/components/schemas/SubscriptionLocalization";
+                        readonly subscriptionPlanAvailabilities: "#/components/schemas/SubscriptionPlanAvailability";
                         readonly subscriptionAvailabilities: "#/components/schemas/SubscriptionAvailability";
                     };
                 };
@@ -45831,6 +46143,9 @@ export declare const WinBackOfferSchema: {
                     readonly type: "string";
                     readonly enum: readonly ["NOT_PROMOTED", "USE_AUTO_GENERATED_ASSETS"];
                 };
+                readonly targetSubscriptionPlanType: {
+                    readonly $ref: "#/components/schemas/SubscriptionPlanType";
+                };
             };
         };
         readonly relationships: {
@@ -45972,6 +46287,10 @@ export declare const WinBackOfferCreateRequestSchema: {
                             readonly nullable: true;
                             readonly enum: readonly ["NOT_PROMOTED", "USE_AUTO_GENERATED_ASSETS"];
                         };
+                        readonly targetSubscriptionPlanType: {
+                            readonly nullable: true;
+                            readonly $ref: "#/components/schemas/SubscriptionPlanType";
+                        };
                     };
                     readonly required: readonly ["duration", "customerEligibilityTimeSinceLastSubscribedInMonths", "periodCount", "offerId", "offerMode", "priority", "customerEligibilityPaidSubscriptionDurationInMonths", "startDate", "referenceName"];
                 };
@@ -54136,6 +54455,7 @@ export declare const SubscriptionAvailabilityAvailableTerritoriesLinkagesRespons
         };
     };
     readonly required: readonly ["data", "links"];
+    readonly deprecated: true;
 };
 export declare const SubscriptionGroupSubscriptionGroupLocalizationsLinkagesResponseSchema: {
     readonly type: "object";
@@ -54299,6 +54619,56 @@ export declare const SubscriptionOfferCodePricesLinkagesResponseSchema: {
     };
     readonly required: readonly ["data", "links"];
 };
+export declare const SubscriptionPlanAvailabilityAvailableTerritoriesLinkagesResponseSchema: {
+    readonly type: "object";
+    readonly properties: {
+        readonly data: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "object";
+                readonly properties: {
+                    readonly type: {
+                        readonly type: "string";
+                        readonly enum: readonly ["territories"];
+                    };
+                    readonly id: {
+                        readonly type: "string";
+                    };
+                };
+                readonly required: readonly ["id", "type"];
+            };
+        };
+        readonly links: {
+            readonly $ref: "#/components/schemas/PagedDocumentLinks";
+        };
+        readonly meta: {
+            readonly $ref: "#/components/schemas/PagingInformation";
+        };
+    };
+    readonly required: readonly ["data", "links"];
+};
+export declare const SubscriptionPlanAvailabilityAvailableTerritoriesLinkagesRequestSchema: {
+    readonly type: "object";
+    readonly properties: {
+        readonly data: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "object";
+                readonly properties: {
+                    readonly type: {
+                        readonly type: "string";
+                        readonly enum: readonly ["territories"];
+                    };
+                    readonly id: {
+                        readonly type: "string";
+                    };
+                };
+                readonly required: readonly ["id", "type"];
+            };
+        };
+    };
+    readonly required: readonly ["data"];
+};
 export declare const SubscriptionPricePointEqualizationsLinkagesResponseSchema: {
     readonly type: "object";
     readonly properties: {
@@ -54483,6 +54853,34 @@ export declare const SubscriptionOfferCodesLinkagesResponseSchema: {
     };
     readonly required: readonly ["data", "links"];
 };
+export declare const SubscriptionPlanAvailabilitiesLinkagesResponseSchema: {
+    readonly type: "object";
+    readonly properties: {
+        readonly data: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "object";
+                readonly properties: {
+                    readonly type: {
+                        readonly type: "string";
+                        readonly enum: readonly ["subscriptionPlanAvailabilities"];
+                    };
+                    readonly id: {
+                        readonly type: "string";
+                    };
+                };
+                readonly required: readonly ["id", "type"];
+            };
+        };
+        readonly links: {
+            readonly $ref: "#/components/schemas/PagedDocumentLinks";
+        };
+        readonly meta: {
+            readonly $ref: "#/components/schemas/PagingInformation";
+        };
+    };
+    readonly required: readonly ["data", "links"];
+};
 export declare const SubscriptionPricePointsLinkagesResponseSchema: {
     readonly type: "object";
     readonly properties: {
@@ -54632,6 +55030,7 @@ export declare const SubscriptionSubscriptionAvailabilityLinkageResponseSchema:
         };
     };
     readonly required: readonly ["data", "links"];
+    readonly deprecated: true;
 };
 export declare const SubscriptionSubscriptionLocalizationsLinkagesResponseSchema: {
     readonly type: "object";
@@ -55899,7 +56298,7 @@ export declare const AppMediaVideoStateSchema: {
 };
 export declare const AppStoreAgeRatingSchema: {
     readonly type: "string";
-    readonly enum: readonly ["L", "ALL", "ONE_PLUS", "TWO_PLUS", "THREE_PLUS", "FOUR_PLUS", "FIVE_PLUS", "SIX_PLUS", "SEVEN_PLUS", "EIGHT_PLUS", "NINE_PLUS", "TEN_PLUS", "ELEVEN_PLUS", "TWELVE_PLUS", "THIRTEEN_PLUS", "FOURTEEN_PLUS", "FIFTEEN_PLUS", "SIXTEEN_PLUS", "SEVENTEEN_PLUS", "EIGHTEEN_PLUS", "NINETEEN_PLUS", "TWENTY_PLUS", "TWENTY_ONE_PLUS", "UNRATED"];
+    readonly enum: readonly ["L", "ALL", "ZERO_ZERO", "ONE_PLUS", "TWO_PLUS", "THREE_PLUS", "FOUR_PLUS", "FIVE_PLUS", "SIX_PLUS", "SEVEN_PLUS", "EIGHT_PLUS", "NINE_PLUS", "TEN_PLUS", "ELEVEN_PLUS", "TWELVE_PLUS", "THIRTEEN_PLUS", "FOURTEEN_PLUS", "FIFTEEN_PLUS", "SIXTEEN_PLUS", "SEVENTEEN_PLUS", "EIGHTEEN_PLUS", "NINETEEN_PLUS", "TWENTY_PLUS", "TWENTY_ONE_PLUS", "UNRATED"];
 };
 export declare const AppStoreVersionStateSchema: {
     readonly type: "string";
@@ -56613,7 +57012,7 @@ export declare const LocationSchema: {
 };
 export declare const MetricCategorySchema: {
     readonly type: "string";
-    readonly enum: readonly ["HANG", "LAUNCH", "MEMORY", "DISK", "BATTERY", "TERMINATION", "ANIMATION"];
+    readonly enum: readonly ["HANG", "LAUNCH", "MEMORY", "DISK", "BATTERY", "TERMINATION", "ANIMATION", "STORAGE"];
 };
 export declare const MetricsInsightSchema: {
     readonly type: "object";
@@ -56764,6 +57163,10 @@ export declare const SubscriptionOfferModeSchema: {
     readonly type: "string";
     readonly enum: readonly ["PAY_AS_YOU_GO", "PAY_UP_FRONT", "FREE_TRIAL"];
 };
+export declare const SubscriptionPlanTypeSchema: {
+    readonly type: "string";
+    readonly enum: readonly ["MONTHLY", "UPFRONT"];
+};
 export declare const SubscriptionStatusUrlVersionSchema: {
     readonly type: "string";
     readonly enum: readonly ["V1", "V2"];