@forteplatforms/sdk 1.0.510 → 1.0.525

package/dist/generated/models/BlockedRequestSample.d.ts

@@ -0,0 +1,133 @@
+/**
+ * OpenAPI definition
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface BlockedRequestSample
+ */
+export interface BlockedRequestSample {
+    /**
+     *
+     * @type {string}
+     * @memberof BlockedRequestSample
+     */
+    sampleId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BlockedRequestSample
+     */
+    groupKey: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof BlockedRequestSample
+     */
+    timestamp: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof BlockedRequestSample
+     */
+    requestMethod: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BlockedRequestSample
+     */
+    rawPath: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BlockedRequestSample
+     */
+    routePattern: string;
+    /**
+     *
+     * @type {BlockedRequestSampleBlockReasonType}
+     * @memberof BlockedRequestSample
+     */
+    blockReason: BlockedRequestSampleBlockReasonType;
+    /**
+     *
+     * @type {BlockedRequestSampleCategoryType}
+     * @memberof BlockedRequestSample
+     */
+    category: BlockedRequestSampleCategoryType;
+    /**
+     *
+     * @type {string}
+     * @memberof BlockedRequestSample
+     */
+    matchedLocation?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof BlockedRequestSample
+     */
+    clientIp: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BlockedRequestSample
+     */
+    country?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof BlockedRequestSample
+     */
+    userAgent?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof BlockedRequestSample
+     */
+    edgeRequestId?: string | null;
+}
+/**
+ * @export
+ */
+export declare const BlockedRequestSampleBlockReasonType: {
+    readonly SCRIPT_IN_BODY: "SCRIPT_IN_BODY";
+    readonly SCRIPT_IN_QUERY: "SCRIPT_IN_QUERY";
+    readonly SCRIPT_IN_COOKIE: "SCRIPT_IN_COOKIE";
+    readonly SCRIPT_IN_PATH: "SCRIPT_IN_PATH";
+    readonly CODE_INJECTION_PATTERN: "CODE_INJECTION_PATTERN";
+    readonly PATH_TRAVERSAL: "PATH_TRAVERSAL";
+    readonly BLOCKED_FILE_EXTENSION: "BLOCKED_FILE_EXTENSION";
+    readonly CLOUD_METADATA_ACCESS: "CLOUD_METADATA_ACCESS";
+    readonly KNOWN_EXPLOIT_PATTERN: "KNOWN_EXPLOIT_PATTERN";
+    readonly SUSPICIOUS_IP: "SUSPICIOUS_IP";
+    readonly BAD_BOT: "BAD_BOT";
+    readonly OVERSIZED_QUERY: "OVERSIZED_QUERY";
+    readonly RATE_LIMITED: "RATE_LIMITED";
+    readonly OTHER: "OTHER";
+};
+export type BlockedRequestSampleBlockReasonType = typeof BlockedRequestSampleBlockReasonType[keyof typeof BlockedRequestSampleBlockReasonType];
+/**
+ * @export
+ */
+export declare const BlockedRequestSampleCategoryType: {
+    readonly POSSIBLE_FALSE_POSITIVE: "POSSIBLE_FALSE_POSITIVE";
+    readonly ATTACK_TRAFFIC: "ATTACK_TRAFFIC";
+    readonly RATE_LIMITED: "RATE_LIMITED";
+};
+export type BlockedRequestSampleCategoryType = typeof BlockedRequestSampleCategoryType[keyof typeof BlockedRequestSampleCategoryType];
+/**
+ * Check if a given object implements the BlockedRequestSample interface.
+ */
+export declare function instanceOfBlockedRequestSample(value: object): value is BlockedRequestSample;
+export declare function BlockedRequestSampleFromJSON(json: any): BlockedRequestSample;
+export declare function BlockedRequestSampleFromJSONTyped(json: any, ignoreDiscriminator: boolean): BlockedRequestSample;
+export declare function BlockedRequestSampleToJSON(json: any): BlockedRequestSample;
+export declare function BlockedRequestSampleToJSONTyped(value?: BlockedRequestSample | null, ignoreDiscriminator?: boolean): any;

package/dist/generated/models/BlockedRequestSample.js

