chore(js-sdk): add ignore tsdoc tag to client and constructor of inner classes (#9635)

packages/core/js-sdk/src/admin/api-key.ts

@@ -3,7 +3,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class ApiKey {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/campaign.ts

@@ -3,7 +3,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class Campaign {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/claim.ts

@@ -4,7 +4,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class Claim {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/currency.ts

@@ -3,7 +3,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class Currency {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/customer-group.ts

@@ -3,7 +3,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class CustomerGroup {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/customer.ts

@@ -8,7 +8,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class Customer {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/exchange.ts

@@ -4,7 +4,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class Exchange {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/fulfillment-provider.ts

@@ -3,7 +3,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class FulfillmentProvider {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/fulfillment-set.ts

@@ -3,7 +3,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class FulfillmentSet {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/fulfillment.ts

@@ -3,7 +3,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class Fulfillment {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/inventory-item.ts

@@ -3,7 +3,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class InventoryItem {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/invite.ts

@@ -8,7 +8,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class Invite {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/notification.ts

@@ -3,7 +3,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class Notification {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/order-edit.ts

@@ -3,7 +3,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class OrderEdit {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/order.ts

@@ -10,7 +10,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class Order {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/payment-collection.ts

@@ -3,7 +3,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class PaymentCollection {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/payment.ts

@@ -3,7 +3,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class Payment {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/price-list.ts

@@ -3,8 +3,14 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class PriceList {
+  /**
+   * @ignore
+   */
   private client: Client
 
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/price-preference.ts

@@ -3,8 +3,14 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class PricePreference {
+  /**
+   * @ignore
+   */
   private client: Client
 
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/product-category.ts

@@ -3,7 +3,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class ProductCategory {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/product-collection.ts

@@ -3,7 +3,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class ProductCollection {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/product-tag.ts

@@ -3,7 +3,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class ProductTag {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/product-type.ts

@@ -3,7 +3,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class ProductType {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/product-variant.ts

@@ -3,7 +3,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class ProductVariant {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/product.ts

@@ -3,7 +3,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class Product {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/promotion.ts

@@ -3,7 +3,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class Promotion {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/refund-reasons.ts

@@ -3,7 +3,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class RefundReason {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/region.ts

@@ -8,7 +8,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class Region {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/reservation.ts

@@ -3,7 +3,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 class Reservation {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/return-reason.ts

@@ -4,7 +4,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class ReturnReason {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/return.ts

@@ -4,7 +4,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class Return {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/sales-channel.ts

@@ -3,7 +3,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class SalesChannel {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/shipping-option.ts

@@ -3,7 +3,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class ShippingOption {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/shipping-profile.ts

@@ -3,7 +3,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class ShippingProfile {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/stock-location.ts

@@ -3,7 +3,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class StockLocation {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/store.ts

@@ -3,7 +3,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class Store {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/tax-rate.ts

@@ -5,7 +5,13 @@ import { ClientHeaders } from "../types"
 const taxRateUrl = "/admin/tax-rates"
 
 export class TaxRate {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/tax-region.ts

@@ -6,7 +6,13 @@ const taxRegionUrl = "/admin/tax-regions"
 
 // TODO: Add support for updating a tax region
 export class TaxRegion {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/upload.ts

@@ -3,7 +3,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class Upload {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/user.ts

@@ -3,7 +3,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class User {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }

packages/core/js-sdk/src/admin/workflow-execution.ts

@@ -3,7 +3,13 @@ import { Client } from "../client"
 import { ClientHeaders } from "../types"
 
 export class WorkflowExecution {
+  /**
+   * @ignore
+   */
   private client: Client
+  /**
+   * @ignore
+   */
   constructor(client: Client) {
     this.client = client
   }