@connectedxm/admin-sdk 6.25.0 → 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/esm/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
package/dist/esm/api.js CHANGED
@@ -921,6 +921,10 @@ export var GetCustomReport200ResponseStatusEnum;
921
921
  (function (GetCustomReport200ResponseStatusEnum) {
922
922
  GetCustomReport200ResponseStatusEnum["Ok"] = "ok";
923
923
  })(GetCustomReport200ResponseStatusEnum || (GetCustomReport200ResponseStatusEnum = {}));
924
+ export var GetCustomReportSchedule200ResponseStatusEnum;
925
+ (function (GetCustomReportSchedule200ResponseStatusEnum) {
926
+ GetCustomReportSchedule200ResponseStatusEnum["Ok"] = "ok";
927
+ })(GetCustomReportSchedule200ResponseStatusEnum || (GetCustomReportSchedule200ResponseStatusEnum = {}));
924
928
  export var GetCustomReportUsers200ResponseStatusEnum;
925
929
  (function (GetCustomReportUsers200ResponseStatusEnum) {
926
930
  GetCustomReportUsers200ResponseStatusEnum["Ok"] = "ok";
@@ -2649,6 +2653,10 @@ export var UploadVideoCaptions200ResponseStatusEnum;
2649
2653
  (function (UploadVideoCaptions200ResponseStatusEnum) {
2650
2654
  UploadVideoCaptions200ResponseStatusEnum["Ok"] = "ok";
2651
2655
  })(UploadVideoCaptions200ResponseStatusEnum || (UploadVideoCaptions200ResponseStatusEnum = {}));
2656
+ export var UpsertCustomReportSchedule200ResponseStatusEnum;
2657
+ (function (UpsertCustomReportSchedule200ResponseStatusEnum) {
2658
+ UpsertCustomReportSchedule200ResponseStatusEnum["Ok"] = "ok";
2659
+ })(UpsertCustomReportSchedule200ResponseStatusEnum || (UpsertCustomReportSchedule200ResponseStatusEnum = {}));
2652
2660
  export var UpsertLinkPreview200ResponseStatusEnum;
2653
2661
  (function (UpsertLinkPreview200ResponseStatusEnum) {
2654
2662
  UpsertLinkPreview200ResponseStatusEnum["Ok"] = "ok";
@@ -85169,6 +85177,40 @@ export const ReportsApiAxiosParamCreator = function (configuration) {
85169
85177
  options: localVarRequestOptions,
85170
85178
  };
85171
85179
  }),
85180
+ /**
85181
+ * Delete Custom Report Schedule endpoint
85182
+ * @summary Delete Custom Report Schedule
85183
+ * @param {string} reportId The report identifier
85184
+ * @param {*} [options] Override http request option.
85185
+ * @throws {RequiredError}
85186
+ */
85187
+ deleteCustomReportSchedule: (reportId_1, ...args_1) => __awaiter(this, [reportId_1, ...args_1], void 0, function* (reportId, options = {}) {
85188
+ // verify required parameter 'reportId' is not null or undefined
85189
+ assertParamExists('deleteCustomReportSchedule', 'reportId', reportId);
85190
+ const localVarPath = `/reports/custom/{reportId}/schedule`
85191
+ .replace(`{${"reportId"}}`, encodeURIComponent(String(reportId)));
85192
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
85193
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
85194
+ let baseOptions;
85195
+ if (configuration) {
85196
+ baseOptions = configuration.baseOptions;
85197
+ }
85198
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
85199
+ const localVarHeaderParameter = {};
85200
+ const localVarQueryParameter = {};
85201
+ // authentication ApiKeyAuth required
85202
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
85203
+ // authentication OrganizationId required
85204
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
85205
+ localVarHeaderParameter['Accept'] = 'application/json';
85206
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
85207
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
85208
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
85209
+ return {
85210
+ url: toPathString(localVarUrlObj),
85211
+ options: localVarRequestOptions,
85212
+ };
85213
+ }),
85172
85214
  /**
85173
85215
  * Export Custom Report endpoint
85174
85216
  * @summary Export Custom Report
@@ -85242,6 +85284,40 @@ export const ReportsApiAxiosParamCreator = function (configuration) {
85242
85284
  options: localVarRequestOptions,
85243
85285
  };
85244
85286
  }),
85287
+ /**
85288
+ * Get Custom Report Schedule endpoint
85289
+ * @summary Get Custom Report Schedule
85290
+ * @param {string} reportId The report identifier
85291
+ * @param {*} [options] Override http request option.
85292
+ * @throws {RequiredError}
85293
+ */
85294
+ getCustomReportSchedule: (reportId_1, ...args_1) => __awaiter(this, [reportId_1, ...args_1], void 0, function* (reportId, options = {}) {
85295
+ // verify required parameter 'reportId' is not null or undefined
85296
+ assertParamExists('getCustomReportSchedule', 'reportId', reportId);
85297
+ const localVarPath = `/reports/custom/{reportId}/schedule`
85298
+ .replace(`{${"reportId"}}`, encodeURIComponent(String(reportId)));
85299
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
85300
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
85301
+ let baseOptions;
85302
+ if (configuration) {
85303
+ baseOptions = configuration.baseOptions;
85304
+ }
85305
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
85306
+ const localVarHeaderParameter = {};
85307
+ const localVarQueryParameter = {};
85308
+ // authentication ApiKeyAuth required
85309
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
85310
+ // authentication OrganizationId required
85311
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
85312
+ localVarHeaderParameter['Accept'] = 'application/json';
85313
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
85314
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
85315
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
85316
+ return {
85317
+ url: toPathString(localVarUrlObj),
85318
+ options: localVarRequestOptions,
85319
+ };
85320
+ }),
85245
85321
  /**
85246
85322
  * Get Custom Reports endpoint
85247
85323
  * @summary Get Custom Reports
@@ -85412,6 +85488,45 @@ export const ReportsApiAxiosParamCreator = function (configuration) {
85412
85488
  options: localVarRequestOptions,
85413
85489
  };
85414
85490
  }),
85491
+ /**
85492
+ * Upsert Custom Report Schedule endpoint
85493
+ * @summary Upsert Custom Report Schedule
85494
+ * @param {string} reportId The report identifier
85495
+ * @param {CustomReportScheduleInputs} customReportScheduleInputs
85496
+ * @param {*} [options] Override http request option.
85497
+ * @throws {RequiredError}
85498
+ */
85499
+ upsertCustomReportSchedule: (reportId_1, customReportScheduleInputs_1, ...args_1) => __awaiter(this, [reportId_1, customReportScheduleInputs_1, ...args_1], void 0, function* (reportId, customReportScheduleInputs, options = {}) {
85500
+ // verify required parameter 'reportId' is not null or undefined
85501
+ assertParamExists('upsertCustomReportSchedule', 'reportId', reportId);
85502
+ // verify required parameter 'customReportScheduleInputs' is not null or undefined
85503
+ assertParamExists('upsertCustomReportSchedule', 'customReportScheduleInputs', customReportScheduleInputs);
85504
+ const localVarPath = `/reports/custom/{reportId}/schedule`
85505
+ .replace(`{${"reportId"}}`, encodeURIComponent(String(reportId)));
85506
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
85507
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
85508
+ let baseOptions;
85509
+ if (configuration) {
85510
+ baseOptions = configuration.baseOptions;
85511
+ }
85512
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
85513
+ const localVarHeaderParameter = {};
85514
+ const localVarQueryParameter = {};
85515
+ // authentication ApiKeyAuth required
85516
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
85517
+ // authentication OrganizationId required
85518
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
85519
+ localVarHeaderParameter['Content-Type'] = 'application/json';
85520
+ localVarHeaderParameter['Accept'] = 'application/json';
85521
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
85522
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
85523
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
85524
+ localVarRequestOptions.data = serializeDataIfNeeded(customReportScheduleInputs, localVarRequestOptions, configuration);
85525
+ return {
85526
+ url: toPathString(localVarUrlObj),
85527
+ options: localVarRequestOptions,
85528
+ };
85529
+ }),
85415
85530
  };
85416
85531
  };
