#7885

Committed 24 Mar 2025 08:02AM UTC coverage: 95.13% (+0.02%) from 95.108%

Build # #7885

Build Type

push

Committed by

Commit Message

 chore(package): version 3.183.0

Run Details

1316 of 1444 branches covered (91.14%)

Branch coverage included in aggregate %.

6888 of 7180 relevant lines covered (95.93%)

7.59 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

94.5

/src/publicApiClient.ts

import {
  AbstractRestfulClient,
  ConfigurationsClient,
} from './abstractRestfulClient';
import { CheckDomainClient, WhoAmIClient } from './general';
import { LicenseRequestClient, LicensesClient } from './licenses';
import { SubscriptionsClient } from './subscriptions';
import { CustomersClient } from './customers';
import { OrdersClient } from './orders';
import { ContactClient } from './contact';
import { CampaignClient } from './campaign';
import { ConsumptionClient } from './consumption';
import {
  WellArchitectedRegisterClient,
  WellArchitectedStandardsClient,
} from './wellArchitected';
import { CartClient } from './cart/cartClient';
import { SupportCenterClient } from './supportCenter';
import { CatalogClient } from './catalog';
import { UserClient } from './user';
import { NotificationsClient } from './notifications';
import { RegisterClient, StandardsClient } from './security';
import { PartnerClient } from './partner';
import { OrganizationUnitClient } from './organisationUnit';
import { QuotesClient } from './quotes';
import { BillingClient } from './billing';
import { AnalyticsClient } from './analytics';
import { ReportsClient } from './reports';
import { OrderSoftwareClient } from './orderSoftware';
import { MonitoringClient } from './monitoring';

/**
 * Public API Client class, should be the main entry point for your calls
 */
export class PublicApiClient extends AbstractRestfulClient {
  constructor() {
    super();
  }

  private applyConfig(client: AbstractRestfulClient): AbstractRestfulClient {
    return client
      .setUrl(this.url)
      .setSecurity(this.security)
      .setApiKey(this.apiKey)
      .setHeaders(this.headers)
      .setHttpExceptionHandlers(this.httpExceptionHandlers);
  }

  /**
   * Creates a new {@link CustomersClient} instance and returns it
   * @returns {@link CustomersClient}
   */
  public getCustomersClient(
    configuration?: ConfigurationsClient,
  ): CustomersClient {
    const client: CustomersClient = new CustomersClient(configuration);
    this.applyConfig(client);

    return client;
  }

  /**
   * Creates a new {@link PartnerClient} instance and returns it
   * @returns {@link PartnerClient}
   */
  public getPartnerClient(configuration?: ConfigurationsClient): PartnerClient {
    const client: PartnerClient = new PartnerClient(configuration);
    this.applyConfig(client);

    return client;
  }

  /**
   * Creates a new {@link QuotesClient} instance and returns it
   * @returns {@link QuotesClient}
   */
  public getQuotesClient(configuration?: ConfigurationsClient): QuotesClient {
    const client: QuotesClient = new QuotesClient(configuration);
    this.applyConfig(client);

    return client;
  }

  /**
   * Creates a new {@link WhoAmIClient} instance and returns it
   * @returns {@link WhoAmIClient}
   */
  public getWhoamiClient(configuration?: ConfigurationsClient): WhoAmIClient {
    const client: WhoAmIClient = new WhoAmIClient(configuration);
    this.applyConfig(client);

    return client;
  }

  /**
   * Creates a new {@link LicensesClient} instance and returns it
   * @returns {@link LicensesClient}
   */
  public getLicensesClient(
    configuration?: ConfigurationsClient,
  ): LicensesClient {
    const client: LicensesClient = new LicensesClient(configuration);
    this.applyConfig(client);

    return client;
  }

  /**
   * Creates a new {@link LicenseRequestClient} instance and returns it
   * @returns {@link LicenseRequestClient}
   */
  public getLicenseRequestClient(
    configuration?: ConfigurationsClient,
  ): LicenseRequestClient {
    const client: LicenseRequestClient = new LicenseRequestClient(
      configuration,
    );
    this.applyConfig(client);

    return client;
  }

