@connectedxm/admin-sdk 6.25.2 → 6.26.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
@@ -4100,6 +4100,16 @@ export interface CustomReportCreateInputs {
4100
4100
  export interface CustomReportExportInputs {
4101
4101
  'email': string;
4102
4102
  }
4103
+ export interface CustomReportSchedule {
4104
+ 'scheduleExpression': string | null;
4105
+ 'scheduleTimezone': string | null;
4106
+ 'scheduleEmails': Array<string> | null;
4107
+ }
4108
+ export interface CustomReportScheduleInputs {
4109
+ 'scheduleExpression'?: string | null;
4110
+ 'scheduleTimezone'?: string | null;
4111
+ 'scheduleEmails'?: Array<string> | null;
4112
+ }
4103
4113
  export interface CustomReportUpdateInputs {
4104
4114
  'name'?: string | null;
4105
4115
  'description'?: string | null;
@@ -6602,6 +6612,14 @@ export interface GetCustomReport200Response {
6602
6612
  export declare enum GetCustomReport200ResponseStatusEnum {
6603
6613
  Ok = "ok"
6604
6614
  }
6615
+ export interface GetCustomReportSchedule200Response {
6616
+ 'status': GetCustomReportSchedule200ResponseStatusEnum;
6617
+ 'message': string;
6618
+ 'data': CustomReportSchedule | null;
6619
+ }
6620
+ export declare enum GetCustomReportSchedule200ResponseStatusEnum {
6621
+ Ok = "ok"
6622
+ }
6605
6623
  export interface GetCustomReportUsers200Response {
6606
6624
  'status': GetCustomReportUsers200ResponseStatusEnum;
6607
6625
  'message': string;
@@ -12446,6 +12464,14 @@ export interface UploadVideoCaptions200Response {
12446
12464
  export declare enum UploadVideoCaptions200ResponseStatusEnum {
12447
12465
  Ok = "ok"
12448
12466
  }
12467
+ export interface UpsertCustomReportSchedule200Response {
12468
+ 'status': UpsertCustomReportSchedule200ResponseStatusEnum;
12469
+ 'message': string;
12470
+ 'data': CustomReportSchedule;
12471
+ }
12472
+ export declare enum UpsertCustomReportSchedule200ResponseStatusEnum {
12473
+ Ok = "ok"
12474
+ }
12449
12475
  export interface UpsertLinkPreview200Response {
12450
12476
  'status': UpsertLinkPreview200ResponseStatusEnum;
12451
12477
  'message': string;
@@ -67557,6 +67583,14 @@ export declare const ReportsApiAxiosParamCreator: (configuration?: Configuration
67557
67583
  * @throws {RequiredError}
67558
67584
  */
67559
67585
  deleteCustomReport: (reportId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
67586
+ /**
67587
+ * Delete Custom Report Schedule endpoint
67588
+ * @summary Delete Custom Report Schedule
67589
+ * @param {string} reportId The report identifier
67590
+ * @param {*} [options] Override http request option.
67591
+ * @throws {RequiredError}
67592
+ */
67593
+ deleteCustomReportSchedule: (reportId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
67560
67594
  /**
67561
67595
  * Export Custom Report endpoint
67562
67596
  * @summary Export Custom Report
@@ -67574,6 +67608,14 @@ export declare const ReportsApiAxiosParamCreator: (configuration?: Configuration
67574
67608
  * @throws {RequiredError}
67575
67609
  */
67576
67610
  getCustomReport: (reportId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
67611
+ /**
67612
+ * Get Custom Report Schedule endpoint
67613
+ * @summary Get Custom Report Schedule
67614
+ * @param {string} reportId The report identifier
67615
+ * @param {*} [options] Override http request option.
67616
+ * @throws {RequiredError}
67617
+ */
67618
+ getCustomReportSchedule: (reportId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
67577
67619
  /**
67578
67620
  * Get Custom Reports endpoint
67579
67621
  * @summary Get Custom Reports
@@ -67612,6 +67654,15 @@ export declare const ReportsApiAxiosParamCreator: (configuration?: Configuration
67612
67654
  * @throws {RequiredError}
67613
67655
  */
67614
67656
  updateCustomReport: (reportId: string, report: CustomReportUpdateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
67657
+ /**
67658
+ * Upsert Custom Report Schedule endpoint
67659
+ * @summary Upsert Custom Report Schedule
67660
+ * @param {string} reportId The report identifier
67661
+ * @param {CustomReportScheduleInputs} customReportScheduleInputs
67662
+ * @param {*} [options] Override http request option.
67663
+ * @throws {RequiredError}
67664
+ */
67665
+ upsertCustomReportSchedule: (reportId: string, customReportScheduleInputs: CustomReportScheduleInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
67615
67666
  };
67616
67667
  /**
67617
67668
  * ReportsApi - functional programming interface
@@ -67634,6 +67685,14 @@ export declare const ReportsApiFp: (configuration?: Configuration) => {
67634
67685
  * @throws {RequiredError}
67635
67686
  */
67636
67687
  deleteCustomReport(reportId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
67688
+ /**
67689
+ * Delete Custom Report Schedule endpoint
67690
+ * @summary Delete Custom Report Schedule
67691
+ * @param {string} reportId The report identifier
67692
+ * @param {*} [options] Override http request option.
67693
+ * @throws {RequiredError}
67694
+ */
67695
+ deleteCustomReportSchedule(reportId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCustomReportSchedule200Response>>;
67637
67696
  /**
67638
67697
  * Export Custom Report endpoint
67639
67698
  * @summary Export Custom Report
@@ -67651,6 +67710,14 @@ export declare const ReportsApiFp: (configuration?: Configuration) => {
67651
67710
  * @throws {RequiredError}
67652
67711
  */
67653
67712
  getCustomReport(reportId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCustomReport200Response>>;
67713
+ /**
67714
+ * Get Custom Report Schedule endpoint
67715
+ * @summary Get Custom Report Schedule
67716
+ * @param {string} reportId The report identifier
67717
+ * @param {*} [options] Override http request option.
67718
+ * @throws {RequiredError}
67719
+ */
67720
+ getCustomReportSchedule(reportId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCustomReportSchedule200Response>>;
67654
67721
  /**
67655
67722
  * Get Custom Reports endpoint
67656
67723
  * @summary Get Custom Reports
@@ -67689,6 +67756,15 @@ export declare const ReportsApiFp: (configuration?: Configuration) => {
67689
67756
  * @throws {RequiredError}
67690
67757
  */
67691
67758
  updateCustomReport(reportId: string, report: CustomReportUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCustomReport200Response>>;
67759
+ /**
67760
+ * Upsert Custom Report Schedule endpoint
67761
+ * @summary Upsert Custom Report Schedule
67762
+ * @param {string} reportId The report identifier
67763
+ * @param {CustomReportScheduleInputs} customReportScheduleInputs
67764
+ * @param {*} [options] Override http request option.
67765
+ * @throws {RequiredError}
67766
+ */
67767
+ upsertCustomReportSchedule(reportId: string, customReportScheduleInputs: CustomReportScheduleInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpsertCustomReportSchedule200Response>>;
67692
67768
  };
67693
67769
  /**
67694
67770
  * ReportsApi - factory interface
@@ -67710,6 +67786,14 @@ export declare const ReportsApiFactory: (configuration?: Configuration, basePath
67710
67786
  * @throws {RequiredError}
67711
67787
  */
67712
67788
  deleteCustomReport(requestParameters: ReportsApiDeleteCustomReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
67789
+ /**
67790
+ * Delete Custom Report Schedule endpoint
67791
+ * @summary Delete Custom Report Schedule
67792
+ * @param {ReportsApiDeleteCustomReportScheduleRequest} requestParameters Request parameters.
67793
+ * @param {*} [options] Override http request option.
67794
+ * @throws {RequiredError}
67795
+ */
67796
+ deleteCustomReportSchedule(requestParameters: ReportsApiDeleteCustomReportScheduleRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetCustomReportSchedule200Response>;
67713
67797
  /**
67714
67798
  * Export Custom Report endpoint
67715
67799
  * @summary Export Custom Report
@@ -67726,6 +67810,14 @@ export declare const ReportsApiFactory: (configuration?: Configuration, basePath
67726
67810
  * @throws {RequiredError}
67727
67811
  */
67728
67812
  getCustomReport(requestParameters: ReportsApiGetCustomReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetCustomReport200Response>;
67813
+ /**
67814
+ * Get Custom Report Schedule endpoint
67815
+ * @summary Get Custom Report Schedule
67816
+ * @param {ReportsApiGetCustomReportScheduleRequest} requestParameters Request parameters.
67817
+ * @param {*} [options] Override http request option.
67818
+ * @throws {RequiredError}
67819
+ */
67820
+ getCustomReportSchedule(requestParameters: ReportsApiGetCustomReportScheduleRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetCustomReportSchedule200Response>;
67729
67821
  /**
67730
67822
  * Get Custom Reports endpoint
67731
67823
  * @summary Get Custom Reports
@@ -67758,6 +67850,14 @@ export declare const ReportsApiFactory: (configuration?: Configuration, basePath
67758
67850
  * @throws {RequiredError}
67759
67851
  */
67760
67852
  updateCustomReport(requestParameters: ReportsApiUpdateCustomReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetCustomReport200Response>;
67853
+ /**
67854
+ * Upsert Custom Report Schedule endpoint
67855
+ * @summary Upsert Custom Report Schedule
67856
+ * @param {ReportsApiUpsertCustomReportScheduleRequest} requestParameters Request parameters.
67857
+ * @param {*} [options] Override http request option.
67858
+ * @throws {RequiredError}
67859
+ */
67860
+ upsertCustomReportSchedule(requestParameters: ReportsApiUpsertCustomReportScheduleRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpsertCustomReportSchedule200Response>;
67761
67861
  };
67762
67862
  /**
67763
67863
  * Request parameters for createCustomReport operation in ReportsApi.
@@ -67778,6 +67878,15 @@ export interface ReportsApiDeleteCustomReportRequest {
67778
67878
  */
67779
67879
  readonly reportId: string;
67780
67880
  }
67881
+ /**
67882
+ * Request parameters for deleteCustomReportSchedule operation in ReportsApi.
67883
+ */
67884
+ export interface ReportsApiDeleteCustomReportScheduleRequest {
67885
+ /**
67886
+ * The report identifier
67887
+ */
67888
+ readonly reportId: string;
67889
+ }
67781
67890
  /**
67782
67891
  * Request parameters for exportCustomReport operation in ReportsApi.
67783
67892
  */
@@ -67797,6 +67906,15 @@ export interface ReportsApiGetCustomReportRequest {
67797
67906
  */
67798
67907
  readonly reportId: string;
67799
67908
  }
67909
+ /**
67910
+ * Request parameters for getCustomReportSchedule operation in ReportsApi.
67911
+ */
67912
+ export interface ReportsApiGetCustomReportScheduleRequest {
67913
+ /**
67914
+ * The report identifier
67915
+ */
67916
+ readonly reportId: string;
67917
+ }
67800
67918
  /**
67801
67919
  * Request parameters for getCustomReports operation in ReportsApi.
67802
67920
  */
@@ -67857,6 +67975,16 @@ export interface ReportsApiUpdateCustomReportRequest {
67857
67975
  */
67858
67976
  readonly report: CustomReportUpdateInputs;
67859
67977
  }
67978
+ /**
67979
+ * Request parameters for upsertCustomReportSchedule operation in ReportsApi.
67980
+ */
67981
+ export interface ReportsApiUpsertCustomReportScheduleRequest {
67982
+ /**
67983
+ * The report identifier
67984
+ */
67985
+ readonly reportId: string;
67986
+ readonly customReportScheduleInputs: CustomReportScheduleInputs;
67987
+ }
67860
67988
  /**
67861
67989
  * ReportsApi - object-oriented interface
67862
67990
  */
@@ -67877,6 +68005,14 @@ export declare class ReportsApi extends BaseAPI {
67877
68005
  * @throws {RequiredError}
67878
68006
  */
67879
68007
  deleteCustomReport(requestParameters: ReportsApiDeleteCustomReportRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}>>;
68008
+ /**
68009
+ * Delete Custom Report Schedule endpoint
68010
+ * @summary Delete Custom Report Schedule
68011
+ * @param {ReportsApiDeleteCustomReportScheduleRequest} requestParameters Request parameters.
68012
+ * @param {*} [options] Override http request option.
68013
+ * @throws {RequiredError}
68014
+ */
68015
+ deleteCustomReportSchedule(requestParameters: ReportsApiDeleteCustomReportScheduleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCustomReportSchedule200Response, any, {}>>;
67880
68016
  /**
67881
68017
  * Export Custom Report endpoint
67882
68018
  * @summary Export Custom Report
@@ -67893,6 +68029,14 @@ export declare class ReportsApi extends BaseAPI {
67893
68029
  * @throws {RequiredError}
67894
68030
  */
67895
68031
  getCustomReport(requestParameters: ReportsApiGetCustomReportRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCustomReport200Response, any, {}>>;
68032
+ /**
68033
+ * Get Custom Report Schedule endpoint
68034
+ * @summary Get Custom Report Schedule
68035
+ * @param {ReportsApiGetCustomReportScheduleRequest} requestParameters Request parameters.
68036
+ * @param {*} [options] Override http request option.
68037
+ * @throws {RequiredError}
68038
+ */
68039
+ getCustomReportSchedule(requestParameters: ReportsApiGetCustomReportScheduleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCustomReportSchedule200Response, any, {}>>;
67896
68040
  /**
67897
68041
  * Get Custom Reports endpoint
67898
68042
  * @summary Get Custom Reports
@@ -67925,6 +68069,14 @@ export declare class ReportsApi extends BaseAPI {
67925
68069
  * @throws {RequiredError}
67926
68070
  */
67927
68071
  updateCustomReport(requestParameters: ReportsApiUpdateCustomReportRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCustomReport200Response, any, {}>>;
68072
+ /**
68073
+ * Upsert Custom Report Schedule endpoint
68074
+ * @summary Upsert Custom Report Schedule
68075
+ * @param {ReportsApiUpsertCustomReportScheduleRequest} requestParameters Request parameters.
68076
+ * @param {*} [options] Override http request option.
68077
+ * @throws {RequiredError}
68078
+ */
68079
+ upsertCustomReportSchedule(requestParameters: ReportsApiUpsertCustomReportScheduleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UpsertCustomReportSchedule200Response, any, {}>>;
67928
68080
  }
67929
68081
  /**
67930
68082
  * ReportsUsersApi - axios parameter creator