docs: fix typedoc errors and warnings (#7006)

* docs: fix typedoc errors and warnings

* added missing quotations

.changeset/four-beds-smile.md

@@ -0,0 +1,5 @@
+---
+"@medusajs/types": patch
+---
+
+fix(types): remove duplicate CreateCustomerGroupDTO interface

packages/medusa/src/interfaces/fulfillment-service.ts

@@ -17,7 +17,7 @@ type ShippingMethodData = Record<string, unknown>
  * A fulfillment provider is a service that extends the `AbstractFulfillmentService` and implements its methods. So, adding a fulfillment provider is as simple as creating a service file in `src/services`.
  * The file's name is the fulfillment provider's class name as a slug and without the word `Service`. For example, if you're creating a `MyFulfillmentService` class, the file name is `src/services/my-fulfillment.ts`.
  *
- * ```ts title=src/services/my-fulfillment.ts
+ * ```ts title="src/services/my-fulfillment.ts"
  * import { AbstractFulfillmentService } from "@medusajs/medusa"
  *
  * class MyFulfillmentService extends AbstractFulfillmentService {

packages/types/src/api-key/common/api-key.ts

@@ -1,8 +1,6 @@
 import { BaseFilterable } from "../../dal"
 
 /**
- * @interface
- *
  * An API key's type.
  */
 export type ApiKeyType = "secret" | "publishable"

packages/types/src/customer/mutations.ts

@@ -283,26 +283,6 @@ export interface CustomerUpdatableFields {
   metadata?: Record<string, unknown> | null
 }
 
-/**
- * The customer group to be created.
- */
-export interface CreateCustomerGroupDTO {
-  /**
-   * The name of the customer group.
-   */
-  name: string
-
-  /**
-   * Holds custom data in key-value pairs.
-   */
-  metadata?: Record<string, unknown> | null
-
-  /**
-   * Who the customer group.
-   */
-  created_by?: string
-}
-
 /**
  * The updatable fields of a customer group.
  */
@@ -358,7 +338,8 @@ export interface CreateCustomerGroupDTO {
   metadata?: Record<string, unknown> | null
 
   /**
-   * Who created the customer group.
+   * Who created the customer group. For example,
+   * the ID of the user that created the customer group.
    */
   created_by?: string
 }

packages/types/src/fulfillment/mutations/geo-zone.ts

@@ -100,8 +100,6 @@ export interface CreateZipGeoZoneDTO extends CreateGeoZoneBaseDTO {
 }
 
 /**
- * @interface
- *
  * The geo zone to be created. The value of the `type` attributes allows for passing more attributes.
  */
 export type CreateGeoZoneDTO =
@@ -195,8 +193,6 @@ export interface UpdateZipGeoZoneDTO extends UpdateGeoZoneBaseDTO {
 }
 
 /**
- * @interface
- *
  * The attributes to update in the geo zone. The value of the `type` attributes allows for passing more attributes.
  */
 export type UpdateGeoZoneDTO =

packages/types/src/promotion/common/application-method.ts

@@ -3,15 +3,11 @@ import { PromotionDTO } from "./promotion"
 import { CreatePromotionRuleDTO, PromotionRuleDTO } from "./promotion-rule"
 
 /**
- * @interface
- *
  * The application method's possible types.
  */
 export type ApplicationMethodTypeValues = "fixed" | "percentage"
 
 /**
- * @interface
- *
  * The application method's possible target types.
  */
 export type ApplicationMethodTargetTypeValues =
@@ -20,8 +16,6 @@ export type ApplicationMethodTargetTypeValues =
   | "items"
 
 /**
- * @interface
- *
  * The application method's possible allocation values.
  */
 export type ApplicationMethodAllocationValues = "each" | "across"

packages/types/src/promotion/common/campaign-budget.ts

@@ -1,8 +1,6 @@
 import { BaseFilterable } from "../../dal"
 
 /**
- * @interface
- *
  * The campaign budget's possible types.
  */
 export type CampaignBudgetTypeValues = "spend" | "usage"

packages/types/src/promotion/common/compute-actions.ts

@@ -1,6 +1,4 @@
 /**
- * @interface
- *
  * A compute action informs you what adjustment must be made to a cart item or shipping method.
  */
 export type ComputeActions =
@@ -11,8 +9,6 @@ export type ComputeActions =
   | CampaignBudgetExceededAction
 
 /**
- * @interface
- *
  * These computed action types can affect a campaign's budget.
  */
 export type UsageComputedActions =

packages/types/src/promotion/common/promotion-rule.ts

@@ -2,8 +2,6 @@ import { BaseFilterable } from "../../dal"
 import { PromotionRuleValueDTO } from "./promotion-rule-value"
 
 /**
- * @interface
- *
  * The possible operators to use in a promotion rule.
  */
 export type PromotionRuleOperatorValues =

packages/types/src/promotion/common/promotion.ts

@@ -9,8 +9,6 @@ import { CampaignDTO } from "./campaign"
 import { CreatePromotionRuleDTO, PromotionRuleDTO } from "./promotion-rule"
 
 /**
- * @interface
- *
  * The promotion's possible types.
  */
 export type PromotionTypeValues = "standard" | "buyget"

packages/types/src/tax/provider.ts

@@ -90,6 +90,7 @@ export type ItemTaxCalculationLine = {
  *
  * For example:
  *
+ * ```ts
  * export default class MyTaxProvider implements ITaxProvider {
  *   // ...
  *   constructor(container, options) {
@@ -100,6 +101,7 @@ export type ItemTaxCalculationLine = {
  *     this.client = new Client(options)
  *   }
  * }
+ * ```
  *
  * ---
  */