  /**
   * Creates a new {@link CheckDomainClient} instance and returns it
   * @returns {@link CheckDomainClient}
   */
  public getCheckDomainClient(
    configuration?: ConfigurationsClient,
  ): CheckDomainClient {
    const client: CheckDomainClient = new CheckDomainClient(configuration);
    this.applyConfig(client);

    return client;
  }

  /**
   * Creates a new {@link SubscriptionsClient} instance and returns it
   * @returns {@link SubscriptionsClient}
   */
  public getSubscriptionsClient(
    configuration?: ConfigurationsClient,
  ): SubscriptionsClient {
    const client: SubscriptionsClient = new SubscriptionsClient(configuration);
    this.applyConfig(client);

    return client;
  }

  /**
   * Creates a new {@link OrdersClient} instance and returns it
   * @returns {@link OrdersClient}
   */
  public getOrdersClient(configuration?: ConfigurationsClient): OrdersClient {
    const client: OrdersClient = new OrdersClient(configuration);
    this.applyConfig(client);

    return client;
  }

  /**
   * Creates a new {@link OrderSoftwareClient} instance and returns it
   * @returns {@link OrderSoftwareClient}
   */
  public getOrderSoftwareClient(
    configuration?: ConfigurationsClient,
  ): OrderSoftwareClient {
    const client: OrderSoftwareClient = new OrderSoftwareClient(configuration);
    this.applyConfig(client);

    return client;
  }

  /**
   * Creates a new {@link ContactClient} instance and returns it
   * @returns {@link ContactClient}
   */
  public getContactClient(configuration?: ConfigurationsClient): ContactClient {
    const client: ContactClient = new ContactClient(configuration);
    this.applyConfig(client);

    return client;
  }

  /**
   * Creates a new {@link ContactClient} instance and returns it
   * @returns {@link ContactClient}
   */
  public getCampaignClient(
    configuration?: ConfigurationsClient,
  ): CampaignClient {
    const client: CampaignClient = new CampaignClient(configuration);
    this.applyConfig(client);

    return client;
  }

  public getConsumptionClient(
    configuration?: ConfigurationsClient,
  ): ConsumptionClient {
    const client: ConsumptionClient = new ConsumptionClient(configuration);
    this.applyConfig(client);

    return client;
  }

  /**
   * @deprecated
   * Prefer using getWellArchitectedStandardsClient
   */
  public getSecurityStandardsClient(
    configuration?: ConfigurationsClient,
  ): StandardsClient {
    const client: StandardsClient = new StandardsClient(configuration);
    this.applyConfig(client);

    return client;
  }

  /**
   * @deprecated
   * Prefer using getWellArchitectedRegisterClient
   */
  public getSecurityRegisterClient(
    configuration?: ConfigurationsClient,
  ): RegisterClient {
    const client: RegisterClient = new RegisterClient(configuration);
    this.applyConfig(client);

    return client;
  }

  public getWellArchitectedStandardsClient(
    configuration?: ConfigurationsClient,
  ): WellArchitectedStandardsClient {
    const client: WellArchitectedStandardsClient = new WellArchitectedStandardsClient(
      configuration,
    );
    this.applyConfig(client);

    return client;
  }

  public getWellArchitectedRegisterClient(
    configuration?: ConfigurationsClient,
  ): WellArchitectedRegisterClient {
    const client: WellArchitectedRegisterClient = new WellArchitectedRegisterClient(
      configuration,
    );
    this.applyConfig(client);

    return client;
  }

  public getCartClient(configuration?: ConfigurationsClient): CartClient {
    const client: CartClient = new CartClient(configuration);
    this.applyConfig(client);

    return client;
  }
  public getSupportCenterClient(
    configuration?: ConfigurationsClient,
  ): SupportCenterClient {
    const client: SupportCenterClient = new SupportCenterClient(configuration);
    this.applyConfig(client);

    return client;
  }

  public getCatalogClient(configuration?: ConfigurationsClient): CatalogClient {
    const client: CatalogClient = new CatalogClient(configuration);
    this.applyConfig(client);

    return client;
  }

  public getUserClient(configuration?: ConfigurationsClient): UserClient {
    const client: UserClient = new UserClient(configuration);
    this.applyConfig(client);

    return client;
  }

