yellowgrid-api-ts 3.2.176-dev.0 → 3.2.177-dev.0

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
@@ -731,6 +731,7 @@ export declare const AdminUserModelPermissionsEnum: {
731
731
  readonly Privileged: "Privileged";
732
732
  readonly Development: "Development";
733
733
  readonly Finance: "Finance";
734
+ readonly Telesales: "Telesales";
734
735
  };
735
736
  export type AdminUserModelPermissionsEnum = typeof AdminUserModelPermissionsEnum[keyof typeof AdminUserModelPermissionsEnum];
736
737
  /**
@@ -1643,6 +1644,23 @@ export interface CreditNoteModel {
1643
1644
  */
1644
1645
  'items'?: Array<CreditNoteItemModel>;
1645
1646
  }
1647
+ /**
1648
+ * 3CX Credit Status
1649
+ */
1650
+ export interface CreditStatusDTO {
1651
+ /**
1652
+ * Currency Code
1653
+ */
1654
+ 'CurrencyCode'?: string | null;
1655
+ /**
1656
+ * Credit Limit
1657
+ */
1658
+ 'CreditLimit'?: number | null;
1659
+ /**
1660
+ * Credit
1661
+ */
1662
+ 'Credit'?: number | null;
1663
+ }
1646
1664
  /**
1647
1665
  * CRM Activities Response
1648
1666
  */
@@ -2550,6 +2568,9 @@ export interface GenericFileModel {
2550
2568
  */
2551
2569
  'type'?: string;
2552
2570
  }
2571
+ export interface GetCheckMacExists200Response {
2572
+ 'found'?: boolean;
2573
+ }
2553
2574
  export interface GetGetPrice200Response {
2554
2575
  'price'?: number;
2555
2576
  }
@@ -3207,6 +3228,19 @@ export interface MFARequiredModel {
3207
3228
  */
3208
3229
  'png'?: string;
3209
3230
  }
3231
+ /**
3232
+ * MAC Address DTO
3233
+ */
3234
+ export interface MacAddressDTO {
3235
+ /**
3236
+ * Group ID
3237
+ */
3238
+ 'groupId'?: number;
3239
+ /**
3240
+ * MAC Address
3241
+ */
3242
+ 'macAddress'?: string;
3243
+ }
3210
3244
  /**
3211
3245
  * Monthly Contract Usage
3212
3246
  */
@@ -4307,6 +4341,10 @@ export interface PartnerDTO {
4307
4341
  * Aligned
4308
4342
  */
4309
4343
  'aligned'?: boolean;
4344
+ /**
4345
+ * Customer
4346
+ */
4347
+ 'customer'?: AccountSummaryDTO | null;
4310
4348
  }
