Applying comments from review

Shopify · Sep 5, 2023 · 05c395a · 05c395a
1 parent 5da6add
commit 05c395a
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 22 deletions.
diff --git a/.changeset/tasty-foxes-work.md b/.changeset/tasty-foxes-work.md
@@ -2,4 +2,4 @@
 '@shopify/shopify-api': minor
 ---
 
-Add new trialDaysOverride parameter to billing.request, so that apps can override the default config value.
+Add new trialDays parameter to billing.request, so that apps can override the default config value.
diff --git a/docs/reference/billing/request.md b/docs/reference/billing/request.md
@@ -136,7 +136,7 @@ Which URL to redirect the merchant to after the charge is confirmed.
 
 Whether to return the `confirmationUrl` as a `string`, or to return a more detailed object (see below).
 
-### trialDaysOverride
+### trialDays
 
 `number`
 

diff --git a/lib/billing/__tests__/request.test.ts b/lib/billing/__tests__/request.test.ts
@@ -428,7 +428,7 @@ describe('shopify.billing.request', () => {
       session,
       plan: Responses.PLAN_1,
       returnObject: true,
-      trialDaysOverride: 20,
+      trialDays: 20,
     });
 
     expect({
@@ -462,7 +462,7 @@ describe('shopify.billing.request', () => {
       session,
       plan: Responses.PLAN_1,
       returnObject: true,
-      trialDaysOverride: 0,
+      trialDays: 0,
     });
 
     expect({

diff --git a/lib/billing/request.ts b/lib/billing/request.ts
@@ -29,7 +29,7 @@ interface RequestInternalParams {
 
 interface RequestSubscriptionInternalParams extends RequestInternalParams {
   billingConfig: BillingConfigSubscriptionPlan;
-  trialDaysOverride?: number;
+  trialDays?: number;
 }
 
 interface RequestOneTimePaymentInternalParams extends RequestInternalParams {
@@ -38,7 +38,7 @@ interface RequestOneTimePaymentInternalParams extends RequestInternalParams {
 
 interface RequestUsageSubscriptionInternalParams extends RequestInternalParams {
   billingConfig: BillingConfigUsagePlan;
-  trialDaysOverride?: number;
+  trialDays?: number;
 }
 
 export function request(config: ConfigInterface) {
@@ -48,7 +48,7 @@ export function request(config: ConfigInterface) {
     isTest = true,
     returnUrl: returnUrlParam,
     returnObject = false,
-    trialDaysOverride = undefined,
+    trialDays = undefined,
   }: Params): Promise<BillingRequestResponse<Params>> {
     if (!config.billing || !config.billing[plan]) {
       throw new BillingError({
@@ -93,7 +93,7 @@ export function request(config: ConfigInterface) {
           client,
           returnUrl,
           isTest,
-          trialDaysOverride,
+          trialDays,
         });
         data = mutationUsageResponse.data.appSubscriptionCreate;
         break;
@@ -105,7 +105,7 @@ export function request(config: ConfigInterface) {
           client,
           returnUrl,
           isTest,
-          trialDaysOverride,
+          trialDays,
         });
         data = mutationRecurringResponse.data.appSubscriptionCreate;
       }
@@ -134,18 +134,16 @@ async function requestRecurringPayment({
   client,
   returnUrl,
   isTest,
-  trialDaysOverride,
+  trialDays,
 }: RequestSubscriptionInternalParams): Promise<RecurringPaymentResponse> {
-  const trialDays =
-    trialDaysOverride === undefined
-      ? billingConfig.trialDays
-      : trialDaysOverride;
+  const trialDaysValue =
+    trialDays === undefined ? billingConfig.trialDays : trialDays;
   const mutationResponse = await client.query<RecurringPaymentResponse>({
     data: {
       query: RECURRING_PURCHASE_MUTATION,
       variables: {
         name: plan,
-        trialDays,
+        trialDays: trialDaysValue,
         replacementBehavior: billingConfig.replacementBehavior,
         returnUrl,
         test: isTest,
@@ -190,20 +188,18 @@ async function requestUsagePayment({
   client,
   returnUrl,
   isTest,
-  trialDaysOverride,
+  trialDays,
 }: RequestUsageSubscriptionInternalParams): Promise<RecurringPaymentResponse> {
-  const trialDays =
-    trialDaysOverride === undefined
-      ? billingConfig.trialDays
-      : trialDaysOverride;
+  const trialDaysValue =
+    trialDays === undefined ? billingConfig.trialDays : trialDays;
   const mutationResponse = await client.query<RecurringPaymentResponse>({
     data: {
       query: RECURRING_PURCHASE_MUTATION,
       variables: {
         name: plan,
         returnUrl,
         test: isTest,
-        trialDays,
+        trialDays: trialDaysValue,
         replacementBehavior: billingConfig.replacementBehavior,
         lineItems: [
           {

diff --git a/lib/billing/types.ts b/lib/billing/types.ts
@@ -74,7 +74,7 @@ export interface BillingRequestParams {
   isTest?: boolean;
   returnUrl?: string;
   returnObject?: boolean;
-  trialDaysOverride?: number;
+  trialDays?: number;
 }
 
 export interface BillingRequestResponseObject {