  public getNotificationsClient(
    configuration?: ConfigurationsClient,
  ): NotificationsClient {
    const client: NotificationsClient = new NotificationsClient(configuration);
    this.applyConfig(client);

    return client;
  }

  public getOrganizationUnitClient(
    configuration?: ConfigurationsClient,
  ): OrganizationUnitClient {
    const client: OrganizationUnitClient = new OrganizationUnitClient(
      configuration,
    );
    this.applyConfig(client);

    return client;
  }

  public getBillingClient(configuration?: ConfigurationsClient): BillingClient {
    const client: BillingClient = new BillingClient(configuration);
    this.applyConfig(client);

    return client;
  }

  public getAnalyticsClient(
    configuration?: ConfigurationsClient,
  ): AnalyticsClient {
    const client: AnalyticsClient = new AnalyticsClient(configuration);
    this.applyConfig(client);

    return client;
  }

  public getReportsClient(configuration?: ConfigurationsClient): ReportsClient {
    const client: ReportsClient = new ReportsClient(configuration);
    this.applyConfig(client);

    return client;
  }

  public getMonitoringClient(
    configuration?: ConfigurationsClient,
  ): MonitoringClient {
    const client: MonitoringClient = new MonitoringClient(configuration);
    this.applyConfig(client);

    return client;
  }
}

export default PublicApiClient;