@@ -0,0 +1,119 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * OpenAPI definition
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BlockedRequestSampleCategoryType = exports.BlockedRequestSampleBlockReasonType = void 0;
+exports.instanceOfBlockedRequestSample = instanceOfBlockedRequestSample;
+exports.BlockedRequestSampleFromJSON = BlockedRequestSampleFromJSON;
+exports.BlockedRequestSampleFromJSONTyped = BlockedRequestSampleFromJSONTyped;
+exports.BlockedRequestSampleToJSON = BlockedRequestSampleToJSON;
+exports.BlockedRequestSampleToJSONTyped = BlockedRequestSampleToJSONTyped;
+/**
+ * @export
+ */
+exports.BlockedRequestSampleBlockReasonType = {
+    SCRIPT_IN_BODY: 'SCRIPT_IN_BODY',
+    SCRIPT_IN_QUERY: 'SCRIPT_IN_QUERY',
+    SCRIPT_IN_COOKIE: 'SCRIPT_IN_COOKIE',
+    SCRIPT_IN_PATH: 'SCRIPT_IN_PATH',
+    CODE_INJECTION_PATTERN: 'CODE_INJECTION_PATTERN',
+    PATH_TRAVERSAL: 'PATH_TRAVERSAL',
+    BLOCKED_FILE_EXTENSION: 'BLOCKED_FILE_EXTENSION',
+    CLOUD_METADATA_ACCESS: 'CLOUD_METADATA_ACCESS',
+    KNOWN_EXPLOIT_PATTERN: 'KNOWN_EXPLOIT_PATTERN',
+    SUSPICIOUS_IP: 'SUSPICIOUS_IP',
+    BAD_BOT: 'BAD_BOT',
+    OVERSIZED_QUERY: 'OVERSIZED_QUERY',
+    RATE_LIMITED: 'RATE_LIMITED',
+    OTHER: 'OTHER'
+};
+/**
+ * @export
+ */
+exports.BlockedRequestSampleCategoryType = {
+    POSSIBLE_FALSE_POSITIVE: 'POSSIBLE_FALSE_POSITIVE',
+    ATTACK_TRAFFIC: 'ATTACK_TRAFFIC',
+    RATE_LIMITED: 'RATE_LIMITED'
+};
+/**
+ * Check if a given object implements the BlockedRequestSample interface.
+ */
+function instanceOfBlockedRequestSample(value) {
+    if (!('sampleId' in value) || value['sampleId'] === undefined)
+        return false;
+    if (!('groupKey' in value) || value['groupKey'] === undefined)
+        return false;
+    if (!('timestamp' in value) || value['timestamp'] === undefined)
+        return false;
+    if (!('requestMethod' in value) || value['requestMethod'] === undefined)
+        return false;
+    if (!('rawPath' in value) || value['rawPath'] === undefined)
+        return false;
+    if (!('routePattern' in value) || value['routePattern'] === undefined)
+        return false;
+    if (!('blockReason' in value) || value['blockReason'] === undefined)
+        return false;
+    if (!('category' in value) || value['category'] === undefined)
+        return false;
+    if (!('clientIp' in value) || value['clientIp'] === undefined)
+        return false;
+    return true;
+}
+function BlockedRequestSampleFromJSON(json) {
+    return BlockedRequestSampleFromJSONTyped(json, false);
+}
+function BlockedRequestSampleFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'sampleId': json['sampleId'],
+        'groupKey': json['groupKey'],
+        'timestamp': (new Date(json['timestamp'])),
+        'requestMethod': json['requestMethod'],
+        'rawPath': json['rawPath'],
+        'routePattern': json['routePattern'],
+        'blockReason': json['blockReason'],
+        'category': json['category'],
+        'matchedLocation': json['matchedLocation'] == null ? undefined : json['matchedLocation'],
+        'clientIp': json['clientIp'],
+        'country': json['country'] == null ? undefined : json['country'],
+        'userAgent': json['userAgent'] == null ? undefined : json['userAgent'],
+        'edgeRequestId': json['edgeRequestId'] == null ? undefined : json['edgeRequestId'],
+    };
+}
+function BlockedRequestSampleToJSON(json) {
+    return BlockedRequestSampleToJSONTyped(json, false);
+}
+function BlockedRequestSampleToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'sampleId': value['sampleId'],
+        'groupKey': value['groupKey'],
+        'timestamp': value['timestamp'].toISOString(),
+        'requestMethod': value['requestMethod'],
+        'rawPath': value['rawPath'],
+        'routePattern': value['routePattern'],
+        'blockReason': value['blockReason'],
+        'category': value['category'],
+        'matchedLocation': value['matchedLocation'],
+        'clientIp': value['clientIp'],
+        'country': value['country'],
+        'userAgent': value['userAgent'],
+        'edgeRequestId': value['edgeRequestId'],
+    };
+}