85417
85532
  /**
@@ -85453,6 +85568,22 @@ export const ReportsApiFp = function (configuration) {
85453
85568
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
85454
85569
  });
85455
85570
  },
85571
+ /**
85572
+ * Delete Custom Report Schedule endpoint
85573
+ * @summary Delete Custom Report Schedule
85574
+ * @param {string} reportId The report identifier
85575
+ * @param {*} [options] Override http request option.
85576
+ * @throws {RequiredError}
85577
+ */
85578
+ deleteCustomReportSchedule(reportId, options) {
85579
+ return __awaiter(this, void 0, void 0, function* () {
85580
+ var _a, _b, _c;
85581
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteCustomReportSchedule(reportId, options);
85582
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
85583
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ReportsApi.deleteCustomReportSchedule']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
85584
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
85585
+ });
85586
+ },
85456
85587
  /**
85457
85588
  * Export Custom Report endpoint
85458
85589
  * @summary Export Custom Report
@@ -85486,6 +85617,22 @@ export const ReportsApiFp = function (configuration) {
85486
85617
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
85487
85618
  });
85488
85619
  },
85620
+ /**
85621
+ * Get Custom Report Schedule endpoint
85622
+ * @summary Get Custom Report Schedule
85623
+ * @param {string} reportId The report identifier
85624
+ * @param {*} [options] Override http request option.
85625
+ * @throws {RequiredError}
85626
+ */
85627
+ getCustomReportSchedule(reportId, options) {
85628
+ return __awaiter(this, void 0, void 0, function* () {
85629
+ var _a, _b, _c;
85630
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getCustomReportSchedule(reportId, options);
85631
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
85632
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ReportsApi.getCustomReportSchedule']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
85633
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
85634
+ });
85635
+ },
85489
85636
  /**
85490
85637
  * Get Custom Reports endpoint
85491
85638
  * @summary Get Custom Reports
@@ -85556,6 +85703,23 @@ export const ReportsApiFp = function (configuration) {
85556
85703
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
85557
85704
  });
85558
85705
  },
85706
+ /**
85707
+ * Upsert Custom Report Schedule endpoint
85708
+ * @summary Upsert Custom Report Schedule
85709
+ * @param {string} reportId The report identifier
85710
+ * @param {CustomReportScheduleInputs} customReportScheduleInputs
85711
+ * @param {*} [options] Override http request option.
85712
+ * @throws {RequiredError}
85713
+ */
85714
+ upsertCustomReportSchedule(reportId, customReportScheduleInputs, options) {
85715
+ return __awaiter(this, void 0, void 0, function* () {
85716
+ var _a, _b, _c;
85717
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.upsertCustomReportSchedule(reportId, customReportScheduleInputs, options);
85718
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
85719
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ReportsApi.upsertCustomReportSchedule']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
85720
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
85721
+ });
85722
+ },
85559
85723
  };