4311
4349
  export interface PatchUpdateAccountCnameRequest {
4312
4350
  /**
@@ -10196,6 +10234,13 @@ export declare const Class3CXApiAxiosParamCreator: (configuration?: Configuratio
10196
10234
  * @throws {RequiredError}
10197
10235
  */
10198
10236
  getGetLicenceDetails: (key: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10237
+ /**
10238
+ * Get 3CX Credit Status
10239
+ * @summary Get 3CX Credit Status
10240
+ * @param {*} [options] Override http request option.
10241
+ * @throws {RequiredError}
10242
+ */
10243
+ getGetTcxCreditStatus: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10199
10244
  /**
10200
10245
  * Get 3CX Expiring Keys
10201
10246
  * @summary Get 3CX Expiring Keys
@@ -10203,6 +10248,13 @@ export declare const Class3CXApiAxiosParamCreator: (configuration?: Configuratio
10203
10248
  * @throws {RequiredError}
10204
10249
  */
10205
10250
  getGetTcxExpiringKeys: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10251
+ /**
10252
+ * Get 3CX Partners
10253
+ * @summary Get 3CX Partners
10254
+ * @param {*} [options] Override http request option.
10255
+ * @throws {RequiredError}
10256
+ */
10257
+ getGetTcxPartners: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10206
10258
  /**
10207
10259
  * Get Bulk 3CX Licence Details
10208
10260
  * @summary Get bulk 3CX Licence Details
@@ -10224,6 +10276,13 @@ export declare const Class3CXApiFp: (configuration?: Configuration) => {
10224
10276
  * @throws {RequiredError}
10225
10277
  */
10226
10278
  getGetLicenceDetails(key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TcxLicenceDetailsModel>>;
10279
+ /**
10280
+ * Get 3CX Credit Status
10281
+ * @summary Get 3CX Credit Status
10282
+ * @param {*} [options] Override http request option.
10283
+ * @throws {RequiredError}
10284
+ */
10285
+ getGetTcxCreditStatus(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreditStatusDTO>>;
10227
10286
  /**
10228
10287
  * Get 3CX Expiring Keys
10229
10288
  * @summary Get 3CX Expiring Keys
@@ -10231,6 +10290,13 @@ export declare const Class3CXApiFp: (configuration?: Configuration) => {
10231
10290
  * @throws {RequiredError}
10232
10291
  */
10233
10292
  getGetTcxExpiringKeys(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
10293
+ /**
10294
+ * Get 3CX Partners
10295
+ * @summary Get 3CX Partners
10296
+ * @param {*} [options] Override http request option.
10297
+ * @throws {RequiredError}
10298
+ */
10299
+ getGetTcxPartners(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PartnerDTO>>>;
10234
10300
  /**
10235
10301
  * Get Bulk 3CX Licence Details
10236
10302
  * @summary Get bulk 3CX Licence Details
@@ -10252,6 +10318,13 @@ export declare const Class3CXApiFactory: (configuration?: Configuration, basePat
10252
10318
  * @throws {RequiredError}
10253
10319
  */
10254
10320
  getGetLicenceDetails(key: string, options?: RawAxiosRequestConfig): AxiosPromise<TcxLicenceDetailsModel>;
10321
+ /**
10322
+ * Get 3CX Credit Status
10323
+ * @summary Get 3CX Credit Status
10324
+ * @param {*} [options] Override http request option.
10325
+ * @throws {RequiredError}
10326
+ */
10327
+ getGetTcxCreditStatus(options?: RawAxiosRequestConfig): AxiosPromise<CreditStatusDTO>;
10255
10328
  /**
10256
10329
  * Get 3CX Expiring Keys
10257
10330
  * @summary Get 3CX Expiring Keys
@@ -10259,6 +10332,13 @@ export declare const Class3CXApiFactory: (configuration?: Configuration, basePat
10259
10332
  * @throws {RequiredError}
10260
10333
  */
10261
10334
  getGetTcxExpiringKeys(options?: RawAxiosRequestConfig): AxiosPromise<string>;
10335
+ /**
10336
+ * Get 3CX Partners
10337
+ * @summary Get 3CX Partners
10338
+ * @param {*} [options] Override http request option.
10339
+ * @throws {RequiredError}
10340
+ */
10341
+ getGetTcxPartners(options?: RawAxiosRequestConfig): AxiosPromise<Array<PartnerDTO>>;
10262
10342
  /**
10263
10343
  * Get Bulk 3CX Licence Details
10264
10344
  * @summary Get bulk 3CX Licence Details
@@ -10280,6 +10360,13 @@ export declare class Class3CXApi extends BaseAPI {
10280
10360
  * @throws {RequiredError}
10281
10361
  */
10282
10362
  getGetLicenceDetails(key: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TcxLicenceDetailsModel, any, {}>>;
10363
+ /**
10364
+ * Get 3CX Credit Status
10365
+ * @summary Get 3CX Credit Status
10366
+ * @param {*} [options] Override http request option.
10367
+ * @throws {RequiredError}
10368
+ */
10369
+ getGetTcxCreditStatus(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreditStatusDTO, any, {}>>;
10283
10370
  /**
10284
10371
  * Get 3CX Expiring Keys
10285
10372
  * @summary Get 3CX Expiring Keys
@@ -10287,6 +10374,13 @@ export declare class Class3CXApi extends BaseAPI {
10287
10374
  * @throws {RequiredError}
10288
10375
  */
10289
10376
  getGetTcxExpiringKeys(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
10377
+ /**
10378
+ * Get 3CX Partners
10379
+ * @summary Get 3CX Partners
10380
+ * @param {*} [options] Override http request option.
10381
+ * @throws {RequiredError}
10382
+ */
10383
+ getGetTcxPartners(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PartnerDTO[], any, {}>>;
10290
10384
  /**
10291
10385
  * Get Bulk 3CX Licence Details
10292
10386
  * @summary Get bulk 3CX Licence Details
@@ -14970,6 +15064,7 @@ export declare const GetGetPriceListTypeEnum: {
14970
15064
  readonly Sms: "SMS";
14971
15065
  readonly SipTrunks: "SIP Trunks";
14972
15066
  readonly CrmIntegrations: "CRM Integrations";
15067
+ readonly Jedware: "Jedware";
14973
15068
  };
14974
15069
  export type GetGetPriceListTypeEnum = typeof GetGetPriceListTypeEnum[keyof typeof GetGetPriceListTypeEnum];
14975
15070
  export declare const GetGetPriceListFormatEnum: {
@@ -15013,6 +15108,7 @@ export declare const PostSendPriceListTypeEnum: {
15013
15108
  readonly Sms: "SMS";
15014
15109
  readonly SipTrunks: "SIP Trunks";
15015
15110
  readonly CrmIntegrations: "CRM Integrations";
15111
+ readonly Jedware: "Jedware";
15016
15112
  };
15017
15113
  export type PostSendPriceListTypeEnum = typeof PostSendPriceListTypeEnum[keyof typeof PostSendPriceListTypeEnum];
15018
15114
  export declare const PostSendPriceListFormatEnum: {
@@ -15564,6 +15660,13 @@ export declare const ProvisioningApiAxiosParamCreator: (configuration?: Configur
15564
15660
  * @throws {RequiredError}
15565
15661
  */
15566
15662
  deleteAddFanvilMac: (id: string, mac: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
15663
+ /**
15664
+ * Delete a MAC address in FDPS
15665
+ * @param {string} mac MAC Address
15666
+ * @param {*} [options] Override http request option.
15667
+ * @throws {RequiredError}
15668
+ */
15669
+ deleteCheckMacExists: (mac: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
15567
15670
  /**
15568
15671
  * Delete a Fanvil provisioning group
15569
15672
  * @summary Delete group from DB and FDPS
@@ -15572,6 +15675,13 @@ export declare const ProvisioningApiAxiosParamCreator: (configuration?: Configur
15572
15675
  * @throws {RequiredError}
15573
15676
  */
15574
15677
  deleteDeleteFanvilGroup: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
15678
+ /**
15679
+ * Check if a MAC address exists in FDPS
15680
+ * @param {string} mac MAC Address
15681
+ * @param {*} [options] Override http request option.
15682
+ * @throws {RequiredError}
15683
+ */
15684
+ getCheckMacExists: (mac: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
15575
15685
  /**
15576
15686
  * Get group Fanvil encryption key
15577
15687
  * @summary Get group Fanvil encryption key
@@ -15614,6 +15724,12 @@ export declare const ProvisioningApiAxiosParamCreator: (configuration?: Configur
15614
15724
  * @throws {RequiredError}
15615
15725
  */
15616
15726
  postAddFanvilMac: (id: string, mac: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
15727
+ /**
15728
+ * Create a MAC address in FDPS
15729
+ * @param {*} [options] Override http request option.
15730
+ * @throws {RequiredError}
15731
+ */
15732
+ postCreateMac: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
15617
15733
  };
15618
15734
  /**
15619
15735
  * ProvisioningApi - functional programming interface
@@ -15628,6 +15744,13 @@ export declare const ProvisioningApiFp: (configuration?: Configuration) => {
15628
15744
  * @throws {RequiredError}
15629
15745
  */
15630
15746
  deleteAddFanvilMac(id: string, mac: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
15747
+ /**
15748
+ * Delete a MAC address in FDPS
15749
+ * @param {string} mac MAC Address
15750
+ * @param {*} [options] Override http request option.
15751
+ * @throws {RequiredError}
15752
+ */
15753
+ deleteCheckMacExists(mac: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
15631
15754
  /**
15632
15755
  * Delete a Fanvil provisioning group
15633
15756
  * @summary Delete group from DB and FDPS
@@ -15636,6 +15759,13 @@ export declare const ProvisioningApiFp: (configuration?: Configuration) => {
15636
15759
  * @throws {RequiredError}
15637
15760
  */
15638
15761
  deleteDeleteFanvilGroup(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
15762
+ /**
15763
+ * Check if a MAC address exists in FDPS
15764
+ * @param {string} mac MAC Address
15765
+ * @param {*} [options] Override http request option.
15766
+ * @throws {RequiredError}
15767
+ */
15768
+ getCheckMacExists(mac: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCheckMacExists200Response>>;
15639
15769
  /**
15640
15770
  * Get group Fanvil encryption key
15641
15771
  * @summary Get group Fanvil encryption key
@@ -15678,6 +15808,12 @@ export declare const ProvisioningApiFp: (configuration?: Configuration) => {
15678
15808
  * @throws {RequiredError}
15679
15809
  */
15680
15810
  postAddFanvilMac(id: string, mac: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
15811
+ /**
15812
+ * Create a MAC address in FDPS
15813
+ * @param {*} [options] Override http request option.
15814
+ * @throws {RequiredError}
15815
+ */
15816
+ postCreateMac(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MacAddressDTO>>;
15681
15817
  };
15682
15818
  /**
15683
15819
  * ProvisioningApi - factory interface
@@ -15692,6 +15828,13 @@ export declare const ProvisioningApiFactory: (configuration?: Configuration, bas
15692
15828
  * @throws {RequiredError}
15693
15829
  */
15694
15830
  deleteAddFanvilMac(id: string, mac: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
15831
+ /**
15832
+ * Delete a MAC address in FDPS
15833
+ * @param {string} mac MAC Address
15834
+ * @param {*} [options] Override http request option.
15835
+ * @throws {RequiredError}
15836
+ */
15837
+ deleteCheckMacExists(mac: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
15695
15838
  /**
15696
15839
  * Delete a Fanvil provisioning group
15697
15840
  * @summary Delete group from DB and FDPS
@@ -15700,6 +15843,13 @@ export declare const ProvisioningApiFactory: (configuration?: Configuration, bas
15700
15843
  * @throws {RequiredError}
15701
15844
  */
15702
15845
  deleteDeleteFanvilGroup(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
15846
+ /**
15847
+ * Check if a MAC address exists in FDPS
15848
+ * @param {string} mac MAC Address
15849
+ * @param {*} [options] Override http request option.
15850
+ * @throws {RequiredError}
15851
+ */
15852
+ getCheckMacExists(mac: string, options?: RawAxiosRequestConfig): AxiosPromise<GetCheckMacExists200Response>;
15703
15853
  /**
15704
15854
  * Get group Fanvil encryption key
15705
15855
  * @summary Get group Fanvil encryption key
@@ -15742,6 +15892,12 @@ export declare const ProvisioningApiFactory: (configuration?: Configuration, bas
15742
15892
  * @throws {RequiredError}
15743
15893
  */
15744
15894
  postAddFanvilMac(id: string, mac: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
15895
+ /**
15896
+ * Create a MAC address in FDPS
15897
+ * @param {*} [options] Override http request option.
15898
+ * @throws {RequiredError}
15899
+ */
15900
+ postCreateMac(options?: RawAxiosRequestConfig): AxiosPromise<MacAddressDTO>;
15745
15901
  };
15746
15902
  /**
15747
15903
  * ProvisioningApi - object-oriented interface
@@ -15756,6 +15912,13 @@ export declare class ProvisioningApi extends BaseAPI {
15756
15912
  * @throws {RequiredError}
15757
15913
  */
15758
15914
  deleteAddFanvilMac(id: string, mac: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
15915
+ /**
15916
+ * Delete a MAC address in FDPS
15917
+ * @param {string} mac MAC Address
15918
+ * @param {*} [options] Override http request option.
15919
+ * @throws {RequiredError}
15920
+ */
15921
+ deleteCheckMacExists(mac: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
15759
15922
  /**
15760
15923
  * Delete a Fanvil provisioning group
15761
15924
  * @summary Delete group from DB and FDPS
@@ -15764,6 +15927,13 @@ export declare class ProvisioningApi extends BaseAPI {
15764
15927
  * @throws {RequiredError}
15765
15928
  */
15766
15929
  deleteDeleteFanvilGroup(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
15930
+ /**
15931
+ * Check if a MAC address exists in FDPS
15932
+ * @param {string} mac MAC Address
15933
+ * @param {*} [options] Override http request option.
15934
+ * @throws {RequiredError}
15935
+ */
15936
+ getCheckMacExists(mac: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCheckMacExists200Response, any, {}>>;
15767
15937
  /**
15768
15938
  * Get group Fanvil encryption key
15769
15939
  * @summary Get group Fanvil encryption key
@@ -15806,6 +15976,12 @@ export declare class ProvisioningApi extends BaseAPI {
15806
15976
  * @throws {RequiredError}
15807
15977
  */
15808
15978
  postAddFanvilMac(id: string, mac: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
15979
+ /**
15980
+ * Create a MAC address in FDPS
15981
+ * @param {*} [options] Override http request option.
15982
+ * @throws {RequiredError}
15983
+ */
15984
+ postCreateMac(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MacAddressDTO, any, {}>>;
15809
15985
  }
15810
15986
  /**
15811
15987
  * SIPTrunksApi - axios parameter creator