package/dist/generated/models/CheckoutSubscription.d.ts

@@ -0,0 +1,67 @@
+/**
+ * OpenAPI definition
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { PaymentLineItem } from './PaymentLineItem';
+/**
+ *
+ * @export
+ * @interface CheckoutSubscription
+ */
+export interface CheckoutSubscription {
+    /**
+     *
+     * @type {CheckoutSubscriptionIntervalType}
+     * @memberof CheckoutSubscription
+     */
+    interval: CheckoutSubscriptionIntervalType;
+    /**
+     *
+     * @type {Array<PaymentLineItem>}
+     * @memberof CheckoutSubscription
+     */
+    lineItems: Array<PaymentLineItem>;
+    /**
+     *
+     * @type {string}
+     * @memberof CheckoutSubscription
+     */
+    description?: string | null;
+    /**
+     *
+     * @type {{ [key: string]: string; }}
+     * @memberof CheckoutSubscription
+     */
+    metadata?: {
+        [key: string]: string;
+    };
+    /**
+     *
+     * @type {Date}
+     * @memberof CheckoutSubscription
+     */
+    endTime?: Date | null;
+}
+/**
+ * @export
+ */
+export declare const CheckoutSubscriptionIntervalType: {
+    readonly MONTH: "MONTH";
+    readonly YEAR: "YEAR";
+};
+export type CheckoutSubscriptionIntervalType = typeof CheckoutSubscriptionIntervalType[keyof typeof CheckoutSubscriptionIntervalType];
+/**
+ * Check if a given object implements the CheckoutSubscription interface.
+ */
+export declare function instanceOfCheckoutSubscription(value: object): value is CheckoutSubscription;
+export declare function CheckoutSubscriptionFromJSON(json: any): CheckoutSubscription;
+export declare function CheckoutSubscriptionFromJSONTyped(json: any, ignoreDiscriminator: boolean): CheckoutSubscription;
+export declare function CheckoutSubscriptionToJSON(json: any): CheckoutSubscription;
+export declare function CheckoutSubscriptionToJSONTyped(value?: CheckoutSubscription | null, ignoreDiscriminator?: boolean): any;

package/dist/generated/models/CheckoutSubscription.js

@@ -0,0 +1,70 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * OpenAPI definition
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CheckoutSubscriptionIntervalType = void 0;
+exports.instanceOfCheckoutSubscription = instanceOfCheckoutSubscription;
+exports.CheckoutSubscriptionFromJSON = CheckoutSubscriptionFromJSON;
+exports.CheckoutSubscriptionFromJSONTyped = CheckoutSubscriptionFromJSONTyped;
+exports.CheckoutSubscriptionToJSON = CheckoutSubscriptionToJSON;
+exports.CheckoutSubscriptionToJSONTyped = CheckoutSubscriptionToJSONTyped;
+var PaymentLineItem_1 = require("./PaymentLineItem");
+/**
+ * @export
+ */
+exports.CheckoutSubscriptionIntervalType = {
+    MONTH: 'MONTH',
+    YEAR: 'YEAR'
+};
+/**
+ * Check if a given object implements the CheckoutSubscription interface.
+ */
+function instanceOfCheckoutSubscription(value) {
+    if (!('interval' in value) || value['interval'] === undefined)
+        return false;
+    if (!('lineItems' in value) || value['lineItems'] === undefined)
+        return false;
+    return true;
+}
+function CheckoutSubscriptionFromJSON(json) {
+    return CheckoutSubscriptionFromJSONTyped(json, false);
+}
+function CheckoutSubscriptionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'interval': json['interval'],
+        'lineItems': (json['lineItems'].map(PaymentLineItem_1.PaymentLineItemFromJSON)),
+        'description': json['description'] == null ? undefined : json['description'],
+        'metadata': json['metadata'] == null ? undefined : json['metadata'],
+        'endTime': json['endTime'] == null ? undefined : (new Date(json['endTime'])),
+    };
+}
+function CheckoutSubscriptionToJSON(json) {
+    return CheckoutSubscriptionToJSONTyped(json, false);
+}
+function CheckoutSubscriptionToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'interval': value['interval'],
+        'lineItems': (value['lineItems'].map(PaymentLineItem_1.PaymentLineItemToJSON)),
+        'description': value['description'],
+        'metadata': value['metadata'],
+        'endTime': value['endTime'] == null ? value['endTime'] : value['endTime'].toISOString(),
+    };
+}