85560
85724
  };
85561
85725
  /**
@@ -85584,6 +85748,16 @@ export const ReportsApiFactory = function (configuration, basePath, axios) {
85584
85748
  deleteCustomReport(requestParameters, options) {
85585
85749
  return localVarFp.deleteCustomReport(requestParameters.reportId, options).then((request) => request(axios, basePath));
85586
85750
  },
85751
+ /**
85752
+ * Delete Custom Report Schedule endpoint
85753
+ * @summary Delete Custom Report Schedule
85754
+ * @param {ReportsApiDeleteCustomReportScheduleRequest} requestParameters Request parameters.
85755
+ * @param {*} [options] Override http request option.
85756
+ * @throws {RequiredError}
85757
+ */
85758
+ deleteCustomReportSchedule(requestParameters, options) {
85759
+ return localVarFp.deleteCustomReportSchedule(requestParameters.reportId, options).then((request) => request(axios, basePath));
85760
+ },
85587
85761
  /**
85588
85762
  * Export Custom Report endpoint
85589
85763
  * @summary Export Custom Report
@@ -85604,6 +85778,16 @@ export const ReportsApiFactory = function (configuration, basePath, axios) {
85604
85778
  getCustomReport(requestParameters, options) {
85605
85779
  return localVarFp.getCustomReport(requestParameters.reportId, options).then((request) => request(axios, basePath));
85606
85780
  },
85781
+ /**
85782
+ * Get Custom Report Schedule endpoint
85783
+ * @summary Get Custom Report Schedule
85784
+ * @param {ReportsApiGetCustomReportScheduleRequest} requestParameters Request parameters.
85785
+ * @param {*} [options] Override http request option.
85786
+ * @throws {RequiredError}
85787
+ */
85788
+ getCustomReportSchedule(requestParameters, options) {
85789
+ return localVarFp.getCustomReportSchedule(requestParameters.reportId, options).then((request) => request(axios, basePath));
85790
+ },
85607
85791
  /**
85608
85792
  * Get Custom Reports endpoint
85609
85793
  * @summary Get Custom Reports
@@ -85644,6 +85828,16 @@ export const ReportsApiFactory = function (configuration, basePath, axios) {
85644
85828
  updateCustomReport(requestParameters, options) {
85645
85829
  return localVarFp.updateCustomReport(requestParameters.reportId, requestParameters.report, options).then((request) => request(axios, basePath));
85646
85830
  },
85831
+ /**
85832
+ * Upsert Custom Report Schedule endpoint
85833
+ * @summary Upsert Custom Report Schedule
85834
+ * @param {ReportsApiUpsertCustomReportScheduleRequest} requestParameters Request parameters.
85835
+ * @param {*} [options] Override http request option.
85836
+ * @throws {RequiredError}
85837
+ */
85838
+ upsertCustomReportSchedule(requestParameters, options) {
85839
+ return localVarFp.upsertCustomReportSchedule(requestParameters.reportId, requestParameters.customReportScheduleInputs, options).then((request) => request(axios, basePath));
85840
+ },
85647
85841
  };
85648
85842
  };
