Merge pull request 'Add Apple subscription sync schema' (#253) from apple-iap-pr2-backend-schema into master

Reviewed-on: #253

src/index.tsx

@@ -290,6 +290,7 @@ export type DeployedConfigGql = {
   environment: Scalars["String"]["output"];
   firebase: Scalars["Boolean"]["output"];
   minimumAllowedAppVersion: Scalars["String"]["output"];
+  quotaEnforcementEnabled: Scalars["Boolean"]["output"];
   subscriptionGatingEnabled: Scalars["Boolean"]["output"];
 };
 
@@ -330,6 +331,7 @@ export type EditableShotFieldInputGql = {
 export enum EntitlementSourceTypeEnum {
   Admin = "ADMIN",
   AlphaLegacy = "ALPHA_LEGACY",
+  Apple = "APPLE",
   Manual = "MANUAL",
   Stripe = "STRIPE",
 }
@@ -2428,6 +2430,7 @@ export type Mutation = {
   startChallenge: ChallengeEntry;
   submitCancellationFeedback: Scalars["Boolean"]["output"];
   submitChallengeEntry: ChallengeEntry;
+  syncAppleSubscription: SyncAppleSubscriptionResultGql;
   undismissChallenge: Scalars["Boolean"]["output"];
   unfollowUser: UserGql;
   updateShotAnnotations: UpdateShotAnnotationReturn;
@@ -2631,6 +2634,10 @@ export type MutationSubmitChallengeEntryArgs = {
   videoId: Scalars["ID"]["input"];
 };
 
+export type MutationSyncAppleSubscriptionArgs = {
+  input: SyncAppleSubscriptionInputGql;
+};
+
 export type MutationUndismissChallengeArgs = {
   challengeId: Scalars["ID"]["input"];
 };
@@ -2813,6 +2820,7 @@ export type Query = {
   challenges: Array<Challenge>;
   doesUsernameExist: Scalars["Boolean"]["output"];
   getAggregatedShotMetrics: Array<AggregateResultGql>;
+  getAppleAppAccountToken: Scalars["String"]["output"];
   getAvailableSubscriptionOptions: StripeSubscriptionOptionsGql;
   getBucketSet?: Maybe<BucketSetGql>;
   getDeployedConfig: DeployedConfigGql;
@@ -3023,15 +3031,29 @@ export type QueryWaitForArgs = {
   duration: Scalars["Float"]["input"];
 };
 
+export type QuotaBucketStatusGql = {
+  __typename?: "QuotaBucketStatusGQL";
+  appliesToUploadKind: Scalars["String"]["output"];
+  canUpload: Scalars["Boolean"]["output"];
+  durationLimitSeconds?: Maybe<Scalars["Int"]["output"]>;
+  durationRemainingSeconds?: Maybe<Scalars["Float"]["output"]>;
+  durationUsedSeconds: Scalars["Float"]["output"];
+  periodEnd: Scalars["DateTime"]["output"];
+  periodStart: Scalars["DateTime"]["output"];
+  quotaKey: Scalars["String"]["output"];
+};
+
 export type QuotaStatusGql = {
   __typename?: "QuotaStatusGQL";
   canUpload: Scalars["Boolean"]["output"];
   durationLimitSeconds?: Maybe<Scalars["Int"]["output"]>;
   durationRemainingSeconds?: Maybe<Scalars["Float"]["output"]>;
   durationUsedSeconds: Scalars["Float"]["output"];
+  importQuotaBuckets: Array<QuotaBucketStatusGql>;
   maxVideoDurationSeconds?: Maybe<Scalars["Int"]["output"]>;
   periodEnd: Scalars["DateTime"]["output"];
   periodStart: Scalars["DateTime"]["output"];
+  recordingQuotaBuckets: Array<QuotaBucketStatusGql>;
   tierName: Scalars["String"]["output"];
 };
 
@@ -3362,6 +3384,27 @@ export type SuccessfulAddAddShotAnnotationErrors =
   | AddShotAnnotationErrors
   | SuccessfulAdd;
 
+export type SyncAppleSubscriptionInputGql = {
+  signedRenewalInfo?: InputMaybe<Scalars["String"]["input"]>;
+  signedTransactionInfo: Scalars["String"]["input"];
+};
+
+export type SyncAppleSubscriptionResultGql = {
+  __typename?: "SyncAppleSubscriptionResultGQL";
+  appleStatus?: Maybe<Scalars["Int"]["output"]>;
+  entitlementEndsAt?: Maybe<Scalars["DateTime"]["output"]>;
+  entitlementSource?: Maybe<EntitlementSourceTypeEnum>;
+  entitlementStartsAt?: Maybe<Scalars["DateTime"]["output"]>;
+  errorCode?: Maybe<Scalars["String"]["output"]>;
+  errorMessage?: Maybe<Scalars["String"]["output"]>;
+  expiresAt?: Maybe<Scalars["DateTime"]["output"]>;
+  hasActiveSubscription: Scalars["Boolean"]["output"];
+  latestTransactionId?: Maybe<Scalars["String"]["output"]>;
+  ok: Scalars["Boolean"]["output"];
+  originalTransactionId?: Maybe<Scalars["String"]["output"]>;
+  productId?: Maybe<Scalars["String"]["output"]>;
+};
+
 export type TableStateGql = {
   __typename?: "TableStateGQL";
   homography?: Maybe<HomographyInfoGql>;
@@ -4119,6 +4162,7 @@ export type GetDeployedConfigQuery = {
     firebase: boolean;
     minimumAllowedAppVersion: string;
     subscriptionGatingEnabled: boolean;
+    quotaEnforcementEnabled: boolean;
     defaultAndroidRecordingFormat: StreamSegmentTypeEnum;
     bucketUrl: string;
     bannerMessages: Array<{
@@ -5784,6 +5828,47 @@ export type GetUserPlayTimeQuery = {
   getPlayTime: { __typename?: "UserPlayTimeGQL"; totalSeconds: number };
 };
 
+export type GetUploadQuotaStatusQueryVariables = Exact<{
+  [key: string]: never;
+}>;
+
+export type GetUploadQuotaStatusQuery = {
+  __typename?: "Query";
+  getQuotaStatus: {
+    __typename?: "QuotaStatusGQL";
+    tierName: string;
+    periodStart: any;
+    periodEnd: any;
+    durationUsedSeconds: number;
+    durationLimitSeconds?: number | null;
+    maxVideoDurationSeconds?: number | null;
+    durationRemainingSeconds?: number | null;
+    canUpload: boolean;
+    importQuotaBuckets: Array<{
+      __typename?: "QuotaBucketStatusGQL";
+      quotaKey: string;
+      appliesToUploadKind: string;
+      periodStart: any;
+      periodEnd: any;
+      durationUsedSeconds: number;
+      durationLimitSeconds?: number | null;
+      durationRemainingSeconds?: number | null;
+      canUpload: boolean;
+    }>;
+    recordingQuotaBuckets: Array<{
+      __typename?: "QuotaBucketStatusGQL";
+      quotaKey: string;
+      appliesToUploadKind: string;
+      periodStart: any;
+      periodEnd: any;
+      durationUsedSeconds: number;
+      durationLimitSeconds?: number | null;
+      durationRemainingSeconds?: number | null;
+      canUpload: boolean;
+    }>;
+  };
+};
+
 export type GetUsernamesQueryVariables = Exact<{
   matchString: Scalars["String"]["input"];
   limit?: InputMaybe<Scalars["Int"]["input"]>;
@@ -8734,6 +8819,7 @@ export const GetDeployedConfigDocument = gql`
       firebase
       minimumAllowedAppVersion
       subscriptionGatingEnabled
+      quotaEnforcementEnabled
       bannerMessages {
         color
         dismissible
@@ -12099,6 +12185,105 @@ export type GetUserPlayTimeQueryResult = Apollo.QueryResult<
   GetUserPlayTimeQuery,
   GetUserPlayTimeQueryVariables
 >;
+export const GetUploadQuotaStatusDocument = gql`
+  query GetUploadQuotaStatus {
+    getQuotaStatus {
+      tierName
+      periodStart
+      periodEnd
+      durationUsedSeconds
+      durationLimitSeconds
+      maxVideoDurationSeconds
+      durationRemainingSeconds
+      canUpload
+      importQuotaBuckets {
+        quotaKey
+        appliesToUploadKind
+        periodStart
+        periodEnd
+        durationUsedSeconds
+        durationLimitSeconds
+        durationRemainingSeconds
+        canUpload
+      }
+      recordingQuotaBuckets {
+        quotaKey
+        appliesToUploadKind
+        periodStart
+        periodEnd
+        durationUsedSeconds
+        durationLimitSeconds
+        durationRemainingSeconds
+        canUpload
+      }
+    }
+  }
+`;
+
+/**
+ * __useGetUploadQuotaStatusQuery__
+ *
+ * To run a query within a React component, call `useGetUploadQuotaStatusQuery` and pass it any options that fit your needs.
+ * When your component renders, `useGetUploadQuotaStatusQuery` returns an object from Apollo Client that contains loading, error, and data properties
+ * you can use to render your UI.
+ *
+ * @param baseOptions options that will be passed into the query, supported options are listed on: https://www.apollographql.com/docs/react/api/react-hooks/#options;
+ *
+ * @example
+ * const { data, loading, error } = useGetUploadQuotaStatusQuery({
+ *   variables: {
+ *   },
+ * });
+ */
+export function useGetUploadQuotaStatusQuery(
+  baseOptions?: Apollo.QueryHookOptions<
+    GetUploadQuotaStatusQuery,
+    GetUploadQuotaStatusQueryVariables
+  >,
+) {
+  const options = { ...defaultOptions, ...baseOptions };
+  return Apollo.useQuery<
+    GetUploadQuotaStatusQuery,
+    GetUploadQuotaStatusQueryVariables
+  >(GetUploadQuotaStatusDocument, options);
+}
+export function useGetUploadQuotaStatusLazyQuery(
+  baseOptions?: Apollo.LazyQueryHookOptions<
+    GetUploadQuotaStatusQuery,
+    GetUploadQuotaStatusQueryVariables
+  >,
+) {
+  const options = { ...defaultOptions, ...baseOptions };
+  return Apollo.useLazyQuery<
+    GetUploadQuotaStatusQuery,
+    GetUploadQuotaStatusQueryVariables
+  >(GetUploadQuotaStatusDocument, options);
+}
+export function useGetUploadQuotaStatusSuspenseQuery(
+  baseOptions?: Apollo.SuspenseQueryHookOptions<
+    GetUploadQuotaStatusQuery,
+    GetUploadQuotaStatusQueryVariables
+  >,
+) {
+  const options = { ...defaultOptions, ...baseOptions };
+  return Apollo.useSuspenseQuery<
+    GetUploadQuotaStatusQuery,
+    GetUploadQuotaStatusQueryVariables
+  >(GetUploadQuotaStatusDocument, options);
+}
+export type GetUploadQuotaStatusQueryHookResult = ReturnType<
+  typeof useGetUploadQuotaStatusQuery
+>;
+export type GetUploadQuotaStatusLazyQueryHookResult = ReturnType<
+  typeof useGetUploadQuotaStatusLazyQuery
+>;
+export type GetUploadQuotaStatusSuspenseQueryHookResult = ReturnType<
+  typeof useGetUploadQuotaStatusSuspenseQuery
+>;
+export type GetUploadQuotaStatusQueryResult = Apollo.QueryResult<
+  GetUploadQuotaStatusQuery,
+  GetUploadQuotaStatusQueryVariables
+>;
 export const GetUsernamesDocument = gql`
   query getUsernames(
     $matchString: String!

src/operations/config.gql

@@ -6,6 +6,7 @@ query getDeployedConfig {
     firebase
     minimumAllowedAppVersion
     subscriptionGatingEnabled
+    quotaEnforcementEnabled
     bannerMessages {
       color
       dismissible

src/operations/user.gql

@@ -49,6 +49,39 @@ query GetUserPlayTime($userId: Int!, $filters: VideoFilterInput) {
   }
 }
 
+query GetUploadQuotaStatus {
+  getQuotaStatus {
+    tierName
+    periodStart
+    periodEnd
+    durationUsedSeconds
+    durationLimitSeconds
+    maxVideoDurationSeconds
+    durationRemainingSeconds
+    canUpload
+    importQuotaBuckets {
+      quotaKey
+      appliesToUploadKind
+      periodStart
+      periodEnd
+      durationUsedSeconds
+      durationLimitSeconds
+      durationRemainingSeconds
+      canUpload
+    }
+    recordingQuotaBuckets {
+      quotaKey
+      appliesToUploadKind
+      periodStart
+      periodEnd
+      durationUsedSeconds
+      durationLimitSeconds
+      durationRemainingSeconds
+      canUpload
+    }
+  }
+}
+
 query getUsernames(
   $matchString: String!
   $limit: Int = null

src/schema.gql

@@ -98,6 +98,7 @@ type Query {
   ): UserRelationshipsResult!
   getAvailableSubscriptionOptions: StripeSubscriptionOptionsGQL!
   getUserSubscriptionStatus: UserSubscriptionStatusGQL!
+  getAppleAppAccountToken: String!
   getQuotaStatus: QuotaStatusGQL!
   getPlayTime(userId: Int!, filters: VideoFilterInput = null): UserPlayTimeGQL!
   getUserVideos(
@@ -688,6 +689,7 @@ type DeployedConfigGQL {
   environment: String!
   minimumAllowedAppVersion: String!
   subscriptionGatingEnabled: Boolean!
+  quotaEnforcementEnabled: Boolean!
   bannerMessages: [BannerGQL!]!
   defaultAndroidRecordingFormat: StreamSegmentTypeEnum!
   bucketUrl: String!
@@ -1019,6 +1021,7 @@ enum EntitlementSourceTypeEnum {
   ADMIN
   MANUAL
   STRIPE
+  APPLE
   ALPHA_LEGACY
 }
 
@@ -1040,6 +1043,19 @@ type QuotaStatusGQL {
   durationUsedSeconds: Float!
   durationLimitSeconds: Int
   maxVideoDurationSeconds: Int
+  importQuotaBuckets: [QuotaBucketStatusGQL!]!
+  recordingQuotaBuckets: [QuotaBucketStatusGQL!]!
+  durationRemainingSeconds: Float
+  canUpload: Boolean!
+}
+
+type QuotaBucketStatusGQL {
+  quotaKey: String!
+  appliesToUploadKind: String!
+  periodStart: DateTime!
+  periodEnd: DateTime!
+  durationUsedSeconds: Float!
+  durationLimitSeconds: Int
   durationRemainingSeconds: Float
   canUpload: Boolean!
 }
@@ -1161,6 +1177,9 @@ type Mutation {
   retireTags(tagIds: [Int!]!): Boolean!
   ensureStripeCustomerExists: UserGQL!
   deleteUser: Boolean!
+  syncAppleSubscription(
+    input: SyncAppleSubscriptionInputGQL!
+  ): SyncAppleSubscriptionResultGQL!
   createSubscription(priceId: String!): CreateSubscriptionResultGQL!
   createCustomerPortalSession: CreateCustomerPortalSessionResultGQL!
   cancelSubscription: UserSubscriptionStatusGQL!
@@ -1314,6 +1333,26 @@ input EditUserInputGQL {
   agreesToMarketing: Boolean = null
 }
 
+type SyncAppleSubscriptionResultGQL {
+  ok: Boolean!
+  errorCode: String
+  errorMessage: String
+  hasActiveSubscription: Boolean!
+  entitlementSource: EntitlementSourceTypeEnum
+  entitlementStartsAt: DateTime
+  entitlementEndsAt: DateTime
+  appleStatus: Int
+  originalTransactionId: String
+  latestTransactionId: String
+  productId: String
+  expiresAt: DateTime
+}
+
+input SyncAppleSubscriptionInputGQL {
+  signedTransactionInfo: String!
+  signedRenewalInfo: String = null
+}
+
 type CreateSubscriptionResultGQL {
   checkoutUrl: String!
   sessionId: String!