package/dist/generated/models/CheckoutSubscriptionPreview.d.ts

@@ -0,0 +1,71 @@
+/**
+ * OpenAPI definition
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { PaymentLineItem } from './PaymentLineItem';
+/**
+ *
+ * @export
+ * @interface CheckoutSubscriptionPreview
+ */
+export interface CheckoutSubscriptionPreview {
+    /**
+     *
+     * @type {CheckoutSubscriptionPreviewIntervalType}
+     * @memberof CheckoutSubscriptionPreview
+     */
+    interval: CheckoutSubscriptionPreviewIntervalType;
+    /**
+     *
+     * @type {number}
+     * @memberof CheckoutSubscriptionPreview
+     */
+    subtotalCents: number;
+    /**
+     *
+     * @type {number}
+     * @memberof CheckoutSubscriptionPreview
+     */
+    taxCents?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof CheckoutSubscriptionPreview
+     */
+    amountCents: number;
+    /**
+     *
+     * @type {Array<PaymentLineItem>}
+     * @memberof CheckoutSubscriptionPreview
+     */
+    lineItems: Array<PaymentLineItem>;
+    /**
+     *
+     * @type {Date}
+     * @memberof CheckoutSubscriptionPreview
+     */
+    nextRenewalAt: Date;
+}
+/**
+ * @export
+ */
+export declare const CheckoutSubscriptionPreviewIntervalType: {
+    readonly MONTH: "MONTH";
+    readonly YEAR: "YEAR";
+};
+export type CheckoutSubscriptionPreviewIntervalType = typeof CheckoutSubscriptionPreviewIntervalType[keyof typeof CheckoutSubscriptionPreviewIntervalType];
+/**
+ * Check if a given object implements the CheckoutSubscriptionPreview interface.
+ */
+export declare function instanceOfCheckoutSubscriptionPreview(value: object): value is CheckoutSubscriptionPreview;
+export declare function CheckoutSubscriptionPreviewFromJSON(json: any): CheckoutSubscriptionPreview;
+export declare function CheckoutSubscriptionPreviewFromJSONTyped(json: any, ignoreDiscriminator: boolean): CheckoutSubscriptionPreview;
+export declare function CheckoutSubscriptionPreviewToJSON(json: any): CheckoutSubscriptionPreview;
+export declare function CheckoutSubscriptionPreviewToJSONTyped(value?: CheckoutSubscriptionPreview | null, ignoreDiscriminator?: boolean): any;

package/dist/generated/models/CheckoutSubscriptionPreview.js

@@ -0,0 +1,78 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * OpenAPI definition
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CheckoutSubscriptionPreviewIntervalType = void 0;
+exports.instanceOfCheckoutSubscriptionPreview = instanceOfCheckoutSubscriptionPreview;
+exports.CheckoutSubscriptionPreviewFromJSON = CheckoutSubscriptionPreviewFromJSON;
+exports.CheckoutSubscriptionPreviewFromJSONTyped = CheckoutSubscriptionPreviewFromJSONTyped;
+exports.CheckoutSubscriptionPreviewToJSON = CheckoutSubscriptionPreviewToJSON;
+exports.CheckoutSubscriptionPreviewToJSONTyped = CheckoutSubscriptionPreviewToJSONTyped;
+var PaymentLineItem_1 = require("./PaymentLineItem");
+/**
+ * @export
+ */
+exports.CheckoutSubscriptionPreviewIntervalType = {
+    MONTH: 'MONTH',
+    YEAR: 'YEAR'
+};
+/**
+ * Check if a given object implements the CheckoutSubscriptionPreview interface.
+ */
+function instanceOfCheckoutSubscriptionPreview(value) {
+    if (!('interval' in value) || value['interval'] === undefined)
+        return false;
+    if (!('subtotalCents' in value) || value['subtotalCents'] === undefined)
+        return false;
+    if (!('amountCents' in value) || value['amountCents'] === undefined)
+        return false;
+    if (!('lineItems' in value) || value['lineItems'] === undefined)
+        return false;
+    if (!('nextRenewalAt' in value) || value['nextRenewalAt'] === undefined)
+        return false;
+    return true;
+}
+function CheckoutSubscriptionPreviewFromJSON(json) {
+    return CheckoutSubscriptionPreviewFromJSONTyped(json, false);
+}
+function CheckoutSubscriptionPreviewFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'interval': json['interval'],
+        'subtotalCents': json['subtotalCents'],
+        'taxCents': json['taxCents'] == null ? undefined : json['taxCents'],
+        'amountCents': json['amountCents'],
+        'lineItems': (json['lineItems'].map(PaymentLineItem_1.PaymentLineItemFromJSON)),
+        'nextRenewalAt': (new Date(json['nextRenewalAt'])),
+    };
+}
+function CheckoutSubscriptionPreviewToJSON(json) {
+    return CheckoutSubscriptionPreviewToJSONTyped(json, false);
+}
+function CheckoutSubscriptionPreviewToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'interval': value['interval'],
+        'subtotalCents': value['subtotalCents'],
+        'taxCents': value['taxCents'],
+        'amountCents': value['amountCents'],
+        'lineItems': (value['lineItems'].map(PaymentLineItem_1.PaymentLineItemToJSON)),
+        'nextRenewalAt': value['nextRenewalAt'].toISOString(),
+    };
+}

package/dist/generated/models/CreateActionRequest.d.ts

@@ -17,73 +17,73 @@ import type { ActionScheduleType } from './ActionScheduleType';
  */
 export interface CreateActionRequest {
     /**
-     *
+     * Display name.
      * @type {string}
      * @memberof CreateActionRequest
      */
     name: string;
     /**
-     *
+     * The service in this project that Forte calls.
      * @type {string}
      * @memberof CreateActionRequest
      */
     targetServiceId: string;
     /**
-     *
+     * Path on the target service to POST to, starting with /, e.g. /jobs/nightly.
      * @type {string}
      * @memberof CreateActionRequest
      */
     targetPath: string;
     /**
-     *
+     * Request body sent with every invocation.
      * @type {string}
      * @memberof CreateActionRequest
      */
     requestBody?: string | null;
     /**
-     *
+     * RECURRING runs on cronExpression; ONE_TIME runs once at scheduledAt.
      * @type {ActionScheduleType}
      * @memberof CreateActionRequest
      */
     scheduleType: ActionScheduleType;
     /**
-     *
+     * RECURRING only: standard 5-field cron, e.g. "0,15,30,45 * * * *" for every 15 minutes, or 6-field with seconds first.
      * @type {string}
      * @memberof CreateActionRequest
      */
     cronExpression?: string | null;
     /**
-     *
+     * RECURRING only: IANA timezone the cron expression runs in, e.g. America/New_York.
      * @type {string}
      * @memberof CreateActionRequest
      */
     timezone?: string | null;
     /**
-     *
+     * RECURRING only: no invocations before this time, ISO-8601 UTC.
      * @type {Date}
      * @memberof CreateActionRequest
      */
     windowStart?: Date | null;
     /**
-     *
+     * RECURRING only: no invocations after this time, ISO-8601 UTC.
      * @type {Date}
      * @memberof CreateActionRequest
      */
     windowEnd?: Date | null;
     /**
-     *
+     * ONE_TIME only: when to run, ISO-8601 UTC, in the future.
      * @type {Date}
      * @memberof CreateActionRequest
      */
     scheduledAt?: Date | null;
     /**
-     *
+     * Set true to retry failed invocations.
      * @type {boolean}
      * @memberof CreateActionRequest
      */
     retryable?: boolean | null;
     /**
-     *
+     * Defaults to true; false creates the action paused.
      * @type {boolean}
      * @memberof CreateActionRequest
      */