85649
85843
  /**
@@ -85670,6 +85864,16 @@ export class ReportsApi extends BaseAPI {
85670
85864
  deleteCustomReport(requestParameters, options) {
85671
85865
  return ReportsApiFp(this.configuration).deleteCustomReport(requestParameters.reportId, options).then((request) => request(this.axios, this.basePath));
85672
85866
  }
85867
+ /**
85868
+ * Delete Custom Report Schedule endpoint
85869
+ * @summary Delete Custom Report Schedule
85870
+ * @param {ReportsApiDeleteCustomReportScheduleRequest} requestParameters Request parameters.
85871
+ * @param {*} [options] Override http request option.
85872
+ * @throws {RequiredError}
85873
+ */
85874
+ deleteCustomReportSchedule(requestParameters, options) {
85875
+ return ReportsApiFp(this.configuration).deleteCustomReportSchedule(requestParameters.reportId, options).then((request) => request(this.axios, this.basePath));
85876
+ }
85673
85877
  /**
85674
85878
  * Export Custom Report endpoint
85675
85879
  * @summary Export Custom Report
@@ -85690,6 +85894,16 @@ export class ReportsApi extends BaseAPI {
85690
85894
  getCustomReport(requestParameters, options) {
85691
85895
  return ReportsApiFp(this.configuration).getCustomReport(requestParameters.reportId, options).then((request) => request(this.axios, this.basePath));
85692
85896
  }
85897
+ /**
85898
+ * Get Custom Report Schedule endpoint
85899
+ * @summary Get Custom Report Schedule
85900
+ * @param {ReportsApiGetCustomReportScheduleRequest} requestParameters Request parameters.
85901
+ * @param {*} [options] Override http request option.
85902
+ * @throws {RequiredError}
85903
+ */
85904
+ getCustomReportSchedule(requestParameters, options) {
85905
+ return ReportsApiFp(this.configuration).getCustomReportSchedule(requestParameters.reportId, options).then((request) => request(this.axios, this.basePath));
85906
+ }
85693
85907
  /**
85694
85908
  * Get Custom Reports endpoint
85695
85909
  * @summary Get Custom Reports
@@ -85730,6 +85944,16 @@ export class ReportsApi extends BaseAPI {
85730
85944
  updateCustomReport(requestParameters, options) {
85731
85945
  return ReportsApiFp(this.configuration).updateCustomReport(requestParameters.reportId, requestParameters.report, options).then((request) => request(this.axios, this.basePath));
85732
85946
  }
85947
+ /**
85948
+ * Upsert Custom Report Schedule endpoint
85949
+ * @summary Upsert Custom Report Schedule
85950
+ * @param {ReportsApiUpsertCustomReportScheduleRequest} requestParameters Request parameters.
85951
+ * @param {*} [options] Override http request option.
85952
+ * @throws {RequiredError}
85953
+ */
85954
+ upsertCustomReportSchedule(requestParameters, options) {
85955
+ return ReportsApiFp(this.configuration).upsertCustomReportSchedule(requestParameters.reportId, requestParameters.customReportScheduleInputs, options).then((request) => request(this.axios, this.basePath));
85956
+ }
85733
85957
  }
85734
85958
  /**
85735
85959
  * ReportsUsersApi - axios parameter creator
@@ -0,0 +1,24 @@
1
+ # CustomReportSchedule
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **scheduleExpression** | **string** | | [default to undefined]
9
+ **scheduleTimezone** | **string** | | [default to undefined]
10
+ **scheduleEmails** | **Array&lt;string&gt;** | | [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { CustomReportSchedule } from '@connectedxm/admin-sdk';
16
+
17
+ const instance: CustomReportSchedule = {
18
+ scheduleExpression,
19
+ scheduleTimezone,
20
+ scheduleEmails,
21
+ };
22
+ ```
23
+
24
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,24 @@
1
+ # CustomReportScheduleInputs
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **scheduleExpression** | **string** | | [optional] [default to undefined]
9
+ **scheduleTimezone** | **string** | | [optional] [default to undefined]
10
+ **scheduleEmails** | **Array&lt;string&gt;** | | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { CustomReportScheduleInputs } from '@connectedxm/admin-sdk';
16
+
17
+ const instance: CustomReportScheduleInputs = {
18
+ scheduleExpression,
19
+ scheduleTimezone,
20
+ scheduleEmails,
21
+ };
22
+ ```
23
+
24
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,24 @@
1
+ # GetCustomReportSchedule200Response
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **status** | **string** | | [default to undefined]
9
+ **message** | **string** | | [default to undefined]
10
+ **data** | [**CustomReportSchedule**](CustomReportSchedule.md) | | [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { GetCustomReportSchedule200Response } from '@connectedxm/admin-sdk';
16
+
17
+ const instance: GetCustomReportSchedule200Response = {
18
+ status,
19
+ message,
20
+ data,
21
+ };
22
+ ```
23
+
24
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)