1	import {	1✔
2	AbstractRestfulClient,
3	ConfigurationsClient,
4	} from './abstractRestfulClient';
5	import { CheckDomainClient, WhoAmIClient } from './general';	1✔
6	import { LicenseRequestClient, LicensesClient } from './licenses';	1✔
7	import { SubscriptionsClient } from './subscriptions';	1✔
8	import { CustomersClient } from './customers';	1✔
9	import { OrdersClient } from './orders';	1✔
10	import { ContactClient } from './contact';	1✔
11	import { CampaignClient } from './campaign';	1✔
12	import { ConsumptionClient } from './consumption';	1✔
13	import {	1✔
14	WellArchitectedRegisterClient,
15	WellArchitectedStandardsClient,
16	} from './wellArchitected';
17	import { CartClient } from './cart/cartClient';	1✔
18	import { SupportCenterClient } from './supportCenter';	1✔
19	import { CatalogClient } from './catalog';	1✔
20	import { UserClient } from './user';	1✔
21	import { NotificationsClient } from './notifications';	1✔
22	import { RegisterClient, StandardsClient } from './security';	1✔
23	import { PartnerClient } from './partner';	1✔
24	import { OrganizationUnitClient } from './organisationUnit';	1✔
25	import { QuotesClient } from './quotes';	1✔
26	import { BillingClient } from './billing';	1✔
27	import { AnalyticsClient } from './analytics';	1✔
28	import { ReportsClient } from './reports';	1✔
29	import { OrderSoftwareClient } from './orderSoftware';	1✔
30	import { MonitoringClient } from './monitoring';	1✔
31
32	/**
33	* Public API Client class, should be the main entry point for your calls
34	*/
35	export class PublicApiClient extends AbstractRestfulClient {	1✔
36	constructor() {
37	super();	95✔
38	}
39
40	private applyConfig(client: AbstractRestfulClient): AbstractRestfulClient {
41	return client	95✔
42	.setUrl(this.url)
43	.setSecurity(this.security)
44	.setApiKey(this.apiKey)
45	.setHeaders(this.headers)
46	.setHttpExceptionHandlers(this.httpExceptionHandlers);
47	}
48
49	/**
50	* Creates a new {@link CustomersClient} instance and returns it
51	* @returns {@link CustomersClient}
52	*/
53	public getCustomersClient(
54	configuration?: ConfigurationsClient,
55	): CustomersClient {
56	const client: CustomersClient = new CustomersClient(configuration);	17✔
57	this.applyConfig(client);	17✔
58
59	return client;	17✔
60	}
61
62	/**
63	* Creates a new {@link PartnerClient} instance and returns it
64	* @returns {@link PartnerClient}
65	*/
66	public getPartnerClient(configuration?: ConfigurationsClient): PartnerClient {
67	const client: PartnerClient = new PartnerClient(configuration);	2✔
68	this.applyConfig(client);	2✔
69
70	return client;	2✔
71	}
72
73	/**
74	* Creates a new {@link QuotesClient} instance and returns it
75	* @returns {@link QuotesClient}
76	*/
77	public getQuotesClient(configuration?: ConfigurationsClient): QuotesClient {
78	const client: QuotesClient = new QuotesClient(configuration);	8✔
79	this.applyConfig(client);	8✔
80
81	return client;	8✔
82	}
83
84	/**
85	* Creates a new {@link WhoAmIClient} instance and returns it
86	* @returns {@link WhoAmIClient}
87	*/
88	public getWhoamiClient(configuration?: ConfigurationsClient): WhoAmIClient {
89	const client: WhoAmIClient = new WhoAmIClient(configuration);	5✔
90	this.applyConfig(client);	5✔
91
92	return client;	5✔
93	}
94
95	/**
96	* Creates a new {@link LicensesClient} instance and returns it
97	* @returns {@link LicensesClient}
98	*/
99	public getLicensesClient(
100	configuration?: ConfigurationsClient,
101	): LicensesClient {
102	const client: LicensesClient = new LicensesClient(configuration);	25✔
103	this.applyConfig(client);	25✔
104
105	return client;	25✔
106	}
107
108	/**
109	* Creates a new {@link LicenseRequestClient} instance and returns it
110	* @returns {@link LicenseRequestClient}
111	*/
112	public getLicenseRequestClient(
113	configuration?: ConfigurationsClient,
114	): LicenseRequestClient {
115	const client: LicenseRequestClient = new LicenseRequestClient(	1✔
116	configuration,
117	);
118	this.applyConfig(client);	1✔
119
120	return client;	1✔
121	}
122
123	/**
124	* Creates a new {@link CheckDomainClient} instance and returns it
125	* @returns {@link CheckDomainClient}
126	*/
127	public getCheckDomainClient(
128	configuration?: ConfigurationsClient,
129	): CheckDomainClient {
130	const client: CheckDomainClient = new CheckDomainClient(configuration);	4✔
131	this.applyConfig(client);	4✔
132
133	return client;	4✔
134	}
135
136	/**
137	* Creates a new {@link SubscriptionsClient} instance and returns it
138	* @returns {@link SubscriptionsClient}
139	*/
140	public getSubscriptionsClient(
141	configuration?: ConfigurationsClient,
142	): SubscriptionsClient {
143	const client: SubscriptionsClient = new SubscriptionsClient(configuration);	2✔
144	this.applyConfig(client);	2✔
145
146	return client;	2✔
147	}
148
149	/**
150	* Creates a new {@link OrdersClient} instance and returns it
151	* @returns {@link OrdersClient}
152	*/
153	public getOrdersClient(configuration?: ConfigurationsClient): OrdersClient {
154	const client: OrdersClient = new OrdersClient(configuration);	4✔
155	this.applyConfig(client);	4✔
156
157	return client;	4✔
158	}
159
160	/**
161	* Creates a new {@link OrderSoftwareClient} instance and returns it
162	* @returns {@link OrderSoftwareClient}
163	*/
164	public getOrderSoftwareClient(
165	configuration?: ConfigurationsClient,
166	): OrderSoftwareClient {
167	const client: OrderSoftwareClient = new OrderSoftwareClient(configuration);	1✔
168	this.applyConfig(client);	1✔
169
170	return client;	1✔
171	}
172
173	/**
174	* Creates a new {@link ContactClient} instance and returns it
175	* @returns {@link ContactClient}
176	*/
177	public getContactClient(configuration?: ConfigurationsClient): ContactClient {
178	const client: ContactClient = new ContactClient(configuration);	1✔
179	this.applyConfig(client);	1✔
180
181	return client;	1✔
182	}
183
184	/**
185	* Creates a new {@link ContactClient} instance and returns it
186	* @returns {@link ContactClient}
187	*/
188	public getCampaignClient(
189	configuration?: ConfigurationsClient,
190	): CampaignClient {
191	const client: CampaignClient = new CampaignClient(configuration);	1✔
192	this.applyConfig(client);	1✔
193
194	return client;	1✔
195	}
196
197	public getConsumptionClient(
198	configuration?: ConfigurationsClient,
199	): ConsumptionClient {
200	const client: ConsumptionClient = new ConsumptionClient(configuration);	1✔
201	this.applyConfig(client);	1✔
202
203	return client;	1✔
204	}
205
206	/**
207	* @deprecated
208	* Prefer using getWellArchitectedStandardsClient
209	*/
210	public getSecurityStandardsClient(
211	configuration?: ConfigurationsClient,
212	): StandardsClient {
213	const client: StandardsClient = new StandardsClient(configuration);	1✔
214	this.applyConfig(client);	1✔
215
216	return client;	1✔
217	}
218
219	/**
220	* @deprecated
221	* Prefer using getWellArchitectedRegisterClient
222	*/
223	public getSecurityRegisterClient(
224	configuration?: ConfigurationsClient,
225	): RegisterClient {
226	const client: RegisterClient = new RegisterClient(configuration);	1✔
227	this.applyConfig(client);	1✔
228
229	return client;	1✔
230	}
231
232	public getWellArchitectedStandardsClient(
233	configuration?: ConfigurationsClient,
234	): WellArchitectedStandardsClient {
235	const client: WellArchitectedStandardsClient = new WellArchitectedStandardsClient(	×
236	configuration,
237	);
238	this.applyConfig(client);	×
239
240	return client;	×
241	}
242
243	public getWellArchitectedRegisterClient(
244	configuration?: ConfigurationsClient,
245	): WellArchitectedRegisterClient {
246	const client: WellArchitectedRegisterClient = new WellArchitectedRegisterClient(	×
247	configuration,
248	);
249	this.applyConfig(client);	×
250
251	return client;	×
252	}
253
254	public getCartClient(configuration?: ConfigurationsClient): CartClient {
255	const client: CartClient = new CartClient(configuration);	1✔
256	this.applyConfig(client);	1✔
257
258	return client;	1✔
259	}
260	public getSupportCenterClient(
261	configuration?: ConfigurationsClient,
262	): SupportCenterClient {
263	const client: SupportCenterClient = new SupportCenterClient(configuration);	1✔
264	this.applyConfig(client);	1✔
265
266	return client;	1✔
267	}
268
269	public getCatalogClient(configuration?: ConfigurationsClient): CatalogClient {
270	const client: CatalogClient = new CatalogClient(configuration);	1✔
271	this.applyConfig(client);	1✔
272
273	return client;	1✔
274	}
275
276	public getUserClient(configuration?: ConfigurationsClient): UserClient {
277	const client: UserClient = new UserClient(configuration);	1✔
278	this.applyConfig(client);	1✔
279
280	return client;	1✔
281	}
282
283	public getNotificationsClient(
284	configuration?: ConfigurationsClient,
285	): NotificationsClient {
286	const client: NotificationsClient = new NotificationsClient(configuration);	7✔
287	this.applyConfig(client);	7✔
288
289	return client;	7✔
290	}
291
292	public getOrganizationUnitClient(
293	configuration?: ConfigurationsClient,
294	): OrganizationUnitClient {
295	const client: OrganizationUnitClient = new OrganizationUnitClient(	6✔
296	configuration,
297	);
298	this.applyConfig(client);	6✔
299
300	return client;	6✔
301	}
302
303	public getBillingClient(configuration?: ConfigurationsClient): BillingClient {
304	const client: BillingClient = new BillingClient(configuration);	1✔
305	this.applyConfig(client);	1✔
306
307	return client;	1✔
308	}
309
310	public getAnalyticsClient(
311	configuration?: ConfigurationsClient,
312	): AnalyticsClient {
313	const client: AnalyticsClient = new AnalyticsClient(configuration);	1✔
314	this.applyConfig(client);	1✔
315
316	return client;	1✔
317	}
318
319	public getReportsClient(configuration?: ConfigurationsClient): ReportsClient {
320	const client: ReportsClient = new ReportsClient(configuration);	1✔
321	this.applyConfig(client);	1✔
322
323	return client;	1✔
324	}
325
326	public getMonitoringClient(
327	configuration?: ConfigurationsClient,
328	): MonitoringClient {
329	const client: MonitoringClient = new MonitoringClient(configuration);	1✔
330	this.applyConfig(client);	1✔
331
332	return client;	1✔
333	}
334	}
335
336	export default PublicApiClient;	1✔

ArrowSphere / nodejs-api-client / #7885

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous