@sailpoint/api-client 2.2.45 → 2.2.47

package/dist/certification_campaigns/api.d.ts

@@ -1961,7 +1961,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
      */
     startCampaignReportV1: (id: string, type: ReportType, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged.
+     * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged.  :::note  A STAGED campaign can be activated only when its `deadline` is in the future. Activating with a deadline of today or in the past returns a 400 error. List and get campaign APIs still report `STAGED` after the deadline; set a future deadline with `PATCH /campaigns/v1/{id}` before activating.  :::
      * @summary Activate a campaign
      * @param {string} id Campaign ID.
      * @param {ActivateCampaignOptions} [activateCampaignOptions] Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller\&#39;s timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format.
@@ -2159,7 +2159,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
      */
     startCampaignReportV1(id: string, type: ReportType, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
     /**
-     * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged.
+     * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged.  :::note  A STAGED campaign can be activated only when its `deadline` is in the future. Activating with a deadline of today or in the past returns a 400 error. List and get campaign APIs still report `STAGED` after the deadline; set a future deadline with `PATCH /campaigns/v1/{id}` before activating.  :::
      * @summary Activate a campaign
      * @param {string} id Campaign ID.
      * @param {ActivateCampaignOptions} [activateCampaignOptions] Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller\&#39;s timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format.
@@ -2342,7 +2342,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
      */
     startCampaignReportV1(requestParameters: CertificationCampaignsApiStartCampaignReportV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<object>;
     /**
-     * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged.
+     * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged.  :::note  A STAGED campaign can be activated only when its `deadline` is in the future. Activating with a deadline of today or in the past returns a 400 error. List and get campaign APIs still report `STAGED` after the deadline; set a future deadline with `PATCH /campaigns/v1/{id}` before activating.  :::
      * @summary Activate a campaign
      * @param {CertificationCampaignsApiStartCampaignV1Request} requestParameters Request parameters.
      * @param {*} [axiosOptions] Override http request option.
@@ -2919,7 +2919,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
      */
     startCampaignReportV1(requestParameters: CertificationCampaignsApiStartCampaignReportV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
     /**
-     * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged.
+     * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged.  :::note  A STAGED campaign can be activated only when its `deadline` is in the future. Activating with a deadline of today or in the past returns a 400 error. List and get campaign APIs still report `STAGED` after the deadline; set a future deadline with `PATCH /campaigns/v1/{id}` before activating.  :::
      * @summary Activate a campaign
      * @param {CertificationCampaignsApiStartCampaignV1Request} requestParameters Request parameters.
      * @param {*} [axiosOptions] Override http request option.

package/dist/certification_campaigns/api.js

@@ -1042,7 +1042,7 @@ var CertificationCampaignsApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged.
+         * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged.  :::note  A STAGED campaign can be activated only when its `deadline` is in the future. Activating with a deadline of today or in the past returns a 400 error. List and get campaign APIs still report `STAGED` after the deadline; set a future deadline with `PATCH /campaigns/v1/{id}` before activating.  :::
          * @summary Activate a campaign
          * @param {string} id Campaign ID.
          * @param {ActivateCampaignOptions} [activateCampaignOptions] Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller\'s timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format.
@@ -1610,7 +1610,7 @@ var CertificationCampaignsApiFp = function (configuration) {
             });
         },
         /**
-         * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged.
+         * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged.  :::note  A STAGED campaign can be activated only when its `deadline` is in the future. Activating with a deadline of today or in the past returns a 400 error. List and get campaign APIs still report `STAGED` after the deadline; set a future deadline with `PATCH /campaigns/v1/{id}` before activating.  :::
          * @summary Activate a campaign
          * @param {string} id Campaign ID.
          * @param {ActivateCampaignOptions} [activateCampaignOptions] Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller\'s timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format.
@@ -1882,7 +1882,7 @@ var CertificationCampaignsApiFactory = function (configuration, basePath, axios)
             return localVarFp.startCampaignReportV1(requestParameters.id, requestParameters.type, axiosOptions).then(function (request) { return request(axios, basePath); });
         },
         /**
-         * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged.
+         * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged.  :::note  A STAGED campaign can be activated only when its `deadline` is in the future. Activating with a deadline of today or in the past returns a 400 error. List and get campaign APIs still report `STAGED` after the deadline; set a future deadline with `PATCH /campaigns/v1/{id}` before activating.  :::
          * @summary Activate a campaign
          * @param {CertificationCampaignsApiStartCampaignV1Request} requestParameters Request parameters.
          * @param {*} [axiosOptions] Override http request option.
@@ -2155,7 +2155,7 @@ var CertificationCampaignsApi = /** @class */ (function (_super) {
         return (0, exports.CertificationCampaignsApiFp)(this.configuration).startCampaignReportV1(requestParameters.id, requestParameters.type, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged.
+     * Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged.  :::note  A STAGED campaign can be activated only when its `deadline` is in the future. Activating with a deadline of today or in the past returns a 400 error. List and get campaign APIs still report `STAGED` after the deadline; set a future deadline with `PATCH /campaigns/v1/{id}` before activating.  :::
      * @summary Activate a campaign
      * @param {CertificationCampaignsApiStartCampaignV1Request} requestParameters Request parameters.
      * @param {*} [axiosOptions] Override http request option.