yellowgrid-api-ts 3.2.238 → 3.2.240

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/api.d.ts CHANGED
@@ -956,6 +956,7 @@ export declare const AuditLogEntityTypeEnum: {
956
956
  readonly NumberPortNotes: "number_port_notes";
957
957
  readonly PopsOfflineInstances: "pops_offline_instances";
958
958
  readonly PopsOrderedItems: "pops_ordered_items";
959
+ readonly PopsPasswordSender: "pops_password_sender";
959
960
  readonly PopsPrizes: "pops_prizes";
960
961
  readonly PopsPrinters: "pops_printers";
961
962
  readonly PopsPromoCodes: "pops_promo_codes";
@@ -1019,6 +1020,30 @@ export interface AuthCodeResponseModel {
1019
1020
  */
1020
1021
  'redirect_uri'?: string | null;
1021
1022
  }
1023
+ /**
1024
+ * Graph Axis Data
1025
+ */
1026
+ export interface AxisDataDTO {
1027
+ /**
1028
+ * Type
1029
+ */
1030
+ 'type'?: AxisDataDTOTypeEnum;
1031
+ /**
1032
+ * Data
1033
+ */
1034
+ 'data'?: Array<string> | null;
1035
+ /**
1036
+ * Name
1037
+ */
1038
+ 'name'?: string | null;
1039
+ }
1040
+ export declare const AxisDataDTOTypeEnum: {
1041
+ readonly Value: "value";
1042
+ readonly Category: "category";
1043
+ readonly Time: "time";
1044
+ readonly Log: "log";
1045
+ };
1046
+ export type AxisDataDTOTypeEnum = typeof AxisDataDTOTypeEnum[keyof typeof AxisDataDTOTypeEnum];
1022
1047
  /**
1023
1048
  * Basic Order Item
1024
1049
  */
@@ -2599,6 +2624,73 @@ export interface GetGetPrice200Response {
2599
2624
  export interface GetGetRecording200Response {
2600
2625
  'recordingData'?: string;
2601
2626
  }
2627
+ /**
2628
+ * Graph
2629
+ */
2630
+ export interface GraphDTO {
2631
+ /**
2632
+ * Title
2633
+ */
2634
+ 'title'?: string;
2635
+ /**
2636
+ * X Axis
2637
+ */
2638
+ 'xAxis'?: Array<AxisDataDTO>;
2639
+ /**
2640
+ * Y Axis
2641
+ */
2642
+ 'yAxis'?: Array<AxisDataDTO>;
2643
+ /**
2644
+ * Legend
2645
+ */
2646
+ 'legend'?: Array<string>;
2647
+ /**
2648
+ * Series
2649
+ */
2650
+ 'series'?: Array<SeriesDTO>;
2651
+ /**
2652
+ * Currency
2653
+ */
2654
+ 'currency'?: GraphDTOCurrencyEnum | null;
2655
+ /**
2656
+ * Locale
2657
+ */
2658
+ 'locale'?: string;
2659
+ }
2660
+ export declare const GraphDTOCurrencyEnum: {
2661
+ readonly Eur: "EUR";
2662
+ readonly Usd: "USD";
2663
+ readonly Jpy: "JPY";
2664
+ readonly Bgn: "BGN";
2665
+ readonly Czk: "CZK";
2666
+ readonly Dkk: "DKK";
2667
+ readonly Gbp: "GBP";
2668
+ readonly Huf: "HUF";
2669
+ readonly Pln: "PLN";
2670
+ readonly Ron: "RON";
2671
+ readonly Sek: "SEK";
2672
+ readonly Chf: "CHF";
2673
+ readonly Isk: "ISK";
2674
+ readonly Nok: "NOK";
2675
+ readonly Try: "TRY";
2676
+ readonly Aud: "AUD";
2677
+ readonly Brl: "BRL";
2678
+ readonly Cad: "CAD";
2679
+ readonly Cny: "CNY";
2680
+ readonly Hkd: "HKD";
2681
+ readonly Idr: "IDR";
2682
+ readonly Ils: "ILS";
2683
+ readonly Inr: "INR";
2684
+ readonly Krw: "KRW";
2685
+ readonly Mxn: "MXN";
2686
+ readonly Myr: "MYR";
2687
+ readonly Nzd: "NZD";
2688
+ readonly Php: "PHP";
2689
+ readonly Sgd: "SGD";
2690
+ readonly Thb: "THB";
2691
+ readonly Zar: "ZAR";
2692
+ };
2693
+ export type GraphDTOCurrencyEnum = typeof GraphDTOCurrencyEnum[keyof typeof GraphDTOCurrencyEnum];
2602
2694
  /**
2603
2695
  * Change Response
2604
2696
  */
@@ -4393,6 +4485,86 @@ export interface PartnerDTO {
4393
4485
  */
4394
4486
  'customer'?: AccountSummaryDTO | null;
4395
4487
  }
4488
+ /**
4489
+ * Password Sender Request
4490
+ */
4491
+ export interface PasswordSenderDTO {
4492
+ /**
4493
+ * Username
4494
+ */
4495
+ 'username'?: string;
4496
+ /**
4497
+ * Password
4498
+ */
4499
+ 'password'?: string | null;
4500
+ /**
4501
+ * Expiry Interval
4502
+ */
4503
+ 'expiryInterval'?: number | null;
4504
+ /**
4505
+ * Interval Type
4506
+ */
4507
+ 'intervalType'?: PasswordSenderDTOIntervalTypeEnum | null;
4508
+ /**
4509
+ * Expiry
4510
+ */
4511
+ 'expiry'?: string | null;
4512
+ /**
4513
+ * Recipient
4514
+ */
4515
+ 'recipient'?: Array<string>;
4516
+ /**
4517
+ * URL
4518
+ */
4519
+ 'url'?: string | null;
4520
+ /**
4521
+ * Description
4522
+ */
4523
+ 'description'?: string | null;
4524
+ /**
4525
+ * Password URL
4526
+ */
4527
+ 'passwordUrl'?: string | null;
4528
+ }
4529
+ export declare const PasswordSenderDTOIntervalTypeEnum: {
4530
+ readonly Minute: "Minute";
4531
+ readonly Hour: "Hour";
4532
+ readonly Day: "Day";
4533
+ };
4534
+ export type PasswordSenderDTOIntervalTypeEnum = typeof PasswordSenderDTOIntervalTypeEnum[keyof typeof PasswordSenderDTOIntervalTypeEnum];
4535
+ /**
4536
+ * PasswordSenderEntity
4537
+ */
4538
+ export interface PasswordSenderEntity {
4539
+ /**
4540
+ * uniqueId
4541
+ */
4542
+ 'uniqueId'?: string;
4543
+ /**
4544
+ * url
4545
+ */
4546
+ 'url'?: string;
4547
+ /**
4548
+ * username
4549
+ */
4550
+ 'username'?: string;
4551
+ /**
4552
+ * password
4553
+ */
4554
+ 'password'?: string;
4555
+ /**
4556
+ * expiryTime
4557
+ */
4558
+ 'expiryTime'?: string;
4559
+ /**
4560
+ * emailRecipient
4561
+ */
4562
+ 'emailRecipient'?: string;
4563
+ /**
4564
+ * description
4565
+ */
4566
+ 'description'?: string;
4567
+ }
4396
4568
  export interface PatchUpdateAccountCnameRequest {
4397
4569
  /**
4398
4570
  * CNAME
@@ -4625,6 +4797,10 @@ export interface PostAddOrderNoteRequest {
4625
4797
  export interface PostAddWebhook200Response {
4626
4798
  'url'?: string;
4627
4799
  }
4800
+ /**
4801
+ * @type PostGenerateReport200Response
4802
+ */
4803
+ export type PostGenerateReport200Response = GraphDTO | TableDTO;
4628
4804
  export interface PostGetClientCredentialsRequest {
4629
4805
  /**
4630
4806
  * OAuth 2.0 scopes
@@ -5209,6 +5385,65 @@ export interface RemoteStorageDTO {
5209
5385
  */
5210
5386
  'region'?: string;
5211
5387
  }
5388
+ /**
5389
+ * Report Request
5390
+ */
5391
+ export interface ReportRequestDTO {
5392
+ /**
5393
+ * Report
5394
+ */
5395
+ 'report'?: ReportRequestDTOReportEnum;
5396
+ /**
5397
+ * Start
5398
+ */
5399
+ 'start'?: string | null;
5400
+ /**
5401
+ * End
5402
+ */
5403
+ 'end'?: string | null;
5404
+ /**
5405
+ * Month
5406
+ */
5407
+ 'month'?: number | null;
5408
+ /**
5409
+ * Year
5410
+ */
5411
+ 'year'?: number | null;
5412
+ /**
5413
+ * SKU
5414
+ */
5415
+ 'sku'?: string | null;
5416
+ /**
5417
+ * Price
5418
+ */
5419
+ 'price'?: number | null;
5420
+ /**
5421
+ * Recipients
5422
+ */
5423
+ 'recipients'?: Array<string> | null;
5424
+ /**
5425
+ * Graph Type
5426
+ */
5427
+ 'graphType'?: ReportRequestDTOGraphTypeEnum | null;
5428
+ }
5429
+ export declare const ReportRequestDTOReportEnum: {
5430
+ readonly _1: "1";
5431
+ readonly _2: "2";
5432
+ readonly _3: "3";
5433
+ readonly _4: "4";
5434
+ readonly _5: "5";
5435
+ readonly _6: "6";
5436
+ readonly _7: "7";
5437
+ readonly _8: "8";
5438
+ readonly _9: "9";
5439
+ readonly _10: "10";
5440
+ };
5441
+ export type ReportRequestDTOReportEnum = typeof ReportRequestDTOReportEnum[keyof typeof ReportRequestDTOReportEnum];
5442
+ export declare const ReportRequestDTOGraphTypeEnum: {
5443
+ readonly StackedArea: "stacked-area";
5444
+ readonly Table: "table";
5445
+ };
5446
+ export type ReportRequestDTOGraphTypeEnum = typeof ReportRequestDTOGraphTypeEnum[keyof typeof ReportRequestDTOGraphTypeEnum];
5212
5447
  /**
5213
5448
  * Resource Not Ready
5214
5449
  */
@@ -5339,6 +5574,31 @@ export interface ScopeModel {
5339
5574
  */
5340
5575
  'description'?: string;
5341
5576
  }
5577
+ /**
5578
+ * Graph Series Data
5579
+ */
5580
+ export interface SeriesDTO {
5581
+ /**
5582
+ * Name
5583
+ */
5584
+ 'name'?: string;
5585
+ /**
5586
+ * Type
5587
+ */
5588
+ 'type'?: SeriesDTOTypeEnum;
5589
+ /**
5590
+ * Stack
5591
+ */
5592
+ 'stack'?: string | null;
5593
+ /**
5594
+ * Data
5595
+ */
5596
+ 'data'?: Array<string>;
5597
+ }
5598
+ export declare const SeriesDTOTypeEnum: {
5599
+ readonly Line: "line";
5600
+ };
5601
+ export type SeriesDTOTypeEnum = typeof SeriesDTOTypeEnum[keyof typeof SeriesDTOTypeEnum];
5342
5602
  /**
5343
5603
  * Service Health DTO
5344
5604
  */
@@ -7161,6 +7421,29 @@ export interface SupportTicketModel {
7161
7421
  */
7162
7422
  'conversations'?: Array<ConversationModel>;
7163
7423
  }
7424
+ /**
7425
+ * Table
7426
+ */
7427
+ export interface TableDTO {
7428
+ /**
7429
+ * Title
7430
+ */
7431
+ 'title'?: string;
7432
+ 'headers'?: TableRowDTO;
7433
+ /**
7434
+ * Rows
7435
+ */
7436
+ 'rows'?: Array<TableRowDTO>;
7437
+ }
7438
+ /**
7439
+ * Table Data
7440
+ */
7441
+ export interface TableDataDTO {
7442
+ /**
7443
+ * Value
7444
+ */
7445
+ 'value'?: string;
7446
+ }
7164
7447
  /**
7165
7448
  * TableAttribsEntity
7166
7449
  */
@@ -7198,6 +7481,15 @@ export interface TableHistoryEntity {
7198
7481
  */
7199
7482
  'page'?: number;
7200
7483
  }
7484
+ /**
7485
+ * Table Row
7486
+ */
7487
+ export interface TableRowDTO {
7488
+ /**
7489
+ * Table Data
7490
+ */
7491
+ 'data'?: Array<TableDataDTO>;
7492
+ }
7201
7493
  /**
7202
7494
  * 3CX Wizard Restore From Backup
7203
7495
  */
@@ -13103,6 +13395,54 @@ export declare const GetGetTenantsStatusEnum: {
13103
13395
  readonly FailedOver: "Failed Over";
13104
13396
  };
13105
13397
  export type GetGetTenantsStatusEnum = typeof GetGetTenantsStatusEnum[keyof typeof GetGetTenantsStatusEnum];
13398
+ /**
13399
+ * MiscApi - axios parameter creator
13400
+ */
13401
+ export declare const MiscApiAxiosParamCreator: (configuration?: Configuration) => {
13402
+ /**
13403
+ * Share Credentials
13404
+ * @param {PasswordSenderDTO} [passwordSenderDTO] Password Sender Request
13405
+ * @param {*} [options] Override http request option.
13406
+ * @throws {RequiredError}
13407
+ */
13408
+ postSendPassword: (passwordSenderDTO?: PasswordSenderDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
13409
+ };
13410
+ /**
13411
+ * MiscApi - functional programming interface
13412
+ */
13413
+ export declare const MiscApiFp: (configuration?: Configuration) => {
13414
+ /**
13415
+ * Share Credentials
13416
+ * @param {PasswordSenderDTO} [passwordSenderDTO] Password Sender Request
13417
+ * @param {*} [options] Override http request option.
13418
+ * @throws {RequiredError}
13419
+ */
13420
+ postSendPassword(passwordSenderDTO?: PasswordSenderDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PasswordSenderDTO>>;
13421
+ };
13422
+ /**
13423
+ * MiscApi - factory interface
13424
+ */
13425
+ export declare const MiscApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
13426
+ /**
13427
+ * Share Credentials
13428
+ * @param {PasswordSenderDTO} [passwordSenderDTO] Password Sender Request
13429
+ * @param {*} [options] Override http request option.
13430
+ * @throws {RequiredError}
13431
+ */
13432
+ postSendPassword(passwordSenderDTO?: PasswordSenderDTO, options?: RawAxiosRequestConfig): AxiosPromise<PasswordSenderDTO>;
13433
+ };
13434
+ /**
13435
+ * MiscApi - object-oriented interface
13436
+ */
13437
+ export declare class MiscApi extends BaseAPI {
13438
+ /**
13439
+ * Share Credentials
13440
+ * @param {PasswordSenderDTO} [passwordSenderDTO] Password Sender Request
13441
+ * @param {*} [options] Override http request option.
13442
+ * @throws {RequiredError}
13443
+ */
13444
+ postSendPassword(passwordSenderDTO?: PasswordSenderDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PasswordSenderDTO, any, {}>>;
13445
+ }
13106
13446
  /**
13107
13447
  * MyPBXToolsApi - axios parameter creator
13108
13448
  */
@@ -16311,6 +16651,14 @@ export declare const ReportsApiAxiosParamCreator: (configuration?: Configuration
16311
16651
  * @throws {RequiredError}
16312
16652
  */
16313
16653
  getGetStockReport: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
16654
+ /**
16655
+ * Generate Reports
16656
+ * @summary Generate Reports
16657
+ * @param {ReportRequestDTO} [reportRequestDTO] Report Request
16658
+ * @param {*} [options] Override http request option.
16659
+ * @throws {RequiredError}
16660
+ */
16661
+ postGenerateReport: (reportRequestDTO?: ReportRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
16314
16662
  };
16315
16663
  /**
16316
16664
  * ReportsApi - functional programming interface
@@ -16322,6 +16670,14 @@ export declare const ReportsApiFp: (configuration?: Configuration) => {
16322
16670
  * @throws {RequiredError}
16323
16671
  */
16324
16672
  getGetStockReport(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StockReportModel>>;
16673
+ /**
16674
+ * Generate Reports
16675
+ * @summary Generate Reports
16676
+ * @param {ReportRequestDTO} [reportRequestDTO] Report Request
16677
+ * @param {*} [options] Override http request option.
16678
+ * @throws {RequiredError}
16679
+ */
16680
+ postGenerateReport(reportRequestDTO?: ReportRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostGenerateReport200Response>>;
16325
16681
  };
16326
16682
  /**
16327
16683
  * ReportsApi - factory interface
@@ -16333,6 +16689,14 @@ export declare const ReportsApiFactory: (configuration?: Configuration, basePath
16333
16689
  * @throws {RequiredError}
16334
16690
  */
16335
16691
  getGetStockReport(options?: RawAxiosRequestConfig): AxiosPromise<StockReportModel>;
16692
+ /**
16693
+ * Generate Reports
16694
+ * @summary Generate Reports
16695
+ * @param {ReportRequestDTO} [reportRequestDTO] Report Request
16696
+ * @param {*} [options] Override http request option.
16697
+ * @throws {RequiredError}
16698
+ */
16699
+ postGenerateReport(reportRequestDTO?: ReportRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<PostGenerateReport200Response>;
16336
16700
  };
16337
16701
  /**
16338
16702
  * ReportsApi - object-oriented interface
@@ -16344,6 +16708,14 @@ export declare class ReportsApi extends BaseAPI {
16344
16708
  * @throws {RequiredError}
16345
16709
  */
16346
16710
  getGetStockReport(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<StockReportModel, any, {}>>;
16711
+ /**
16712
+ * Generate Reports
16713
+ * @summary Generate Reports
16714
+ * @param {ReportRequestDTO} [reportRequestDTO] Report Request
16715
+ * @param {*} [options] Override http request option.
16716
+ * @throws {RequiredError}
16717
+ */
16718
+ postGenerateReport(reportRequestDTO?: ReportRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PostGenerateReport200Response, any, {}>>;
16347
16719
  }
16348
16720
  /**
16349
16721
  * SIPTrunksApi - axios parameter creator