/** * NERM API * The NERM API accesss and modifies resources in your environment. * * The version of the OpenAPI document: 1.0.0 * * * 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 { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import type { RequestArgs } from './base'; import { BaseAPI } from './base'; /** * * @export * @interface AdvancedSearch1ConditionRulesAttributesInnerNERM */ export interface AdvancedSearch1ConditionRulesAttributesInnerNERM { /** * * @type {string} * @memberof AdvancedSearch1ConditionRulesAttributesInnerNERM */ 'type': AdvancedSearch1ConditionRulesAttributesInnerNERMTypeNerm; /** * * @type {string} * @memberof AdvancedSearch1ConditionRulesAttributesInnerNERM */ 'comparison_operator': AdvancedSearch1ConditionRulesAttributesInnerNERMComparisonOperatorNerm; /** * * @type {string} * @memberof AdvancedSearch1ConditionRulesAttributesInnerNERM */ 'value': string; /** * * @type {string} * @memberof AdvancedSearch1ConditionRulesAttributesInnerNERM */ 'condition_object_type': AdvancedSearch1ConditionRulesAttributesInnerNERMConditionObjectTypeNerm; /** * * @type {string} * @memberof AdvancedSearch1ConditionRulesAttributesInnerNERM */ 'condition_object_id': string; /** * * @type {string} * @memberof AdvancedSearch1ConditionRulesAttributesInnerNERM */ 'secondary_attribute_type'?: AdvancedSearch1ConditionRulesAttributesInnerNERMSecondaryAttributeTypeNerm; /** * * @type {string} * @memberof AdvancedSearch1ConditionRulesAttributesInnerNERM */ 'secondary_attribute_id'?: string; /** * * @type {string} * @memberof AdvancedSearch1ConditionRulesAttributesInnerNERM */ 'secondary_value': AdvancedSearch1ConditionRulesAttributesInnerNERMSecondaryValueNerm; /** * * @type {string} * @memberof AdvancedSearch1ConditionRulesAttributesInnerNERM */ 'tertiary_value'?: string; } export declare const AdvancedSearch1ConditionRulesAttributesInnerNERMTypeNerm: { readonly ProfileTypeRule: "ProfileTypeRule"; readonly ProfileStatusRule: "ProfileStatusRule"; readonly ProfileAttributeRule: "ProfileAttributeRule"; readonly RiskRule: "RiskRule"; }; export type AdvancedSearch1ConditionRulesAttributesInnerNERMTypeNerm = typeof AdvancedSearch1ConditionRulesAttributesInnerNERMTypeNerm[keyof typeof AdvancedSearch1ConditionRulesAttributesInnerNERMTypeNerm]; export declare const AdvancedSearch1ConditionRulesAttributesInnerNERMComparisonOperatorNerm: { readonly DoubleEqual: "=="; readonly GreaterThan: ">"; readonly LessThan: "<"; }; export type AdvancedSearch1ConditionRulesAttributesInnerNERMComparisonOperatorNerm = typeof AdvancedSearch1ConditionRulesAttributesInnerNERMComparisonOperatorNerm[keyof typeof AdvancedSearch1ConditionRulesAttributesInnerNERMComparisonOperatorNerm]; export declare const AdvancedSearch1ConditionRulesAttributesInnerNERMConditionObjectTypeNerm: { readonly ProfileSelectAttribute: "ProfileSelectAttribute"; readonly ProfileSearchAttribute: "ProfileSearchAttribute"; readonly OwnerSelectAttribute: "OwnerSelectAttribute"; readonly OwnerSearchAttribute: "OwnerSearchAttribute"; readonly ContributorSelectAttribute: "ContributorSelectAttribute"; readonly ContributorSearchAttribute: "ContributorSearchAttribute"; }; export type AdvancedSearch1ConditionRulesAttributesInnerNERMConditionObjectTypeNerm = typeof AdvancedSearch1ConditionRulesAttributesInnerNERMConditionObjectTypeNerm[keyof typeof AdvancedSearch1ConditionRulesAttributesInnerNERMConditionObjectTypeNerm]; export declare const AdvancedSearch1ConditionRulesAttributesInnerNERMSecondaryAttributeTypeNerm: { readonly DateAttribute: "DateAttribute"; }; export type AdvancedSearch1ConditionRulesAttributesInnerNERMSecondaryAttributeTypeNerm = typeof AdvancedSearch1ConditionRulesAttributesInnerNERMSecondaryAttributeTypeNerm[keyof typeof AdvancedSearch1ConditionRulesAttributesInnerNERMSecondaryAttributeTypeNerm]; export declare const AdvancedSearch1ConditionRulesAttributesInnerNERMSecondaryValueNerm: { readonly OverallRisk: "OverallRisk"; }; export type AdvancedSearch1ConditionRulesAttributesInnerNERMSecondaryValueNerm = typeof AdvancedSearch1ConditionRulesAttributesInnerNERMSecondaryValueNerm[keyof typeof AdvancedSearch1ConditionRulesAttributesInnerNERMSecondaryValueNerm]; /** * * @export * @interface AdvancedSearch1NERM */ export interface AdvancedSearch1NERM { /** * * @type {string} * @memberof AdvancedSearch1NERM */ 'label'?: string; /** * * @type {Array} * @memberof AdvancedSearch1NERM */ 'condition_rules_attributes'?: Array; } /** * * @export * @interface AdvancedSearchConditionRulesAttributesInnerNERM */ export interface AdvancedSearchConditionRulesAttributesInnerNERM { /** * * @type {string} * @memberof AdvancedSearchConditionRulesAttributesInnerNERM */ 'id'?: string; /** * * @type {string} * @memberof AdvancedSearchConditionRulesAttributesInnerNERM */ 'uid'?: string; /** * * @type {string} * @memberof AdvancedSearchConditionRulesAttributesInnerNERM */ 'type': AdvancedSearchConditionRulesAttributesInnerNERMTypeNerm; /** * * @type {string} * @memberof AdvancedSearchConditionRulesAttributesInnerNERM */ 'comparison_operator': AdvancedSearchConditionRulesAttributesInnerNERMComparisonOperatorNerm; /** * * @type {string} * @memberof AdvancedSearchConditionRulesAttributesInnerNERM */ 'value': string; /** * * @type {string} * @memberof AdvancedSearchConditionRulesAttributesInnerNERM */ 'condition_object_type': AdvancedSearchConditionRulesAttributesInnerNERMConditionObjectTypeNerm; /** * * @type {string} * @memberof AdvancedSearchConditionRulesAttributesInnerNERM */ 'condition_object_id': string; /** * * @type {string} * @memberof AdvancedSearchConditionRulesAttributesInnerNERM */ 'secondary_attribute_type'?: AdvancedSearchConditionRulesAttributesInnerNERMSecondaryAttributeTypeNerm; /** * * @type {string} * @memberof AdvancedSearchConditionRulesAttributesInnerNERM */ 'secondary_attribute_id'?: string; /** * * @type {string} * @memberof AdvancedSearchConditionRulesAttributesInnerNERM */ 'secondary_value': AdvancedSearchConditionRulesAttributesInnerNERMSecondaryValueNerm; /** * * @type {string} * @memberof AdvancedSearchConditionRulesAttributesInnerNERM */ 'tertiary_value'?: string; } export declare const AdvancedSearchConditionRulesAttributesInnerNERMTypeNerm: { readonly ProfileTypeRule: "ProfileTypeRule"; readonly ProfileStatusRule: "ProfileStatusRule"; readonly ProfileAttributeRule: "ProfileAttributeRule"; readonly RiskRule: "RiskRule"; }; export type AdvancedSearchConditionRulesAttributesInnerNERMTypeNerm = typeof AdvancedSearchConditionRulesAttributesInnerNERMTypeNerm[keyof typeof AdvancedSearchConditionRulesAttributesInnerNERMTypeNerm]; export declare const AdvancedSearchConditionRulesAttributesInnerNERMComparisonOperatorNerm: { readonly DoubleEqual: "=="; readonly GreaterThan: ">"; readonly LessThan: "<"; }; export type AdvancedSearchConditionRulesAttributesInnerNERMComparisonOperatorNerm = typeof AdvancedSearchConditionRulesAttributesInnerNERMComparisonOperatorNerm[keyof typeof AdvancedSearchConditionRulesAttributesInnerNERMComparisonOperatorNerm]; export declare const AdvancedSearchConditionRulesAttributesInnerNERMConditionObjectTypeNerm: { readonly ProfileSelectAttribute: "ProfileSelectAttribute"; readonly ProfileSearchAttribute: "ProfileSearchAttribute"; readonly OwnerSelectAttribute: "OwnerSelectAttribute"; readonly OwnerSearchAttribute: "OwnerSearchAttribute"; readonly ContributorSelectAttribute: "ContributorSelectAttribute"; readonly ContributorSearchAttribute: "ContributorSearchAttribute"; }; export type AdvancedSearchConditionRulesAttributesInnerNERMConditionObjectTypeNerm = typeof AdvancedSearchConditionRulesAttributesInnerNERMConditionObjectTypeNerm[keyof typeof AdvancedSearchConditionRulesAttributesInnerNERMConditionObjectTypeNerm]; export declare const AdvancedSearchConditionRulesAttributesInnerNERMSecondaryAttributeTypeNerm: { readonly DateAttribute: "DateAttribute"; }; export type AdvancedSearchConditionRulesAttributesInnerNERMSecondaryAttributeTypeNerm = typeof AdvancedSearchConditionRulesAttributesInnerNERMSecondaryAttributeTypeNerm[keyof typeof AdvancedSearchConditionRulesAttributesInnerNERMSecondaryAttributeTypeNerm]; export declare const AdvancedSearchConditionRulesAttributesInnerNERMSecondaryValueNerm: { readonly OverallRisk: "OverallRisk"; }; export type AdvancedSearchConditionRulesAttributesInnerNERMSecondaryValueNerm = typeof AdvancedSearchConditionRulesAttributesInnerNERMSecondaryValueNerm[keyof typeof AdvancedSearchConditionRulesAttributesInnerNERMSecondaryValueNerm]; /** * * @export * @interface AdvancedSearchNERM */ export interface AdvancedSearchNERM { /** * * @type {string} * @memberof AdvancedSearchNERM */ 'id'?: string; /** * * @type {string} * @memberof AdvancedSearchNERM */ 'uid'?: string; /** * * @type {string} * @memberof AdvancedSearchNERM */ 'label'?: string; /** * * @type {Array} * @memberof AdvancedSearchNERM */ 'condition_rules_attributes'?: Array; } /** * * @export * @interface ApprovalActionNERM */ export interface ApprovalActionNERM { /** * The workflow the workflow action belongs to. * @type {string} * @memberof ApprovalActionNERM */ 'workflow_id': string; /** * The description of the workflow action. * @type {string} * @memberof ApprovalActionNERM */ 'description'?: string; /** * The page the workflow action should render. * @type {string} * @memberof ApprovalActionNERM */ 'page_id': string; /** * If the workflow action is archived or not. * @type {boolean} * @memberof ApprovalActionNERM */ 'archived'?: boolean; /** * If the workflow action is skippable or not. * @type {boolean} * @memberof ApprovalActionNERM */ 'skippable'?: boolean; /** * If the workflow action requires a comment or not. * @type {boolean} * @memberof ApprovalActionNERM */ 'requires_comment'?: boolean; } /** * * @export * @interface AskSecurityQuestionActionNERM */ export interface AskSecurityQuestionActionNERM { /** * The workflow the workflow action belongs to. * @type {string} * @memberof AskSecurityQuestionActionNERM */ 'workflow_id': string; /** * The description of the workflow action. * @type {string} * @memberof AskSecurityQuestionActionNERM */ 'description': string; /** * The number of questions the user should answer upon login. * @type {number} * @memberof AskSecurityQuestionActionNERM */ 'number_of_questions': number; /** * The token expiration time, coordinates with token_expiration_type. * @type {number} * @memberof AskSecurityQuestionActionNERM */ 'token_expiration': number; /** * The token expiration type, coordinates with token_expiration. * @type {string} * @memberof AskSecurityQuestionActionNERM */ 'token_expiration_type': AskSecurityQuestionActionNERMTokenExpirationTypeNerm; /** * If the workflow action is archived or not. * @type {boolean} * @memberof AskSecurityQuestionActionNERM */ 'archived'?: boolean; } export declare const AskSecurityQuestionActionNERMTokenExpirationTypeNerm: { readonly Hours: "hours"; readonly Days: "days"; readonly LoginAttempts: "login attempts"; readonly Always: "always"; }; export type AskSecurityQuestionActionNERMTokenExpirationTypeNerm = typeof AskSecurityQuestionActionNERMTokenExpirationTypeNerm[keyof typeof AskSecurityQuestionActionNERMTokenExpirationTypeNerm]; /** * * @export * @interface Attribute1NERM */ export interface Attribute1NERM { /** * The id of the attribute * @type {string} * @memberof Attribute1NERM */ 'id'?: string; /** * The user-specified identifier of the attribute * @type {string} * @memberof Attribute1NERM */ 'uid'?: string; /** * The label for the attribute * @type {string} * @memberof Attribute1NERM */ 'label'?: string; /** * A description of the attribute * @type {string} * @memberof Attribute1NERM */ 'description'?: string; /** * The helper text that accompanies the attribute * @type {string} * @memberof Attribute1NERM */ 'tool_tip'?: string; /** * Whether the attribute is archived * @type {boolean} * @memberof Attribute1NERM */ 'archived'?: boolean; /** * The format of the date input if it is a date input * @type {string} * @memberof Attribute1NERM */ 'date_format'?: Attribute1NERMDateFormatNerm; /** * The status of the profiles that can be selected * @type {string} * @memberof Attribute1NERM */ 'selectable_status'?: string; /** * Type of risk that applies to the attribute * @type {string} * @memberof Attribute1NERM */ 'risk_type'?: string; /** * Only shows profiles that the user currently has access to, to be selected * @type {boolean} * @memberof Attribute1NERM */ 'ownership_driven'?: boolean; /** * Whether or not multiple selections can be made on something like a contributor search. * @type {boolean} * @memberof Attribute1NERM */ 'allow_multiple_selections'?: boolean; /** * Whether or not the attribute is filtered by another attribute * @type {boolean} * @memberof Attribute1NERM */ 'filtered_by_ne_attribute'?: boolean; /** * The ID of the filtering attribute * @type {string} * @memberof Attribute1NERM */ 'filtering_ne_attribute_id'?: string; /** * The ID of the attribute filter * @type {string} * @memberof Attribute1NERM */ 'ne_attribute_filter_id'?: string; /** * * @type {AttributePropertiesNERM} * @memberof Attribute1NERM */ 'reverse_association_attribute'?: AttributePropertiesNERM; /** * The ID of the profile type the attribute applies to * @type {string} * @memberof Attribute1NERM */ 'profile_type_id'?: string; /** * The type of data that applies to the attribute * @type {string} * @memberof Attribute1NERM */ 'data_type'?: Attribute1NERMDataTypeNerm; /** * The attribute\'s type * @type {string} * @memberof Attribute1NERM */ 'type'?: Attribute1NERMTypeNerm; /** * * @type {Attribute1ValidationsAttributesNERM} * @memberof Attribute1NERM */ 'validations_attributes'?: Attribute1ValidationsAttributesNERM; } export declare const Attribute1NERMDateFormatNerm: { readonly MmDdYyyy: "mm/dd/yyyy"; readonly MmDdYyyy2: "mm-dd-yyyy"; readonly DdMmYyyy: "dd/mm/yyyy"; readonly DdMmYyyy2: "dd-mm-yyyy"; readonly YyyyMmDd: "yyyy/mm/dd"; readonly YyyyMmDd2: "yyyy-mm-dd"; }; export type Attribute1NERMDateFormatNerm = typeof Attribute1NERMDateFormatNerm[keyof typeof Attribute1NERMDateFormatNerm]; export declare const Attribute1NERMDataTypeNerm: { readonly TextField: "text field"; readonly TextArea: "text area"; readonly DropDown: "drop-down"; readonly RadioButtons: "radio buttons"; readonly CheckBoxes: "check boxes"; readonly Date: "date"; readonly Tags: "tags"; readonly Attachment: "attachment"; readonly ProfileSelect: "profile select"; readonly ProfileSearch: "profile search"; readonly OwnerSelect: "owner select"; readonly OwnerSearch: "owner search"; readonly ContributorSelect: "contributor select"; readonly ContributorSearch: "contributor search"; }; export type Attribute1NERMDataTypeNerm = typeof Attribute1NERMDataTypeNerm[keyof typeof Attribute1NERMDataTypeNerm]; export declare const Attribute1NERMTypeNerm: { readonly AttachmentAttribute: "AttachmentAttribute"; readonly CheckBoxesAttribute: "CheckBoxesAttribute"; readonly ContributorSearchAttribute: "ContributorSearchAttribute"; readonly ContributorSelectAttribute: "ContributorSelectAttribute"; readonly DateAttribute: "DateAttribute"; readonly DropDownAttribute: "DropDownAttribute"; readonly OwnerSearchAttribute: "OwnerSearchAttribute"; readonly OwnerSelectAttribute: "OwnerSelectAttribute"; readonly ProfileSearchAttribute: "ProfileSearchAttribute"; readonly ProfileSelectAttribute: "ProfileSelectAttribute"; readonly RadioButtonsAttribute: "RadioButtonsAttribute"; readonly TagsAttribute: "TagsAttribute"; readonly TextAreaAttribute: "TextAreaAttribute"; readonly TextFieldAttribute: "TextFieldAttribute"; }; export type Attribute1NERMTypeNerm = typeof Attribute1NERMTypeNerm[keyof typeof Attribute1NERMTypeNerm]; /** * * @export * @interface Attribute1ValidationsAttributesNERM */ export interface Attribute1ValidationsAttributesNERM { /** * The type of validation to be applied * @type {string} * @memberof Attribute1ValidationsAttributesNERM */ 'validation_method'?: Attribute1ValidationsAttributesNERMValidationMethodNerm; /** * The value of the validator * @type {string} * @memberof Attribute1ValidationsAttributesNERM */ 'value'?: string; /** * If the validator should be removed * @type {boolean} * @memberof Attribute1ValidationsAttributesNERM */ '_destroy'?: boolean; } export declare const Attribute1ValidationsAttributesNERMValidationMethodNerm: { readonly Required: "required"; readonly Unique: "unique"; readonly DateFormat: "date_format"; readonly Days: "days"; readonly Characters: "characters"; readonly Extension: "extension"; readonly Numericality: "numericality"; readonly EmailFormat: "email_format"; readonly CustomFormat: "custom_format"; readonly NoSpecialChars: "no_special_chars"; }; export type Attribute1ValidationsAttributesNERMValidationMethodNerm = typeof Attribute1ValidationsAttributesNERMValidationMethodNerm[keyof typeof Attribute1ValidationsAttributesNERMValidationMethodNerm]; /** * * @export * @interface AttributeNERM */ export interface AttributeNERM { /** * The id of the attribute * @type {string} * @memberof AttributeNERM */ 'id'?: string; /** * The user-specified identifier of the attribute * @type {string} * @memberof AttributeNERM */ 'uid'?: string; /** * The label for the attribute * @type {string} * @memberof AttributeNERM */ 'label'?: string; /** * A description of the attribute * @type {string} * @memberof AttributeNERM */ 'description'?: string; /** * The helper text that accompanies the attribute * @type {string} * @memberof AttributeNERM */ 'tool_tip'?: string; /** * Whether the attribute is encrypted * @type {boolean} * @memberof AttributeNERM */ 'crypt'?: boolean; /** * Whether the attribute is archived * @type {boolean} * @memberof AttributeNERM */ 'archived'?: boolean; /** * When the attribute was archived * @type {string} * @memberof AttributeNERM */ 'archived_on'?: string; /** * When the attribute was created * @type {string} * @memberof AttributeNERM */ 'created_at'?: string; /** * When the attribute was updated * @type {string} * @memberof AttributeNERM */ 'updated_at'?: string; /** * The format of the date input if it is a date input * @type {string} * @memberof AttributeNERM */ 'date_format'?: AttributeNERMDateFormatNerm; /** * The status of the profiles that can be selected * @type {string} * @memberof AttributeNERM */ 'selectable_status'?: string; /** * Type of risk that applies to the attribute * @type {string} * @memberof AttributeNERM */ 'risk_type'?: string; /** * Only shows profiles that the user currently has access to, to be selected * @type {boolean} * @memberof AttributeNERM */ 'ownership_driven'?: boolean; /** * Whether or not multiple selections can be made on something like a contributor search. * @type {boolean} * @memberof AttributeNERM */ 'allow_multiple_selections'?: boolean; /** * Whether or not the attribute is filtered by another attribute * @type {boolean} * @memberof AttributeNERM */ 'filtered_by_ne_attribute'?: boolean; /** * The ID of the filtering attribute * @type {string} * @memberof AttributeNERM */ 'filtering_ne_attribute_id'?: string; /** * The ID of the attribute filter * @type {string} * @memberof AttributeNERM */ 'ne_attribute_filter_id'?: string; /** * * @type {AttributePropertiesNERM} * @memberof AttributeNERM */ 'reverse_association_attribute'?: AttributePropertiesNERM; /** * The ID of the profile type the attribute applies to * @type {string} * @memberof AttributeNERM */ 'profile_type_id'?: string; /** * The type of data that applies to the attribute * @type {string} * @memberof AttributeNERM */ 'data_type'?: AttributeNERMDataTypeNerm; /** * The attribute\'s type * @type {string} * @memberof AttributeNERM */ 'type'?: AttributeNERMTypeNerm; } export declare const AttributeNERMDateFormatNerm: { readonly MmDdYyyy: "mm/dd/yyyy"; readonly MmDdYyyy2: "mm-dd-yyyy"; readonly DdMmYyyy: "dd/mm/yyyy"; readonly DdMmYyyy2: "dd-mm-yyyy"; readonly YyyyMmDd: "yyyy/mm/dd"; readonly YyyyMmDd2: "yyyy-mm-dd"; }; export type AttributeNERMDateFormatNerm = typeof AttributeNERMDateFormatNerm[keyof typeof AttributeNERMDateFormatNerm]; export declare const AttributeNERMDataTypeNerm: { readonly TextField: "text field"; readonly TextArea: "text area"; readonly DropDown: "drop-down"; readonly RadioButtons: "radio buttons"; readonly CheckBoxes: "check boxes"; readonly Date: "date"; readonly Tags: "tags"; readonly Attachment: "attachment"; readonly ProfileSelect: "profile select"; readonly ProfileSearch: "profile search"; readonly OwnerSelect: "owner select"; readonly OwnerSearch: "owner search"; readonly ContributorSelect: "contributor select"; readonly ContributorSearch: "contributor search"; }; export type AttributeNERMDataTypeNerm = typeof AttributeNERMDataTypeNerm[keyof typeof AttributeNERMDataTypeNerm]; export declare const AttributeNERMTypeNerm: { readonly AttachmentAttribute: "AttachmentAttribute"; readonly CheckBoxesAttribute: "CheckBoxesAttribute"; readonly ContributorSearchAttribute: "ContributorSearchAttribute"; readonly ContributorSelectAttribute: "ContributorSelectAttribute"; readonly DateAttribute: "DateAttribute"; readonly DropDownAttribute: "DropDownAttribute"; readonly OwnerSearchAttribute: "OwnerSearchAttribute"; readonly OwnerSelectAttribute: "OwnerSelectAttribute"; readonly ProfileSearchAttribute: "ProfileSearchAttribute"; readonly ProfileSelectAttribute: "ProfileSelectAttribute"; readonly RadioButtonsAttribute: "RadioButtonsAttribute"; readonly TagsAttribute: "TagsAttribute"; readonly TextAreaAttribute: "TextAreaAttribute"; readonly TextFieldAttribute: "TextFieldAttribute"; }; export type AttributeNERMTypeNerm = typeof AttributeNERMTypeNerm[keyof typeof AttributeNERMTypeNerm]; /** * * @export * @interface AttributeOption1NERM */ export interface AttributeOption1NERM { /** * * @type {string} * @memberof AttributeOption1NERM */ 'ne_attribute_id'?: string; /** * * @type {string} * @memberof AttributeOption1NERM */ 'option'?: string; } /** * * @export * @interface AttributeOptionNERM */ export interface AttributeOptionNERM { /** * * @type {string} * @memberof AttributeOptionNERM */ 'id'?: string; /** * * @type {string} * @memberof AttributeOptionNERM */ 'uid'?: string; /** * * @type {string} * @memberof AttributeOptionNERM */ 'ne_attribute_id'?: string; /** * * @type {string} * @memberof AttributeOptionNERM */ 'option'?: string; } /** * * @export * @interface AttributeOptionsNERM */ export interface AttributeOptionsNERM { /** * * @type {Array} * @memberof AttributeOptionsNERM */ 'ne_attribute_options'?: Array; } /** * * @export * @interface AttributePropertiesNERM */ export interface AttributePropertiesNERM { /** * The id of the attribute * @type {string} * @memberof AttributePropertiesNERM */ 'id'?: string; /** * The user-specified identifier of the attribute * @type {string} * @memberof AttributePropertiesNERM */ 'uid'?: string; /** * The label for the attribute * @type {string} * @memberof AttributePropertiesNERM */ 'label'?: string; /** * A description of the attribute * @type {string} * @memberof AttributePropertiesNERM */ 'description'?: string; /** * The helper text that accompanies the attribute * @type {string} * @memberof AttributePropertiesNERM */ 'tool_tip'?: string; /** * Whether or not the attribute is encrypted * @type {boolean} * @memberof AttributePropertiesNERM */ 'crypt'?: boolean; /** * Whether the attribute is archived * @type {boolean} * @memberof AttributePropertiesNERM */ 'archived'?: boolean; /** * When the attribute was archived * @type {string} * @memberof AttributePropertiesNERM */ 'archived_on'?: string; /** * When the attribute was created * @type {string} * @memberof AttributePropertiesNERM */ 'created_at'?: string; /** * When the attribute was last updated * @type {string} * @memberof AttributePropertiesNERM */ 'updated_at'?: string; /** * The format of the date input if it is a date input * @type {string} * @memberof AttributePropertiesNERM */ 'date_format'?: AttributePropertiesNERMDateFormatNerm; /** * The status of the profiles that can be selected * @type {string} * @memberof AttributePropertiesNERM */ 'selectable_status'?: string; /** * What setting is used for the risk score * @type {string} * @memberof AttributePropertiesNERM */ 'risk_score_setting'?: string; /** * Type of risk that applies to the attribute * @type {string} * @memberof AttributePropertiesNERM */ 'risk_type'?: string; /** * Only shows profiles that the user currently has access to, to be selected * @type {boolean} * @memberof AttributePropertiesNERM */ 'ownership_driven'?: boolean; /** * Whether or not multiple selections can be made on something like a contributor search. * @type {boolean} * @memberof AttributePropertiesNERM */ 'allow_multiple_selections'?: boolean; /** * Whether or not the attribute is filtered by another attribute * @type {boolean} * @memberof AttributePropertiesNERM */ 'filtered_by_ne_attribute'?: boolean; /** * The ID of the filtering attribute * @type {string} * @memberof AttributePropertiesNERM */ 'filtering_ne_attribute_id'?: string; /** * The ID of the attribute filter * @type {string} * @memberof AttributePropertiesNERM */ 'ne_attribute_filter_id'?: string; /** * The ID of the attribute used with reverse association * @type {string} * @memberof AttributePropertiesNERM */ 'reverse_association_attribute_id'?: string; /** * The ID of the profile type the attribute applies to * @type {string} * @memberof AttributePropertiesNERM */ 'profile_type_id'?: string; /** * The legacy ID * @type {string} * @memberof AttributePropertiesNERM */ 'legacy_id'?: string; /** * the temp of when attribute was created * @type {string} * @memberof AttributePropertiesNERM */ 'tmp_created_at'?: string; /** * the temp of when attribute was last updated * @type {string} * @memberof AttributePropertiesNERM */ 'tmp_updated_at'?: string; } export declare const AttributePropertiesNERMDateFormatNerm: { readonly MmDdYyyy: "mm/dd/yyyy"; readonly MmDdYyyy2: "mm-dd-yyyy"; readonly DdMmYyyy: "dd/mm/yyyy"; readonly DdMmYyyy2: "dd-mm-yyyy"; readonly YyyyMmDd: "yyyy/mm/dd"; readonly YyyyMmDd2: "yyyy-mm-dd"; }; export type AttributePropertiesNERMDateFormatNerm = typeof AttributePropertiesNERMDateFormatNerm[keyof typeof AttributePropertiesNERMDateFormatNerm]; /** * Search for record based on the created_at date * @export * @interface AuditEventCreatedAtNERM */ export interface AuditEventCreatedAtNERM { /** * Greater Than - search for events with a date greater than the value * @type {string} * @memberof AuditEventCreatedAtNERM */ 'gt'?: string; /** * Less Than - search for events with a date less than the value * @type {string} * @memberof AuditEventCreatedAtNERM */ 'lt'?: string; /** * Equal - search for events with a date equal to the value * @type {string} * @memberof AuditEventCreatedAtNERM */ 'eq'?: string; } /** * * @export * @interface AuditEventDataNERM */ export interface AuditEventDataNERM { /** * The profile id associated with the event * @type {string} * @memberof AuditEventDataNERM */ 'profile_id'?: string; /** * The workflow id associated with the event * @type {string} * @memberof AuditEventDataNERM */ 'workflow_id'?: string; /** * The workflow name associated with the event * @type {string} * @memberof AuditEventDataNERM */ 'workflow_name'?: string; /** * The workflow uid associated with the event * @type {string} * @memberof AuditEventDataNERM */ 'workflow_uid'?: string; /** * The profile type associated with the event * @type {string} * @memberof AuditEventDataNERM */ 'profile_type_id'?: string; } /** * * @export * @interface AuditEventNERM */ export interface AuditEventNERM { /** * * @type {AuditEventCreatedAtNERM} * @memberof AuditEventNERM */ 'created_at'?: AuditEventCreatedAtNERM; /** * Categorization of audit event. * @type {string} * @memberof AuditEventNERM */ 'subject_type'?: AuditEventNERMSubjectTypeNerm; /** * The type of audit event * @type {string} * @memberof AuditEventNERM */ 'type'?: AuditEventNERMTypeNerm; /** * Identifier of the subject * @type {string} * @memberof AuditEventNERM */ 'subject_id'?: string; /** * * @type {AuditEventDataNERM} * @memberof AuditEventNERM */ 'data'?: AuditEventDataNERM; } export declare const AuditEventNERMSubjectTypeNerm: { readonly Profile: "Profile"; readonly WorkflowSession: "WorkflowSession"; readonly Email: "Email"; readonly FormAttributeForm: "FormAttributeForm"; readonly FormAttribute: "FormAttribute"; readonly Form: "Form"; readonly IdentityProofingResult: "IdentityProofingResult"; readonly IdproxyPermission: "IdproxyPermission"; readonly NeAttributeOption: "NeAttributeOption"; readonly NeAttribute: "NeAttribute"; readonly Notification: "Notification"; readonly WorkflowPage: "WorkflowPage"; readonly ProfilePage: "ProfilePage"; readonly Permission: "Permission"; readonly PortalRegistrationWorkflow: "PortalRegistrationWorkflow"; readonly Portal: "Portal"; readonly ProfileTypeRole: "ProfileTypeRole"; readonly ProfileType: "ProfileType"; readonly RoleProfile: "RoleProfile"; readonly NeprofileRole: "NeprofileRole"; readonly NeaccessRole: "NeaccessRole"; readonly IdproxyRole: "IdproxyRole"; readonly SecurityQuestion: "SecurityQuestion"; readonly UserManager: "UserManager"; readonly UserProfile: "UserProfile"; readonly UserRole: "UserRole"; readonly User: "User"; readonly Validation: "Validation"; readonly VerificationEmail: "VerificationEmail"; readonly WorkflowAction: "WorkflowAction"; readonly CreateWorkflow: "CreateWorkflow"; readonly UpdateWorkflow: "UpdateWorkflow"; readonly AutomatedWorkflow: "AutomatedWorkflow"; readonly BatchWorkflow: "BatchWorkflow"; readonly ExpirationWorkflow: "ExpirationWorkflow"; readonly InvitationWorkflow: "InvitationWorkflow"; readonly LoginWorkflow: "LoginWorkflow"; readonly PasswordResetWorkflow: "PasswordResetWorkflow"; readonly RegistrationWorkflow: "RegistrationWorkflow"; readonly Get: "Get"; readonly Post: "Post"; readonly Patch: "Patch"; readonly Delete: "Delete"; readonly ApprovalAction: "ApprovalAction"; readonly AutomatedUser: "AutomatedUser"; readonly DelegateUser: "DelegateUser"; readonly NeaccessUser: "NeaccessUser"; readonly NeprofileUser: "NeprofileUser"; readonly Page: "Page"; readonly Role: "Role"; readonly SamlConfiguration: "SamlConfiguration"; readonly SchemaMapping: "SchemaMapping"; readonly SchemaMappingField: "SchemaMappingField"; readonly Workflow: "Workflow"; }; export type AuditEventNERMSubjectTypeNerm = typeof AuditEventNERMSubjectTypeNerm[keyof typeof AuditEventNERMSubjectTypeNerm]; export declare const AuditEventNERMTypeNerm: { readonly AuditableProfileCreate: "AuditableProfileCreate"; readonly AuditableProfileUpdate: "AuditableProfileUpdate"; readonly AuditableProfileDestroy: "AuditableProfileDestroy"; readonly AuditableBulkProfileUpdate: "AuditableBulkProfileUpdate"; readonly AuditableProfileContributorAdd: "AuditableProfileContributorAdd"; readonly AuditableProfileContributorRemove: "AuditableProfileContributorRemove"; readonly AuditableProfileContributorRoleAdd: "AuditableProfileContributorRoleAdd"; readonly AuditableProfileContributorRoleRemove: "AuditableProfileContributorRoleRemove"; readonly AuditableProfileOwnerUpdate: "AuditableProfileOwnerUpdate"; readonly AuditableProfileWorkflowEvent: "AuditableProfileWorkflowEvent"; readonly AuditableWorkflowActionSkippedEvent: "AuditableWorkflowActionSkippedEvent"; readonly AuditableWorkflowApprovedEvent: "AuditableWorkflowApprovedEvent"; readonly AuditableWorkflowApprovedEvent2: "AuditableWorkflowApprovedEvent"; readonly AuditableWorkflowAssignedEvent: "AuditableWorkflowAssignedEvent"; readonly AuditableWorkflowAutoAssignedEvent: "AuditableWorkflowAutoAssignedEvent"; readonly AuditableWorkflowBatchCompleteEvent: "AuditableWorkflowBatchCompleteEvent"; readonly AuditableWorkflowClosedEvent: "AuditableWorkflowClosedEvent"; readonly AuditableWorkflowDuplicateCheckStartEvent: "AuditableWorkflowDuplicateCheckStartEvent"; readonly AuditableWorkflowDuplicateResolutionEvent: "AuditableWorkflowDuplicateResolutionEvent"; readonly AuditableWorkflowFailedEvent: "AuditableWorkflowFailedEvent"; readonly AuditableWorkflowIdentityProofedEvent: "AuditableWorkflowIdentityProofedEvent"; readonly AuditableWorkflowInvitationSentEvent: "AuditableWorkflowInvitationSentEvent"; readonly AuditableWorkflowLdapProvidedEvent: "AuditableWorkflowLdapProvidedEvent"; readonly AuditableWorkflowNotificationSentEvent: "AuditableWorkflowNotificationSentEvent"; readonly AuditableWorkflowPendingApprovalEvent: "AuditableWorkflowPendingApprovalEvent"; readonly AuditableWorkflowPendingAssignmentEvent: "AuditableWorkflowPendingAssignmentEvent"; readonly AuditableWorkflowPendingFulfillmentEvent: "AuditableWorkflowPendingFulfillmentEvent"; readonly AuditableWorkflowFulfilledEvent: "AuditableWorkflowFulfilledEvent"; readonly AuditableWorkflowPendingIdentityProofEvent: "AuditableWorkflowPendingIdentityProofEvent"; readonly AuditableWorkflowPendingLdapEvent: "AuditableWorkflowPendingLdapEvent"; readonly AuditableWorkflowPendingRequestEvent: "AuditableWorkflowPendingRequestEvent"; readonly AuditableWorkflowPendingReviewEvent: "AuditableWorkflowPendingReviewEvent"; readonly AuditableWorkflowProfileCreatedEvent: "AuditableWorkflowProfileCreatedEvent"; readonly AuditableWorkflowProfileSelectEvent: "AuditableWorkflowProfileSelectEvent"; readonly AuditableWorkflowProfileUpdatedEvent: "AuditableWorkflowProfileUpdatedEvent"; readonly AuditableWorkflowRejectedEvent: "AuditableWorkflowRejectedEvent"; readonly AuditableWorkflowRequestMadeEvent: "AuditableWorkflowRequestMadeEvent"; readonly AuditableWorkflowRestApiEvent: "AuditableWorkflowRestApiEvent"; readonly AuditableWorkflowReviewedEvent: "AuditableWorkflowReviewedEvent"; readonly AuditableWorkflowRunningWorkflowEvent: "AuditableWorkflowRunningWorkflowEvent"; readonly AuditableWorkflowSoapApiEvent: "AuditableWorkflowSoapApiEvent"; readonly AuditableWorkflowStatusChangedEvent: "AuditableWorkflowStatusChangedEvent"; readonly AuditableWorkflowStoredProcedureEvent: "AuditableWorkflowStoredProcedureEvent"; readonly AuditableWorkflowUnassignEvent: "AuditableWorkflowUnassignEvent"; readonly AuditableWorkflowWaitingForWorkflowEvent: "AuditableWorkflowWaitingForWorkflowEvent"; readonly AuditableWorkflowWorkflowChangedEvent: "AuditableWorkflowWorkflowChangedEvent"; readonly ActiveRecordCreate: "ActiveRecordCreate"; readonly ActiveRecordUpdate: "ActiveRecordUpdate"; readonly ActiveRecordDestroy: "ActiveRecordDestroy"; readonly AuditableApiEvent: "AuditableApiEvent"; }; export type AuditEventNERMTypeNerm = typeof AuditEventNERMTypeNerm[keyof typeof AuditEventNERMTypeNerm]; /** * * @export * @interface AutoAssignActionNERM */ export interface AutoAssignActionNERM { /** * The workflow the workflow action belongs to. * @type {string} * @memberof AutoAssignActionNERM */ 'workflow_id': string; /** * The description of the workflow action. * @type {string} * @memberof AutoAssignActionNERM */ 'description': string; /** * If the workflow action is archived or not. * @type {boolean} * @memberof AutoAssignActionNERM */ 'archived'?: boolean; /** * The id of the contributor attribute for contributors from another profile. If workflow_action_roles are not associated to this object, this is required. * @type {string} * @memberof AutoAssignActionNERM */ 'contributor_attr'?: string; } /** * * @export * @interface AutomatedWorkflowConditionRulesAttributesInnerNERM */ export interface AutomatedWorkflowConditionRulesAttributesInnerNERM { /** * The type of condition rule. * @type {string} * @memberof AutomatedWorkflowConditionRulesAttributesInnerNERM */ 'logical_operator': AutomatedWorkflowConditionRulesAttributesInnerNERMLogicalOperatorNerm; /** * The operator used by the condition rule. * @type {string} * @memberof AutomatedWorkflowConditionRulesAttributesInnerNERM */ 'comparison_operator': AutomatedWorkflowConditionRulesAttributesInnerNERMComparisonOperatorNerm; /** * UUID for object targeted by the condition. * @type {string} * @memberof AutomatedWorkflowConditionRulesAttributesInnerNERM */ 'condition_object_id'?: string; /** * Type of object targeted by the condition. * @type {string} * @memberof AutomatedWorkflowConditionRulesAttributesInnerNERM */ 'condition_object_type': string; /** * Used for time_frame comparison. * @type {string} * @memberof AutomatedWorkflowConditionRulesAttributesInnerNERM */ 'secondary_value'?: string; /** * Represents the days of a temporal comparison. * @type {string} * @memberof AutomatedWorkflowConditionRulesAttributesInnerNERM */ 'tertiary_value'?: string; /** * The value being compared against. * @type {string} * @memberof AutomatedWorkflowConditionRulesAttributesInnerNERM */ 'value'?: string; /** * If there are multiple rules against one workflow, this is the order that they are ran in. * @type {number} * @memberof AutomatedWorkflowConditionRulesAttributesInnerNERM */ 'order'?: number; /** * The type of condition rule. * @type {string} * @memberof AutomatedWorkflowConditionRulesAttributesInnerNERM */ 'type': AutomatedWorkflowConditionRulesAttributesInnerNERMTypeNerm; } export declare const AutomatedWorkflowConditionRulesAttributesInnerNERMLogicalOperatorNerm: { readonly And: "AND"; readonly Or: "OR"; }; export type AutomatedWorkflowConditionRulesAttributesInnerNERMLogicalOperatorNerm = typeof AutomatedWorkflowConditionRulesAttributesInnerNERMLogicalOperatorNerm[keyof typeof AutomatedWorkflowConditionRulesAttributesInnerNERMLogicalOperatorNerm]; export declare const AutomatedWorkflowConditionRulesAttributesInnerNERMComparisonOperatorNerm: { readonly LessThan: "<"; readonly GreaterThan: ">"; readonly DoubleEqual: "=="; readonly Before: "before"; readonly Include: "include?"; readonly Absent: "absent?"; readonly After: "after"; }; export type AutomatedWorkflowConditionRulesAttributesInnerNERMComparisonOperatorNerm = typeof AutomatedWorkflowConditionRulesAttributesInnerNERMComparisonOperatorNerm[keyof typeof AutomatedWorkflowConditionRulesAttributesInnerNERMComparisonOperatorNerm]; export declare const AutomatedWorkflowConditionRulesAttributesInnerNERMTypeNerm: { readonly RiskRule: "RiskRule"; readonly ProfileIdRule: "ProfileIdRule"; readonly ProfileTypeRule: "ProfileTypeRule"; readonly ProfileExistsRule: "ProfileExistsRule"; readonly ProfileStatusRule: "ProfileStatusRule"; readonly SessionAttributeRule: "SessionAttributeRule"; readonly ProfileAttributeRule: "ProfileAttributeRule"; readonly ProfileDoesNotExistRule: "ProfileDoesNotExistRule"; readonly IdentityProofingRule: "IdentityProofingRule"; }; export type AutomatedWorkflowConditionRulesAttributesInnerNERMTypeNerm = typeof AutomatedWorkflowConditionRulesAttributesInnerNERMTypeNerm[keyof typeof AutomatedWorkflowConditionRulesAttributesInnerNERMTypeNerm]; /** * * @export * @interface AutomatedWorkflowNERM */ export interface AutomatedWorkflowNERM { /** * The profile type the workflow effects. * @type {string} * @memberof AutomatedWorkflowNERM */ 'profile_type_id': string; /** * Whether or not the workflow is enabled or disabled. * @type {string} * @memberof AutomatedWorkflowNERM */ 'status': AutomatedWorkflowNERMStatusNerm; /** * The user-specified identifier of the workflow. * @type {string} * @memberof AutomatedWorkflowNERM */ 'uid': string; /** * Name of the workflow * @type {string} * @memberof AutomatedWorkflowNERM */ 'name': string; /** * When honored at runtime, suppresses failure email notifications for this workflow\'s sessions. * @type {boolean} * @memberof AutomatedWorkflowNERM */ 'disable_failure_email_notifications'?: boolean | null; /** * The ProfileTypeRule this workflow will be working with. * @type {Array} * @memberof AutomatedWorkflowNERM */ 'condition_rules_attributes': Array; } export declare const AutomatedWorkflowNERMStatusNerm: { readonly Enabled: "Enabled"; readonly Disabled: "Disabled"; }; export type AutomatedWorkflowNERMStatusNerm = typeof AutomatedWorkflowNERMStatusNerm[keyof typeof AutomatedWorkflowNERMStatusNerm]; /** * * @export * @interface BatchUpdateActionNERM */ export interface BatchUpdateActionNERM { /** * The workflow the workflow action belongs to. * @type {string} * @memberof BatchUpdateActionNERM */ 'workflow_id': string; /** * The description of the workflow action. * @type {string} * @memberof BatchUpdateActionNERM */ 'description': string; /** * If the workflow action is archived or not. * @type {boolean} * @memberof BatchUpdateActionNERM */ 'archived'?: boolean; } /** * * @export * @interface BatchWorkflowNERM */ export interface BatchWorkflowNERM { /** * The profile type the workflow effects. * @type {string} * @memberof BatchWorkflowNERM */ 'profile_type_id': string; /** * Whether or not the workflow is enabled or disabled. * @type {string} * @memberof BatchWorkflowNERM */ 'status': BatchWorkflowNERMStatusNerm; /** * The user-specified identifier of the workflow. * @type {string} * @memberof BatchWorkflowNERM */ 'uid': string; /** * Name of the workflow * @type {string} * @memberof BatchWorkflowNERM */ 'name': string; /** * * @type {BatchWorkflowOptionsNERM} * @memberof BatchWorkflowNERM */ 'options'?: BatchWorkflowOptionsNERM; /** * When honored at runtime, suppresses failure email notifications for this workflow\'s sessions. * @type {boolean} * @memberof BatchWorkflowNERM */ 'disable_failure_email_notifications'?: boolean | null; } export declare const BatchWorkflowNERMStatusNerm: { readonly Enabled: "Enabled"; readonly Disabled: "Disabled"; }; export type BatchWorkflowNERMStatusNerm = typeof BatchWorkflowNERMStatusNerm[keyof typeof BatchWorkflowNERMStatusNerm]; /** * * @export * @interface BatchWorkflowOptionsNERM */ export interface BatchWorkflowOptionsNERM { /** * Used for batch workflows. * @type {string} * @memberof BatchWorkflowOptionsNERM */ 'all_profiles'?: BatchWorkflowOptionsNERMAllProfilesNerm; /** * Used for batch workflows for if multiple requests. * @type {string} * @memberof BatchWorkflowOptionsNERM */ 'multiple_requests'?: BatchWorkflowOptionsNERMMultipleRequestsNerm; } export declare const BatchWorkflowOptionsNERMAllProfilesNerm: { readonly True: "true"; readonly False: "false"; }; export type BatchWorkflowOptionsNERMAllProfilesNerm = typeof BatchWorkflowOptionsNERMAllProfilesNerm[keyof typeof BatchWorkflowOptionsNERMAllProfilesNerm]; export declare const BatchWorkflowOptionsNERMMultipleRequestsNerm: { readonly True: "true"; readonly False: "false"; }; export type BatchWorkflowOptionsNERMMultipleRequestsNerm = typeof BatchWorkflowOptionsNERMMultipleRequestsNerm[keyof typeof BatchWorkflowOptionsNERMMultipleRequestsNerm]; /** * * @export * @interface CloseSessionActionNERM */ export interface CloseSessionActionNERM { /** * The workflow the workflow action belongs to. * @type {string} * @memberof CloseSessionActionNERM */ 'workflow_id': string; /** * The description of the workflow action. * @type {string} * @memberof CloseSessionActionNERM */ 'description': string; /** * If the workflow action is archived or not. * @type {boolean} * @memberof CloseSessionActionNERM */ 'archived'?: boolean; } /** * * @export * @interface ContributorsActionNERM */ export interface ContributorsActionNERM { /** * The workflow the workflow action belongs to. * @type {string} * @memberof ContributorsActionNERM */ 'workflow_id': string; /** * The description of the workflow action. * @type {string} * @memberof ContributorsActionNERM */ 'description': string; /** * If the assignment option should be an owner. Owner, Contributors, or Roles must be chosen. * @type {string} * @memberof ContributorsActionNERM */ 'owner'?: ContributorsActionNERMOwnerNerm; /** * If the assignment option should be contributors. Owner, Contributors, or Roles must be chosen. * @type {string} * @memberof ContributorsActionNERM */ 'contributors'?: ContributorsActionNERMContributorsNerm; /** * If the assignment option should be roles. Owner, Contributors, or Roles must be chosen. * @type {string} * @memberof ContributorsActionNERM */ 'roles'?: ContributorsActionNERMRolesNerm; /** * If the workflow action is archived or not. * @type {boolean} * @memberof ContributorsActionNERM */ 'archived'?: boolean; } export declare const ContributorsActionNERMOwnerNerm: { readonly True: "true"; readonly False: "false"; }; export type ContributorsActionNERMOwnerNerm = typeof ContributorsActionNERMOwnerNerm[keyof typeof ContributorsActionNERMOwnerNerm]; export declare const ContributorsActionNERMContributorsNerm: { readonly True: "true"; readonly False: "false"; }; export type ContributorsActionNERMContributorsNerm = typeof ContributorsActionNERMContributorsNerm[keyof typeof ContributorsActionNERMContributorsNerm]; export declare const ContributorsActionNERMRolesNerm: { readonly True: "true"; readonly False: "false"; }; export type ContributorsActionNERMRolesNerm = typeof ContributorsActionNERMRolesNerm[keyof typeof ContributorsActionNERMRolesNerm]; /** * * @export * @interface CreateApprovalAction200ResponseNERM */ export interface CreateApprovalAction200ResponseNERM { /** * * @type {WorkflowActionNERM} * @memberof CreateApprovalAction200ResponseNERM */ 'workflow_action'?: WorkflowActionNERM; } /** * * @export * @interface CreateApprovalActionRequestNERM */ export interface CreateApprovalActionRequestNERM { /** * * @type {ApprovalActionNERM} * @memberof CreateApprovalActionRequestNERM */ 'workflow_action'?: ApprovalActionNERM; } /** * * @export * @interface CreateAskSecurityQuestionActionRequestNERM */ export interface CreateAskSecurityQuestionActionRequestNERM { /** * * @type {AskSecurityQuestionActionNERM} * @memberof CreateAskSecurityQuestionActionRequestNERM */ 'workflow_action'?: AskSecurityQuestionActionNERM; } /** * * @export * @interface CreateAttribute201ResponseNERM */ export interface CreateAttribute201ResponseNERM { /** * * @type {AttributeNERM} * @memberof CreateAttribute201ResponseNERM */ 'ne_attribute'?: AttributeNERM; } /** * * @export * @interface CreateAttributeRequestNERM */ export interface CreateAttributeRequestNERM { /** * * @type {Attribute1NERM} * @memberof CreateAttributeRequestNERM */ 'ne_attribute'?: Attribute1NERM; } /** * * @export * @interface CreateAutoAssignActionRequestNERM */ export interface CreateAutoAssignActionRequestNERM { /** * * @type {AutoAssignActionNERM} * @memberof CreateAutoAssignActionRequestNERM */ 'workflow_action'?: AutoAssignActionNERM; } /** * * @export * @interface CreateAutomatedWorkflowRequestNERM */ export interface CreateAutomatedWorkflowRequestNERM { /** * * @type {AutomatedWorkflowNERM} * @memberof CreateAutomatedWorkflowRequestNERM */ 'workflow'?: AutomatedWorkflowNERM; } /** * * @export * @interface CreateBatchUpdateActionRequestNERM */ export interface CreateBatchUpdateActionRequestNERM { /** * * @type {BatchUpdateActionNERM} * @memberof CreateBatchUpdateActionRequestNERM */ 'workflow_action'?: BatchUpdateActionNERM; } /** * * @export * @interface CreateBatchWorkflowRequestNERM */ export interface CreateBatchWorkflowRequestNERM { /** * * @type {BatchWorkflowNERM} * @memberof CreateBatchWorkflowRequestNERM */ 'workflow'?: BatchWorkflowNERM; } /** * * @export * @interface CreateCloseSessionActionRequestNERM */ export interface CreateCloseSessionActionRequestNERM { /** * * @type {CloseSessionActionNERM} * @memberof CreateCloseSessionActionRequestNERM */ 'workflow_action'?: CloseSessionActionNERM; } /** * * @export * @interface CreateContributorsActionRequestNERM */ export interface CreateContributorsActionRequestNERM { /** * * @type {ContributorsActionNERM} * @memberof CreateContributorsActionRequestNERM */ 'workflow_action'?: ContributorsActionNERM; } /** * * @export * @interface CreateCreateProfileActionRequestNERM */ export interface CreateCreateProfileActionRequestNERM { /** * * @type {CreateProfileActionNERM} * @memberof CreateCreateProfileActionRequestNERM */ 'workflow_action'?: CreateProfileActionNERM; } /** * * @export * @interface CreateCreateWorkflow200ResponseNERM */ export interface CreateCreateWorkflow200ResponseNERM { /** * * @type {WorkflowSessionNERM} * @memberof CreateCreateWorkflow200ResponseNERM */ 'workflow'?: WorkflowSessionNERM; } /** * * @export * @interface CreateCreateWorkflowRequestNERM */ export interface CreateCreateWorkflowRequestNERM { /** * * @type {CreateWorkflowNERM} * @memberof CreateCreateWorkflowRequestNERM */ 'workflow'?: CreateWorkflowNERM; } /** * * @export * @interface CreateDuplicatePreventionActionRequestNERM */ export interface CreateDuplicatePreventionActionRequestNERM { /** * * @type {DuplicatePreventionActionNERM} * @memberof CreateDuplicatePreventionActionRequestNERM */ 'workflow_action'?: DuplicatePreventionActionNERM; } /** * * @export * @interface CreateEmailVerificationActionRequestNERM */ export interface CreateEmailVerificationActionRequestNERM { /** * * @type {EmailVerificationActionNERM} * @memberof CreateEmailVerificationActionRequestNERM */ 'workflow_action'?: EmailVerificationActionNERM; } /** * * @export * @interface CreateFormAttributeRequestNERM */ export interface CreateFormAttributeRequestNERM { /** * * @type {FormAttributesNERM} * @memberof CreateFormAttributeRequestNERM */ 'form_attribute'?: FormAttributesNERM; } /** * * @export * @interface CreateFormRequestNERM */ export interface CreateFormRequestNERM { /** * * @type {Array} * @memberof CreateFormRequestNERM */ 'forms'?: Array; } /** * * @export * @interface CreateFulfillmentActionRequestNERM */ export interface CreateFulfillmentActionRequestNERM { /** * * @type {FulfillmentActionNERM} * @memberof CreateFulfillmentActionRequestNERM */ 'workflow_action'?: FulfillmentActionNERM; } /** * * @export * @interface CreateIdentityProofingActionRequestNERM */ export interface CreateIdentityProofingActionRequestNERM { /** * * @type {IdentityProofingActionNERM} * @memberof CreateIdentityProofingActionRequestNERM */ 'workflow_action'?: IdentityProofingActionNERM; } /** * * @export * @interface CreateInvitationActionRequestNERM */ export interface CreateInvitationActionRequestNERM { /** * * @type {InvitationActionNERM} * @memberof CreateInvitationActionRequestNERM */ 'workflow_action'?: InvitationActionNERM; } /** * * @export * @interface CreateLdapActionRequestNERM */ export interface CreateLdapActionRequestNERM { /** * * @type {LdapActionNERM} * @memberof CreateLdapActionRequestNERM */ 'workflow_action'?: LdapActionNERM; } /** * * @export * @interface CreateLoginWorkflowRequestNERM */ export interface CreateLoginWorkflowRequestNERM { /** * * @type {LoginWorkflowNERM} * @memberof CreateLoginWorkflowRequestNERM */ 'workflow'?: LoginWorkflowNERM; } /** * * @export * @interface CreateNotificationActionRequestNERM */ export interface CreateNotificationActionRequestNERM { /** * * @type {NotificationActionNERM} * @memberof CreateNotificationActionRequestNERM */ 'workflow_action'?: NotificationActionNERM; } /** * * @export * @interface CreatePageContentRequestNERM */ export interface CreatePageContentRequestNERM { /** * * @type {PageContent1NERM} * @memberof CreatePageContentRequestNERM */ 'page_content'?: PageContent1NERM; } /** * * @export * @interface CreatePageContentTranslationRequestNERM */ export interface CreatePageContentTranslationRequestNERM { /** * * @type {PageContentTranslation1NERM} * @memberof CreatePageContentTranslationRequestNERM */ 'page_content_translation'?: PageContentTranslation1NERM; } /** * * @export * @interface CreatePageElementRequestNERM */ export interface CreatePageElementRequestNERM { /** * * @type {PageElement1NERM} * @memberof CreatePageElementRequestNERM */ 'page_element'?: PageElement1NERM; } /** * * @export * @interface CreatePasswordResetActionRequestNERM */ export interface CreatePasswordResetActionRequestNERM { /** * * @type {PasswordResetActionNERM} * @memberof CreatePasswordResetActionRequestNERM */ 'workflow_action'?: PasswordResetActionNERM; } /** * * @export * @interface CreatePermission200ResponseNERM */ export interface CreatePermission200ResponseNERM { /** * * @type {PermissionNERM} * @memberof CreatePermission200ResponseNERM */ 'permission'?: PermissionNERM; } /** * * @export * @interface CreatePermissionRequestNERM */ export interface CreatePermissionRequestNERM { /** * * @type {Permission1NERM} * @memberof CreatePermissionRequestNERM */ 'permission'?: Permission1NERM; } /** * * @export * @interface CreateProfileActionNERM */ export interface CreateProfileActionNERM { /** * The workflow the workflow action belongs to. * @type {string} * @memberof CreateProfileActionNERM */ 'workflow_id': string; /** * The description of the workflow action. * @type {string} * @memberof CreateProfileActionNERM */ 'description': string; /** * If the requester should be added as the owner of the profile to be created. * @type {boolean} * @memberof CreateProfileActionNERM */ 'add_requester_as_owner'?: boolean; /** * If the workflow action is archived or not. * @type {boolean} * @memberof CreateProfileActionNERM */ 'archived'?: boolean; } /** * * @export * @interface CreateProfileCheckActionRequestNERM */ export interface CreateProfileCheckActionRequestNERM { /** * * @type {ProfileCheckActionNERM} * @memberof CreateProfileCheckActionRequestNERM */ 'workflow_action'?: ProfileCheckActionNERM; } /** * * @export * @interface CreateProfilePage200ResponseNERM */ export interface CreateProfilePage200ResponseNERM { /** * * @type {PagesNERM} * @memberof CreateProfilePage200ResponseNERM */ 'page'?: PagesNERM; } /** * * @export * @interface CreateProfilePageRequestNERM */ export interface CreateProfilePageRequestNERM { /** * * @type {ProfilePageNERM} * @memberof CreateProfilePageRequestNERM */ 'page'?: ProfilePageNERM; } /** * * @export * @interface CreateProfileSelectActionRequestNERM */ export interface CreateProfileSelectActionRequestNERM { /** * * @type {ProfileSelectActionNERM} * @memberof CreateProfileSelectActionRequestNERM */ 'workflow_action'?: ProfileSelectActionNERM; } /** * * @export * @interface CreateProfileTypeRole200ResponseNERM */ export interface CreateProfileTypeRole200ResponseNERM { /** * * @type {ProfileTypeRolesNERM} * @memberof CreateProfileTypeRole200ResponseNERM */ 'profile_type_roles'?: ProfileTypeRolesNERM; } /** * * @export * @interface CreateProfileTypeRoleRequestNERM */ export interface CreateProfileTypeRoleRequestNERM { /** * * @type {ProfileTypeRoles1NERM} * @memberof CreateProfileTypeRoleRequestNERM */ 'profile_type_role'?: ProfileTypeRoles1NERM; } /** * * @export * @interface CreateProfilesRequestNERM */ export interface CreateProfilesRequestNERM { /** * * @type {Array} * @memberof CreateProfilesRequestNERM */ 'profiles'?: Array; } /** * * @export * @interface CreateRequestActionRequestNERM */ export interface CreateRequestActionRequestNERM { /** * * @type {RequestActionNERM} * @memberof CreateRequestActionRequestNERM */ 'workflow_action'?: RequestActionNERM; } /** * * @export * @interface CreateRestApiActionRequestNERM */ export interface CreateRestApiActionRequestNERM { /** * * @type {RestApiActionNERM} * @memberof CreateRestApiActionRequestNERM */ 'workflow_action'?: RestApiActionNERM; } /** * * @export * @interface CreateReviewActionRequestNERM */ export interface CreateReviewActionRequestNERM { /** * * @type {ReviewActionNERM} * @memberof CreateReviewActionRequestNERM */ 'workflow_action'?: ReviewActionNERM; } /** * * @export * @interface CreateRunWorkflowActionRequestNERM */ export interface CreateRunWorkflowActionRequestNERM { /** * * @type {RunWorkflowActionNERM} * @memberof CreateRunWorkflowActionRequestNERM */ 'workflow_action'?: RunWorkflowActionNERM; } /** * * @export * @interface CreateSetAttributesActionRequestNERM */ export interface CreateSetAttributesActionRequestNERM { /** * * @type {SetAttributesActionNERM} * @memberof CreateSetAttributesActionRequestNERM */ 'workflow_action'?: SetAttributesActionNERM; } /** * * @export * @interface CreateSetSecurityQuestionActionRequestNERM */ export interface CreateSetSecurityQuestionActionRequestNERM { /** * * @type {SetSecurityQuestionActionNERM} * @memberof CreateSetSecurityQuestionActionRequestNERM */ 'workflow_action'?: SetSecurityQuestionActionNERM; } /** * * @export * @interface CreateSoapApiActionRequestNERM */ export interface CreateSoapApiActionRequestNERM { /** * * @type {SoapApiActionNERM} * @memberof CreateSoapApiActionRequestNERM */ 'workflow_action'?: SoapApiActionNERM; } /** * * @export * @interface CreateStatusChangeActionRequestNERM */ export interface CreateStatusChangeActionRequestNERM { /** * * @type {StatusChangeActionNERM} * @memberof CreateStatusChangeActionRequestNERM */ 'workflow_action'?: StatusChangeActionNERM; } /** * * @export * @interface CreateSyncedAttribute201ResponseNERM */ export interface CreateSyncedAttribute201ResponseNERM { /** * * @type {SyncedAttributeNERM} * @memberof CreateSyncedAttribute201ResponseNERM */ 'synced_attribute'?: SyncedAttributeNERM; } /** * * @export * @interface CreateSystemRolePermission200ResponseNERM */ export interface CreateSystemRolePermission200ResponseNERM { /** * * @type {SystemRolePermissionNERM} * @memberof CreateSystemRolePermission200ResponseNERM */ 'system_role_permission'?: SystemRolePermissionNERM; } /** * * @export * @interface CreateSystemRolePermissionRequestNERM */ export interface CreateSystemRolePermissionRequestNERM { /** * * @type {SystemRolePermission1NERM} * @memberof CreateSystemRolePermissionRequestNERM */ 'system_role_permission'?: SystemRolePermission1NERM; } /** * * @export * @interface CreateUnassignActionRequestNERM */ export interface CreateUnassignActionRequestNERM { /** * * @type {UnassignActionNERM} * @memberof CreateUnassignActionRequestNERM */ 'workflow_action'?: UnassignActionNERM; } /** * * @export * @interface CreateUpdateProfileActionRequestNERM */ export interface CreateUpdateProfileActionRequestNERM { /** * * @type {UpdateProfileActionNERM} * @memberof CreateUpdateProfileActionRequestNERM */ 'workflow_action'?: UpdateProfileActionNERM; } /** * * @export * @interface CreateUpdateWorkflowRequestNERM */ export interface CreateUpdateWorkflowRequestNERM { /** * * @type {UpdateWorkflowNERM} * @memberof CreateUpdateWorkflowRequestNERM */ 'workflow'?: UpdateWorkflowNERM; } /** * @type CreateUserProfiles200ResponseNERM * @export */ export type CreateUserProfiles200ResponseNERM = JobNERM | UserProfilesNERM; /** * * @export * @interface CreateUserProfilesRequestNERM */ export interface CreateUserProfilesRequestNERM { /** * * @type {Array} * @memberof CreateUserProfilesRequestNERM */ 'user_profiles'?: Array; } /** * * @export * @interface CreateUsernamePasswordActionRequestNERM */ export interface CreateUsernamePasswordActionRequestNERM { /** * * @type {UsernamePasswordActionNERM} * @memberof CreateUsernamePasswordActionRequestNERM */ 'workflow_action'?: UsernamePasswordActionNERM; } /** * * @export * @interface CreateWorkflowActionPerformer200ResponseNERM */ export interface CreateWorkflowActionPerformer200ResponseNERM { /** * * @type {WorkflowActionPerformersNERM} * @memberof CreateWorkflowActionPerformer200ResponseNERM */ 'workflow_action_performer'?: WorkflowActionPerformersNERM; } /** * * @export * @interface CreateWorkflowActionPerformerRequestNERM */ export interface CreateWorkflowActionPerformerRequestNERM { /** * * @type {WorkflowActionPerformers1NERM} * @memberof CreateWorkflowActionPerformerRequestNERM */ 'workflow_action_performers'?: WorkflowActionPerformers1NERM; } /** * * @export * @interface CreateWorkflowNERM */ export interface CreateWorkflowNERM { /** * The profile type the workflow effects. * @type {string} * @memberof CreateWorkflowNERM */ 'profile_type_id': string; /** * Whether or not the workflow is enabled or disabled. * @type {string} * @memberof CreateWorkflowNERM */ 'status': CreateWorkflowNERMStatusNerm; /** * The user-specified identifier of the workflow. * @type {string} * @memberof CreateWorkflowNERM */ 'uid': string; /** * Name of the workflow * @type {string} * @memberof CreateWorkflowNERM */ 'name': string; /** * When honored at runtime, suppresses failure email notifications for this workflow\'s sessions. * @type {boolean} * @memberof CreateWorkflowNERM */ 'disable_failure_email_notifications'?: boolean | null; } export declare const CreateWorkflowNERMStatusNerm: { readonly Enabled: "Enabled"; readonly Disabled: "Disabled"; }; export type CreateWorkflowNERMStatusNerm = typeof CreateWorkflowNERMStatusNerm[keyof typeof CreateWorkflowNERMStatusNerm]; /** * * @export * @interface CreateWorkflowPageRequestNERM */ export interface CreateWorkflowPageRequestNERM { /** * * @type {WorkflowPageNERM} * @memberof CreateWorkflowPageRequestNERM */ 'page'?: WorkflowPageNERM; } /** * * @export * @interface DataRecordsNERM */ export interface DataRecordsNERM { /** * The id of the master record * @type {string} * @memberof DataRecordsNERM */ 'master_record_id'?: string; } /** * * @export * @interface Delegation1NERM */ export interface Delegation1NERM { /** * The id of the delegator * @type {string} * @memberof Delegation1NERM */ 'delegator_id'?: string; /** * The id of the delegate * @type {string} * @memberof Delegation1NERM */ 'delegate_id'?: string; /** * The expiration date of the delegation * @type {string} * @memberof Delegation1NERM */ 'expiration'?: string; } /** * * @export * @interface DelegationNERM */ export interface DelegationNERM { /** * The id of the delegation * @type {string} * @memberof DelegationNERM */ 'id'?: string; /** * The id of the delegator user * @type {object} * @memberof DelegationNERM */ 'delegator_id'?: object; /** * The id of the delegate user * @type {object} * @memberof DelegationNERM */ 'delegate_id'?: object; /** * The expiration date of the delegation * @type {string} * @memberof DelegationNERM */ 'expiration'?: string; /** * Indicates if the delegation is expired * @type {boolean} * @memberof DelegationNERM */ 'expired'?: boolean; /** * The date-time the record created. * @type {string} * @memberof DelegationNERM */ 'created_at'?: string; /** * The date-time the record was last updated. * @type {string} * @memberof DelegationNERM */ 'updated_at'?: string; } /** * * @export * @interface DelegationsGet200ResponseNERM */ export interface DelegationsGet200ResponseNERM { /** * * @type {Array} * @memberof DelegationsGet200ResponseNERM */ 'delegations'?: Array; /** * * @type {MetadataNERM} * @memberof DelegationsGet200ResponseNERM */ '_metadata'?: MetadataNERM; } /** * * @export * @interface DelegationsPost201ResponseNERM */ export interface DelegationsPost201ResponseNERM { /** * * @type {DelegationNERM} * @memberof DelegationsPost201ResponseNERM */ 'delegation'?: DelegationNERM; } /** * * @export * @interface DelegationsPost404ResponseNERM */ export interface DelegationsPost404ResponseNERM { /** * The requested record, either ID or UID, was not found * @type {object} * @memberof DelegationsPost404ResponseNERM */ 'error'?: object; } /** * * @export * @interface DelegationsPostRequestNERM */ export interface DelegationsPostRequestNERM { /** * * @type {Delegation1NERM} * @memberof DelegationsPostRequestNERM */ 'delegation'?: Delegation1NERM; } /** * * @export * @interface DeleteAttributeOptionById200ResponseNERM */ export interface DeleteAttributeOptionById200ResponseNERM { /** * * @type {string} * @memberof DeleteAttributeOptionById200ResponseNERM */ 'info'?: string; } /** * * @export * @interface DeleteMasterRecord400ResponseNERM */ export interface DeleteMasterRecord400ResponseNERM { /** * A message describing the error that occurred * @type {string} * @memberof DeleteMasterRecord400ResponseNERM */ 'error'?: string; } /** * * @export * @interface DeleteProfileTypeById200ResponseNERM */ export interface DeleteProfileTypeById200ResponseNERM { /** * A message confirming the operation * @type {object} * @memberof DeleteProfileTypeById200ResponseNERM */ 'info'?: object; } /** * @type DeleteProfiles200ResponseNERM * @export */ export type DeleteProfiles200ResponseNERM = JobNERM | ProfilesNERM; /** * * @export * @interface DuplicatePreventionActionNERM */ export interface DuplicatePreventionActionNERM { /** * The workflow the workflow action belongs to. * @type {string} * @memberof DuplicatePreventionActionNERM */ 'workflow_id': string; /** * The description of the workflow action. * @type {string} * @memberof DuplicatePreventionActionNERM */ 'description': string; /** * The search scope of the profiles to check against. * @type {string} * @memberof DuplicatePreventionActionNERM */ 'search_scope': DuplicatePreventionActionNERMSearchScopeNerm; /** * An array of ne_attribute_ids. * @type {Array} * @memberof DuplicatePreventionActionNERM */ 'ne_attribute_ids'?: Array; /** * The handle id. * @type {string} * @memberof DuplicatePreventionActionNERM */ 'handle_id'?: string; /** * If the workflow action is archived or not. * @type {boolean} * @memberof DuplicatePreventionActionNERM */ 'archived'?: boolean; } export declare const DuplicatePreventionActionNERMSearchScopeNerm: { readonly All: "all"; readonly Current: "current"; }; export type DuplicatePreventionActionNERMSearchScopeNerm = typeof DuplicatePreventionActionNERMSearchScopeNerm[keyof typeof DuplicatePreventionActionNERMSearchScopeNerm]; /** * * @export * @interface EmailVerificationActionNERM */ export interface EmailVerificationActionNERM { /** * The workflow the workflow action belongs to. * @type {string} * @memberof EmailVerificationActionNERM */ 'workflow_id': string; /** * The description of the workflow action. * @type {string} * @memberof EmailVerificationActionNERM */ 'description': string; /** * The email expiration time, in minutes. * @type {number} * @memberof EmailVerificationActionNERM */ 'email_expiration': number; /** * The token expiration time, coordinates with token_expiration_type. * @type {number} * @memberof EmailVerificationActionNERM */ 'token_expiration': number; /** * The token expiration type, coordinates with token_expiration. * @type {string} * @memberof EmailVerificationActionNERM */ 'token_expiration_type': EmailVerificationActionNERMTokenExpirationTypeNerm; /** * If the workflow action is archived or not. * @type {boolean} * @memberof EmailVerificationActionNERM */ 'archived'?: boolean; } export declare const EmailVerificationActionNERMTokenExpirationTypeNerm: { readonly Hours: "hours"; readonly Days: "days"; readonly LoginAttempts: "login attempts"; readonly Always: "always"; }; export type EmailVerificationActionNERMTokenExpirationTypeNerm = typeof EmailVerificationActionNERMTokenExpirationTypeNerm[keyof typeof EmailVerificationActionNERMTokenExpirationTypeNerm]; /** * * @export * @interface Form1NERM */ export interface Form1NERM { /** * The user-specified identifier of the form * @type {string} * @memberof Form1NERM */ 'uid'?: string; /** * The description of the form * @type {string} * @memberof Form1NERM */ 'description'?: string; /** * The name of the form * @type {string} * @memberof Form1NERM */ 'name'?: string; /** * Determines whether the form is archived * @type {boolean} * @memberof Form1NERM */ 'archived'?: boolean; } /** * * @export * @interface FormAttributeNERM */ export interface FormAttributeNERM { /** * The id of the form * @type {string} * @memberof FormAttributeNERM */ 'form_id'?: string; /** * The id of the attribute * @type {string} * @memberof FormAttributeNERM */ 'ne_attribute_id'?: string; /** * The attribute type * @type {string} * @memberof FormAttributeNERM */ 'attr_type'?: FormAttributeNERMAttrTypeNerm; /** * The ordinal position of the attribute on the Form. The order value determines the order or sequence the Form values are presented in the user interface. Each FormAttribute on a Form must have a unique order value. Order valuess can start at zero (0), but often start at one (1). The FormAttribute with order 1 is presented before the FormAttribute with order 2, and so on. Gaps in the order can exist and the system ignores them. * @type {number} * @memberof FormAttributeNERM */ 'order'?: number; /** * The id of the form attribute * @type {string} * @memberof FormAttributeNERM */ 'id'?: string; /** * The date-time the record created. * @type {string} * @memberof FormAttributeNERM */ 'created_at'?: string; /** * The date-time the record was last updated. * @type {string} * @memberof FormAttributeNERM */ 'updated_at'?: string; } export declare const FormAttributeNERMAttrTypeNerm: { readonly NeAttribute: "ne_attribute"; readonly Break: "break"; }; export type FormAttributeNERMAttrTypeNerm = typeof FormAttributeNERMAttrTypeNerm[keyof typeof FormAttributeNERMAttrTypeNerm]; /** * * @export * @interface FormAttributesNERM */ export interface FormAttributesNERM { /** * The id of the form * @type {string} * @memberof FormAttributesNERM */ 'form_id'?: string; /** * The id of the attribute * @type {string} * @memberof FormAttributesNERM */ 'ne_attribute_id'?: string; /** * The attribute type * @type {string} * @memberof FormAttributesNERM */ 'attr_type'?: FormAttributesNERMAttrTypeNerm; /** * The ordinal position of the attribute on the Form. The order value determines the order or sequence the Form values are presented in the user interface. Each FormAttribute on a Form must have a unique order value. Order valuess can start at zero (0), but often start at one (1). The FormAttribute with order 1 is presented before the FormAttribute with order 2, and so on. Gaps in the order can exist and the system ignores them. * @type {number} * @memberof FormAttributesNERM */ 'order'?: number; } export declare const FormAttributesNERMAttrTypeNerm: { readonly NeAttribute: "ne_attribute"; readonly Break: "break"; }; export type FormAttributesNERMAttrTypeNerm = typeof FormAttributesNERMAttrTypeNerm[keyof typeof FormAttributesNERMAttrTypeNerm]; /** * * @export * @interface FormNERM */ export interface FormNERM { /** * The user-specified identifier of the form * @type {string} * @memberof FormNERM */ 'uid'?: string; /** * The description of the form * @type {string} * @memberof FormNERM */ 'description'?: string; /** * The name of the form * @type {string} * @memberof FormNERM */ 'name'?: string; /** * Determines whether the form is archived * @type {boolean} * @memberof FormNERM */ 'archived'?: boolean; /** * The id of the form * @type {string} * @memberof FormNERM */ 'id'?: string; } /** * * @export * @interface FormsNERM */ export interface FormsNERM { /** * The user-specified identifier of the form * @type {string} * @memberof FormsNERM */ 'uid'?: string; /** * The description of the form * @type {string} * @memberof FormsNERM */ 'description'?: string; /** * The name of the form * @type {string} * @memberof FormsNERM */ 'name'?: string; /** * Determines whether the form is archived * @type {boolean} * @memberof FormsNERM */ 'archived'?: boolean; } /** * * @export * @interface FulfillmentActionNERM */ export interface FulfillmentActionNERM { /** * The workflow the workflow action belongs to. * @type {string} * @memberof FulfillmentActionNERM */ 'workflow_id': string; /** * The description of the workflow action. * @type {string} * @memberof FulfillmentActionNERM */ 'description': string; /** * The page the workflow action should render. * @type {string} * @memberof FulfillmentActionNERM */ 'page_id'?: string; /** * If the workflow action is archived or not. * @type {boolean} * @memberof FulfillmentActionNERM */ 'archived'?: boolean; /** * If the workflow action requires a comment or not. * @type {boolean} * @memberof FulfillmentActionNERM */ 'requires_comment'?: boolean; } /** * * @export * @interface GetAdvancedSearch200ResponseNERM */ export interface GetAdvancedSearch200ResponseNERM { /** * * @type {Array} * @memberof GetAdvancedSearch200ResponseNERM */ 'advanced_search'?: Array; } /** * * @export * @interface GetAttributeOptions200ResponseNERM */ export interface GetAttributeOptions200ResponseNERM { /** * * @type {Array} * @memberof GetAttributeOptions200ResponseNERM */ 'ne_attribute_options'?: Array; /** * * @type {MetadataNERM} * @memberof GetAttributeOptions200ResponseNERM */ '_metadata'?: MetadataNERM; } /** * * @export * @interface GetAttributes200ResponseNERM */ export interface GetAttributes200ResponseNERM { /** * * @type {Array} * @memberof GetAttributes200ResponseNERM */ 'ne_attributes'?: Array; /** * * @type {MetadataNERM} * @memberof GetAttributes200ResponseNERM */ '_metadata'?: MetadataNERM; } /** * @type GetAttributes400ResponseNERM * @export */ export type GetAttributes400ResponseNERM = InvalidJsonNERM | ValidationErrorsNERM; /** * * @export * @interface GetAttributes500ResponseNERM */ export interface GetAttributes500ResponseNERM { /** * A message describing the error * @type {object} * @memberof GetAttributes500ResponseNERM */ 'error'?: object; } /** * * @export * @interface GetFormAttributes200ResponseNERM */ export interface GetFormAttributes200ResponseNERM { /** * * @type {FormAttributeNERM} * @memberof GetFormAttributes200ResponseNERM */ 'form_attribute'?: FormAttributeNERM; } /** * * @export * @interface GetForms200ResponseNERM */ export interface GetForms200ResponseNERM { /** * * @type {Array} * @memberof GetForms200ResponseNERM */ 'forms'?: Array; } /** * * @export * @interface GetIdentityProofingResults200ResponseNERM */ export interface GetIdentityProofingResults200ResponseNERM { /** * * @type {Array} * @memberof GetIdentityProofingResults200ResponseNERM */ 'identity_proofing_results'?: Array; /** * * @type {MetadataNERM} * @memberof GetIdentityProofingResults200ResponseNERM */ '_metadata'?: MetadataNERM; } /** * * @export * @interface GetJobStatus200ResponseJobDataInnerNERM */ export interface GetJobStatus200ResponseJobDataInnerNERM { /** * * @type {string} * @memberof GetJobStatus200ResponseJobDataInnerNERM */ 'user_id'?: string; /** * * @type {string} * @memberof GetJobStatus200ResponseJobDataInnerNERM */ 'manager_id'?: string; /** * * @type {Array} * @memberof GetJobStatus200ResponseJobDataInnerNERM */ 'errors'?: Array; } /** * * @export * @interface GetJobStatus200ResponseNERM */ export interface GetJobStatus200ResponseNERM { /** * * @type {string} * @memberof GetJobStatus200ResponseNERM */ 'uid'?: string; /** * * @type {string} * @memberof GetJobStatus200ResponseNERM */ 'status'?: string; /** * * @type {string} * @memberof GetJobStatus200ResponseNERM */ 'job_type'?: string; /** * * @type {Array} * @memberof GetJobStatus200ResponseNERM */ 'job_data'?: Array; } /** * * @export * @interface GetPageContentTranslation200ResponseNERM */ export interface GetPageContentTranslation200ResponseNERM { /** * * @type {PageContentTranslationNERM} * @memberof GetPageContentTranslation200ResponseNERM */ 'page_content_translation'?: PageContentTranslationNERM; } /** * * @export * @interface GetPageContents200ResponseNERM */ export interface GetPageContents200ResponseNERM { /** * * @type {PageContentNERM} * @memberof GetPageContents200ResponseNERM */ 'page'?: PageContentNERM; } /** * * @export * @interface GetPageElements200ResponseNERM */ export interface GetPageElements200ResponseNERM { /** * * @type {PageElementNERM} * @memberof GetPageElements200ResponseNERM */ 'page_element'?: PageElementNERM; } /** * * @export * @interface GetProfileTypeAttributes200ResponseNERM */ export interface GetProfileTypeAttributes200ResponseNERM { /** * * @type {ProfileTypeAttributesNERM} * @memberof GetProfileTypeAttributes200ResponseNERM */ 'profile_type_attributes'?: ProfileTypeAttributesNERM; } /** * * @export * @interface GetProfileTypeAttributesSortParameterNERM */ export interface GetProfileTypeAttributesSortParameterNERM { /** * * @type {string} * @memberof GetProfileTypeAttributesSortParameterNERM */ 'attr'?: string; /** * * @type {string} * @memberof GetProfileTypeAttributesSortParameterNERM */ 'order'?: GetProfileTypeAttributesSortParameterNERMOrderNerm; } export declare const GetProfileTypeAttributesSortParameterNERMOrderNerm: { readonly Asc: "asc"; readonly Desc: "desc"; }; export type GetProfileTypeAttributesSortParameterNERMOrderNerm = typeof GetProfileTypeAttributesSortParameterNERMOrderNerm[keyof typeof GetProfileTypeAttributesSortParameterNERMOrderNerm]; /** * * @export * @interface GetProfileTypes200ResponseNERM */ export interface GetProfileTypes200ResponseNERM { /** * * @type {Array} * @memberof GetProfileTypes200ResponseNERM */ 'profile_types'?: Array; /** * * @type {MetadataNERM} * @memberof GetProfileTypes200ResponseNERM */ '_metadata'?: MetadataNERM; } /** * * @export * @interface GetRiskLevel200ResponseNERM */ export interface GetRiskLevel200ResponseNERM { /** * * @type {RiskLevelNERM} * @memberof GetRiskLevel200ResponseNERM */ 'risk_level'?: RiskLevelNERM; } /** * * @export * @interface GetRiskLevels200ResponseNERM */ export interface GetRiskLevels200ResponseNERM { /** * * @type {Array} * @memberof GetRiskLevels200ResponseNERM */ 'risk_levels'?: Array; /** * * @type {MetadataNERM} * @memberof GetRiskLevels200ResponseNERM */ '_metadata'?: MetadataNERM; } /** * * @export * @interface GetRiskScore200ResponseNERM */ export interface GetRiskScore200ResponseNERM { /** * * @type {RiskScoreNERM} * @memberof GetRiskScore200ResponseNERM */ 'risk_score'?: RiskScoreNERM; } /** * * @export * @interface GetRiskScores200ResponseNERM */ export interface GetRiskScores200ResponseNERM { /** * * @type {Array} * @memberof GetRiskScores200ResponseNERM */ 'risk_scores'?: Array; /** * * @type {MetadataNERM} * @memberof GetRiskScores200ResponseNERM */ '_metadata'?: MetadataNERM; } /** * * @export * @interface GetRoleProfiles200ResponseNERM */ export interface GetRoleProfiles200ResponseNERM { /** * * @type {Array} * @memberof GetRoleProfiles200ResponseNERM */ 'role_profiles'?: Array; /** * * @type {MetadataNERM} * @memberof GetRoleProfiles200ResponseNERM */ '_metadata'?: MetadataNERM; } /** * * @export * @interface GetRoles200ResponseNERM */ export interface GetRoles200ResponseNERM { /** * * @type {Array} * @memberof GetRoles200ResponseNERM */ 'roles'?: Array; /** * * @type {MetadataNERM} * @memberof GetRoles200ResponseNERM */ '_metadata'?: MetadataNERM; } /** * * @export * @interface GetSchemaMappedProfilesCollection200ResponseNERM */ export interface GetSchemaMappedProfilesCollection200ResponseNERM { /** * * @type {Array} * @memberof GetSchemaMappedProfilesCollection200ResponseNERM */ 'profiles'?: Array; /** * * @type {MetadataWithAfterIdNERM} * @memberof GetSchemaMappedProfilesCollection200ResponseNERM */ '_metadata'?: MetadataWithAfterIdNERM; } /** * * @export * @interface GetSingleSchemaMappedProfile200ResponseNERM */ export interface GetSingleSchemaMappedProfile200ResponseNERM { /** * * @type {ProfileNERM} * @memberof GetSingleSchemaMappedProfile200ResponseNERM */ 'profile'?: ProfileNERM; } /** * * @export * @interface GetSystemRoles200ResponseNERM */ export interface GetSystemRoles200ResponseNERM { /** * * @type {Array} * @memberof GetSystemRoles200ResponseNERM */ 'system_roles'?: Array; /** * * @type {MetadataNERM} * @memberof GetSystemRoles200ResponseNERM */ '_metadata'?: MetadataNERM; } /** * * @export * @interface GetUserManagers200ResponseNERM */ export interface GetUserManagers200ResponseNERM { /** * * @type {Array} * @memberof GetUserManagers200ResponseNERM */ 'user_managers'?: Array; /** * * @type {MetadataNERM} * @memberof GetUserManagers200ResponseNERM */ '_metadata'?: MetadataNERM; } /** * * @export * @interface GetUserProfiles200ResponseNERM */ export interface GetUserProfiles200ResponseNERM { /** * * @type {Array} * @memberof GetUserProfiles200ResponseNERM */ 'user_profiles'?: Array; /** * * @type {MetadataNERM} * @memberof GetUserProfiles200ResponseNERM */ '_metadata'?: MetadataNERM; } /** * * @export * @interface GetUserRoles200ResponseNERM */ export interface GetUserRoles200ResponseNERM { /** * * @type {Array} * @memberof GetUserRoles200ResponseNERM */ 'user_roles'?: Array; /** * * @type {MetadataNERM} * @memberof GetUserRoles200ResponseNERM */ '_metadata'?: MetadataNERM; } /** * * @export * @interface GetUsers200ResponseNERM */ export interface GetUsers200ResponseNERM { /** * * @type {Array} * @memberof GetUsers200ResponseNERM */ 'users'?: Array; /** * * @type {MetadataNERM} * @memberof GetUsers200ResponseNERM */ '_metadata'?: MetadataNERM; } /** * * @export * @interface GetWorkflowActions200ResponseNERM */ export interface GetWorkflowActions200ResponseNERM { /** * * @type {WorkflowActionNERM} * @memberof GetWorkflowActions200ResponseNERM */ 'workflow_actions'?: WorkflowActionNERM; } /** * * @export * @interface GetWorkflowSessions200ResponseNERM */ export interface GetWorkflowSessions200ResponseNERM { /** * * @type {Array} * @memberof GetWorkflowSessions200ResponseNERM */ 'workflow_sessions'?: Array; /** * * @type {MetadataNERM} * @memberof GetWorkflowSessions200ResponseNERM */ '_metadata'?: MetadataNERM; } /** * * @export * @interface IdentityProofingActionNERM */ export interface IdentityProofingActionNERM { /** * The workflow the workflow action belongs to. * @type {string} * @memberof IdentityProofingActionNERM */ 'workflow_id': string; /** * The description of the workflow action. * @type {string} * @memberof IdentityProofingActionNERM */ 'description': string; /** * If the workflow action is archived or not. * @type {boolean} * @memberof IdentityProofingActionNERM */ 'archived'?: boolean; } /** * * @export * @interface IdentityProofingResultNERM */ export interface IdentityProofingResultNERM { /** * * @type {string} * @memberof IdentityProofingResultNERM */ 'id'?: string; /** * * @type {string} * @memberof IdentityProofingResultNERM */ 'identity_proofing_action_id'?: string; /** * * @type {string} * @memberof IdentityProofingResultNERM */ 'workflow_session_id'?: string; /** * * @type {string} * @memberof IdentityProofingResultNERM */ 'profile_id'?: string; /** * * @type {string} * @memberof IdentityProofingResultNERM */ 'proofing_workflow'?: string; /** * * @type {string} * @memberof IdentityProofingResultNERM */ 'result'?: IdentityProofingResultNERMResultNerm; /** * * @type {{ [key: string]: string; }} * @memberof IdentityProofingResultNERM */ 'proofing_attributes'?: { [key: string]: string; }; /** * * @type {string} * @memberof IdentityProofingResultNERM */ 'created_at'?: string; /** * * @type {string} * @memberof IdentityProofingResultNERM */ 'updated_at'?: string; } export declare const IdentityProofingResultNERMResultNerm: { readonly Pending: "pending"; readonly Pass: "pass"; readonly Fail: "fail"; }; export type IdentityProofingResultNERMResultNerm = typeof IdentityProofingResultNERMResultNerm[keyof typeof IdentityProofingResultNERMResultNerm]; /** * * @export * @interface InvalidJsonNERM */ export interface InvalidJsonNERM { /** * * @type {object} * @memberof InvalidJsonNERM */ 'error'?: object; } /** * * @export * @interface InvitationActionConfigurationAttributesNERM */ export interface InvitationActionConfigurationAttributesNERM { /** * the id. * @type {string} * @memberof InvitationActionConfigurationAttributesNERM */ 'id'?: string; /** * If the invitation action should pause the parent workflow to wait for completion. * @type {boolean} * @memberof InvitationActionConfigurationAttributesNERM */ 'wait_for_completion'?: boolean; /** * If the invitation action should return a profile. * @type {boolean} * @memberof InvitationActionConfigurationAttributesNERM */ 'return_profile'?: boolean; /** * the id of the portal. * @type {string} * @memberof InvitationActionConfigurationAttributesNERM */ 'portal_id'?: string; /** * the id of the registration workflow. * @type {string} * @memberof InvitationActionConfigurationAttributesNERM */ 'registration_workflow_id'?: string; /** * the id of the email attribute. * @type {string} * @memberof InvitationActionConfigurationAttributesNERM */ 'email_attribute_id'?: string; /** * If the action should validate against completed registrations by email address. * @type {boolean} * @memberof InvitationActionConfigurationAttributesNERM */ 'validate_completed_registration'?: boolean; /** * If the action should validate against open registrations by email address. * @type {boolean} * @memberof InvitationActionConfigurationAttributesNERM */ 'validate_open_registration'?: boolean; } /** * * @export * @interface InvitationActionNERM */ export interface InvitationActionNERM { /** * The workflow the workflow action belongs to. * @type {string} * @memberof InvitationActionNERM */ 'workflow_id': string; /** * The description of the workflow action. * @type {string} * @memberof InvitationActionNERM */ 'description': string; /** * If the workflow action is archived or not. * @type {boolean} * @memberof InvitationActionNERM */ 'archived'?: boolean; /** * * @type {InvitationActionConfigurationAttributesNERM} * @memberof InvitationActionNERM */ 'configuration_attributes'?: InvitationActionConfigurationAttributesNERM; /** * * @type {InvitationActionWorkflowActionEmailAttributesNERM} * @memberof InvitationActionNERM */ 'workflow_action_email_attributes'?: InvitationActionWorkflowActionEmailAttributesNERM; } /** * * @export * @interface InvitationActionWorkflowActionEmailAttributesNERM */ export interface InvitationActionWorkflowActionEmailAttributesNERM { /** * the id. * @type {string} * @memberof InvitationActionWorkflowActionEmailAttributesNERM */ 'id'?: string; /** * the id of the workflow action. * @type {string} * @memberof InvitationActionWorkflowActionEmailAttributesNERM */ 'workflow_action_id'?: string; /** * the id of the email. * @type {string} * @memberof InvitationActionWorkflowActionEmailAttributesNERM */ 'email_id'?: string; /** * the type of email. * @type {string} * @memberof InvitationActionWorkflowActionEmailAttributesNERM */ 'type'?: InvitationActionWorkflowActionEmailAttributesNERMTypeNerm; } export declare const InvitationActionWorkflowActionEmailAttributesNERMTypeNerm: { readonly StandardEmail: "StandardEmail"; readonly PerformerNotificationEmail: "PerformerNotificationEmail"; readonly ApprovalEmail: "ApprovalEmail"; readonly RejectionEmail: "RejectionEmail"; }; export type InvitationActionWorkflowActionEmailAttributesNERMTypeNerm = typeof InvitationActionWorkflowActionEmailAttributesNERMTypeNerm[keyof typeof InvitationActionWorkflowActionEmailAttributesNERMTypeNerm]; /** * * @export * @interface JobJobStatusNERM */ export interface JobJobStatusNERM { /** * * @type {string} * @memberof JobJobStatusNERM */ 'job_id'?: string; /** * * @type {string} * @memberof JobJobStatusNERM */ 'status'?: string; } /** * * @export * @interface JobNERM */ export interface JobNERM { /** * * @type {string} * @memberof JobNERM */ 'info'?: string; /** * * @type {JobJobStatusNERM} * @memberof JobNERM */ 'job_status'?: JobJobStatusNERM; /** * * @type {number} * @memberof JobNERM */ 'status'?: number; } /** * * @export * @interface LanguageNERM */ export interface LanguageNERM { /** * Set default to True to set a default language, to set another language to default, set default to True on the target language and the current default will become disabled * @type {boolean} * @memberof LanguageNERM */ 'default'?: boolean; /** * True when the language is enabled, False when it is not * @type {boolean} * @memberof LanguageNERM */ 'enabled'?: boolean; /** * The locale string for the language, current options are- en, fr, es, de, fr-CA * @type {string} * @memberof LanguageNERM */ 'locale'?: string; } /** * * @export * @interface LdapActionLdapActionUserRolesAttributesNERM */ export interface LdapActionLdapActionUserRolesAttributesNERM { /** * the id. * @type {string} * @memberof LdapActionLdapActionUserRolesAttributesNERM */ 'id'?: string; /** * the id of the role. * @type {string} * @memberof LdapActionLdapActionUserRolesAttributesNERM */ 'role_id'?: string; } /** * * @export * @interface LdapActionNERM */ export interface LdapActionNERM { /** * The workflow the workflow action belongs to. * @type {string} * @memberof LdapActionNERM */ 'workflow_id': string; /** * The description of the workflow action. * @type {string} * @memberof LdapActionNERM */ 'description': string; /** * If the workflow action is archived or not. * @type {boolean} * @memberof LdapActionNERM */ 'archived'?: boolean; /** * the type of store. * @type {string} * @memberof LdapActionNERM */ 'store_type': LdapActionNERMStoreTypeNerm; /** * * @type {LdapActionLdapActionUserRolesAttributesNERM} * @memberof LdapActionNERM */ 'ldap_action_user_roles_attributes'?: LdapActionLdapActionUserRolesAttributesNERM; /** * * @type {LdapActionWorkflowActionValueBuildersAttributesNERM} * @memberof LdapActionNERM */ 'workflow_action_value_builders_attributes'?: LdapActionWorkflowActionValueBuildersAttributesNERM; /** * * @type {LdapActionWorkflowActionDirectoryGroupsAttributesNERM} * @memberof LdapActionNERM */ 'workflow_action_directory_groups_attributes'?: LdapActionWorkflowActionDirectoryGroupsAttributesNERM; } export declare const LdapActionNERMStoreTypeNerm: { readonly Local: "Local"; readonly Directory: "Directory"; }; export type LdapActionNERMStoreTypeNerm = typeof LdapActionNERMStoreTypeNerm[keyof typeof LdapActionNERMStoreTypeNerm]; /** * * @export * @interface LdapActionWorkflowActionDirectoryGroupsAttributesNERM */ export interface LdapActionWorkflowActionDirectoryGroupsAttributesNERM { /** * the id. * @type {string} * @memberof LdapActionWorkflowActionDirectoryGroupsAttributesNERM */ 'id'?: string; /** * the id of the directory. * @type {string} * @memberof LdapActionWorkflowActionDirectoryGroupsAttributesNERM */ 'directory_id'?: string; /** * the group label. * @type {string} * @memberof LdapActionWorkflowActionDirectoryGroupsAttributesNERM */ 'group_label'?: string; /** * the group dn. * @type {string} * @memberof LdapActionWorkflowActionDirectoryGroupsAttributesNERM */ 'group_dn'?: string; } /** * * @export * @interface LdapActionWorkflowActionValueBuildersAttributesNERM */ export interface LdapActionWorkflowActionValueBuildersAttributesNERM { /** * the id. * @type {string} * @memberof LdapActionWorkflowActionValueBuildersAttributesNERM */ 'id'?: string; /** * the id of the workflow action. * @type {string} * @memberof LdapActionWorkflowActionValueBuildersAttributesNERM */ 'workflow_action_id'?: string; /** * the id of the value builder. * @type {string} * @memberof LdapActionWorkflowActionValueBuildersAttributesNERM */ 'value_builder_id'?: string; /** * the position of the value builder attribute. * @type {number} * @memberof LdapActionWorkflowActionValueBuildersAttributesNERM */ 'position'?: number; } /** * * @export * @interface LoginWorkflowNERM */ export interface LoginWorkflowNERM { /** * The profile type the workflow effects. * @type {string} * @memberof LoginWorkflowNERM */ 'profile_type_id': string; /** * Whether or not the workflow is enabled or disabled. * @type {string} * @memberof LoginWorkflowNERM */ 'status': LoginWorkflowNERMStatusNerm; /** * The user-specified identifier of the workflow. * @type {string} * @memberof LoginWorkflowNERM */ 'uid': string; /** * Name of the workflow * @type {string} * @memberof LoginWorkflowNERM */ 'name': string; /** * * @type {LoginWorkflowOptionsNERM} * @memberof LoginWorkflowNERM */ 'options'?: LoginWorkflowOptionsNERM; /** * When honored at runtime, suppresses failure email notifications for this workflow\'s sessions. * @type {boolean} * @memberof LoginWorkflowNERM */ 'disable_failure_email_notifications'?: boolean | null; } export declare const LoginWorkflowNERMStatusNerm: { readonly Enabled: "Enabled"; readonly Disabled: "Disabled"; }; export type LoginWorkflowNERMStatusNerm = typeof LoginWorkflowNERMStatusNerm[keyof typeof LoginWorkflowNERMStatusNerm]; /** * * @export * @interface LoginWorkflowOptionsNERM */ export interface LoginWorkflowOptionsNERM { /** * Used for login/password reset for when the password will expire. * @type {number} * @memberof LoginWorkflowOptionsNERM */ 'expiration_time'?: number; } /** * * @export * @interface MetadataNERM */ export interface MetadataNERM { /** * * @type {number} * @memberof MetadataNERM */ 'limit'?: number; /** * * @type {number} * @memberof MetadataNERM */ 'offset'?: number; /** * * @type {number} * @memberof MetadataNERM */ 'total'?: number; /** * * @type {string} * @memberof MetadataNERM */ 'next'?: string; /** * * @type {string} * @memberof MetadataNERM */ 'previous'?: string; } /** * * @export * @interface MetadataWithAfterIdNERM */ export interface MetadataWithAfterIdNERM { /** * The maximum number of records to return in the search * @type {number} * @memberof MetadataWithAfterIdNERM */ 'limit'?: number; /** * The number of records to skip before starting to return results. * @type {number} * @memberof MetadataWithAfterIdNERM */ 'offset'?: number; /** * The total number of records available matching the search criteria. * @type {number} * @memberof MetadataWithAfterIdNERM */ 'total'?: number; /** * The ID of the first record in the next set of results * @type {string} * @memberof MetadataWithAfterIdNERM */ 'next'?: string; /** * The ID of the last record in the previous set of results * @type {string} * @memberof MetadataWithAfterIdNERM */ 'previous'?: string; /** * The ID from which the search will start, ignoring all records before it. * @type {string} * @memberof MetadataWithAfterIdNERM */ 'after_id'?: string; } /** * * @export * @interface NotificationActionNERM */ export interface NotificationActionNERM { /** * The workflow the workflow action belongs to. * @type {string} * @memberof NotificationActionNERM */ 'workflow_id': string; /** * The description of the workflow action. * @type {string} * @memberof NotificationActionNERM */ 'description': string; /** * The attribute storing the email address for the workflow action. * @type {string} * @memberof NotificationActionNERM */ 'email_attribute_id'?: string; /** * The email addresses for the workflow action. * @type {Array} * @memberof NotificationActionNERM */ 'email_addresses'?: Array; /** * If the workflow action is archived or not. * @type {boolean} * @memberof NotificationActionNERM */ 'archived'?: boolean; /** * * @type {NotificationActionWorkflowActionEmailAttributesNERM} * @memberof NotificationActionNERM */ 'workflow_action_email_attributes'?: NotificationActionWorkflowActionEmailAttributesNERM; } /** * * @export * @interface NotificationActionWorkflowActionEmailAttributesNERM */ export interface NotificationActionWorkflowActionEmailAttributesNERM { /** * the id. * @type {string} * @memberof NotificationActionWorkflowActionEmailAttributesNERM */ 'id'?: string; /** * the id of the workflow action. * @type {string} * @memberof NotificationActionWorkflowActionEmailAttributesNERM */ 'workflow_action_id'?: string; /** * the id of the email. * @type {string} * @memberof NotificationActionWorkflowActionEmailAttributesNERM */ 'email_id'?: string; /** * the type of email. * @type {string} * @memberof NotificationActionWorkflowActionEmailAttributesNERM */ 'type'?: NotificationActionWorkflowActionEmailAttributesNERMTypeNerm; } export declare const NotificationActionWorkflowActionEmailAttributesNERMTypeNerm: { readonly StandardEmail: "StandardEmail"; }; export type NotificationActionWorkflowActionEmailAttributesNERMTypeNerm = typeof NotificationActionWorkflowActionEmailAttributesNERMTypeNerm[keyof typeof NotificationActionWorkflowActionEmailAttributesNERMTypeNerm]; /** * * @export * @interface PageContent1NERM */ export interface PageContent1NERM { /** * The user-specified identifier for the record * @type {string} * @memberof PageContent1NERM */ 'uid'?: string; /** * The type of content on the page. * @type {string} * @memberof PageContent1NERM */ 'type': PageContent1NERMTypeNerm; /** * The text content to present in this page content record. * @type {string} * @memberof PageContent1NERM */ 'content'?: string; } export declare const PageContent1NERMTypeNerm: { readonly FormHeading: "FormHeading"; readonly LargeHeading: "LargeHeading"; readonly MediumHeading: "MediumHeading"; readonly SmallHeading: "SmallHeading"; readonly Paragraph: "Paragraph"; readonly HtmlContainer: "HtmlContainer"; readonly Owner: "Owner"; readonly RequestProgressBar: "RequestProgressBar"; }; export type PageContent1NERMTypeNerm = typeof PageContent1NERMTypeNerm[keyof typeof PageContent1NERMTypeNerm]; /** * * @export * @interface PageContentNERM */ export interface PageContentNERM { /** * The id of the page content * @type {string} * @memberof PageContentNERM */ 'id'?: string; /** * The user-specified identifier for the record * @type {string} * @memberof PageContentNERM */ 'uid'?: string; /** * The type of content on the page. * @type {string} * @memberof PageContentNERM */ 'type': PageContentNERMTypeNerm; /** * The text content to present in this page content record. * @type {string} * @memberof PageContentNERM */ 'content'?: string; /** * The date-time the record created. * @type {string} * @memberof PageContentNERM */ 'created_at'?: string; /** * The date-time the record was last updated. * @type {string} * @memberof PageContentNERM */ 'updated_at'?: string; } export declare const PageContentNERMTypeNerm: { readonly FormHeading: "FormHeading"; readonly LargeHeading: "LargeHeading"; readonly MediumHeading: "MediumHeading"; readonly SmallHeading: "SmallHeading"; readonly Paragraph: "Paragraph"; readonly HtmlContainer: "HtmlContainer"; readonly Owner: "Owner"; readonly RequestProgressBar: "RequestProgressBar"; }; export type PageContentNERMTypeNerm = typeof PageContentNERMTypeNerm[keyof typeof PageContentNERMTypeNerm]; /** * * @export * @interface PageContentTranslation1NERM */ export interface PageContentTranslation1NERM { /** * The user-specified identifier for the record * @type {string} * @memberof PageContentTranslation1NERM */ 'uid'?: string; /** * The user-specified identifier of the page content record this translation applies to; one of page_content_id or page_content_uid must be present. * @type {string} * @memberof PageContentTranslation1NERM */ 'page_content_uid'?: string; /** * The id of the page content record this translation applies to; one of page_content_id or page_content_uid must be present. * @type {string} * @memberof PageContentTranslation1NERM */ 'page_content_id'?: string; /** * The language locale this translation contains. * @type {string} * @memberof PageContentTranslation1NERM */ 'locale'?: string; /** * The translated string to present in the user interface. * @type {string} * @memberof PageContentTranslation1NERM */ 'value'?: string; } /** * * @export * @interface PageContentTranslationNERM */ export interface PageContentTranslationNERM { /** * The id of the page content * @type {string} * @memberof PageContentTranslationNERM */ 'id'?: string; /** * The user-specified identifier for the record * @type {string} * @memberof PageContentTranslationNERM */ 'uid'?: string; /** * The language locale this translation contains. * @type {string} * @memberof PageContentTranslationNERM */ 'locale'?: string; /** * The translated string to present in the user interface. * @type {string} * @memberof PageContentTranslationNERM */ 'value'?: string; /** * The date-time the record created. * @type {string} * @memberof PageContentTranslationNERM */ 'created_at'?: string; /** * The date-time the record was last updated. * @type {string} * @memberof PageContentTranslationNERM */ 'updated_at'?: string; } /** * * @export * @interface PageElement1NERM */ export interface PageElement1NERM { /** * The id of the page content * @type {string} * @memberof PageElement1NERM */ 'id'?: string; /** * The user-specified identifier for the record * @type {string} * @memberof PageElement1NERM */ 'uid'?: string; /** * The type of content on the page. * @type {string} * @memberof PageElement1NERM */ 'element_type': PageElement1NERMElementTypeNerm; /** * The user-specified identifier of the page record this applies to; one of page_id or page_uid must be present. * @type {string} * @memberof PageElement1NERM */ 'page_uid'?: string; /** * The id of the page record this applies to; one of page_id or page_uid must be present. * @type {string} * @memberof PageElement1NERM */ 'page_id'?: string; /** * The user-specified identifier of the record (Form or PageContent) this applies to; one of element_id or element_uid must be present. * @type {string} * @memberof PageElement1NERM */ 'element_uid'?: string; /** * The id of the record (Form or PageContent) this applies to; one of element_id or element_uid must be present. * @type {string} * @memberof PageElement1NERM */ 'element_id'?: string; /** * The ordinal position of the attribute in the user-interface page. * @type {number} * @memberof PageElement1NERM */ 'order'?: number; } export declare const PageElement1NERMElementTypeNerm: { readonly PageContent: "PageContent"; readonly Form: "Form"; }; export type PageElement1NERMElementTypeNerm = typeof PageElement1NERMElementTypeNerm[keyof typeof PageElement1NERMElementTypeNerm]; /** * * @export * @interface PageElementNERM */ export interface PageElementNERM { /** * The id of the page element * @type {string} * @memberof PageElementNERM */ 'id'?: string; /** * The user-specified identifier for the record * @type {string} * @memberof PageElementNERM */ 'uid'?: string; /** * The type of content on the page. * @type {string} * @memberof PageElementNERM */ 'element_type': PageElementNERMElementTypeNerm; /** * The user-specified identifier of the page record this applies to; one of page_id or page_uid must be present. * @type {string} * @memberof PageElementNERM */ 'page_uid'?: string; /** * The id of the page record this applies to; one of page_id or page_uid must be present. * @type {string} * @memberof PageElementNERM */ 'page_id'?: string; /** * The user-specified identifier of the record (Form or PageContent) this applies to; one of element_id or element_uid must be present. * @type {string} * @memberof PageElementNERM */ 'element_uid'?: string; /** * The id of the record (Form or PageContent) this applies to; one of element_id or element_uid must be present. * @type {string} * @memberof PageElementNERM */ 'element_id'?: string; /** * The position of the attribute in the ProfileType\'s naming * @type {number} * @memberof PageElementNERM */ 'order'?: number; } export declare const PageElementNERMElementTypeNerm: { readonly PageContent: "PageContent"; readonly Form: "Form"; }; export type PageElementNERMElementTypeNerm = typeof PageElementNERMElementTypeNerm[keyof typeof PageElementNERMElementTypeNerm]; /** * * @export * @interface PagesNERM */ export interface PagesNERM { /** * The user-specified identifier of the page * @type {string} * @memberof PagesNERM */ 'uid'?: string; /** * The description of the page * @type {string} * @memberof PagesNERM */ 'description'?: string; /** * The name of the page * @type {string} * @memberof PagesNERM */ 'name'?: string; /** * Determines whether the page is archived * @type {boolean} * @memberof PagesNERM */ 'archived'?: boolean; /** * The id of the form * @type {string} * @memberof PagesNERM */ 'id'?: string; } /** * * @export * @interface PasswordResetActionNERM */ export interface PasswordResetActionNERM { /** * The workflow the workflow action belongs to. * @type {string} * @memberof PasswordResetActionNERM */ 'workflow_id': string; /** * The description of the workflow action. * @type {string} * @memberof PasswordResetActionNERM */ 'description': string; /** * If the workflow action is archived or not. * @type {boolean} * @memberof PasswordResetActionNERM */ 'archived'?: boolean; } /** * * @export * @interface PatchLanguageRequestNERM */ export interface PatchLanguageRequestNERM { /** * * @type {LanguageNERM} * @memberof PatchLanguageRequestNERM */ 'language'?: LanguageNERM; } /** * * @export * @interface Permission1NERM */ export interface Permission1NERM { /** * The id of the role * @type {string} * @memberof Permission1NERM */ 'role_id'?: string; /** * The ID of the object that the permission is giving access to * @type {string} * @memberof Permission1NERM */ 'subject_id'?: string; /** * The permissions level of access * @type {number} * @memberof Permission1NERM */ 'value'?: Permission1NERMValueNerm; /** * The type of permission * @type {number} * @memberof Permission1NERM */ 'subject'?: Permission1NERMSubjectNerm; } export declare const Permission1NERMValueNerm: { readonly NUMBER_1: 1; readonly NUMBER_2: 2; readonly NUMBER_3: 3; readonly NUMBER_4: 4; readonly NUMBER_5: 5; readonly NUMBER_6: 6; readonly NUMBER_7: 7; }; export type Permission1NERMValueNerm = typeof Permission1NERMValueNerm[keyof typeof Permission1NERMValueNerm]; export declare const Permission1NERMSubjectNerm: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; readonly NUMBER_2: 2; readonly NUMBER_3: 3; readonly NUMBER_4: 4; readonly NUMBER_5: 5; readonly NUMBER_6: 6; readonly NUMBER_7: 7; readonly NUMBER_8: 8; readonly NUMBER_9: 9; readonly NUMBER_10: 10; readonly NUMBER_11: 11; readonly NUMBER_12: 12; readonly NUMBER_13: 13; readonly NUMBER_14: 14; readonly NUMBER_15: 15; readonly NUMBER_16: 16; readonly NUMBER_17: 17; readonly NUMBER_18: 18; readonly NUMBER_19: 19; readonly NUMBER_20: 20; readonly NUMBER_21: 21; readonly NUMBER_22: 22; readonly NUMBER_23: 23; }; export type Permission1NERMSubjectNerm = typeof Permission1NERMSubjectNerm[keyof typeof Permission1NERMSubjectNerm]; /** * * @export * @interface PermissionNERM */ export interface PermissionNERM { /** * The id of the permission * @type {string} * @memberof PermissionNERM */ 'id'?: string; /** * The id of the role * @type {string} * @memberof PermissionNERM */ 'role_id'?: string; /** * The permissions level of access * @type {number} * @memberof PermissionNERM */ 'value'?: number; /** * The type of permission * @type {number} * @memberof PermissionNERM */ 'subject'?: number; /** * The ID of the object that the permission is giving access to * @type {string} * @memberof PermissionNERM */ 'subject_id'?: string; } /** * * @export * @interface Profile1NERM */ export interface Profile1NERM { /** * The profile name. * @type {string} * @memberof Profile1NERM */ 'name'?: string; /** * The profile type id. * @type {string} * @memberof Profile1NERM */ 'profile_type_id': string; /** * The profile status. * @type {string} * @memberof Profile1NERM */ 'status': Profile1NERMStatusNerm; /** * The id proofing status of the profile. * @type {string} * @memberof Profile1NERM */ 'id_proofing_status'?: Profile1NERMIdProofingStatusNerm; /** * Describes whether the profile is archived or not. * @type {boolean} * @memberof Profile1NERM */ 'archived'?: boolean; /** * The attributes associated with the profile. * @type {{ [key: string]: string; }} * @memberof Profile1NERM */ 'attributes'?: { [key: string]: string; }; } export declare const Profile1NERMStatusNerm: { readonly Active: "Active"; readonly Inactive: "Inactive"; readonly OnLeave: "On Leave"; readonly Terminated: "Terminated"; }; export type Profile1NERMStatusNerm = typeof Profile1NERMStatusNerm[keyof typeof Profile1NERMStatusNerm]; export declare const Profile1NERMIdProofingStatusNerm: { readonly Pending: "pending"; readonly Pass: "pass"; readonly Fail: "fail"; }; export type Profile1NERMIdProofingStatusNerm = typeof Profile1NERMIdProofingStatusNerm[keyof typeof Profile1NERMIdProofingStatusNerm]; /** * * @export * @interface ProfileAttributeRuleDate1NERM */ export interface ProfileAttributeRuleDate1NERM { /** * * @type {string} * @memberof ProfileAttributeRuleDate1NERM */ 'type': ProfileAttributeRuleDate1NERMTypeNerm; /** * * @type {string} * @memberof ProfileAttributeRuleDate1NERM */ 'condition_object_type': ProfileAttributeRuleDate1NERMConditionObjectTypeNerm; /** * * @type {string} * @memberof ProfileAttributeRuleDate1NERM */ 'condition_object_id'?: string; /** * * @type {string} * @memberof ProfileAttributeRuleDate1NERM */ 'secondary_attribute_type'?: ProfileAttributeRuleDate1NERMSecondaryAttributeTypeNerm; /** * * @type {string} * @memberof ProfileAttributeRuleDate1NERM */ 'secondary_attribute_id'?: string; /** * * @type {string} * @memberof ProfileAttributeRuleDate1NERM */ 'comparison_operator'?: ProfileAttributeRuleDate1NERMComparisonOperatorNerm; /** * * @type {string} * @memberof ProfileAttributeRuleDate1NERM */ 'value': ProfileAttributeRuleDate1NERMValueNerm; /** * * @type {string} * @memberof ProfileAttributeRuleDate1NERM */ 'secondary_value'?: ProfileAttributeRuleDate1NERMSecondaryValueNerm; /** * * @type {string} * @memberof ProfileAttributeRuleDate1NERM */ 'tertiary_value'?: string; } export declare const ProfileAttributeRuleDate1NERMTypeNerm: { readonly ProfileAttributeRule: "ProfileAttributeRule"; }; export type ProfileAttributeRuleDate1NERMTypeNerm = typeof ProfileAttributeRuleDate1NERMTypeNerm[keyof typeof ProfileAttributeRuleDate1NERMTypeNerm]; export declare const ProfileAttributeRuleDate1NERMConditionObjectTypeNerm: { readonly DateAttribute: "DateAttribute"; }; export type ProfileAttributeRuleDate1NERMConditionObjectTypeNerm = typeof ProfileAttributeRuleDate1NERMConditionObjectTypeNerm[keyof typeof ProfileAttributeRuleDate1NERMConditionObjectTypeNerm]; export declare const ProfileAttributeRuleDate1NERMSecondaryAttributeTypeNerm: { readonly DateAttribute: "DateAttribute"; }; export type ProfileAttributeRuleDate1NERMSecondaryAttributeTypeNerm = typeof ProfileAttributeRuleDate1NERMSecondaryAttributeTypeNerm[keyof typeof ProfileAttributeRuleDate1NERMSecondaryAttributeTypeNerm]; export declare const ProfileAttributeRuleDate1NERMComparisonOperatorNerm: { readonly GreaterThan: ">"; readonly LessThan: "<"; readonly After: "after"; readonly Before: "before"; }; export type ProfileAttributeRuleDate1NERMComparisonOperatorNerm = typeof ProfileAttributeRuleDate1NERMComparisonOperatorNerm[keyof typeof ProfileAttributeRuleDate1NERMComparisonOperatorNerm]; export declare const ProfileAttributeRuleDate1NERMValueNerm: { readonly Today: "Today"; readonly Uid: ""; }; export type ProfileAttributeRuleDate1NERMValueNerm = typeof ProfileAttributeRuleDate1NERMValueNerm[keyof typeof ProfileAttributeRuleDate1NERMValueNerm]; export declare const ProfileAttributeRuleDate1NERMSecondaryValueNerm: { readonly After: "after"; readonly Before: "before"; }; export type ProfileAttributeRuleDate1NERMSecondaryValueNerm = typeof ProfileAttributeRuleDate1NERMSecondaryValueNerm[keyof typeof ProfileAttributeRuleDate1NERMSecondaryValueNerm]; /** * * @export * @interface ProfileAttributeRuleDateNERM */ export interface ProfileAttributeRuleDateNERM { /** * * @type {string} * @memberof ProfileAttributeRuleDateNERM */ 'id'?: string; /** * * @type {string} * @memberof ProfileAttributeRuleDateNERM */ 'uid'?: string; /** * * @type {string} * @memberof ProfileAttributeRuleDateNERM */ 'type': ProfileAttributeRuleDateNERMTypeNerm; /** * * @type {string} * @memberof ProfileAttributeRuleDateNERM */ 'condition_object_type': ProfileAttributeRuleDateNERMConditionObjectTypeNerm; /** * * @type {string} * @memberof ProfileAttributeRuleDateNERM */ 'condition_object_id'?: string; /** * * @type {string} * @memberof ProfileAttributeRuleDateNERM */ 'secondary_attribute_type'?: ProfileAttributeRuleDateNERMSecondaryAttributeTypeNerm; /** * * @type {string} * @memberof ProfileAttributeRuleDateNERM */ 'secondary_attribute_id'?: string; /** * * @type {string} * @memberof ProfileAttributeRuleDateNERM */ 'comparison_operator'?: ProfileAttributeRuleDateNERMComparisonOperatorNerm; /** * * @type {string} * @memberof ProfileAttributeRuleDateNERM */ 'value': ProfileAttributeRuleDateNERMValueNerm; /** * * @type {string} * @memberof ProfileAttributeRuleDateNERM */ 'secondary_value'?: ProfileAttributeRuleDateNERMSecondaryValueNerm; /** * * @type {string} * @memberof ProfileAttributeRuleDateNERM */ 'tertiary_value'?: string; } export declare const ProfileAttributeRuleDateNERMTypeNerm: { readonly ProfileAttributeRule: "ProfileAttributeRule"; }; export type ProfileAttributeRuleDateNERMTypeNerm = typeof ProfileAttributeRuleDateNERMTypeNerm[keyof typeof ProfileAttributeRuleDateNERMTypeNerm]; export declare const ProfileAttributeRuleDateNERMConditionObjectTypeNerm: { readonly DateAttribute: "DateAttribute"; }; export type ProfileAttributeRuleDateNERMConditionObjectTypeNerm = typeof ProfileAttributeRuleDateNERMConditionObjectTypeNerm[keyof typeof ProfileAttributeRuleDateNERMConditionObjectTypeNerm]; export declare const ProfileAttributeRuleDateNERMSecondaryAttributeTypeNerm: { readonly DateAttribute: "DateAttribute"; }; export type ProfileAttributeRuleDateNERMSecondaryAttributeTypeNerm = typeof ProfileAttributeRuleDateNERMSecondaryAttributeTypeNerm[keyof typeof ProfileAttributeRuleDateNERMSecondaryAttributeTypeNerm]; export declare const ProfileAttributeRuleDateNERMComparisonOperatorNerm: { readonly GreaterThan: ">"; readonly LessThan: "<"; readonly After: "after"; readonly Before: "before"; }; export type ProfileAttributeRuleDateNERMComparisonOperatorNerm = typeof ProfileAttributeRuleDateNERMComparisonOperatorNerm[keyof typeof ProfileAttributeRuleDateNERMComparisonOperatorNerm]; export declare const ProfileAttributeRuleDateNERMValueNerm: { readonly Today: "Today"; readonly Uid: ""; }; export type ProfileAttributeRuleDateNERMValueNerm = typeof ProfileAttributeRuleDateNERMValueNerm[keyof typeof ProfileAttributeRuleDateNERMValueNerm]; export declare const ProfileAttributeRuleDateNERMSecondaryValueNerm: { readonly After: "after"; readonly Before: "before"; }; export type ProfileAttributeRuleDateNERMSecondaryValueNerm = typeof ProfileAttributeRuleDateNERMSecondaryValueNerm[keyof typeof ProfileAttributeRuleDateNERMSecondaryValueNerm]; /** * * @export * @interface ProfileAttributeRuleId1NERM */ export interface ProfileAttributeRuleId1NERM { /** * * @type {string} * @memberof ProfileAttributeRuleId1NERM */ 'type': ProfileAttributeRuleId1NERMTypeNerm; /** * * @type {string} * @memberof ProfileAttributeRuleId1NERM */ 'condition_object_type': ProfileAttributeRuleId1NERMConditionObjectTypeNerm; /** * * @type {string} * @memberof ProfileAttributeRuleId1NERM */ 'condition_object_id': string; /** * * @type {string} * @memberof ProfileAttributeRuleId1NERM */ 'comparison_operator': ProfileAttributeRuleId1NERMComparisonOperatorNerm; /** * * @type {string} * @memberof ProfileAttributeRuleId1NERM */ 'value': string; } export declare const ProfileAttributeRuleId1NERMTypeNerm: { readonly ProfileAttributeRule: "ProfileAttributeRule"; }; export type ProfileAttributeRuleId1NERMTypeNerm = typeof ProfileAttributeRuleId1NERMTypeNerm[keyof typeof ProfileAttributeRuleId1NERMTypeNerm]; export declare const ProfileAttributeRuleId1NERMConditionObjectTypeNerm: { readonly ProfileSelectAttribute: "ProfileSelectAttribute"; readonly ProfileSearchAttribute: "ProfileSearchAttribute"; readonly OwnerSelectAttribute: "OwnerSelectAttribute"; readonly OwnerSearchAttribute: "OwnerSearchAttribute"; readonly ContributorSelectAttribute: "ContributorSelectAttribute"; readonly ContributorSearchAttribute: "ContributorSearchAttribute"; }; export type ProfileAttributeRuleId1NERMConditionObjectTypeNerm = typeof ProfileAttributeRuleId1NERMConditionObjectTypeNerm[keyof typeof ProfileAttributeRuleId1NERMConditionObjectTypeNerm]; export declare const ProfileAttributeRuleId1NERMComparisonOperatorNerm: { readonly Include: "include?"; readonly Exclude: "exclude?"; }; export type ProfileAttributeRuleId1NERMComparisonOperatorNerm = typeof ProfileAttributeRuleId1NERMComparisonOperatorNerm[keyof typeof ProfileAttributeRuleId1NERMComparisonOperatorNerm]; /** * * @export * @interface ProfileAttributeRuleIdNERM */ export interface ProfileAttributeRuleIdNERM { /** * * @type {string} * @memberof ProfileAttributeRuleIdNERM */ 'id'?: string; /** * * @type {string} * @memberof ProfileAttributeRuleIdNERM */ 'uid'?: string; /** * * @type {string} * @memberof ProfileAttributeRuleIdNERM */ 'type': ProfileAttributeRuleIdNERMTypeNerm; /** * * @type {string} * @memberof ProfileAttributeRuleIdNERM */ 'condition_object_type': ProfileAttributeRuleIdNERMConditionObjectTypeNerm; /** * * @type {string} * @memberof ProfileAttributeRuleIdNERM */ 'condition_object_id': string; /** * * @type {string} * @memberof ProfileAttributeRuleIdNERM */ 'comparison_operator': ProfileAttributeRuleIdNERMComparisonOperatorNerm; /** * * @type {string} * @memberof ProfileAttributeRuleIdNERM */ 'value': string; } export declare const ProfileAttributeRuleIdNERMTypeNerm: { readonly ProfileAttributeRule: "ProfileAttributeRule"; }; export type ProfileAttributeRuleIdNERMTypeNerm = typeof ProfileAttributeRuleIdNERMTypeNerm[keyof typeof ProfileAttributeRuleIdNERMTypeNerm]; export declare const ProfileAttributeRuleIdNERMConditionObjectTypeNerm: { readonly ProfileSelectAttribute: "ProfileSelectAttribute"; readonly ProfileSearchAttribute: "ProfileSearchAttribute"; readonly OwnerSelectAttribute: "OwnerSelectAttribute"; readonly OwnerSearchAttribute: "OwnerSearchAttribute"; readonly ContributorSelectAttribute: "ContributorSelectAttribute"; readonly ContributorSearchAttribute: "ContributorSearchAttribute"; }; export type ProfileAttributeRuleIdNERMConditionObjectTypeNerm = typeof ProfileAttributeRuleIdNERMConditionObjectTypeNerm[keyof typeof ProfileAttributeRuleIdNERMConditionObjectTypeNerm]; export declare const ProfileAttributeRuleIdNERMComparisonOperatorNerm: { readonly Include: "include?"; readonly Exclude: "exclude?"; }; export type ProfileAttributeRuleIdNERMComparisonOperatorNerm = typeof ProfileAttributeRuleIdNERMComparisonOperatorNerm[keyof typeof ProfileAttributeRuleIdNERMComparisonOperatorNerm]; /** * * @export * @interface ProfileAttributeRuleString1NERM */ export interface ProfileAttributeRuleString1NERM { /** * * @type {string} * @memberof ProfileAttributeRuleString1NERM */ 'type': ProfileAttributeRuleString1NERMTypeNerm; /** * * @type {string} * @memberof ProfileAttributeRuleString1NERM */ 'condition_object_type': ProfileAttributeRuleString1NERMConditionObjectTypeNerm; /** * * @type {string} * @memberof ProfileAttributeRuleString1NERM */ 'condition_object_id': string; /** * * @type {string} * @memberof ProfileAttributeRuleString1NERM */ 'comparison_operator': ProfileAttributeRuleString1NERMComparisonOperatorNerm; /** * * @type {string} * @memberof ProfileAttributeRuleString1NERM */ 'value': string; } export declare const ProfileAttributeRuleString1NERMTypeNerm: { readonly ProfileAttributeRule: "ProfileAttributeRule"; }; export type ProfileAttributeRuleString1NERMTypeNerm = typeof ProfileAttributeRuleString1NERMTypeNerm[keyof typeof ProfileAttributeRuleString1NERMTypeNerm]; export declare const ProfileAttributeRuleString1NERMConditionObjectTypeNerm: { readonly TextFieldAttribute: "TextFieldAttribute"; readonly TextAreaAttribute: "TextAreaAttribute"; }; export type ProfileAttributeRuleString1NERMConditionObjectTypeNerm = typeof ProfileAttributeRuleString1NERMConditionObjectTypeNerm[keyof typeof ProfileAttributeRuleString1NERMConditionObjectTypeNerm]; export declare const ProfileAttributeRuleString1NERMComparisonOperatorNerm: { readonly DoubleEqual: "=="; readonly NotEqual: "!="; readonly GreaterThan: ">"; readonly LessThan: "<"; readonly StartWith: "start_with?"; readonly EndWith: "end_with?"; readonly Include: "include?"; }; export type ProfileAttributeRuleString1NERMComparisonOperatorNerm = typeof ProfileAttributeRuleString1NERMComparisonOperatorNerm[keyof typeof ProfileAttributeRuleString1NERMComparisonOperatorNerm]; /** * * @export * @interface ProfileAttributeRuleStringNERM */ export interface ProfileAttributeRuleStringNERM { /** * * @type {string} * @memberof ProfileAttributeRuleStringNERM */ 'id'?: string; /** * * @type {string} * @memberof ProfileAttributeRuleStringNERM */ 'uid'?: string; /** * * @type {string} * @memberof ProfileAttributeRuleStringNERM */ 'type': ProfileAttributeRuleStringNERMTypeNerm; /** * * @type {string} * @memberof ProfileAttributeRuleStringNERM */ 'condition_object_type': ProfileAttributeRuleStringNERMConditionObjectTypeNerm; /** * * @type {string} * @memberof ProfileAttributeRuleStringNERM */ 'condition_object_id': string; /** * * @type {string} * @memberof ProfileAttributeRuleStringNERM */ 'comparison_operator': ProfileAttributeRuleStringNERMComparisonOperatorNerm; /** * * @type {string} * @memberof ProfileAttributeRuleStringNERM */ 'value': string; } export declare const ProfileAttributeRuleStringNERMTypeNerm: { readonly ProfileAttributeRule: "ProfileAttributeRule"; }; export type ProfileAttributeRuleStringNERMTypeNerm = typeof ProfileAttributeRuleStringNERMTypeNerm[keyof typeof ProfileAttributeRuleStringNERMTypeNerm]; export declare const ProfileAttributeRuleStringNERMConditionObjectTypeNerm: { readonly TextFieldAttribute: "TextFieldAttribute"; readonly TextAreaAttribute: "TextAreaAttribute"; }; export type ProfileAttributeRuleStringNERMConditionObjectTypeNerm = typeof ProfileAttributeRuleStringNERMConditionObjectTypeNerm[keyof typeof ProfileAttributeRuleStringNERMConditionObjectTypeNerm]; export declare const ProfileAttributeRuleStringNERMComparisonOperatorNerm: { readonly DoubleEqual: "=="; readonly NotEqual: "!="; readonly GreaterThan: ">"; readonly LessThan: "<"; readonly StartWith: "start_with?"; readonly EndWith: "end_with?"; readonly Include: "include?"; }; export type ProfileAttributeRuleStringNERMComparisonOperatorNerm = typeof ProfileAttributeRuleStringNERMComparisonOperatorNerm[keyof typeof ProfileAttributeRuleStringNERMComparisonOperatorNerm]; /** * * @export * @interface ProfileCheckActionNERM */ export interface ProfileCheckActionNERM { /** * The workflow the workflow action belongs to. * @type {string} * @memberof ProfileCheckActionNERM */ 'workflow_id': string; /** * The description of the workflow action. * @type {string} * @memberof ProfileCheckActionNERM */ 'description': string; /** * If the workflow action is archived or not. * @type {boolean} * @memberof ProfileCheckActionNERM */ 'archived'?: boolean; /** * An array of ne_attribute_ids. * @type {Array} * @memberof ProfileCheckActionNERM */ 'ne_attribute_ids'?: Array; /** * The handle type for what should happen if an existing profile is found. * @type {string} * @memberof ProfileCheckActionNERM */ 'handle_type'?: ProfileCheckActionNERMHandleTypeNerm; /** * The handle id. When handle type is session, this is the session id. * @type {string} * @memberof ProfileCheckActionNERM */ 'handle_id'?: string; } export declare const ProfileCheckActionNERMHandleTypeNerm: { readonly Session: "session"; readonly Attribute: "attribute"; }; export type ProfileCheckActionNERMHandleTypeNerm = typeof ProfileCheckActionNERMHandleTypeNerm[keyof typeof ProfileCheckActionNERMHandleTypeNerm]; /** * * @export * @interface ProfileNERM */ export interface ProfileNERM { /** * The objects ID * @type {string} * @memberof ProfileNERM */ 'id'?: string; /** * The objects UID * @type {string} * @memberof ProfileNERM */ 'uid'?: string; /** * This is the name of the profile. * @type {string} * @memberof ProfileNERM */ 'name'?: string; /** * This is the ID of the profile type the profile belongs to * @type {string} * @memberof ProfileNERM */ 'profile_type_id'?: string; /** * This is the status of the profile * @type {string} * @memberof ProfileNERM */ 'status'?: ProfileNERMStatusNerm; /** * This is the ID proofing staus of the profile * @type {string} * @memberof ProfileNERM */ 'id_proofing_status'?: ProfileNERMIdProofingStatusNerm; /** * The date and time the profile was created * @type {string} * @memberof ProfileNERM */ 'created_at'?: string; /** * The date and time the profile was updated * @type {string} * @memberof ProfileNERM */ 'updated_at'?: string; /** * Attributes that belong to this profile. * @type {{ [key: string]: string; }} * @memberof ProfileNERM */ 'attributes'?: { [key: string]: string; }; } export declare const ProfileNERMStatusNerm: { readonly Active: "Active"; readonly Inactive: "Inactive"; readonly OnLeave: "On Leave"; readonly Terminated: "Terminated"; }; export type ProfileNERMStatusNerm = typeof ProfileNERMStatusNerm[keyof typeof ProfileNERMStatusNerm]; export declare const ProfileNERMIdProofingStatusNerm: { readonly Pending: "pending"; readonly Pass: "pass"; readonly Fail: "fail"; }; export type ProfileNERMIdProofingStatusNerm = typeof ProfileNERMIdProofingStatusNerm[keyof typeof ProfileNERMIdProofingStatusNerm]; /** * * @export * @interface ProfilePageNERM */ export interface ProfilePageNERM { /** * The user-specified identifier of the page * @type {string} * @memberof ProfilePageNERM */ 'uid'?: string; /** * The description of the page * @type {string} * @memberof ProfilePageNERM */ 'description'?: string; /** * The name of the page * @type {string} * @memberof ProfilePageNERM */ 'name'?: string; /** * Determines whether the page is archived * @type {boolean} * @memberof ProfilePageNERM */ 'archived'?: boolean; } /** * * @export * @interface ProfileSelectActionNERM */ export interface ProfileSelectActionNERM { /** * The workflow the workflow action belongs to. * @type {string} * @memberof ProfileSelectActionNERM */ 'workflow_id': string; /** * The description of the workflow action. * @type {string} * @memberof ProfileSelectActionNERM */ 'description': string; /** * If the workflow action is archived or not. * @type {boolean} * @memberof ProfileSelectActionNERM */ 'archived'?: boolean; } /** * * @export * @interface ProfileStatusRule1NERM */ export interface ProfileStatusRule1NERM { /** * * @type {string} * @memberof ProfileStatusRule1NERM */ 'type': ProfileStatusRule1NERMTypeNerm; /** * * @type {string} * @memberof ProfileStatusRule1NERM */ 'comparison_operator': ProfileStatusRule1NERMComparisonOperatorNerm; /** * * @type {string} * @memberof ProfileStatusRule1NERM */ 'value': ProfileStatusRule1NERMValueNerm; } export declare const ProfileStatusRule1NERMTypeNerm: { readonly ProfileStatusRule: "ProfileStatusRule"; }; export type ProfileStatusRule1NERMTypeNerm = typeof ProfileStatusRule1NERMTypeNerm[keyof typeof ProfileStatusRule1NERMTypeNerm]; export declare const ProfileStatusRule1NERMComparisonOperatorNerm: { readonly DoubleEqual: "=="; readonly NotEqual: "!="; }; export type ProfileStatusRule1NERMComparisonOperatorNerm = typeof ProfileStatusRule1NERMComparisonOperatorNerm[keyof typeof ProfileStatusRule1NERMComparisonOperatorNerm]; export declare const ProfileStatusRule1NERMValueNerm: { readonly Active: "Active"; readonly Inactive: "Inactive"; readonly LeaveOfAbsence: "Leave of absence"; readonly Terminated: "Terminated"; }; export type ProfileStatusRule1NERMValueNerm = typeof ProfileStatusRule1NERMValueNerm[keyof typeof ProfileStatusRule1NERMValueNerm]; /** * * @export * @interface ProfileStatusRuleNERM */ export interface ProfileStatusRuleNERM { /** * * @type {string} * @memberof ProfileStatusRuleNERM */ 'id'?: string; /** * * @type {string} * @memberof ProfileStatusRuleNERM */ 'uid'?: string; /** * * @type {string} * @memberof ProfileStatusRuleNERM */ 'type': ProfileStatusRuleNERMTypeNerm; /** * * @type {string} * @memberof ProfileStatusRuleNERM */ 'comparison_operator'?: ProfileStatusRuleNERMComparisonOperatorNerm; /** * * @type {string} * @memberof ProfileStatusRuleNERM */ 'value'?: ProfileStatusRuleNERMValueNerm; } export declare const ProfileStatusRuleNERMTypeNerm: { readonly ProfileStatusRule: "ProfileStatusRule"; }; export type ProfileStatusRuleNERMTypeNerm = typeof ProfileStatusRuleNERMTypeNerm[keyof typeof ProfileStatusRuleNERMTypeNerm]; export declare const ProfileStatusRuleNERMComparisonOperatorNerm: { readonly DoubleEqual: "=="; readonly NotEqual: "!="; }; export type ProfileStatusRuleNERMComparisonOperatorNerm = typeof ProfileStatusRuleNERMComparisonOperatorNerm[keyof typeof ProfileStatusRuleNERMComparisonOperatorNerm]; export declare const ProfileStatusRuleNERMValueNerm: { readonly Active: "Active"; readonly Inactive: "Inactive"; readonly LeaveOfAbsence: "Leave of absence"; readonly Terminated: "Terminated"; }; export type ProfileStatusRuleNERMValueNerm = typeof ProfileStatusRuleNERMValueNerm[keyof typeof ProfileStatusRuleNERMValueNerm]; /** * * @export * @interface ProfileType1NERM */ export interface ProfileType1NERM { /** * This is the name of the profile type. * @type {string} * @memberof ProfileType1NERM */ 'name'?: string; /** * This is the category the profile type falls into. * @type {string} * @memberof ProfileType1NERM */ 'category'?: ProfileType1NERMCategoryNerm; /** * Whether or not duplication protection is bypassed. * @type {boolean} * @memberof ProfileType1NERM */ 'bypass_dup_protection'?: boolean; /** * Whether or not the profile type is archived. * @type {boolean} * @memberof ProfileType1NERM */ 'archived'?: boolean; /** * The role ids that are permitted for this profile type. * @type {Array} * @memberof ProfileType1NERM */ 'permitted_role_ids'?: Array; /** * Is this profile type synced with ics * @type {boolean} * @memberof ProfileType1NERM */ 'isc_synced'?: boolean; /** * * @type {Array} * @memberof ProfileType1NERM */ 'profile_type_dup_attributes_attributes'?: Array; /** * * @type {Array} * @memberof ProfileType1NERM */ 'profile_type_namings_attributes'?: Array; } export declare const ProfileType1NERMCategoryNerm: { readonly Employee: "employee"; readonly NonEmployee: "non-employee"; readonly Organization: "organization"; readonly Assignment: "assignment"; readonly Other: "other"; }; export type ProfileType1NERMCategoryNerm = typeof ProfileType1NERMCategoryNerm[keyof typeof ProfileType1NERMCategoryNerm]; /** * * @export * @interface ProfileType1ProfileTypeDupAttributesAttributesInnerNERM */ export interface ProfileType1ProfileTypeDupAttributesAttributesInnerNERM { /** * The ID of the ne attribute. * @type {string} * @memberof ProfileType1ProfileTypeDupAttributesAttributesInnerNERM */ 'ne_attribute_id'?: string; } /** * * @export * @interface ProfileType1ProfileTypeNamingsAttributesInnerNERM */ export interface ProfileType1ProfileTypeNamingsAttributesInnerNERM { /** * The ID of the associated ne attribute. * @type {string} * @memberof ProfileType1ProfileTypeNamingsAttributesInnerNERM */ 'ne_attribute_id'?: string; /** * The order that the namings are used in. * @type {number} * @memberof ProfileType1ProfileTypeNamingsAttributesInnerNERM */ 'order'?: number; } /** * * @export * @interface ProfileTypeAttributeNERM */ export interface ProfileTypeAttributeNERM { /** * ID of ne attribute * @type {string} * @memberof ProfileTypeAttributeNERM */ 'id'?: string; /** * Ne attribute\'s uid * @type {string} * @memberof ProfileTypeAttributeNERM */ 'uid'?: string; /** * Ne attribute\'s label * @type {string} * @memberof ProfileTypeAttributeNERM */ 'label': string; /** * synced_attribute ID if there is one * @type {string} * @memberof ProfileTypeAttributeNERM */ 'synced'?: string; } /** * * @export * @interface ProfileTypeAttributesNERM */ export interface ProfileTypeAttributesNERM { /** * How many ne attribute records exist * @type {number} * @memberof ProfileTypeAttributesNERM */ 'count'?: number; /** * * @type {Array} * @memberof ProfileTypeAttributesNERM */ 'records'?: Array; } /** * * @export * @interface ProfileTypeNERM */ export interface ProfileTypeNERM { /** * The objects ID. * @type {string} * @memberof ProfileTypeNERM */ 'id'?: string; /** * The objects UID. * @type {string} * @memberof ProfileTypeNERM */ 'uid'?: string; /** * This is the name of the profile type. * @type {string} * @memberof ProfileTypeNERM */ 'name'?: string; /** * This is the category the profile type falls into. * @type {string} * @memberof ProfileTypeNERM */ 'category'?: ProfileTypeNERMCategoryNerm; /** * Whether or not duplication protection is bypassed. * @type {boolean} * @memberof ProfileTypeNERM */ 'bypass_dup_protection'?: boolean; /** * Whether or not the profile type is archived. * @type {boolean} * @memberof ProfileTypeNERM */ 'archived'?: boolean; /** * The role ids that are permitted for this profile type. * @type {Array} * @memberof ProfileTypeNERM */ 'permitted_role_ids'?: Array; /** * Is this profile type synced with ics * @type {boolean} * @memberof ProfileTypeNERM */ 'isc_synced'?: boolean; /** * * @type {Array} * @memberof ProfileTypeNERM */ 'profile_type_dup_attributes'?: Array; /** * * @type {Array} * @memberof ProfileTypeNERM */ 'profile_type_namings'?: Array; } export declare const ProfileTypeNERMCategoryNerm: { readonly Employee: "employee"; readonly NonEmployee: "non-employee"; readonly Organization: "organization"; readonly Assignment: "assignment"; readonly Other: "other"; }; export type ProfileTypeNERMCategoryNerm = typeof ProfileTypeNERMCategoryNerm[keyof typeof ProfileTypeNERMCategoryNerm]; /** * * @export * @interface ProfileTypeProfileTypeDupAttributesInnerNERM */ export interface ProfileTypeProfileTypeDupAttributesInnerNERM { /** * The ID of the properties that are used for duplication protection. * @type {string} * @memberof ProfileTypeProfileTypeDupAttributesInnerNERM */ 'id'?: string; /** * The user-specified identifier of the properties that are used for duplication protection. * @type {string} * @memberof ProfileTypeProfileTypeDupAttributesInnerNERM */ 'uid'?: string; /** * The ID of the profile type. * @type {string} * @memberof ProfileTypeProfileTypeDupAttributesInnerNERM */ 'profile_type_id'?: string; /** * The ID of the ne attribute. * @type {string} * @memberof ProfileTypeProfileTypeDupAttributesInnerNERM */ 'ne_attribute_id'?: string; } /** * * @export * @interface ProfileTypeProfileTypeNamingsInnerNERM */ export interface ProfileTypeProfileTypeNamingsInnerNERM { /** * The ID of the profile type naming. * @type {string} * @memberof ProfileTypeProfileTypeNamingsInnerNERM */ 'id'?: string; /** * The user-specified identifier of the profile type naming. * @type {string} * @memberof ProfileTypeProfileTypeNamingsInnerNERM */ 'uid'?: string; /** * The ID of the associated profile type. * @type {string} * @memberof ProfileTypeProfileTypeNamingsInnerNERM */ 'profile_type_id'?: string; /** * The ID of the associated ne attribute. * @type {string} * @memberof ProfileTypeProfileTypeNamingsInnerNERM */ 'ne_attribute_id'?: string; /** * The order that the namings are used in. * @type {number} * @memberof ProfileTypeProfileTypeNamingsInnerNERM */ 'order'?: number; } /** * * @export * @interface ProfileTypeRoles1NERM */ export interface ProfileTypeRoles1NERM { /** * The id of the profile type * @type {string} * @memberof ProfileTypeRoles1NERM */ 'profile_type_id'?: string; /** * The id of the role * @type {string} * @memberof ProfileTypeRoles1NERM */ 'role_id'?: string; } /** * * @export * @interface ProfileTypeRolesNERM */ export interface ProfileTypeRolesNERM { /** * The id of the profile type * @type {string} * @memberof ProfileTypeRolesNERM */ 'profile_type_id'?: string; /** * The id of the role * @type {string} * @memberof ProfileTypeRolesNERM */ 'role_id'?: string; /** * The id of the profile type role * @type {string} * @memberof ProfileTypeRolesNERM */ 'id'?: string; } /** * * @export * @interface ProfileTypeRule1NERM */ export interface ProfileTypeRule1NERM { /** * * @type {string} * @memberof ProfileTypeRule1NERM */ 'type': ProfileTypeRule1NERMTypeNerm; /** * * @type {string} * @memberof ProfileTypeRule1NERM */ 'comparison_operator': ProfileTypeRule1NERMComparisonOperatorNerm; /** * * @type {string} * @memberof ProfileTypeRule1NERM */ 'value': string; } export declare const ProfileTypeRule1NERMTypeNerm: { readonly ProfileTypeRule: "ProfileTypeRule"; }; export type ProfileTypeRule1NERMTypeNerm = typeof ProfileTypeRule1NERMTypeNerm[keyof typeof ProfileTypeRule1NERMTypeNerm]; export declare const ProfileTypeRule1NERMComparisonOperatorNerm: { readonly DoubleEqual: "=="; readonly NotEqual: "!="; }; export type ProfileTypeRule1NERMComparisonOperatorNerm = typeof ProfileTypeRule1NERMComparisonOperatorNerm[keyof typeof ProfileTypeRule1NERMComparisonOperatorNerm]; /** * * @export * @interface ProfileTypeRuleNERM */ export interface ProfileTypeRuleNERM { /** * * @type {string} * @memberof ProfileTypeRuleNERM */ 'id'?: string; /** * * @type {string} * @memberof ProfileTypeRuleNERM */ 'uid'?: string; /** * * @type {string} * @memberof ProfileTypeRuleNERM */ 'type': ProfileTypeRuleNERMTypeNerm; /** * * @type {string} * @memberof ProfileTypeRuleNERM */ 'comparison_operator'?: ProfileTypeRuleNERMComparisonOperatorNerm; /** * * @type {string} * @memberof ProfileTypeRuleNERM */ 'value'?: string; } export declare const ProfileTypeRuleNERMTypeNerm: { readonly ProfileTypeRule: "ProfileTypeRule"; }; export type ProfileTypeRuleNERMTypeNerm = typeof ProfileTypeRuleNERMTypeNerm[keyof typeof ProfileTypeRuleNERMTypeNerm]; export declare const ProfileTypeRuleNERMComparisonOperatorNerm: { readonly DoubleEqual: "=="; readonly NotEqual: "!="; }; export type ProfileTypeRuleNERMComparisonOperatorNerm = typeof ProfileTypeRuleNERMComparisonOperatorNerm[keyof typeof ProfileTypeRuleNERMComparisonOperatorNerm]; /** * * @export * @interface ProfilesNERM */ export interface ProfilesNERM { /** * * @type {Array} * @memberof ProfilesNERM */ 'profiles'?: Array; } /** * * @export * @interface RequestActionNERM */ export interface RequestActionNERM { /** * The workflow the workflow action belongs to. * @type {string} * @memberof RequestActionNERM */ 'workflow_id': string; /** * The description of the workflow action. * @type {string} * @memberof RequestActionNERM */ 'description': string; /** * The page the workflow action should render. * @type {string} * @memberof RequestActionNERM */ 'page_id'?: string; /** * If the workflow action is archived or not. * @type {boolean} * @memberof RequestActionNERM */ 'archived'?: boolean; /** * If the workflow action requires a comment or not. * @type {boolean} * @memberof RequestActionNERM */ 'requires_comment'?: boolean; } /** * * @export * @interface RestApiActionNERM */ export interface RestApiActionNERM { /** * The workflow the workflow action belongs to. * @type {string} * @memberof RestApiActionNERM */ 'workflow_id': string; /** * The description of the workflow action. * @type {string} * @memberof RestApiActionNERM */ 'description': string; /** * If the workflow action is archived or not. * @type {boolean} * @memberof RestApiActionNERM */ 'archived'?: boolean; } /** * * @export * @interface ReviewActionNERM */ export interface ReviewActionNERM { /** * The workflow the workflow action belongs to. * @type {string} * @memberof ReviewActionNERM */ 'workflow_id': string; /** * The description of the workflow action. * @type {string} * @memberof ReviewActionNERM */ 'description': string; /** * The page the workflow action should render. * @type {string} * @memberof ReviewActionNERM */ 'page_id'?: string; /** * If the workflow action is archived or not. * @type {boolean} * @memberof ReviewActionNERM */ 'archived'?: boolean; /** * If the workflow action requires a comment or not. * @type {boolean} * @memberof ReviewActionNERM */ 'requires_comment'?: boolean; } /** * * @export * @interface RiskLevelNERM */ export interface RiskLevelNERM { /** * * @type {string} * @memberof RiskLevelNERM */ 'id'?: string; /** * * @type {string} * @memberof RiskLevelNERM */ 'uid'?: string; /** * * @type {string} * @memberof RiskLevelNERM */ 'label'?: string; /** * * @type {number} * @memberof RiskLevelNERM */ 'points'?: number; /** * * @type {number} * @memberof RiskLevelNERM */ 'order'?: number; } /** * * @export * @interface RiskRule1NERM */ export interface RiskRule1NERM { /** * * @type {string} * @memberof RiskRule1NERM */ 'type': RiskRule1NERMTypeNerm; /** * * @type {string} * @memberof RiskRule1NERM */ 'comparison_operator'?: RiskRule1NERMComparisonOperatorNerm; /** * * @type {string} * @memberof RiskRule1NERM */ 'value': string; /** * * @type {string} * @memberof RiskRule1NERM */ 'secondary_value': RiskRule1NERMSecondaryValueNerm; } export declare const RiskRule1NERMTypeNerm: { readonly RiskRule: "RiskRule"; }; export type RiskRule1NERMTypeNerm = typeof RiskRule1NERMTypeNerm[keyof typeof RiskRule1NERMTypeNerm]; export declare const RiskRule1NERMComparisonOperatorNerm: { readonly DoubleEqual: "=="; readonly GreaterThan: ">"; readonly LessThan: "<"; }; export type RiskRule1NERMComparisonOperatorNerm = typeof RiskRule1NERMComparisonOperatorNerm[keyof typeof RiskRule1NERMComparisonOperatorNerm]; export declare const RiskRule1NERMSecondaryValueNerm: { readonly OverallRisk: "OverallRisk"; }; export type RiskRule1NERMSecondaryValueNerm = typeof RiskRule1NERMSecondaryValueNerm[keyof typeof RiskRule1NERMSecondaryValueNerm]; /** * * @export * @interface RiskRuleNERM */ export interface RiskRuleNERM { /** * * @type {string} * @memberof RiskRuleNERM */ 'id'?: string; /** * * @type {string} * @memberof RiskRuleNERM */ 'uid'?: string; /** * * @type {string} * @memberof RiskRuleNERM */ 'type': RiskRuleNERMTypeNerm; /** * * @type {string} * @memberof RiskRuleNERM */ 'comparison_operator'?: RiskRuleNERMComparisonOperatorNerm; /** * * @type {string} * @memberof RiskRuleNERM */ 'value': string; /** * * @type {string} * @memberof RiskRuleNERM */ 'secondary_value': RiskRuleNERMSecondaryValueNerm; } export declare const RiskRuleNERMTypeNerm: { readonly RiskRule: "RiskRule"; }; export type RiskRuleNERMTypeNerm = typeof RiskRuleNERMTypeNerm[keyof typeof RiskRuleNERMTypeNerm]; export declare const RiskRuleNERMComparisonOperatorNerm: { readonly DoubleEqual: "=="; readonly GreaterThan: ">"; readonly LessThan: "<"; }; export type RiskRuleNERMComparisonOperatorNerm = typeof RiskRuleNERMComparisonOperatorNerm[keyof typeof RiskRuleNERMComparisonOperatorNerm]; export declare const RiskRuleNERMSecondaryValueNerm: { readonly OverallRisk: "OverallRisk"; }; export type RiskRuleNERMSecondaryValueNerm = typeof RiskRuleNERMSecondaryValueNerm[keyof typeof RiskRuleNERMSecondaryValueNerm]; /** * * @export * @interface RiskScoreNERM */ export interface RiskScoreNERM { /** * * @type {string} * @memberof RiskScoreNERM */ 'id'?: string; /** * * @type {string} * @memberof RiskScoreNERM */ 'uid'?: string; /** * * @type {string} * @memberof RiskScoreNERM */ 'object_id'?: string; /** * * @type {string} * @memberof RiskScoreNERM */ 'object_type'?: RiskScoreNERMObjectTypeNerm; /** * * @type {number} * @memberof RiskScoreNERM */ 'overall_score'?: number; /** * * @type {string} * @memberof RiskScoreNERM */ 'overall_risk_level_id'?: string; /** * * @type {number} * @memberof RiskScoreNERM */ 'impact_score'?: number; /** * * @type {string} * @memberof RiskScoreNERM */ 'impact_risk_level_id'?: string; /** * * @type {number} * @memberof RiskScoreNERM */ 'probability_score'?: number; /** * * @type {string} * @memberof RiskScoreNERM */ 'probability_risk_level_id'?: string; } export declare const RiskScoreNERMObjectTypeNerm: { readonly Profile: "Profile"; readonly WorkflowSession: "WorkflowSession"; }; export type RiskScoreNERMObjectTypeNerm = typeof RiskScoreNERMObjectTypeNerm[keyof typeof RiskScoreNERMObjectTypeNerm]; /** * * @export * @interface Role1NERM */ export interface Role1NERM { /** * * @type {string} * @memberof Role1NERM */ 'uid'?: string; /** * * @type {string} * @memberof Role1NERM */ 'type'?: Role1NERMTypeNerm; /** * * @type {string} * @memberof Role1NERM */ 'name'?: string; /** * * @type {Array} * @memberof Role1NERM */ 'groups'?: Array; } export declare const Role1NERMTypeNerm: { readonly NeprofileRole: "NeprofileRole"; readonly NeaccessRole: "NeaccessRole"; }; export type Role1NERMTypeNerm = typeof Role1NERMTypeNerm[keyof typeof Role1NERMTypeNerm]; /** * * @export * @interface RoleNERM */ export interface RoleNERM { /** * * @type {string} * @memberof RoleNERM */ 'id'?: string; /** * * @type {string} * @memberof RoleNERM */ 'uid'?: string; /** * * @type {string} * @memberof RoleNERM */ 'name'?: string; /** * * @type {Array} * @memberof RoleNERM */ 'groups'?: Array; } /** * * @export * @interface RoleProfile1NERM */ export interface RoleProfile1NERM { /** * * @type {string} * @memberof RoleProfile1NERM */ 'role_id'?: string; /** * * @type {string} * @memberof RoleProfile1NERM */ 'profile_id'?: string; } /** * * @export * @interface RoleProfileNERM */ export interface RoleProfileNERM { /** * * @type {string} * @memberof RoleProfileNERM */ 'id'?: string; /** * * @type {string} * @memberof RoleProfileNERM */ 'uid'?: string; /** * * @type {string} * @memberof RoleProfileNERM */ 'role_id'?: string; /** * * @type {string} * @memberof RoleProfileNERM */ 'profile_id'?: string; } /** * * @export * @interface RoleProfilesNERM */ export interface RoleProfilesNERM { /** * * @type {Array} * @memberof RoleProfilesNERM */ 'role_profiles'?: Array; } /** * * @export * @interface RolesNERM */ export interface RolesNERM { /** * * @type {Array} * @memberof RolesNERM */ 'roles'?: Array; } /** * * @export * @interface RunWorkflowActionConfigurationAttributesNERM */ export interface RunWorkflowActionConfigurationAttributesNERM { /** * the id. * @type {string} * @memberof RunWorkflowActionConfigurationAttributesNERM */ 'id'?: string; /** * the id of the workflow. * @type {string} * @memberof RunWorkflowActionConfigurationAttributesNERM */ 'workflow_id'?: string; /** * If the parent workflow should wait for the child to complete. * @type {boolean} * @memberof RunWorkflowActionConfigurationAttributesNERM */ 'wait_for_completion'?: boolean; /** * the profile the parent should send to the child workflow. * @type {string} * @memberof RunWorkflowActionConfigurationAttributesNERM */ 'profile_to_send'?: RunWorkflowActionConfigurationAttributesNERMProfileToSendNerm; /** * if the child workflow should return a profile. * @type {boolean} * @memberof RunWorkflowActionConfigurationAttributesNERM */ 'return_profile'?: boolean; /** * the id of the child workflow to run. * @type {string} * @memberof RunWorkflowActionConfigurationAttributesNERM */ 'run_workflow_action_id'?: string; /** * the id of the profile type. * @type {string} * @memberof RunWorkflowActionConfigurationAttributesNERM */ 'profile_type_id'?: string; } export declare const RunWorkflowActionConfigurationAttributesNERMProfileToSendNerm: { readonly None: "none"; readonly Current: "current"; readonly Attribute: "attribute"; readonly ProfileType: "profile_type"; }; export type RunWorkflowActionConfigurationAttributesNERMProfileToSendNerm = typeof RunWorkflowActionConfigurationAttributesNERMProfileToSendNerm[keyof typeof RunWorkflowActionConfigurationAttributesNERMProfileToSendNerm]; /** * * @export * @interface RunWorkflowActionNERM */ export interface RunWorkflowActionNERM { /** * The workflow the workflow action belongs to. * @type {string} * @memberof RunWorkflowActionNERM */ 'workflow_id': string; /** * The description of the workflow action. * @type {string} * @memberof RunWorkflowActionNERM */ 'description': string; /** * If the workflow action is archived or not. * @type {boolean} * @memberof RunWorkflowActionNERM */ 'archived'?: boolean; /** * * @type {RunWorkflowActionConfigurationAttributesNERM} * @memberof RunWorkflowActionNERM */ 'configuration_attributes'?: RunWorkflowActionConfigurationAttributesNERM; } /** * * @export * @interface Search200ResponseNERM */ export interface Search200ResponseNERM { /** * * @type {Array} * @memberof Search200ResponseNERM */ 'audit_events'?: Array; } /** * * @export * @interface SearchAdvancedSearch200ResponseNERM */ export interface SearchAdvancedSearch200ResponseNERM { /** * * @type {Array} * @memberof SearchAdvancedSearch200ResponseNERM */ 'profiles'?: Array; } /** * * @export * @interface SearchRequestAuditEventsNERM */ export interface SearchRequestAuditEventsNERM { /** * How many records to skip before pulling records to return. * @type {number} * @memberof SearchRequestAuditEventsNERM */ 'offset'?: number; /** * A column that we are sorting these records from. * @type {string} * @memberof SearchRequestAuditEventsNERM */ 'sort_by'?: string; /** * The limiting count for the amount of records returned. * @type {number} * @memberof SearchRequestAuditEventsNERM */ 'limit'?: number; /** * Which direction the list should be sorted by * @type {string} * @memberof SearchRequestAuditEventsNERM */ 'order'?: SearchRequestAuditEventsNERMOrderNerm; /** * * @type {AuditEventNERM} * @memberof SearchRequestAuditEventsNERM */ 'filters'?: AuditEventNERM; } export declare const SearchRequestAuditEventsNERMOrderNerm: { readonly Asc: "asc"; readonly Desc: "desc"; }; export type SearchRequestAuditEventsNERMOrderNerm = typeof SearchRequestAuditEventsNERMOrderNerm[keyof typeof SearchRequestAuditEventsNERMOrderNerm]; /** * * @export * @interface SearchRequestNERM */ export interface SearchRequestNERM { /** * * @type {SearchRequestAuditEventsNERM} * @memberof SearchRequestNERM */ 'audit_events'?: SearchRequestAuditEventsNERM; } /** * * @export * @interface SetAttributesActionNERM */ export interface SetAttributesActionNERM { /** * The workflow the workflow action belongs to. * @type {string} * @memberof SetAttributesActionNERM */ 'workflow_id': string; /** * The description of the workflow action. * @type {string} * @memberof SetAttributesActionNERM */ 'description': string; /** * If the workflow action is archived or not. * @type {boolean} * @memberof SetAttributesActionNERM */ 'archived'?: boolean; } /** * * @export * @interface SetSecurityQuestionActionNERM */ export interface SetSecurityQuestionActionNERM { /** * The workflow the workflow action belongs to. * @type {string} * @memberof SetSecurityQuestionActionNERM */ 'workflow_id': string; /** * The description of the workflow action. * @type {string} * @memberof SetSecurityQuestionActionNERM */ 'description': string; /** * If the workflow action is archived or not. * @type {boolean} * @memberof SetSecurityQuestionActionNERM */ 'archived'?: boolean; /** * The number of questions the user should answer upon login. * @type {number} * @memberof SetSecurityQuestionActionNERM */ 'number_of_questions': number; } /** * * @export * @interface SoapApiActionNERM */ export interface SoapApiActionNERM { /** * The workflow the workflow action belongs to. * @type {string} * @memberof SoapApiActionNERM */ 'workflow_id': string; /** * The description of the workflow action. * @type {string} * @memberof SoapApiActionNERM */ 'description': string; /** * If the workflow action is archived or not. * @type {boolean} * @memberof SoapApiActionNERM */ 'archived'?: boolean; } /** * * @export * @interface StatusChangeActionNERM */ export interface StatusChangeActionNERM { /** * The workflow the workflow action belongs to. * @type {string} * @memberof StatusChangeActionNERM */ 'workflow_id': string; /** * The description of the workflow action. * @type {string} * @memberof StatusChangeActionNERM */ 'description': string; /** * The new status for the Status Change workflow action. * @type {string} * @memberof StatusChangeActionNERM */ 'new_status'?: StatusChangeActionNERMNewStatusNerm; /** * If the workflow action is archived or not. * @type {boolean} * @memberof StatusChangeActionNERM */ 'archived'?: boolean; } export declare const StatusChangeActionNERMNewStatusNerm: { readonly Active: "Active"; readonly Inactive: "Inactive"; readonly OnLeave: "On Leave"; readonly Terminated: "Terminated"; }; export type StatusChangeActionNERMNewStatusNerm = typeof StatusChangeActionNERMNewStatusNerm[keyof typeof StatusChangeActionNERMNewStatusNerm]; /** * * @export * @interface SubmitAdvancedSearch200ResponseNERM */ export interface SubmitAdvancedSearch200ResponseNERM { /** * * @type {AdvancedSearchNERM} * @memberof SubmitAdvancedSearch200ResponseNERM */ 'advanced_search'?: AdvancedSearchNERM; } /** * * @export * @interface SubmitAdvancedSearchRequestNERM */ export interface SubmitAdvancedSearchRequestNERM { /** * * @type {AdvancedSearch1NERM} * @memberof SubmitAdvancedSearchRequestNERM */ 'advanced_search'?: AdvancedSearch1NERM; } /** * * @export * @interface SubmitAttributeOption200ResponseNERM */ export interface SubmitAttributeOption200ResponseNERM { /** * * @type {AttributeOptionNERM} * @memberof SubmitAttributeOption200ResponseNERM */ 'ne_attribute_option'?: AttributeOptionNERM; } /** * * @export * @interface SubmitAttributeOptionRequestNERM */ export interface SubmitAttributeOptionRequestNERM { /** * * @type {AttributeOption1NERM} * @memberof SubmitAttributeOptionRequestNERM */ 'ne_attribute_option'?: AttributeOption1NERM; } /** * @type SubmitAttributeOptions200ResponseNERM * @export */ export type SubmitAttributeOptions200ResponseNERM = AttributeOptionsNERM | JobNERM; /** * * @export * @interface SubmitAttributeOptionsRequestNERM */ export interface SubmitAttributeOptionsRequestNERM { /** * * @type {Array} * @memberof SubmitAttributeOptionsRequestNERM */ 'ne_attribute_options'?: Array; } /** * * @export * @interface SubmitProfileRequestNERM */ export interface SubmitProfileRequestNERM { /** * * @type {Profile1NERM} * @memberof SubmitProfileRequestNERM */ 'profile'?: Profile1NERM; } /** * * @export * @interface SubmitProfileType200ResponseNERM */ export interface SubmitProfileType200ResponseNERM { /** * * @type {ProfileTypeNERM} * @memberof SubmitProfileType200ResponseNERM */ 'profile_type'?: ProfileTypeNERM; } /** * * @export * @interface SubmitProfileTypeRequestNERM */ export interface SubmitProfileTypeRequestNERM { /** * * @type {ProfileType1NERM} * @memberof SubmitProfileTypeRequestNERM */ 'profile_type'?: ProfileType1NERM; } /** * * @export * @interface SubmitProfileUploadRequestNERM */ export interface SubmitProfileUploadRequestNERM { /** * * @type {File} * @memberof SubmitProfileUploadRequestNERM */ 'file'?: File; } /** * * @export * @interface SubmitRole200ResponseNERM */ export interface SubmitRole200ResponseNERM { /** * * @type {RoleNERM} * @memberof SubmitRole200ResponseNERM */ 'role'?: RoleNERM; } /** * * @export * @interface SubmitRoleProfile200ResponseNERM */ export interface SubmitRoleProfile200ResponseNERM { /** * * @type {RoleProfileNERM} * @memberof SubmitRoleProfile200ResponseNERM */ 'role_profile'?: RoleProfileNERM; } /** * * @export * @interface SubmitRoleProfileRequestNERM */ export interface SubmitRoleProfileRequestNERM { /** * * @type {RoleProfile1NERM} * @memberof SubmitRoleProfileRequestNERM */ 'role_profile'?: RoleProfile1NERM; } /** * @type SubmitRoleProfiles200ResponseNERM * @export */ export type SubmitRoleProfiles200ResponseNERM = JobNERM | RoleProfilesNERM; /** * * @export * @interface SubmitRoleProfilesRequestNERM */ export interface SubmitRoleProfilesRequestNERM { /** * * @type {Array} * @memberof SubmitRoleProfilesRequestNERM */ 'role_profiles'?: Array; } /** * * @export * @interface SubmitRoleRequestNERM */ export interface SubmitRoleRequestNERM { /** * * @type {Role1NERM} * @memberof SubmitRoleRequestNERM */ 'role'?: Role1NERM; } /** * @type SubmitRoles200ResponseNERM * @export */ export type SubmitRoles200ResponseNERM = JobNERM | RolesNERM; /** * * @export * @interface SubmitRolesRequestNERM */ export interface SubmitRolesRequestNERM { /** * * @type {Array} * @memberof SubmitRolesRequestNERM */ 'roles'?: Array; } /** * * @export * @interface SubmitUser200ResponseNERM */ export interface SubmitUser200ResponseNERM { /** * * @type {UserNERM} * @memberof SubmitUser200ResponseNERM */ 'user'?: UserNERM; } /** * * @export * @interface SubmitUserManager200ResponseNERM */ export interface SubmitUserManager200ResponseNERM { /** * * @type {UserManagerNERM} * @memberof SubmitUserManager200ResponseNERM */ 'user_manager'?: UserManagerNERM; } /** * * @export * @interface SubmitUserManagerRequestNERM */ export interface SubmitUserManagerRequestNERM { /** * * @type {UserManager1NERM} * @memberof SubmitUserManagerRequestNERM */ 'user_manager'?: UserManager1NERM; } /** * @type SubmitUserManagers200ResponseNERM * @export */ export type SubmitUserManagers200ResponseNERM = JobNERM | UserManagersNERM; /** * * @export * @interface SubmitUserManagersRequestNERM */ export interface SubmitUserManagersRequestNERM { /** * * @type {Array} * @memberof SubmitUserManagersRequestNERM */ 'user_managers'?: Array; } /** * * @export * @interface SubmitUserProfile200ResponseNERM */ export interface SubmitUserProfile200ResponseNERM { /** * * @type {UserProfileNERM} * @memberof SubmitUserProfile200ResponseNERM */ 'user_profile'?: UserProfileNERM; } /** * * @export * @interface SubmitUserProfileRequestNERM */ export interface SubmitUserProfileRequestNERM { /** * * @type {UserProfile1NERM} * @memberof SubmitUserProfileRequestNERM */ 'user_profile'?: UserProfile1NERM; } /** * * @export * @interface SubmitUserRequestNERM */ export interface SubmitUserRequestNERM { /** * * @type {User1NERM} * @memberof SubmitUserRequestNERM */ 'user'?: User1NERM; } /** * * @export * @interface SubmitUserRole200ResponseNERM */ export interface SubmitUserRole200ResponseNERM { /** * * @type {UserRoleNERM} * @memberof SubmitUserRole200ResponseNERM */ 'user_role'?: UserRoleNERM; } /** * * @export * @interface SubmitUserRoleRequestNERM */ export interface SubmitUserRoleRequestNERM { /** * * @type {UserRole1NERM} * @memberof SubmitUserRoleRequestNERM */ 'user_role'?: UserRole1NERM; } /** * @type SubmitUserRoles200ResponseNERM * @export */ export type SubmitUserRoles200ResponseNERM = JobNERM | UserRolesNERM; /** * * @export * @interface SubmitUserRolesRequestNERM */ export interface SubmitUserRolesRequestNERM { /** * * @type {Array} * @memberof SubmitUserRolesRequestNERM */ 'user_roles'?: Array; } /** * @type SubmitUsers200ResponseNERM * @export */ export type SubmitUsers200ResponseNERM = JobNERM | UsersNERM; /** * * @export * @interface SubmitUsersRequestNERM */ export interface SubmitUsersRequestNERM { /** * * @type {Array} * @memberof SubmitUsersRequestNERM */ 'users'?: Array; } /** * * @export * @interface SubmitWorkflowSession200ResponseNERM */ export interface SubmitWorkflowSession200ResponseNERM { /** * * @type {WorkflowSessionNERM} * @memberof SubmitWorkflowSession200ResponseNERM */ 'workflow_session'?: WorkflowSessionNERM; } /** * * @export * @interface SubmitWorkflowSessionRequestNERM */ export interface SubmitWorkflowSessionRequestNERM { /** * * @type {WorkflowSession1NERM} * @memberof SubmitWorkflowSessionRequestNERM */ 'workflow_session'?: WorkflowSession1NERM; } /** * * @export * @interface SyncedAttribute1NERM */ export interface SyncedAttribute1NERM { /** * synced attribute\'s ID * @type {string} * @memberof SyncedAttribute1NERM */ 'ne_attribute_id'?: string; } /** * * @export * @interface SyncedAttributeNERM */ export interface SyncedAttributeNERM { /** * synced attribute\'s ID * @type {string} * @memberof SyncedAttributeNERM */ 'id'?: string; /** * Profile type ID of synced attribute * @type {string} * @memberof SyncedAttributeNERM */ 'profile_type_id'?: string; /** * Ne attribute ID of synced attribute * @type {string} * @memberof SyncedAttributeNERM */ 'ne_attribute_id'?: string; } /** * * @export * @interface SystemRoleNERM */ export interface SystemRoleNERM { /** * The unique identifier for the object * @type {string} * @memberof SystemRoleNERM */ 'id'?: string; /** * The user identifier for the object * @type {string} * @memberof SystemRoleNERM */ 'uid'?: SystemRoleNERMUidNerm; /** * The name of the role * @type {string} * @memberof SystemRoleNERM */ 'name'?: SystemRoleNERMNameNerm; } export declare const SystemRoleNERMUidNerm: { readonly ProfileContributor: "profile_contributor"; readonly ProfileOwner: "profile_owner"; }; export type SystemRoleNERMUidNerm = typeof SystemRoleNERMUidNerm[keyof typeof SystemRoleNERMUidNerm]; export declare const SystemRoleNERMNameNerm: { readonly ProfileContributor: "Profile Contributor"; readonly ProfileOwner: "Profile Owner"; }; export type SystemRoleNERMNameNerm = typeof SystemRoleNERMNameNerm[keyof typeof SystemRoleNERMNameNerm]; /** * * @export * @interface SystemRolePermission1NERM */ export interface SystemRolePermission1NERM { /** * The id of the system role * @type {string} * @memberof SystemRolePermission1NERM */ 'system_role_id'?: string; /** * The ID of the object that the permission is giving access to * @type {string} * @memberof SystemRolePermission1NERM */ 'subject_id'?: string; /** * The permissions level of access * @type {number} * @memberof SystemRolePermission1NERM */ 'value'?: SystemRolePermission1NERMValueNerm; /** * The type of permission * @type {number} * @memberof SystemRolePermission1NERM */ 'subject'?: SystemRolePermission1NERMSubjectNerm; } export declare const SystemRolePermission1NERMValueNerm: { readonly NUMBER_1: 1; readonly NUMBER_2: 2; readonly NUMBER_3: 3; readonly NUMBER_4: 4; readonly NUMBER_5: 5; readonly NUMBER_6: 6; readonly NUMBER_7: 7; }; export type SystemRolePermission1NERMValueNerm = typeof SystemRolePermission1NERMValueNerm[keyof typeof SystemRolePermission1NERMValueNerm]; export declare const SystemRolePermission1NERMSubjectNerm: { readonly NUMBER_0: 0; readonly NUMBER_2: 2; readonly NUMBER_14: 14; }; export type SystemRolePermission1NERMSubjectNerm = typeof SystemRolePermission1NERMSubjectNerm[keyof typeof SystemRolePermission1NERMSubjectNerm]; /** * * @export * @interface SystemRolePermissionNERM */ export interface SystemRolePermissionNERM { /** * The id of the system role permission * @type {string} * @memberof SystemRolePermissionNERM */ 'id'?: string; /** * The id of the system role * @type {string} * @memberof SystemRolePermissionNERM */ 'system_role_id'?: string; /** * The permissions level of access * @type {number} * @memberof SystemRolePermissionNERM */ 'value'?: number; /** * The type of permission * @type {number} * @memberof SystemRolePermissionNERM */ 'subject'?: number; /** * The ID of the object that the permission is giving access to * @type {string} * @memberof SystemRolePermissionNERM */ 'subject_id'?: string; } /** * * @export * @interface UnassignActionNERM */ export interface UnassignActionNERM { /** * The workflow the workflow action belongs to. * @type {string} * @memberof UnassignActionNERM */ 'workflow_id': string; /** * The description of the workflow action. * @type {string} * @memberof UnassignActionNERM */ 'description': string; /** * If the workflow action is archived or not. * @type {boolean} * @memberof UnassignActionNERM */ 'archived'?: boolean; } /** * * @export * @interface UpdateFormByIdRequestNERM */ export interface UpdateFormByIdRequestNERM { /** * * @type {Form1NERM} * @memberof UpdateFormByIdRequestNERM */ 'role'?: Form1NERM; } /** * * @export * @interface UpdatePageContentTranslationByIdRequestNERM */ export interface UpdatePageContentTranslationByIdRequestNERM { /** * * @type {PageContent1NERM} * @memberof UpdatePageContentTranslationByIdRequestNERM */ 'page_content_translation'?: PageContent1NERM; } /** * * @export * @interface UpdateProfileActionNERM */ export interface UpdateProfileActionNERM { /** * The workflow the workflow action belongs to. * @type {string} * @memberof UpdateProfileActionNERM */ 'workflow_id': string; /** * The description of the workflow action. * @type {string} * @memberof UpdateProfileActionNERM */ 'description': string; /** * If the workflow action is archived or not. * @type {boolean} * @memberof UpdateProfileActionNERM */ 'archived'?: boolean; } /** * * @export * @interface UpdateProfileRequestNERM */ export interface UpdateProfileRequestNERM { /** * * @type {UpdateProfileRequestProfileNERM} * @memberof UpdateProfileRequestNERM */ 'profile': UpdateProfileRequestProfileNERM; } /** * The profile object to be updated with its schema-mapped attributes. * @export * @interface UpdateProfileRequestProfileNERM */ export interface UpdateProfileRequestProfileNERM { /** * schema-mapped attributes to be updated * @type {{ [key: string]: any; }} * @memberof UpdateProfileRequestProfileNERM */ 'attributes'?: { [key: string]: any; }; } /** * * @export * @interface UpdateWorkflowNERM */ export interface UpdateWorkflowNERM { /** * The profile type the workflow effects. * @type {string} * @memberof UpdateWorkflowNERM */ 'profile_type_id': string; /** * Whether or not the workflow is enabled or disabled. * @type {string} * @memberof UpdateWorkflowNERM */ 'status': UpdateWorkflowNERMStatusNerm; /** * The user-specified identifier of the workflow. * @type {string} * @memberof UpdateWorkflowNERM */ 'uid': string; /** * Name of the workflow * @type {string} * @memberof UpdateWorkflowNERM */ 'name': string; /** * The status of the profiles the workflow will effect. * @type {string} * @memberof UpdateWorkflowNERM */ 'profile_status': string; /** * When honored at runtime, suppresses failure email notifications for this workflow\'s sessions. * @type {boolean} * @memberof UpdateWorkflowNERM */ 'disable_failure_email_notifications'?: boolean | null; } export declare const UpdateWorkflowNERMStatusNerm: { readonly Enabled: "Enabled"; readonly Disabled: "Disabled"; }; export type UpdateWorkflowNERMStatusNerm = typeof UpdateWorkflowNERMStatusNerm[keyof typeof UpdateWorkflowNERMStatusNerm]; /** * * @export * @interface UrlNERM */ export interface UrlNERM { /** * * @type {string} * @memberof UrlNERM */ 'url'?: string; } /** * * @export * @interface User1NERM */ export interface User1NERM { /** * The user name * @type {string} * @memberof User1NERM */ 'name': string; /** * The user email * @type {string} * @memberof User1NERM */ 'email': string; /** * The user type * @type {string} * @memberof User1NERM */ 'type': User1NERMTypeNerm; /** * The user profile id. Not required for NeprofileUser * @type {string} * @memberof User1NERM */ 'profile_id'?: string; /** * The user description * @type {string} * @memberof User1NERM */ 'title'?: string; /** * The user status * @type {string} * @memberof User1NERM */ 'status'?: User1NERMStatusNerm; /** * The user login * @type {string} * @memberof User1NERM */ 'login': string; /** * The user group strings * @type {string} * @memberof User1NERM */ 'group_strings'?: string; /** * The locale the user prefers to use * @type {string} * @memberof User1NERM */ 'locale'?: string; /** * The user password. Not required for NeprofileUser * @type {string} * @memberof User1NERM */ 'password'?: string; /** * The SailPoint Identity ID associated with this user * @type {string} * @memberof User1NERM */ 'sailpoint_identity_id'?: string; } export declare const User1NERMTypeNerm: { readonly NeprofileUser: "NeprofileUser"; readonly NeaccessUser: "NeaccessUser"; }; export type User1NERMTypeNerm = typeof User1NERMTypeNerm[keyof typeof User1NERMTypeNerm]; export declare const User1NERMStatusNerm: { readonly Active: "Active"; readonly Pending: "Pending"; readonly Disabled: "Disabled"; }; export type User1NERMStatusNerm = typeof User1NERMStatusNerm[keyof typeof User1NERMStatusNerm]; /** * * @export * @interface UserManager1NERM */ export interface UserManager1NERM { /** * * @type {string} * @memberof UserManager1NERM */ 'user_id'?: string; /** * * @type {string} * @memberof UserManager1NERM */ 'manager_id'?: string; } /** * * @export * @interface UserManagerNERM */ export interface UserManagerNERM { /** * * @type {string} * @memberof UserManagerNERM */ 'id'?: string; /** * * @type {string} * @memberof UserManagerNERM */ 'uid'?: string; /** * * @type {string} * @memberof UserManagerNERM */ 'user_id'?: string; /** * * @type {string} * @memberof UserManagerNERM */ 'manager_id'?: string; } /** * * @export * @interface UserManagersNERM */ export interface UserManagersNERM { /** * * @type {Array} * @memberof UserManagersNERM */ 'user_managers'?: Array; } /** * * @export * @interface UserNERM */ export interface UserNERM { /** * ID of the object to retrieve or update * @type {string} * @memberof UserNERM */ 'id'?: string; /** * UID of the user * @type {string} * @memberof UserNERM */ 'uid'?: string; /** * The name * @type {string} * @memberof UserNERM */ 'name'?: string; /** * The email * @type {string} * @memberof UserNERM */ 'email'?: string; /** * Type of user * @type {string} * @memberof UserNERM */ 'type'?: UserNERMTypeNerm; /** * The title * @type {string} * @memberof UserNERM */ 'title'?: string; /** * Status of the user * @type {string} * @memberof UserNERM */ 'status'?: UserNERMStatusNerm; /** * The login * @type {string} * @memberof UserNERM */ 'login'?: string; /** * When the user last logged in * @type {string} * @memberof UserNERM */ 'last_login'?: string; /** * When cookies were accepted * @type {string} * @memberof UserNERM */ 'cookies_accepted_at'?: string; /** * The locale the user prefers to use * @type {string} * @memberof UserNERM */ 'preferred_language'?: string; /** * The locale the user prefers to use * @type {string} * @memberof UserNERM */ 'locale'?: string; /** * Group strings configured on the customer\'s Active Directory configuration, provided by the IDP at the moment on authentication. * @type {string} * @memberof UserNERM */ 'group_strings'?: string; /** * The identity ID of the user in ISC * @type {string} * @memberof UserNERM */ 'sailpoint_identity_id'?: string; } export declare const UserNERMTypeNerm: { readonly NeprofileUser: "NeprofileUser"; readonly NeaccessUser: "NeaccessUser"; }; export type UserNERMTypeNerm = typeof UserNERMTypeNerm[keyof typeof UserNERMTypeNerm]; export declare const UserNERMStatusNerm: { readonly Active: "Active"; readonly Pending: "Pending"; readonly Disabled: "Disabled"; }; export type UserNERMStatusNerm = typeof UserNERMStatusNerm[keyof typeof UserNERMStatusNerm]; /** * * @export * @interface UserProfile1NERM */ export interface UserProfile1NERM { /** * * @type {string} * @memberof UserProfile1NERM */ 'user_id'?: string; /** * * @type {string} * @memberof UserProfile1NERM */ 'profile_id'?: string; /** * * @type {string} * @memberof UserProfile1NERM */ 'ne_attribute_id'?: string; /** * * @type {string} * @memberof UserProfile1NERM */ 'relationship_type'?: UserProfile1NERMRelationshipTypeNerm; } export declare const UserProfile1NERMRelationshipTypeNerm: { readonly Owner: "owner"; readonly Contributor: "contributor"; }; export type UserProfile1NERMRelationshipTypeNerm = typeof UserProfile1NERMRelationshipTypeNerm[keyof typeof UserProfile1NERMRelationshipTypeNerm]; /** * * @export * @interface UserProfileNERM */ export interface UserProfileNERM { /** * * @type {string} * @memberof UserProfileNERM */ 'id'?: string; /** * * @type {string} * @memberof UserProfileNERM */ 'uid'?: string; /** * * @type {string} * @memberof UserProfileNERM */ 'user_id'?: string; /** * * @type {string} * @memberof UserProfileNERM */ 'profile_id'?: string; /** * * @type {string} * @memberof UserProfileNERM */ 'ne_attribute_id'?: string; /** * * @type {string} * @memberof UserProfileNERM */ 'relationship_type'?: UserProfileNERMRelationshipTypeNerm; } export declare const UserProfileNERMRelationshipTypeNerm: { readonly Owner: "owner"; readonly Contributor: "contributor"; }; export type UserProfileNERMRelationshipTypeNerm = typeof UserProfileNERMRelationshipTypeNerm[keyof typeof UserProfileNERMRelationshipTypeNerm]; /** * * @export * @interface UserProfilesNERM */ export interface UserProfilesNERM { /** * * @type {Array} * @memberof UserProfilesNERM */ 'user_profiles'?: Array; } /** * * @export * @interface UserRole1NERM */ export interface UserRole1NERM { /** * * @type {string} * @memberof UserRole1NERM */ 'user_id'?: string; /** * * @type {string} * @memberof UserRole1NERM */ 'role_id'?: string; } /** * * @export * @interface UserRoleNERM */ export interface UserRoleNERM { /** * * @type {string} * @memberof UserRoleNERM */ 'id'?: string; /** * * @type {string} * @memberof UserRoleNERM */ 'uid'?: string; /** * * @type {string} * @memberof UserRoleNERM */ 'user_id'?: string; /** * * @type {string} * @memberof UserRoleNERM */ 'role_id'?: string; } /** * * @export * @interface UserRolesNERM */ export interface UserRolesNERM { /** * * @type {Array} * @memberof UserRolesNERM */ 'user_roles'?: Array; } /** * * @export * @interface UsernamePasswordActionNERM */ export interface UsernamePasswordActionNERM { /** * The workflow the workflow action belongs to. * @type {string} * @memberof UsernamePasswordActionNERM */ 'workflow_id': string; /** * The description of the workflow action. * @type {string} * @memberof UsernamePasswordActionNERM */ 'description': string; /** * If the workflow action is archived or not. * @type {boolean} * @memberof UsernamePasswordActionNERM */ 'archived'?: boolean; } /** * * @export * @interface UsersNERM */ export interface UsersNERM { /** * * @type {Array} * @memberof UsersNERM */ 'users'?: Array; } /** * * @export * @interface ValidationErrorsNERM */ export interface ValidationErrorsNERM { /** * * @type {object} * @memberof ValidationErrorsNERM */ 'error'?: object; /** * * @type {object} * @memberof ValidationErrorsNERM */ 'errors'?: object; } /** * * @export * @interface WorkflowActionNERM */ export interface WorkflowActionNERM { /** * The workflow the workflow action belongs to. * @type {string} * @memberof WorkflowActionNERM */ 'workflow_id': string; /** * The description of the workflow action. * @type {string} * @memberof WorkflowActionNERM */ 'description'?: string; /** * The page the workflow action should render. * @type {string} * @memberof WorkflowActionNERM */ 'page_id': string; /** * If the requester should be added as the owner of the profile to be created. * @type {boolean} * @memberof WorkflowActionNERM */ 'add_requester_as_owner'?: boolean; /** * The attribute storing the email address for the workflow action. * @type {string} * @memberof WorkflowActionNERM */ 'email_attribute_id'?: string; /** * The email addresses for the workflow action. * @type {Array} * @memberof WorkflowActionNERM */ 'email_addresses'?: Array; /** * The new status for the Status Change workflow action. * @type {string} * @memberof WorkflowActionNERM */ 'new_status'?: string; /** * If the workflow action is archived or not. * @type {boolean} * @memberof WorkflowActionNERM */ 'archived'?: boolean; /** * If the workflow action is skippable or not. * @type {boolean} * @memberof WorkflowActionNERM */ 'skippable'?: boolean; /** * If the workflow action requires a comment or not. * @type {boolean} * @memberof WorkflowActionNERM */ 'requires_comment'?: boolean; } /** * * @export * @interface WorkflowActionPerformers1NERM */ export interface WorkflowActionPerformers1NERM { /** * Specify the id of the user attribute to perform the action. * @type {string} * @memberof WorkflowActionPerformers1NERM */ 'contributor_attribute_id'?: string; /** * Set to true to allow profile contributor to perform the action. * @type {boolean} * @memberof WorkflowActionPerformers1NERM */ 'contributors'?: boolean; /** * Specify the id of the user attribute to perform the action. * @type {string} * @memberof WorkflowActionPerformers1NERM */ 'contributors_manager_attribute_id'?: string; /** * Set to true to allow profile owner to perform the action. * @type {boolean} * @memberof WorkflowActionPerformers1NERM */ 'owner'?: boolean; /** * Specify the id of the profile attribute to perform the action. * @type {string} * @memberof WorkflowActionPerformers1NERM */ 'profiles_contributors_attribute_id'?: string; /** * Set to true to allow requester from the request to perform the action. * @type {boolean} * @memberof WorkflowActionPerformers1NERM */ 'requester'?: boolean; /** * Set to true to allow the requester\'s manager from the request to perform the action. * @type {boolean} * @memberof WorkflowActionPerformers1NERM */ 'requesters_manager'?: boolean; /** * Specify the id of the workflow action you would like to create the workflow action performer/s for. * @type {string} * @memberof WorkflowActionPerformers1NERM */ 'workflow_action_id'?: string; } /** * * @export * @interface WorkflowActionPerformersNERM */ export interface WorkflowActionPerformersNERM { /** * The id of the workflow action performer that was created. * @type {string} * @memberof WorkflowActionPerformersNERM */ 'id'?: string; /** * The id of the user attribute to perform the action. * @type {string} * @memberof WorkflowActionPerformersNERM */ 'contributor_attribute_id'?: string; /** * Set to allow profile contributor to perform the action. * @type {boolean} * @memberof WorkflowActionPerformersNERM */ 'contributors'?: boolean; /** * The id of the user attribute to perform the action. * @type {string} * @memberof WorkflowActionPerformersNERM */ 'contributors_manager_attribute_id'?: string; /** * Set to allow profile owner to perform the action. * @type {boolean} * @memberof WorkflowActionPerformersNERM */ 'owner'?: boolean; /** * The id of the profile attribute to perform the action. * @type {string} * @memberof WorkflowActionPerformersNERM */ 'profiles_contributors_attribute_id'?: string; /** * Set to allow requester from the request to perform the action. * @type {boolean} * @memberof WorkflowActionPerformersNERM */ 'requester'?: boolean; /** * Set to allow the requester\'s manager from the request to perform the action. * @type {boolean} * @memberof WorkflowActionPerformersNERM */ 'requesters_manager'?: boolean; /** * The id of the workflow action. * @type {string} * @memberof WorkflowActionPerformersNERM */ 'workflow_action_id'?: string; } /** * * @export * @interface WorkflowPageNERM */ export interface WorkflowPageNERM { /** * The user-specified identifier of the page * @type {string} * @memberof WorkflowPageNERM */ 'uid'?: string; /** * The description of the page * @type {string} * @memberof WorkflowPageNERM */ 'description'?: string; /** * The name of the page * @type {string} * @memberof WorkflowPageNERM */ 'name'?: string; /** * Determines whether the page is archived * @type {boolean} * @memberof WorkflowPageNERM */ 'archived'?: boolean; /** * The id of the form * @type {string} * @memberof WorkflowPageNERM */ 'id'?: string; } /** * * @export * @interface WorkflowSession1NERM */ export interface WorkflowSession1NERM { /** * The workflow id. * @type {string} * @memberof WorkflowSession1NERM */ 'workflow_id': string; /** * The requester\'s id. * @type {string} * @memberof WorkflowSession1NERM */ 'requester_id': string; /** * The requester type. * @type {string} * @memberof WorkflowSession1NERM */ 'requester_type': WorkflowSession1NERMRequesterTypeNerm; /** * The profile this workflow session will be working with. Only Applicable for Update workflows * @type {string} * @memberof WorkflowSession1NERM */ 'profile_id'?: string; /** * The profiles this workflow session will be working with. Only Applicable for Batch workflows * @type {Array} * @memberof WorkflowSession1NERM */ 'profile_ids'?: Array; /** * The attributes associated with the workflow session. * @type {{ [key: string]: string; }} * @memberof WorkflowSession1NERM */ 'attributes'?: { [key: string]: string; }; } export declare const WorkflowSession1NERMRequesterTypeNerm: { readonly User: "User"; readonly NeprofileUser: "NeprofileUser"; readonly NeaccessUser: "NeaccessUser"; }; export type WorkflowSession1NERMRequesterTypeNerm = typeof WorkflowSession1NERMRequesterTypeNerm[keyof typeof WorkflowSession1NERMRequesterTypeNerm]; /** * * @export * @interface WorkflowSessionNERM */ export interface WorkflowSessionNERM { /** * The objects ID. * @type {string} * @memberof WorkflowSessionNERM */ 'id'?: string; /** * The objects UID. * @type {string} * @memberof WorkflowSessionNERM */ 'uid'?: string; /** * The workflow id. * @type {string} * @memberof WorkflowSessionNERM */ 'workflow_id'?: string; /** * The requester\'s id. * @type {string} * @memberof WorkflowSessionNERM */ 'requester_id'?: string; /** * The requester type. * @type {string} * @memberof WorkflowSessionNERM */ 'requester_type'?: WorkflowSessionNERMRequesterTypeNerm; /** * The profile this workflow session will be working with. Only Applicable for Update workflows * @type {string} * @memberof WorkflowSessionNERM */ 'profile_id'?: string; /** * The profiles this workflow session will be working with. Only Applicable for Batch workflows * @type {Array} * @memberof WorkflowSessionNERM */ 'profile_ids'?: Array; /** * The status of the workflow session. * @type {string} * @memberof WorkflowSessionNERM */ 'status'?: WorkflowSessionNERMStatusNerm; /** * The attributes asscoiated with the workflow session. * @type {{ [key: string]: string; }} * @memberof WorkflowSessionNERM */ 'attributes'?: { [key: string]: string; }; } export declare const WorkflowSessionNERMRequesterTypeNerm: { readonly User: "User"; readonly NeprofileUser: "NeprofileUser"; readonly NeaccessUser: "NeaccessUser"; }; export type WorkflowSessionNERMRequesterTypeNerm = typeof WorkflowSessionNERMRequesterTypeNerm[keyof typeof WorkflowSessionNERMRequesterTypeNerm]; export declare const WorkflowSessionNERMStatusNerm: { readonly ApiRequestSent: "api_request_sent"; readonly Approved: "approved"; readonly Assigned: "assigned"; readonly AttemptingToStartWorkflow: "attempting_to_start_workflow"; readonly AuthStatus1: "AUTH-STATUS1"; readonly AuthStatus2: "AUTH-STATUS2"; readonly AuthStatus3: "AUTH-STATUS3"; readonly AuthStatus4: "AUTH-STATUS4"; readonly AuthStatus5: "AUTH-STATUS5"; readonly AuthStatus6: "AUTH-STATUS6"; readonly AuthStatus7: "AUTH-STATUS7"; readonly AuthStatus8: "AUTH-STATUS8"; readonly AuthStatus9: "AUTH-STATUS9"; readonly AutoAssigned: "auto_assigned"; readonly BatchCompleted: "batch_completed"; readonly CheckingForDuplicates: "checking_for_duplicates"; readonly Closed: "closed"; readonly Completed: "completed"; readonly CourionAdd: "courion_add"; readonly CourionExtend: "courion_extend"; readonly CourionTerminate: "courion_terminate"; readonly CourionUpdate: "courion_update"; readonly DuplicatesResolved: "duplicates_resolved"; readonly Failed: "failed"; readonly Fulfilled: "fulfilled"; readonly InvitationSent: "invitation_sent"; readonly LdapProvided: "ldap_provided"; readonly New: "new"; readonly NonEmployeeCreated: "non_employee_created"; readonly NonEmployeeUpdated: "non_employee_updated"; readonly Notified: "notified"; readonly PendingApproval: "pending_approval"; readonly PendingAssignment: "pending_assignment"; readonly PendingCourionAdd: "pending_courion_add"; readonly PendingCourionExtend: "pending_courion_extend"; readonly PendingCourionTerminate: "pending_courion_terminate"; readonly PendingCourionUpdate: "pending_courion_update"; readonly PendingCreation: "pending_creation"; readonly PendingFulfillment: "pending_fulfillment"; readonly PendingLdap: "pending_ldap"; readonly PendingNotification: "pending_notification"; readonly PendingProfileSelect: "pending_profile_select"; readonly PendingRequest: "pending_request"; readonly PendingReview: "pending_review"; readonly PendingStatusChange: "pending_status_change"; readonly PendingStoredProcedure: "pending_stored_procedure"; readonly PendingTrigger: "pending_trigger"; readonly PendingUpdate: "pending_update"; readonly Processing: "processing"; readonly ProfileCheckComplete: "profile_check_complete"; readonly ProfilesSelected: "profiles_selected"; readonly Rejected: "rejected"; readonly Requested: "requested"; readonly Reviewed: "reviewed"; readonly SoapRequestSent: "soap_request_sent"; readonly StartedWorkflow: "started_workflow"; readonly StatusChanged: "status_changed"; readonly StoredProcedure: "stored_procedure"; readonly UnAssigned: "un_assigned"; readonly WaitingOnWorkflow: "waiting_on_workflow"; readonly WorkflowChanged: "workflow_changed"; }; export type WorkflowSessionNERMStatusNerm = typeof WorkflowSessionNERMStatusNerm[keyof typeof WorkflowSessionNERMStatusNerm]; /** * AdvancedSearchNERMApi - axios parameter creator * @export */ export declare const AdvancedSearchNERMApiAxiosParamCreator: (configuration?: Configuration) => { /** * Get saved advanced search queries * @summary Get saved advanced search queries * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAdvancedSearch: (axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update a saved advanced search query * @summary Update a saved advanced search * @param {string} id ID of the object to retrieve, update, or delete * @param {SubmitAdvancedSearchRequestNERM} submitAdvancedSearchRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchAdvancedSearch: (id: string, submitAdvancedSearchRequestNERM: SubmitAdvancedSearchRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Run an advanced search for profiles, without saving the query * @summary Run profiles advanced search * @param {SubmitAdvancedSearchRequestNERM} submitAdvancedSearchRequestNERM * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {string} [order] The field to order results by. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ searchAdvancedSearch: (submitAdvancedSearchRequestNERM: SubmitAdvancedSearchRequestNERM, limit?: number, offset?: number, order?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Run a saved advanced search query * @summary Run a saved advanced search * @param {string} id ID of the object to retrieve, update, or delete * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {string} [order] The field to order results by. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ searchAdvancedSearchbyID: (id: string, limit?: number, offset?: number, order?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Save an advanced search query for later use * @summary Save an advanced search query * @param {SubmitAdvancedSearchRequestNERM} submitAdvancedSearchRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitAdvancedSearch: (submitAdvancedSearchRequestNERM: SubmitAdvancedSearchRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * AdvancedSearchNERMApi - functional programming interface * @export */ export declare const AdvancedSearchNERMApiFp: (configuration?: Configuration) => { /** * Get saved advanced search queries * @summary Get saved advanced search queries * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAdvancedSearch(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a saved advanced search query * @summary Update a saved advanced search * @param {string} id ID of the object to retrieve, update, or delete * @param {SubmitAdvancedSearchRequestNERM} submitAdvancedSearchRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchAdvancedSearch(id: string, submitAdvancedSearchRequestNERM: SubmitAdvancedSearchRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Run an advanced search for profiles, without saving the query * @summary Run profiles advanced search * @param {SubmitAdvancedSearchRequestNERM} submitAdvancedSearchRequestNERM * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {string} [order] The field to order results by. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ searchAdvancedSearch(submitAdvancedSearchRequestNERM: SubmitAdvancedSearchRequestNERM, limit?: number, offset?: number, order?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Run a saved advanced search query * @summary Run a saved advanced search * @param {string} id ID of the object to retrieve, update, or delete * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {string} [order] The field to order results by. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ searchAdvancedSearchbyID(id: string, limit?: number, offset?: number, order?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Save an advanced search query for later use * @summary Save an advanced search query * @param {SubmitAdvancedSearchRequestNERM} submitAdvancedSearchRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitAdvancedSearch(submitAdvancedSearchRequestNERM: SubmitAdvancedSearchRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * AdvancedSearchNERMApi - factory interface * @export */ export declare const AdvancedSearchNERMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Get saved advanced search queries * @summary Get saved advanced search queries * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAdvancedSearch(axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update a saved advanced search query * @summary Update a saved advanced search * @param {AdvancedSearchNERMApiPatchAdvancedSearchRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchAdvancedSearch(requestParameters: AdvancedSearchNERMApiPatchAdvancedSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Run an advanced search for profiles, without saving the query * @summary Run profiles advanced search * @param {AdvancedSearchNERMApiSearchAdvancedSearchRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ searchAdvancedSearch(requestParameters: AdvancedSearchNERMApiSearchAdvancedSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Run a saved advanced search query * @summary Run a saved advanced search * @param {AdvancedSearchNERMApiSearchAdvancedSearchbyIDRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ searchAdvancedSearchbyID(requestParameters: AdvancedSearchNERMApiSearchAdvancedSearchbyIDRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Save an advanced search query for later use * @summary Save an advanced search query * @param {AdvancedSearchNERMApiSubmitAdvancedSearchRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitAdvancedSearch(requestParameters: AdvancedSearchNERMApiSubmitAdvancedSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for patchAdvancedSearch operation in AdvancedSearchNERMApi. * @export * @interface AdvancedSearchNERMApiPatchAdvancedSearchRequest */ export interface AdvancedSearchNERMApiPatchAdvancedSearchRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof AdvancedSearchNERMApiPatchAdvancedSearch */ readonly id: string; /** * * @type {SubmitAdvancedSearchRequestNERM} * @memberof AdvancedSearchNERMApiPatchAdvancedSearch */ readonly submitAdvancedSearchRequestNERM: SubmitAdvancedSearchRequestNERM; } /** * Request parameters for searchAdvancedSearch operation in AdvancedSearchNERMApi. * @export * @interface AdvancedSearchNERMApiSearchAdvancedSearchRequest */ export interface AdvancedSearchNERMApiSearchAdvancedSearchRequest { /** * * @type {SubmitAdvancedSearchRequestNERM} * @memberof AdvancedSearchNERMApiSearchAdvancedSearch */ readonly submitAdvancedSearchRequestNERM: SubmitAdvancedSearchRequestNERM; /** * The maximum number of items to return. * @type {number} * @memberof AdvancedSearchNERMApiSearchAdvancedSearch */ readonly limit?: number; /** * The number of items to skip before starting to collect the result set. * @type {number} * @memberof AdvancedSearchNERMApiSearchAdvancedSearch */ readonly offset?: number; /** * The field to order results by. * @type {string} * @memberof AdvancedSearchNERMApiSearchAdvancedSearch */ readonly order?: string; } /** * Request parameters for searchAdvancedSearchbyID operation in AdvancedSearchNERMApi. * @export * @interface AdvancedSearchNERMApiSearchAdvancedSearchbyIDRequest */ export interface AdvancedSearchNERMApiSearchAdvancedSearchbyIDRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof AdvancedSearchNERMApiSearchAdvancedSearchbyID */ readonly id: string; /** * The maximum number of items to return. * @type {number} * @memberof AdvancedSearchNERMApiSearchAdvancedSearchbyID */ readonly limit?: number; /** * The number of items to skip before starting to collect the result set. * @type {number} * @memberof AdvancedSearchNERMApiSearchAdvancedSearchbyID */ readonly offset?: number; /** * The field to order results by. * @type {string} * @memberof AdvancedSearchNERMApiSearchAdvancedSearchbyID */ readonly order?: string; } /** * Request parameters for submitAdvancedSearch operation in AdvancedSearchNERMApi. * @export * @interface AdvancedSearchNERMApiSubmitAdvancedSearchRequest */ export interface AdvancedSearchNERMApiSubmitAdvancedSearchRequest { /** * * @type {SubmitAdvancedSearchRequestNERM} * @memberof AdvancedSearchNERMApiSubmitAdvancedSearch */ readonly submitAdvancedSearchRequestNERM: SubmitAdvancedSearchRequestNERM; } /** * AdvancedSearchNERMApi - object-oriented interface * @export * @class AdvancedSearchNERMApi * @extends {BaseAPI} */ export declare class AdvancedSearchNERMApi extends BaseAPI { /** * Get saved advanced search queries * @summary Get saved advanced search queries * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AdvancedSearchNERMApi */ getAdvancedSearch(axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update a saved advanced search query * @summary Update a saved advanced search * @param {AdvancedSearchNERMApiPatchAdvancedSearchRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AdvancedSearchNERMApi */ patchAdvancedSearch(requestParameters: AdvancedSearchNERMApiPatchAdvancedSearchRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Run an advanced search for profiles, without saving the query * @summary Run profiles advanced search * @param {AdvancedSearchNERMApiSearchAdvancedSearchRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AdvancedSearchNERMApi */ searchAdvancedSearch(requestParameters: AdvancedSearchNERMApiSearchAdvancedSearchRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Run a saved advanced search query * @summary Run a saved advanced search * @param {AdvancedSearchNERMApiSearchAdvancedSearchbyIDRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AdvancedSearchNERMApi */ searchAdvancedSearchbyID(requestParameters: AdvancedSearchNERMApiSearchAdvancedSearchbyIDRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Save an advanced search query for later use * @summary Save an advanced search query * @param {AdvancedSearchNERMApiSubmitAdvancedSearchRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AdvancedSearchNERMApi */ submitAdvancedSearch(requestParameters: AdvancedSearchNERMApiSubmitAdvancedSearchRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * AttributeOptionsNERMApi - axios parameter creator * @export */ export declare const AttributeOptionsNERMApiAxiosParamCreator: (configuration?: Configuration) => { /** * Delete a option based attribute value by id * @summary Delete option based attribute value * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteAttributeOptionById: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Delete a option based attribute value by UID (user-specified identifier) * @summary Delete option value * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteAttributeOptionByUid: (uid?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Info for a specific option based attribute value by id * @summary Find option based attribute value * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAttributeOptionById: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Get a specific option based attribute value by UID (user-specified identifier) * @summary Find option attribute value * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAttributeOptionByUid: (uid?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Get option based attribute values * @summary Get option based attribute values * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {string} [order] The field to order results by. * @param {string} [neAttributeId] ID of an attribute for filtering * @param {boolean} [metadata] Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAttributeOptions: (limit?: number, offset?: number, order?: string, neAttributeId?: string, metadata?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update a option based attribute value by id * @summary Update option based attribute value * @param {string} id ID of the object to retrieve, update, or delete * @param {SubmitAttributeOptionRequestNERM} submitAttributeOptionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchAttributeOptionById: (id: string, submitAttributeOptionRequestNERM: SubmitAttributeOptionRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update a option based attribute value by UID (user-specified identifier) * @summary Update option value * @param {SubmitAttributeOptionRequestNERM} submitAttributeOptionRequestNERM * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchAttributeOptionByUid: (submitAttributeOptionRequestNERM: SubmitAttributeOptionRequestNERM, uid?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update multiple option based attribute values * @summary Update multiple option values * @param {SubmitAttributeOptionsRequestNERM} submitAttributeOptionsRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchAttributeOptions: (submitAttributeOptionsRequestNERM: SubmitAttributeOptionsRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Adds a value to an option based attribute * @summary Add value to option * @param {SubmitAttributeOptionRequestNERM} submitAttributeOptionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitAttributeOption: (submitAttributeOptionRequestNERM: SubmitAttributeOptionRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create multiple new option based attribute values * @summary Create multiple option values * @param {SubmitAttributeOptionsRequestNERM} submitAttributeOptionsRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitAttributeOptions: (submitAttributeOptionsRequestNERM: SubmitAttributeOptionsRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * AttributeOptionsNERMApi - functional programming interface * @export */ export declare const AttributeOptionsNERMApiFp: (configuration?: Configuration) => { /** * Delete a option based attribute value by id * @summary Delete option based attribute value * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteAttributeOptionById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete a option based attribute value by UID (user-specified identifier) * @summary Delete option value * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteAttributeOptionByUid(uid?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Info for a specific option based attribute value by id * @summary Find option based attribute value * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAttributeOptionById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get a specific option based attribute value by UID (user-specified identifier) * @summary Find option attribute value * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAttributeOptionByUid(uid?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get option based attribute values * @summary Get option based attribute values * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {string} [order] The field to order results by. * @param {string} [neAttributeId] ID of an attribute for filtering * @param {boolean} [metadata] Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAttributeOptions(limit?: number, offset?: number, order?: string, neAttributeId?: string, metadata?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a option based attribute value by id * @summary Update option based attribute value * @param {string} id ID of the object to retrieve, update, or delete * @param {SubmitAttributeOptionRequestNERM} submitAttributeOptionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchAttributeOptionById(id: string, submitAttributeOptionRequestNERM: SubmitAttributeOptionRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a option based attribute value by UID (user-specified identifier) * @summary Update option value * @param {SubmitAttributeOptionRequestNERM} submitAttributeOptionRequestNERM * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchAttributeOptionByUid(submitAttributeOptionRequestNERM: SubmitAttributeOptionRequestNERM, uid?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update multiple option based attribute values * @summary Update multiple option values * @param {SubmitAttributeOptionsRequestNERM} submitAttributeOptionsRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchAttributeOptions(submitAttributeOptionsRequestNERM: SubmitAttributeOptionsRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Adds a value to an option based attribute * @summary Add value to option * @param {SubmitAttributeOptionRequestNERM} submitAttributeOptionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitAttributeOption(submitAttributeOptionRequestNERM: SubmitAttributeOptionRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create multiple new option based attribute values * @summary Create multiple option values * @param {SubmitAttributeOptionsRequestNERM} submitAttributeOptionsRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitAttributeOptions(submitAttributeOptionsRequestNERM: SubmitAttributeOptionsRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * AttributeOptionsNERMApi - factory interface * @export */ export declare const AttributeOptionsNERMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Delete a option based attribute value by id * @summary Delete option based attribute value * @param {AttributeOptionsNERMApiDeleteAttributeOptionByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteAttributeOptionById(requestParameters: AttributeOptionsNERMApiDeleteAttributeOptionByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Delete a option based attribute value by UID (user-specified identifier) * @summary Delete option value * @param {AttributeOptionsNERMApiDeleteAttributeOptionByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteAttributeOptionByUid(requestParameters?: AttributeOptionsNERMApiDeleteAttributeOptionByUidRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Info for a specific option based attribute value by id * @summary Find option based attribute value * @param {AttributeOptionsNERMApiGetAttributeOptionByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAttributeOptionById(requestParameters: AttributeOptionsNERMApiGetAttributeOptionByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Get a specific option based attribute value by UID (user-specified identifier) * @summary Find option attribute value * @param {AttributeOptionsNERMApiGetAttributeOptionByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAttributeOptionByUid(requestParameters?: AttributeOptionsNERMApiGetAttributeOptionByUidRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Get option based attribute values * @summary Get option based attribute values * @param {AttributeOptionsNERMApiGetAttributeOptionsRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAttributeOptions(requestParameters?: AttributeOptionsNERMApiGetAttributeOptionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update a option based attribute value by id * @summary Update option based attribute value * @param {AttributeOptionsNERMApiPatchAttributeOptionByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchAttributeOptionById(requestParameters: AttributeOptionsNERMApiPatchAttributeOptionByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update a option based attribute value by UID (user-specified identifier) * @summary Update option value * @param {AttributeOptionsNERMApiPatchAttributeOptionByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchAttributeOptionByUid(requestParameters: AttributeOptionsNERMApiPatchAttributeOptionByUidRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update multiple option based attribute values * @summary Update multiple option values * @param {AttributeOptionsNERMApiPatchAttributeOptionsRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchAttributeOptions(requestParameters: AttributeOptionsNERMApiPatchAttributeOptionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Adds a value to an option based attribute * @summary Add value to option * @param {AttributeOptionsNERMApiSubmitAttributeOptionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitAttributeOption(requestParameters: AttributeOptionsNERMApiSubmitAttributeOptionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create multiple new option based attribute values * @summary Create multiple option values * @param {AttributeOptionsNERMApiSubmitAttributeOptionsRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitAttributeOptions(requestParameters: AttributeOptionsNERMApiSubmitAttributeOptionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for deleteAttributeOptionById operation in AttributeOptionsNERMApi. * @export * @interface AttributeOptionsNERMApiDeleteAttributeOptionByIdRequest */ export interface AttributeOptionsNERMApiDeleteAttributeOptionByIdRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof AttributeOptionsNERMApiDeleteAttributeOptionById */ readonly id: string; } /** * Request parameters for deleteAttributeOptionByUid operation in AttributeOptionsNERMApi. * @export * @interface AttributeOptionsNERMApiDeleteAttributeOptionByUidRequest */ export interface AttributeOptionsNERMApiDeleteAttributeOptionByUidRequest { /** * UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @type {string} * @memberof AttributeOptionsNERMApiDeleteAttributeOptionByUid */ readonly uid?: string; } /** * Request parameters for getAttributeOptionById operation in AttributeOptionsNERMApi. * @export * @interface AttributeOptionsNERMApiGetAttributeOptionByIdRequest */ export interface AttributeOptionsNERMApiGetAttributeOptionByIdRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof AttributeOptionsNERMApiGetAttributeOptionById */ readonly id: string; } /** * Request parameters for getAttributeOptionByUid operation in AttributeOptionsNERMApi. * @export * @interface AttributeOptionsNERMApiGetAttributeOptionByUidRequest */ export interface AttributeOptionsNERMApiGetAttributeOptionByUidRequest { /** * UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @type {string} * @memberof AttributeOptionsNERMApiGetAttributeOptionByUid */ readonly uid?: string; } /** * Request parameters for getAttributeOptions operation in AttributeOptionsNERMApi. * @export * @interface AttributeOptionsNERMApiGetAttributeOptionsRequest */ export interface AttributeOptionsNERMApiGetAttributeOptionsRequest { /** * The maximum number of items to return. * @type {number} * @memberof AttributeOptionsNERMApiGetAttributeOptions */ readonly limit?: number; /** * The number of items to skip before starting to collect the result set. * @type {number} * @memberof AttributeOptionsNERMApiGetAttributeOptions */ readonly offset?: number; /** * The field to order results by. * @type {string} * @memberof AttributeOptionsNERMApiGetAttributeOptions */ readonly order?: string; /** * ID of an attribute for filtering * @type {string} * @memberof AttributeOptionsNERMApiGetAttributeOptions */ readonly neAttributeId?: string; /** * Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @type {boolean} * @memberof AttributeOptionsNERMApiGetAttributeOptions */ readonly metadata?: boolean; } /** * Request parameters for patchAttributeOptionById operation in AttributeOptionsNERMApi. * @export * @interface AttributeOptionsNERMApiPatchAttributeOptionByIdRequest */ export interface AttributeOptionsNERMApiPatchAttributeOptionByIdRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof AttributeOptionsNERMApiPatchAttributeOptionById */ readonly id: string; /** * * @type {SubmitAttributeOptionRequestNERM} * @memberof AttributeOptionsNERMApiPatchAttributeOptionById */ readonly submitAttributeOptionRequestNERM: SubmitAttributeOptionRequestNERM; } /** * Request parameters for patchAttributeOptionByUid operation in AttributeOptionsNERMApi. * @export * @interface AttributeOptionsNERMApiPatchAttributeOptionByUidRequest */ export interface AttributeOptionsNERMApiPatchAttributeOptionByUidRequest { /** * * @type {SubmitAttributeOptionRequestNERM} * @memberof AttributeOptionsNERMApiPatchAttributeOptionByUid */ readonly submitAttributeOptionRequestNERM: SubmitAttributeOptionRequestNERM; /** * UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @type {string} * @memberof AttributeOptionsNERMApiPatchAttributeOptionByUid */ readonly uid?: string; } /** * Request parameters for patchAttributeOptions operation in AttributeOptionsNERMApi. * @export * @interface AttributeOptionsNERMApiPatchAttributeOptionsRequest */ export interface AttributeOptionsNERMApiPatchAttributeOptionsRequest { /** * * @type {SubmitAttributeOptionsRequestNERM} * @memberof AttributeOptionsNERMApiPatchAttributeOptions */ readonly submitAttributeOptionsRequestNERM: SubmitAttributeOptionsRequestNERM; } /** * Request parameters for submitAttributeOption operation in AttributeOptionsNERMApi. * @export * @interface AttributeOptionsNERMApiSubmitAttributeOptionRequest */ export interface AttributeOptionsNERMApiSubmitAttributeOptionRequest { /** * * @type {SubmitAttributeOptionRequestNERM} * @memberof AttributeOptionsNERMApiSubmitAttributeOption */ readonly submitAttributeOptionRequestNERM: SubmitAttributeOptionRequestNERM; } /** * Request parameters for submitAttributeOptions operation in AttributeOptionsNERMApi. * @export * @interface AttributeOptionsNERMApiSubmitAttributeOptionsRequest */ export interface AttributeOptionsNERMApiSubmitAttributeOptionsRequest { /** * * @type {SubmitAttributeOptionsRequestNERM} * @memberof AttributeOptionsNERMApiSubmitAttributeOptions */ readonly submitAttributeOptionsRequestNERM: SubmitAttributeOptionsRequestNERM; } /** * AttributeOptionsNERMApi - object-oriented interface * @export * @class AttributeOptionsNERMApi * @extends {BaseAPI} */ export declare class AttributeOptionsNERMApi extends BaseAPI { /** * Delete a option based attribute value by id * @summary Delete option based attribute value * @param {AttributeOptionsNERMApiDeleteAttributeOptionByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AttributeOptionsNERMApi */ deleteAttributeOptionById(requestParameters: AttributeOptionsNERMApiDeleteAttributeOptionByIdRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Delete a option based attribute value by UID (user-specified identifier) * @summary Delete option value * @param {AttributeOptionsNERMApiDeleteAttributeOptionByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AttributeOptionsNERMApi */ deleteAttributeOptionByUid(requestParameters?: AttributeOptionsNERMApiDeleteAttributeOptionByUidRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Info for a specific option based attribute value by id * @summary Find option based attribute value * @param {AttributeOptionsNERMApiGetAttributeOptionByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AttributeOptionsNERMApi */ getAttributeOptionById(requestParameters: AttributeOptionsNERMApiGetAttributeOptionByIdRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Get a specific option based attribute value by UID (user-specified identifier) * @summary Find option attribute value * @param {AttributeOptionsNERMApiGetAttributeOptionByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AttributeOptionsNERMApi */ getAttributeOptionByUid(requestParameters?: AttributeOptionsNERMApiGetAttributeOptionByUidRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Get option based attribute values * @summary Get option based attribute values * @param {AttributeOptionsNERMApiGetAttributeOptionsRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AttributeOptionsNERMApi */ getAttributeOptions(requestParameters?: AttributeOptionsNERMApiGetAttributeOptionsRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update a option based attribute value by id * @summary Update option based attribute value * @param {AttributeOptionsNERMApiPatchAttributeOptionByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AttributeOptionsNERMApi */ patchAttributeOptionById(requestParameters: AttributeOptionsNERMApiPatchAttributeOptionByIdRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update a option based attribute value by UID (user-specified identifier) * @summary Update option value * @param {AttributeOptionsNERMApiPatchAttributeOptionByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AttributeOptionsNERMApi */ patchAttributeOptionByUid(requestParameters: AttributeOptionsNERMApiPatchAttributeOptionByUidRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update multiple option based attribute values * @summary Update multiple option values * @param {AttributeOptionsNERMApiPatchAttributeOptionsRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AttributeOptionsNERMApi */ patchAttributeOptions(requestParameters: AttributeOptionsNERMApiPatchAttributeOptionsRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Adds a value to an option based attribute * @summary Add value to option * @param {AttributeOptionsNERMApiSubmitAttributeOptionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AttributeOptionsNERMApi */ submitAttributeOption(requestParameters: AttributeOptionsNERMApiSubmitAttributeOptionRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create multiple new option based attribute values * @summary Create multiple option values * @param {AttributeOptionsNERMApiSubmitAttributeOptionsRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AttributeOptionsNERMApi */ submitAttributeOptions(requestParameters: AttributeOptionsNERMApiSubmitAttributeOptionsRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * AttributesNERMApi - axios parameter creator * @export */ export declare const AttributesNERMApiAxiosParamCreator: (configuration?: Configuration) => { /** * This endpoint can create an attribute * @summary Create an attribute * @param {CreateAttributeRequestNERM} createAttributeRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createAttribute: (createAttributeRequestNERM: CreateAttributeRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Delete attribute by id * @summary Delete attribute by id * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteAttributeById: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Delete attribute by UID (user-specified identifier) * @summary Delete attribute * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteAttributeByUid: (uid?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Info for a specific attribute * @summary Find attribute data by id * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAttributeById: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Info for a specific attribute by UID (user-specified identifier) * @summary Find attribute data * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAttributeByUid: (uid?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This endpoint can retrieve attribute data in bulk from Lifecycle or you can search for attributes using parameters * @summary Get attribute data in bulk * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {string} [order] The field to order results by. * @param {string} [label] The attribute label to filter by * @param {GetAttributesDataTypeNerm} [dataType] The attribute data type to filter by * @param {boolean} [metadata] Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAttributes: (limit?: number, offset?: number, order?: string, label?: string, dataType?: GetAttributesDataTypeNerm, metadata?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update info for a specific attribute * @summary Update attribute data by id * @param {string} id ID of the object to retrieve, update, or delete * @param {CreateAttributeRequestNERM} createAttributeRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateAttributeById: (id: string, createAttributeRequestNERM: CreateAttributeRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update info for a specific attribute by UID (user-specified identifier) * @summary Update attribute data * @param {CreateAttributeRequestNERM} createAttributeRequestNERM * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateAttributeByUid: (createAttributeRequestNERM: CreateAttributeRequestNERM, uid?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * AttributesNERMApi - functional programming interface * @export */ export declare const AttributesNERMApiFp: (configuration?: Configuration) => { /** * This endpoint can create an attribute * @summary Create an attribute * @param {CreateAttributeRequestNERM} createAttributeRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createAttribute(createAttributeRequestNERM: CreateAttributeRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete attribute by id * @summary Delete attribute by id * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteAttributeById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete attribute by UID (user-specified identifier) * @summary Delete attribute * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteAttributeByUid(uid?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Info for a specific attribute * @summary Find attribute data by id * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAttributeById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Info for a specific attribute by UID (user-specified identifier) * @summary Find attribute data * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAttributeByUid(uid?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This endpoint can retrieve attribute data in bulk from Lifecycle or you can search for attributes using parameters * @summary Get attribute data in bulk * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {string} [order] The field to order results by. * @param {string} [label] The attribute label to filter by * @param {GetAttributesDataTypeNerm} [dataType] The attribute data type to filter by * @param {boolean} [metadata] Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAttributes(limit?: number, offset?: number, order?: string, label?: string, dataType?: GetAttributesDataTypeNerm, metadata?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update info for a specific attribute * @summary Update attribute data by id * @param {string} id ID of the object to retrieve, update, or delete * @param {CreateAttributeRequestNERM} createAttributeRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateAttributeById(id: string, createAttributeRequestNERM: CreateAttributeRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update info for a specific attribute by UID (user-specified identifier) * @summary Update attribute data * @param {CreateAttributeRequestNERM} createAttributeRequestNERM * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateAttributeByUid(createAttributeRequestNERM: CreateAttributeRequestNERM, uid?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * AttributesNERMApi - factory interface * @export */ export declare const AttributesNERMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * This endpoint can create an attribute * @summary Create an attribute * @param {AttributesNERMApiCreateAttributeRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createAttribute(requestParameters: AttributesNERMApiCreateAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Delete attribute by id * @summary Delete attribute by id * @param {AttributesNERMApiDeleteAttributeByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteAttributeById(requestParameters: AttributesNERMApiDeleteAttributeByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Delete attribute by UID (user-specified identifier) * @summary Delete attribute * @param {AttributesNERMApiDeleteAttributeByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteAttributeByUid(requestParameters?: AttributesNERMApiDeleteAttributeByUidRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Info for a specific attribute * @summary Find attribute data by id * @param {AttributesNERMApiGetAttributeByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAttributeById(requestParameters: AttributesNERMApiGetAttributeByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Info for a specific attribute by UID (user-specified identifier) * @summary Find attribute data * @param {AttributesNERMApiGetAttributeByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAttributeByUid(requestParameters?: AttributesNERMApiGetAttributeByUidRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This endpoint can retrieve attribute data in bulk from Lifecycle or you can search for attributes using parameters * @summary Get attribute data in bulk * @param {AttributesNERMApiGetAttributesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAttributes(requestParameters?: AttributesNERMApiGetAttributesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update info for a specific attribute * @summary Update attribute data by id * @param {AttributesNERMApiUpdateAttributeByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateAttributeById(requestParameters: AttributesNERMApiUpdateAttributeByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update info for a specific attribute by UID (user-specified identifier) * @summary Update attribute data * @param {AttributesNERMApiUpdateAttributeByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateAttributeByUid(requestParameters: AttributesNERMApiUpdateAttributeByUidRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createAttribute operation in AttributesNERMApi. * @export * @interface AttributesNERMApiCreateAttributeRequest */ export interface AttributesNERMApiCreateAttributeRequest { /** * * @type {CreateAttributeRequestNERM} * @memberof AttributesNERMApiCreateAttribute */ readonly createAttributeRequestNERM: CreateAttributeRequestNERM; } /** * Request parameters for deleteAttributeById operation in AttributesNERMApi. * @export * @interface AttributesNERMApiDeleteAttributeByIdRequest */ export interface AttributesNERMApiDeleteAttributeByIdRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof AttributesNERMApiDeleteAttributeById */ readonly id: string; } /** * Request parameters for deleteAttributeByUid operation in AttributesNERMApi. * @export * @interface AttributesNERMApiDeleteAttributeByUidRequest */ export interface AttributesNERMApiDeleteAttributeByUidRequest { /** * UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @type {string} * @memberof AttributesNERMApiDeleteAttributeByUid */ readonly uid?: string; } /** * Request parameters for getAttributeById operation in AttributesNERMApi. * @export * @interface AttributesNERMApiGetAttributeByIdRequest */ export interface AttributesNERMApiGetAttributeByIdRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof AttributesNERMApiGetAttributeById */ readonly id: string; } /** * Request parameters for getAttributeByUid operation in AttributesNERMApi. * @export * @interface AttributesNERMApiGetAttributeByUidRequest */ export interface AttributesNERMApiGetAttributeByUidRequest { /** * UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @type {string} * @memberof AttributesNERMApiGetAttributeByUid */ readonly uid?: string; } /** * Request parameters for getAttributes operation in AttributesNERMApi. * @export * @interface AttributesNERMApiGetAttributesRequest */ export interface AttributesNERMApiGetAttributesRequest { /** * The maximum number of items to return. * @type {number} * @memberof AttributesNERMApiGetAttributes */ readonly limit?: number; /** * The number of items to skip before starting to collect the result set. * @type {number} * @memberof AttributesNERMApiGetAttributes */ readonly offset?: number; /** * The field to order results by. * @type {string} * @memberof AttributesNERMApiGetAttributes */ readonly order?: string; /** * The attribute label to filter by * @type {string} * @memberof AttributesNERMApiGetAttributes */ readonly label?: string; /** * The attribute data type to filter by * @type {'text field' | 'text area' | 'drop-down' | 'radio buttons' | 'check boxes' | 'date' | 'tags' | 'attachment' | 'profile select' | 'profile search' | 'owner select' | 'owner search' | 'contributor select' | 'contributor search'} * @memberof AttributesNERMApiGetAttributes */ readonly dataType?: GetAttributesDataTypeNerm; /** * Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @type {boolean} * @memberof AttributesNERMApiGetAttributes */ readonly metadata?: boolean; } /** * Request parameters for updateAttributeById operation in AttributesNERMApi. * @export * @interface AttributesNERMApiUpdateAttributeByIdRequest */ export interface AttributesNERMApiUpdateAttributeByIdRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof AttributesNERMApiUpdateAttributeById */ readonly id: string; /** * * @type {CreateAttributeRequestNERM} * @memberof AttributesNERMApiUpdateAttributeById */ readonly createAttributeRequestNERM: CreateAttributeRequestNERM; } /** * Request parameters for updateAttributeByUid operation in AttributesNERMApi. * @export * @interface AttributesNERMApiUpdateAttributeByUidRequest */ export interface AttributesNERMApiUpdateAttributeByUidRequest { /** * * @type {CreateAttributeRequestNERM} * @memberof AttributesNERMApiUpdateAttributeByUid */ readonly createAttributeRequestNERM: CreateAttributeRequestNERM; /** * UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @type {string} * @memberof AttributesNERMApiUpdateAttributeByUid */ readonly uid?: string; } /** * AttributesNERMApi - object-oriented interface * @export * @class AttributesNERMApi * @extends {BaseAPI} */ export declare class AttributesNERMApi extends BaseAPI { /** * This endpoint can create an attribute * @summary Create an attribute * @param {AttributesNERMApiCreateAttributeRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AttributesNERMApi */ createAttribute(requestParameters: AttributesNERMApiCreateAttributeRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Delete attribute by id * @summary Delete attribute by id * @param {AttributesNERMApiDeleteAttributeByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AttributesNERMApi */ deleteAttributeById(requestParameters: AttributesNERMApiDeleteAttributeByIdRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Delete attribute by UID (user-specified identifier) * @summary Delete attribute * @param {AttributesNERMApiDeleteAttributeByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AttributesNERMApi */ deleteAttributeByUid(requestParameters?: AttributesNERMApiDeleteAttributeByUidRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Info for a specific attribute * @summary Find attribute data by id * @param {AttributesNERMApiGetAttributeByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AttributesNERMApi */ getAttributeById(requestParameters: AttributesNERMApiGetAttributeByIdRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Info for a specific attribute by UID (user-specified identifier) * @summary Find attribute data * @param {AttributesNERMApiGetAttributeByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AttributesNERMApi */ getAttributeByUid(requestParameters?: AttributesNERMApiGetAttributeByUidRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This endpoint can retrieve attribute data in bulk from Lifecycle or you can search for attributes using parameters * @summary Get attribute data in bulk * @param {AttributesNERMApiGetAttributesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AttributesNERMApi */ getAttributes(requestParameters?: AttributesNERMApiGetAttributesRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update info for a specific attribute * @summary Update attribute data by id * @param {AttributesNERMApiUpdateAttributeByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AttributesNERMApi */ updateAttributeById(requestParameters: AttributesNERMApiUpdateAttributeByIdRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update info for a specific attribute by UID (user-specified identifier) * @summary Update attribute data * @param {AttributesNERMApiUpdateAttributeByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AttributesNERMApi */ updateAttributeByUid(requestParameters: AttributesNERMApiUpdateAttributeByUidRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const GetAttributesDataTypeNerm: { readonly TextField: "text field"; readonly TextArea: "text area"; readonly DropDown: "drop-down"; readonly RadioButtons: "radio buttons"; readonly CheckBoxes: "check boxes"; readonly Date: "date"; readonly Tags: "tags"; readonly Attachment: "attachment"; readonly ProfileSelect: "profile select"; readonly ProfileSearch: "profile search"; readonly OwnerSelect: "owner select"; readonly OwnerSearch: "owner search"; readonly ContributorSelect: "contributor select"; readonly ContributorSearch: "contributor search"; }; export type GetAttributesDataTypeNerm = typeof GetAttributesDataTypeNerm[keyof typeof GetAttributesDataTypeNerm]; /** * AuditsNERMApi - axios parameter creator * @export */ export declare const AuditsNERMApiAxiosParamCreator: (configuration?: Configuration) => { /** * This endpoint provides a search engine for Audit Events by optionally combining subject_type, type, and subject_id to narrow down the audit events. A Subject Type of Profile links up to the AuditableProfile types. An Subject Type of WorkflowSession links up to the AuditableWorkflow types. An Subject Type of Get/Post/Patch/Delete links up to the AuditableApi types. The remaining Subject Types link up to the ActiveRecord types (configuration changes). - Any workflow audit event created as of 10/11/2024 will be able to be queried by workflow name, workflow uid, or workflow profile type. - Any profile audit event created as of 10/11/2024 will be able to be queried by profile type. - The entity_type parameter has been updated to subject_type, which now matches what is in the response object. - With the additional query filters added, there is a max of 5 filter parameters at one time (aside from pagination parameters) To accommodate these changes, an API contract change was required. Please read the updated API documentation for the new request syntax. * @summary Query for Audit events * @param {SearchRequestNERM} searchRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ search: (searchRequestNERM: SearchRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * AuditsNERMApi - functional programming interface * @export */ export declare const AuditsNERMApiFp: (configuration?: Configuration) => { /** * This endpoint provides a search engine for Audit Events by optionally combining subject_type, type, and subject_id to narrow down the audit events. A Subject Type of Profile links up to the AuditableProfile types. An Subject Type of WorkflowSession links up to the AuditableWorkflow types. An Subject Type of Get/Post/Patch/Delete links up to the AuditableApi types. The remaining Subject Types link up to the ActiveRecord types (configuration changes). - Any workflow audit event created as of 10/11/2024 will be able to be queried by workflow name, workflow uid, or workflow profile type. - Any profile audit event created as of 10/11/2024 will be able to be queried by profile type. - The entity_type parameter has been updated to subject_type, which now matches what is in the response object. - With the additional query filters added, there is a max of 5 filter parameters at one time (aside from pagination parameters) To accommodate these changes, an API contract change was required. Please read the updated API documentation for the new request syntax. * @summary Query for Audit events * @param {SearchRequestNERM} searchRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ search(searchRequestNERM: SearchRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * AuditsNERMApi - factory interface * @export */ export declare const AuditsNERMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * This endpoint provides a search engine for Audit Events by optionally combining subject_type, type, and subject_id to narrow down the audit events. A Subject Type of Profile links up to the AuditableProfile types. An Subject Type of WorkflowSession links up to the AuditableWorkflow types. An Subject Type of Get/Post/Patch/Delete links up to the AuditableApi types. The remaining Subject Types link up to the ActiveRecord types (configuration changes). - Any workflow audit event created as of 10/11/2024 will be able to be queried by workflow name, workflow uid, or workflow profile type. - Any profile audit event created as of 10/11/2024 will be able to be queried by profile type. - The entity_type parameter has been updated to subject_type, which now matches what is in the response object. - With the additional query filters added, there is a max of 5 filter parameters at one time (aside from pagination parameters) To accommodate these changes, an API contract change was required. Please read the updated API documentation for the new request syntax. * @summary Query for Audit events * @param {AuditsNERMApiSearchRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ search(requestParameters: AuditsNERMApiSearchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for search operation in AuditsNERMApi. * @export * @interface AuditsNERMApiSearchRequest */ export interface AuditsNERMApiSearchRequest { /** * * @type {SearchRequestNERM} * @memberof AuditsNERMApiSearch */ readonly searchRequestNERM: SearchRequestNERM; } /** * AuditsNERMApi - object-oriented interface * @export * @class AuditsNERMApi * @extends {BaseAPI} */ export declare class AuditsNERMApi extends BaseAPI { /** * This endpoint provides a search engine for Audit Events by optionally combining subject_type, type, and subject_id to narrow down the audit events. A Subject Type of Profile links up to the AuditableProfile types. An Subject Type of WorkflowSession links up to the AuditableWorkflow types. An Subject Type of Get/Post/Patch/Delete links up to the AuditableApi types. The remaining Subject Types link up to the ActiveRecord types (configuration changes). - Any workflow audit event created as of 10/11/2024 will be able to be queried by workflow name, workflow uid, or workflow profile type. - Any profile audit event created as of 10/11/2024 will be able to be queried by profile type. - The entity_type parameter has been updated to subject_type, which now matches what is in the response object. - With the additional query filters added, there is a max of 5 filter parameters at one time (aside from pagination parameters) To accommodate these changes, an API contract change was required. Please read the updated API documentation for the new request syntax. * @summary Query for Audit events * @param {AuditsNERMApiSearchRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AuditsNERMApi */ search(requestParameters: AuditsNERMApiSearchRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * ConsolidationNERMApi - axios parameter creator * @export */ export declare const ConsolidationNERMApiAxiosParamCreator: (configuration?: Configuration) => { /** * Consolidation is a deprecated feature, this endpoint provides a mechanism to delete a master record to assist customers. * @summary Delete a master record * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteMasterRecord: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Consolidation is a deprecated feature, this endpoint provides a mechanism to reassign a data record to a new master record to assist customers. * @summary Reassign data record * @param {string} id ID of the object to retrieve, update, or delete * @param {DataRecordsNERM} dataRecordsNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchDataRecord: (id: string, dataRecordsNERM: DataRecordsNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * ConsolidationNERMApi - functional programming interface * @export */ export declare const ConsolidationNERMApiFp: (configuration?: Configuration) => { /** * Consolidation is a deprecated feature, this endpoint provides a mechanism to delete a master record to assist customers. * @summary Delete a master record * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteMasterRecord(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Consolidation is a deprecated feature, this endpoint provides a mechanism to reassign a data record to a new master record to assist customers. * @summary Reassign data record * @param {string} id ID of the object to retrieve, update, or delete * @param {DataRecordsNERM} dataRecordsNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchDataRecord(id: string, dataRecordsNERM: DataRecordsNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ConsolidationNERMApi - factory interface * @export */ export declare const ConsolidationNERMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Consolidation is a deprecated feature, this endpoint provides a mechanism to delete a master record to assist customers. * @summary Delete a master record * @param {ConsolidationNERMApiDeleteMasterRecordRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteMasterRecord(requestParameters: ConsolidationNERMApiDeleteMasterRecordRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Consolidation is a deprecated feature, this endpoint provides a mechanism to reassign a data record to a new master record to assist customers. * @summary Reassign data record * @param {ConsolidationNERMApiPatchDataRecordRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchDataRecord(requestParameters: ConsolidationNERMApiPatchDataRecordRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for deleteMasterRecord operation in ConsolidationNERMApi. * @export * @interface ConsolidationNERMApiDeleteMasterRecordRequest */ export interface ConsolidationNERMApiDeleteMasterRecordRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof ConsolidationNERMApiDeleteMasterRecord */ readonly id: string; } /** * Request parameters for patchDataRecord operation in ConsolidationNERMApi. * @export * @interface ConsolidationNERMApiPatchDataRecordRequest */ export interface ConsolidationNERMApiPatchDataRecordRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof ConsolidationNERMApiPatchDataRecord */ readonly id: string; /** * * @type {DataRecordsNERM} * @memberof ConsolidationNERMApiPatchDataRecord */ readonly dataRecordsNERM: DataRecordsNERM; } /** * ConsolidationNERMApi - object-oriented interface * @export * @class ConsolidationNERMApi * @extends {BaseAPI} */ export declare class ConsolidationNERMApi extends BaseAPI { /** * Consolidation is a deprecated feature, this endpoint provides a mechanism to delete a master record to assist customers. * @summary Delete a master record * @param {ConsolidationNERMApiDeleteMasterRecordRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConsolidationNERMApi */ deleteMasterRecord(requestParameters: ConsolidationNERMApiDeleteMasterRecordRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Consolidation is a deprecated feature, this endpoint provides a mechanism to reassign a data record to a new master record to assist customers. * @summary Reassign data record * @param {ConsolidationNERMApiPatchDataRecordRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ConsolidationNERMApi */ patchDataRecord(requestParameters: ConsolidationNERMApiPatchDataRecordRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * DelegationsNERMApi - axios parameter creator * @export */ export declare const DelegationsNERMApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns a list of delegation records, optionally filtered by delegate, delegator, or expiration status. * @summary List delegations * @param {string} [delegateId] Filter by delegate ID * @param {string} [delegatorId] Filter by delegator ID * @param {boolean} [expired] Filter by expiration status (true for expired, false for not expired) * @param {boolean} [metadata] Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ delegationsGet: (delegateId?: string, delegatorId?: string, expired?: boolean, metadata?: boolean, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Delete an existing delegation record. * @summary Delete a delegation * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ delegationsIdDelete: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Returns a single delegation record by its ID. * @summary Get a single delegation * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ delegationsIdGet: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update an existing delegation record. * @summary Update a delegation * @param {string} id ID of the object to retrieve, update, or delete * @param {DelegationsPostRequestNERM} delegationsPostRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ delegationsIdPatch: (id: string, delegationsPostRequestNERM: DelegationsPostRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a new delegation record. * @summary Create a delegation * @param {DelegationsPostRequestNERM} delegationsPostRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ delegationsPost: (delegationsPostRequestNERM: DelegationsPostRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * DelegationsNERMApi - functional programming interface * @export */ export declare const DelegationsNERMApiFp: (configuration?: Configuration) => { /** * Returns a list of delegation records, optionally filtered by delegate, delegator, or expiration status. * @summary List delegations * @param {string} [delegateId] Filter by delegate ID * @param {string} [delegatorId] Filter by delegator ID * @param {boolean} [expired] Filter by expiration status (true for expired, false for not expired) * @param {boolean} [metadata] Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ delegationsGet(delegateId?: string, delegatorId?: string, expired?: boolean, metadata?: boolean, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete an existing delegation record. * @summary Delete a delegation * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ delegationsIdDelete(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a single delegation record by its ID. * @summary Get a single delegation * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ delegationsIdGet(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update an existing delegation record. * @summary Update a delegation * @param {string} id ID of the object to retrieve, update, or delete * @param {DelegationsPostRequestNERM} delegationsPostRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ delegationsIdPatch(id: string, delegationsPostRequestNERM: DelegationsPostRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a new delegation record. * @summary Create a delegation * @param {DelegationsPostRequestNERM} delegationsPostRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ delegationsPost(delegationsPostRequestNERM: DelegationsPostRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * DelegationsNERMApi - factory interface * @export */ export declare const DelegationsNERMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns a list of delegation records, optionally filtered by delegate, delegator, or expiration status. * @summary List delegations * @param {DelegationsNERMApiDelegationsGetRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ delegationsGet(requestParameters?: DelegationsNERMApiDelegationsGetRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Delete an existing delegation record. * @summary Delete a delegation * @param {DelegationsNERMApiDelegationsIdDeleteRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ delegationsIdDelete(requestParameters: DelegationsNERMApiDelegationsIdDeleteRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a single delegation record by its ID. * @summary Get a single delegation * @param {DelegationsNERMApiDelegationsIdGetRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ delegationsIdGet(requestParameters: DelegationsNERMApiDelegationsIdGetRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update an existing delegation record. * @summary Update a delegation * @param {DelegationsNERMApiDelegationsIdPatchRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ delegationsIdPatch(requestParameters: DelegationsNERMApiDelegationsIdPatchRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a new delegation record. * @summary Create a delegation * @param {DelegationsNERMApiDelegationsPostRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ delegationsPost(requestParameters: DelegationsNERMApiDelegationsPostRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for delegationsGet operation in DelegationsNERMApi. * @export * @interface DelegationsNERMApiDelegationsGetRequest */ export interface DelegationsNERMApiDelegationsGetRequest { /** * Filter by delegate ID * @type {string} * @memberof DelegationsNERMApiDelegationsGet */ readonly delegateId?: string; /** * Filter by delegator ID * @type {string} * @memberof DelegationsNERMApiDelegationsGet */ readonly delegatorId?: string; /** * Filter by expiration status (true for expired, false for not expired) * @type {boolean} * @memberof DelegationsNERMApiDelegationsGet */ readonly expired?: boolean; /** * Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @type {boolean} * @memberof DelegationsNERMApiDelegationsGet */ readonly metadata?: boolean; /** * The maximum number of items to return. * @type {number} * @memberof DelegationsNERMApiDelegationsGet */ readonly limit?: number; /** * The number of items to skip before starting to collect the result set. * @type {number} * @memberof DelegationsNERMApiDelegationsGet */ readonly offset?: number; } /** * Request parameters for delegationsIdDelete operation in DelegationsNERMApi. * @export * @interface DelegationsNERMApiDelegationsIdDeleteRequest */ export interface DelegationsNERMApiDelegationsIdDeleteRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof DelegationsNERMApiDelegationsIdDelete */ readonly id: string; } /** * Request parameters for delegationsIdGet operation in DelegationsNERMApi. * @export * @interface DelegationsNERMApiDelegationsIdGetRequest */ export interface DelegationsNERMApiDelegationsIdGetRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof DelegationsNERMApiDelegationsIdGet */ readonly id: string; } /** * Request parameters for delegationsIdPatch operation in DelegationsNERMApi. * @export * @interface DelegationsNERMApiDelegationsIdPatchRequest */ export interface DelegationsNERMApiDelegationsIdPatchRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof DelegationsNERMApiDelegationsIdPatch */ readonly id: string; /** * * @type {DelegationsPostRequestNERM} * @memberof DelegationsNERMApiDelegationsIdPatch */ readonly delegationsPostRequestNERM: DelegationsPostRequestNERM; } /** * Request parameters for delegationsPost operation in DelegationsNERMApi. * @export * @interface DelegationsNERMApiDelegationsPostRequest */ export interface DelegationsNERMApiDelegationsPostRequest { /** * * @type {DelegationsPostRequestNERM} * @memberof DelegationsNERMApiDelegationsPost */ readonly delegationsPostRequestNERM: DelegationsPostRequestNERM; } /** * DelegationsNERMApi - object-oriented interface * @export * @class DelegationsNERMApi * @extends {BaseAPI} */ export declare class DelegationsNERMApi extends BaseAPI { /** * Returns a list of delegation records, optionally filtered by delegate, delegator, or expiration status. * @summary List delegations * @param {DelegationsNERMApiDelegationsGetRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof DelegationsNERMApi */ delegationsGet(requestParameters?: DelegationsNERMApiDelegationsGetRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Delete an existing delegation record. * @summary Delete a delegation * @param {DelegationsNERMApiDelegationsIdDeleteRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof DelegationsNERMApi */ delegationsIdDelete(requestParameters: DelegationsNERMApiDelegationsIdDeleteRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Returns a single delegation record by its ID. * @summary Get a single delegation * @param {DelegationsNERMApiDelegationsIdGetRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof DelegationsNERMApi */ delegationsIdGet(requestParameters: DelegationsNERMApiDelegationsIdGetRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update an existing delegation record. * @summary Update a delegation * @param {DelegationsNERMApiDelegationsIdPatchRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof DelegationsNERMApi */ delegationsIdPatch(requestParameters: DelegationsNERMApiDelegationsIdPatchRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a new delegation record. * @summary Create a delegation * @param {DelegationsNERMApiDelegationsPostRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof DelegationsNERMApi */ delegationsPost(requestParameters: DelegationsNERMApiDelegationsPostRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * FormAttributesNERMApi - axios parameter creator * @export */ export declare const FormAttributesNERMApiAxiosParamCreator: (configuration?: Configuration) => { /** * This endpoint can create a form attribute * @summary Create a form attribute * @param {CreateFormAttributeRequestNERM} createFormAttributeRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createFormAttribute: (createFormAttributeRequestNERM: CreateFormAttributeRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Delete form attribute by id * @summary Delete form attribute * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteFormAttributeById: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Delete form attribute by UID * @summary Delete form attribute * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteFormAttributeByUid: (uid?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Gets info for a specific form attribute by ID * @summary Get form attribute data * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getFormAttributeById: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Get info for a specific form attribute by UID * @summary Get form attribute data * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getFormAttributeByUid: (uid?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Get defined form attribute in the system * @summary Get form attributes * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getFormAttributes: (axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update info for a specific form attribute by ID * @summary Update form attribute data * @param {string} id ID of the object to retrieve, update, or delete * @param {CreateFormAttributeRequestNERM} createFormAttributeRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateFormAttributeById: (id: string, createFormAttributeRequestNERM: CreateFormAttributeRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update info for a specific form attribute by UID * @summary Update form attribute data * @param {CreateFormAttributeRequestNERM} createFormAttributeRequestNERM * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateFormAttributeByUid: (createFormAttributeRequestNERM: CreateFormAttributeRequestNERM, uid?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * FormAttributesNERMApi - functional programming interface * @export */ export declare const FormAttributesNERMApiFp: (configuration?: Configuration) => { /** * This endpoint can create a form attribute * @summary Create a form attribute * @param {CreateFormAttributeRequestNERM} createFormAttributeRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createFormAttribute(createFormAttributeRequestNERM: CreateFormAttributeRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete form attribute by id * @summary Delete form attribute * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteFormAttributeById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete form attribute by UID * @summary Delete form attribute * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteFormAttributeByUid(uid?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets info for a specific form attribute by ID * @summary Get form attribute data * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getFormAttributeById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get info for a specific form attribute by UID * @summary Get form attribute data * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getFormAttributeByUid(uid?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get defined form attribute in the system * @summary Get form attributes * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getFormAttributes(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update info for a specific form attribute by ID * @summary Update form attribute data * @param {string} id ID of the object to retrieve, update, or delete * @param {CreateFormAttributeRequestNERM} createFormAttributeRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateFormAttributeById(id: string, createFormAttributeRequestNERM: CreateFormAttributeRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update info for a specific form attribute by UID * @summary Update form attribute data * @param {CreateFormAttributeRequestNERM} createFormAttributeRequestNERM * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateFormAttributeByUid(createFormAttributeRequestNERM: CreateFormAttributeRequestNERM, uid?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * FormAttributesNERMApi - factory interface * @export */ export declare const FormAttributesNERMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * This endpoint can create a form attribute * @summary Create a form attribute * @param {FormAttributesNERMApiCreateFormAttributeRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createFormAttribute(requestParameters: FormAttributesNERMApiCreateFormAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Delete form attribute by id * @summary Delete form attribute * @param {FormAttributesNERMApiDeleteFormAttributeByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteFormAttributeById(requestParameters: FormAttributesNERMApiDeleteFormAttributeByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Delete form attribute by UID * @summary Delete form attribute * @param {FormAttributesNERMApiDeleteFormAttributeByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteFormAttributeByUid(requestParameters?: FormAttributesNERMApiDeleteFormAttributeByUidRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Gets info for a specific form attribute by ID * @summary Get form attribute data * @param {FormAttributesNERMApiGetFormAttributeByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getFormAttributeById(requestParameters: FormAttributesNERMApiGetFormAttributeByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Get info for a specific form attribute by UID * @summary Get form attribute data * @param {FormAttributesNERMApiGetFormAttributeByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getFormAttributeByUid(requestParameters?: FormAttributesNERMApiGetFormAttributeByUidRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Get defined form attribute in the system * @summary Get form attributes * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getFormAttributes(axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update info for a specific form attribute by ID * @summary Update form attribute data * @param {FormAttributesNERMApiUpdateFormAttributeByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateFormAttributeById(requestParameters: FormAttributesNERMApiUpdateFormAttributeByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update info for a specific form attribute by UID * @summary Update form attribute data * @param {FormAttributesNERMApiUpdateFormAttributeByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateFormAttributeByUid(requestParameters: FormAttributesNERMApiUpdateFormAttributeByUidRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createFormAttribute operation in FormAttributesNERMApi. * @export * @interface FormAttributesNERMApiCreateFormAttributeRequest */ export interface FormAttributesNERMApiCreateFormAttributeRequest { /** * * @type {CreateFormAttributeRequestNERM} * @memberof FormAttributesNERMApiCreateFormAttribute */ readonly createFormAttributeRequestNERM: CreateFormAttributeRequestNERM; } /** * Request parameters for deleteFormAttributeById operation in FormAttributesNERMApi. * @export * @interface FormAttributesNERMApiDeleteFormAttributeByIdRequest */ export interface FormAttributesNERMApiDeleteFormAttributeByIdRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof FormAttributesNERMApiDeleteFormAttributeById */ readonly id: string; } /** * Request parameters for deleteFormAttributeByUid operation in FormAttributesNERMApi. * @export * @interface FormAttributesNERMApiDeleteFormAttributeByUidRequest */ export interface FormAttributesNERMApiDeleteFormAttributeByUidRequest { /** * UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @type {string} * @memberof FormAttributesNERMApiDeleteFormAttributeByUid */ readonly uid?: string; } /** * Request parameters for getFormAttributeById operation in FormAttributesNERMApi. * @export * @interface FormAttributesNERMApiGetFormAttributeByIdRequest */ export interface FormAttributesNERMApiGetFormAttributeByIdRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof FormAttributesNERMApiGetFormAttributeById */ readonly id: string; } /** * Request parameters for getFormAttributeByUid operation in FormAttributesNERMApi. * @export * @interface FormAttributesNERMApiGetFormAttributeByUidRequest */ export interface FormAttributesNERMApiGetFormAttributeByUidRequest { /** * UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @type {string} * @memberof FormAttributesNERMApiGetFormAttributeByUid */ readonly uid?: string; } /** * Request parameters for updateFormAttributeById operation in FormAttributesNERMApi. * @export * @interface FormAttributesNERMApiUpdateFormAttributeByIdRequest */ export interface FormAttributesNERMApiUpdateFormAttributeByIdRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof FormAttributesNERMApiUpdateFormAttributeById */ readonly id: string; /** * * @type {CreateFormAttributeRequestNERM} * @memberof FormAttributesNERMApiUpdateFormAttributeById */ readonly createFormAttributeRequestNERM: CreateFormAttributeRequestNERM; } /** * Request parameters for updateFormAttributeByUid operation in FormAttributesNERMApi. * @export * @interface FormAttributesNERMApiUpdateFormAttributeByUidRequest */ export interface FormAttributesNERMApiUpdateFormAttributeByUidRequest { /** * * @type {CreateFormAttributeRequestNERM} * @memberof FormAttributesNERMApiUpdateFormAttributeByUid */ readonly createFormAttributeRequestNERM: CreateFormAttributeRequestNERM; /** * UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @type {string} * @memberof FormAttributesNERMApiUpdateFormAttributeByUid */ readonly uid?: string; } /** * FormAttributesNERMApi - object-oriented interface * @export * @class FormAttributesNERMApi * @extends {BaseAPI} */ export declare class FormAttributesNERMApi extends BaseAPI { /** * This endpoint can create a form attribute * @summary Create a form attribute * @param {FormAttributesNERMApiCreateFormAttributeRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof FormAttributesNERMApi */ createFormAttribute(requestParameters: FormAttributesNERMApiCreateFormAttributeRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Delete form attribute by id * @summary Delete form attribute * @param {FormAttributesNERMApiDeleteFormAttributeByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof FormAttributesNERMApi */ deleteFormAttributeById(requestParameters: FormAttributesNERMApiDeleteFormAttributeByIdRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Delete form attribute by UID * @summary Delete form attribute * @param {FormAttributesNERMApiDeleteFormAttributeByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof FormAttributesNERMApi */ deleteFormAttributeByUid(requestParameters?: FormAttributesNERMApiDeleteFormAttributeByUidRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Gets info for a specific form attribute by ID * @summary Get form attribute data * @param {FormAttributesNERMApiGetFormAttributeByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof FormAttributesNERMApi */ getFormAttributeById(requestParameters: FormAttributesNERMApiGetFormAttributeByIdRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Get info for a specific form attribute by UID * @summary Get form attribute data * @param {FormAttributesNERMApiGetFormAttributeByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof FormAttributesNERMApi */ getFormAttributeByUid(requestParameters?: FormAttributesNERMApiGetFormAttributeByUidRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Get defined form attribute in the system * @summary Get form attributes * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof FormAttributesNERMApi */ getFormAttributes(axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update info for a specific form attribute by ID * @summary Update form attribute data * @param {FormAttributesNERMApiUpdateFormAttributeByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof FormAttributesNERMApi */ updateFormAttributeById(requestParameters: FormAttributesNERMApiUpdateFormAttributeByIdRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update info for a specific form attribute by UID * @summary Update form attribute data * @param {FormAttributesNERMApiUpdateFormAttributeByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof FormAttributesNERMApi */ updateFormAttributeByUid(requestParameters: FormAttributesNERMApiUpdateFormAttributeByUidRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * FormsNERMApi - axios parameter creator * @export */ export declare const FormsNERMApiAxiosParamCreator: (configuration?: Configuration) => { /** * This endpoint can create a form * @summary Create a form * @param {CreateFormRequestNERM} createFormRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createForm: (createFormRequestNERM: CreateFormRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Delete form by id * @summary Delete form by id * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteFormById: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Delete form by UID * @summary Delete form by UID * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteFormByUid: (uid?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Info for a specific form * @summary Get form data by Id * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getFormById: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Info for a specific form * @summary Get form data by UID * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getFormByUid: (uid?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Get defined forms in the system * @summary Get forms * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getForms: (axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update info for a specific form * @summary Update form data by id * @param {string} id ID of the object to retrieve, update, or delete * @param {UpdateFormByIdRequestNERM} updateFormByIdRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateFormById: (id: string, updateFormByIdRequestNERM: UpdateFormByIdRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update info for a specific form * @summary Update form data by UID * @param {UpdateFormByIdRequestNERM} updateFormByIdRequestNERM * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateFormByUid: (updateFormByIdRequestNERM: UpdateFormByIdRequestNERM, uid?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * FormsNERMApi - functional programming interface * @export */ export declare const FormsNERMApiFp: (configuration?: Configuration) => { /** * This endpoint can create a form * @summary Create a form * @param {CreateFormRequestNERM} createFormRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createForm(createFormRequestNERM: CreateFormRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete form by id * @summary Delete form by id * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteFormById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete form by UID * @summary Delete form by UID * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteFormByUid(uid?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Info for a specific form * @summary Get form data by Id * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getFormById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Info for a specific form * @summary Get form data by UID * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getFormByUid(uid?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get defined forms in the system * @summary Get forms * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getForms(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update info for a specific form * @summary Update form data by id * @param {string} id ID of the object to retrieve, update, or delete * @param {UpdateFormByIdRequestNERM} updateFormByIdRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateFormById(id: string, updateFormByIdRequestNERM: UpdateFormByIdRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update info for a specific form * @summary Update form data by UID * @param {UpdateFormByIdRequestNERM} updateFormByIdRequestNERM * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateFormByUid(updateFormByIdRequestNERM: UpdateFormByIdRequestNERM, uid?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * FormsNERMApi - factory interface * @export */ export declare const FormsNERMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * This endpoint can create a form * @summary Create a form * @param {FormsNERMApiCreateFormRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createForm(requestParameters: FormsNERMApiCreateFormRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Delete form by id * @summary Delete form by id * @param {FormsNERMApiDeleteFormByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteFormById(requestParameters: FormsNERMApiDeleteFormByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Delete form by UID * @summary Delete form by UID * @param {FormsNERMApiDeleteFormByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteFormByUid(requestParameters?: FormsNERMApiDeleteFormByUidRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Info for a specific form * @summary Get form data by Id * @param {FormsNERMApiGetFormByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getFormById(requestParameters: FormsNERMApiGetFormByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Info for a specific form * @summary Get form data by UID * @param {FormsNERMApiGetFormByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getFormByUid(requestParameters?: FormsNERMApiGetFormByUidRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Get defined forms in the system * @summary Get forms * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getForms(axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update info for a specific form * @summary Update form data by id * @param {FormsNERMApiUpdateFormByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateFormById(requestParameters: FormsNERMApiUpdateFormByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update info for a specific form * @summary Update form data by UID * @param {FormsNERMApiUpdateFormByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateFormByUid(requestParameters: FormsNERMApiUpdateFormByUidRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createForm operation in FormsNERMApi. * @export * @interface FormsNERMApiCreateFormRequest */ export interface FormsNERMApiCreateFormRequest { /** * * @type {CreateFormRequestNERM} * @memberof FormsNERMApiCreateForm */ readonly createFormRequestNERM: CreateFormRequestNERM; } /** * Request parameters for deleteFormById operation in FormsNERMApi. * @export * @interface FormsNERMApiDeleteFormByIdRequest */ export interface FormsNERMApiDeleteFormByIdRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof FormsNERMApiDeleteFormById */ readonly id: string; } /** * Request parameters for deleteFormByUid operation in FormsNERMApi. * @export * @interface FormsNERMApiDeleteFormByUidRequest */ export interface FormsNERMApiDeleteFormByUidRequest { /** * UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @type {string} * @memberof FormsNERMApiDeleteFormByUid */ readonly uid?: string; } /** * Request parameters for getFormById operation in FormsNERMApi. * @export * @interface FormsNERMApiGetFormByIdRequest */ export interface FormsNERMApiGetFormByIdRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof FormsNERMApiGetFormById */ readonly id: string; } /** * Request parameters for getFormByUid operation in FormsNERMApi. * @export * @interface FormsNERMApiGetFormByUidRequest */ export interface FormsNERMApiGetFormByUidRequest { /** * UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @type {string} * @memberof FormsNERMApiGetFormByUid */ readonly uid?: string; } /** * Request parameters for updateFormById operation in FormsNERMApi. * @export * @interface FormsNERMApiUpdateFormByIdRequest */ export interface FormsNERMApiUpdateFormByIdRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof FormsNERMApiUpdateFormById */ readonly id: string; /** * * @type {UpdateFormByIdRequestNERM} * @memberof FormsNERMApiUpdateFormById */ readonly updateFormByIdRequestNERM: UpdateFormByIdRequestNERM; } /** * Request parameters for updateFormByUid operation in FormsNERMApi. * @export * @interface FormsNERMApiUpdateFormByUidRequest */ export interface FormsNERMApiUpdateFormByUidRequest { /** * * @type {UpdateFormByIdRequestNERM} * @memberof FormsNERMApiUpdateFormByUid */ readonly updateFormByIdRequestNERM: UpdateFormByIdRequestNERM; /** * UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @type {string} * @memberof FormsNERMApiUpdateFormByUid */ readonly uid?: string; } /** * FormsNERMApi - object-oriented interface * @export * @class FormsNERMApi * @extends {BaseAPI} */ export declare class FormsNERMApi extends BaseAPI { /** * This endpoint can create a form * @summary Create a form * @param {FormsNERMApiCreateFormRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof FormsNERMApi */ createForm(requestParameters: FormsNERMApiCreateFormRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Delete form by id * @summary Delete form by id * @param {FormsNERMApiDeleteFormByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof FormsNERMApi */ deleteFormById(requestParameters: FormsNERMApiDeleteFormByIdRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Delete form by UID * @summary Delete form by UID * @param {FormsNERMApiDeleteFormByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof FormsNERMApi */ deleteFormByUid(requestParameters?: FormsNERMApiDeleteFormByUidRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Info for a specific form * @summary Get form data by Id * @param {FormsNERMApiGetFormByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof FormsNERMApi */ getFormById(requestParameters: FormsNERMApiGetFormByIdRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Info for a specific form * @summary Get form data by UID * @param {FormsNERMApiGetFormByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof FormsNERMApi */ getFormByUid(requestParameters?: FormsNERMApiGetFormByUidRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Get defined forms in the system * @summary Get forms * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof FormsNERMApi */ getForms(axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update info for a specific form * @summary Update form data by id * @param {FormsNERMApiUpdateFormByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof FormsNERMApi */ updateFormById(requestParameters: FormsNERMApiUpdateFormByIdRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update info for a specific form * @summary Update form data by UID * @param {FormsNERMApiUpdateFormByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof FormsNERMApi */ updateFormByUid(requestParameters: FormsNERMApiUpdateFormByUidRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * IdentityProofingResultsNERMApi - axios parameter creator * @export */ export declare const IdentityProofingResultsNERMApiAxiosParamCreator: (configuration?: Configuration) => { /** * Retrieves identity proofing result data in bulk from Lifecycle * @summary Get identity proofing result data * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {string} [order] The field to order results by. * @param {string} [profileId] Profile ID to filter by * @param {string} [workflowSessionId] Workflow Session ID to filter by * @param {GetIdentityProofingResultsResultNerm} [result] ID Proofing Result to filter by * @param {boolean} [metadata] Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getIdentityProofingResults: (limit?: number, offset?: number, order?: string, profileId?: string, workflowSessionId?: string, result?: GetIdentityProofingResultsResultNerm, metadata?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * IdentityProofingResultsNERMApi - functional programming interface * @export */ export declare const IdentityProofingResultsNERMApiFp: (configuration?: Configuration) => { /** * Retrieves identity proofing result data in bulk from Lifecycle * @summary Get identity proofing result data * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {string} [order] The field to order results by. * @param {string} [profileId] Profile ID to filter by * @param {string} [workflowSessionId] Workflow Session ID to filter by * @param {GetIdentityProofingResultsResultNerm} [result] ID Proofing Result to filter by * @param {boolean} [metadata] Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getIdentityProofingResults(limit?: number, offset?: number, order?: string, profileId?: string, workflowSessionId?: string, result?: GetIdentityProofingResultsResultNerm, metadata?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * IdentityProofingResultsNERMApi - factory interface * @export */ export declare const IdentityProofingResultsNERMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Retrieves identity proofing result data in bulk from Lifecycle * @summary Get identity proofing result data * @param {IdentityProofingResultsNERMApiGetIdentityProofingResultsRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getIdentityProofingResults(requestParameters?: IdentityProofingResultsNERMApiGetIdentityProofingResultsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for getIdentityProofingResults operation in IdentityProofingResultsNERMApi. * @export * @interface IdentityProofingResultsNERMApiGetIdentityProofingResultsRequest */ export interface IdentityProofingResultsNERMApiGetIdentityProofingResultsRequest { /** * The maximum number of items to return. * @type {number} * @memberof IdentityProofingResultsNERMApiGetIdentityProofingResults */ readonly limit?: number; /** * The number of items to skip before starting to collect the result set. * @type {number} * @memberof IdentityProofingResultsNERMApiGetIdentityProofingResults */ readonly offset?: number; /** * The field to order results by. * @type {string} * @memberof IdentityProofingResultsNERMApiGetIdentityProofingResults */ readonly order?: string; /** * Profile ID to filter by * @type {string} * @memberof IdentityProofingResultsNERMApiGetIdentityProofingResults */ readonly profileId?: string; /** * Workflow Session ID to filter by * @type {string} * @memberof IdentityProofingResultsNERMApiGetIdentityProofingResults */ readonly workflowSessionId?: string; /** * ID Proofing Result to filter by * @type {'pass' | 'fail'} * @memberof IdentityProofingResultsNERMApiGetIdentityProofingResults */ readonly result?: GetIdentityProofingResultsResultNerm; /** * Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @type {boolean} * @memberof IdentityProofingResultsNERMApiGetIdentityProofingResults */ readonly metadata?: boolean; } /** * IdentityProofingResultsNERMApi - object-oriented interface * @export * @class IdentityProofingResultsNERMApi * @extends {BaseAPI} */ export declare class IdentityProofingResultsNERMApi extends BaseAPI { /** * Retrieves identity proofing result data in bulk from Lifecycle * @summary Get identity proofing result data * @param {IdentityProofingResultsNERMApiGetIdentityProofingResultsRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IdentityProofingResultsNERMApi */ getIdentityProofingResults(requestParameters?: IdentityProofingResultsNERMApiGetIdentityProofingResultsRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const GetIdentityProofingResultsResultNerm: { readonly Pass: "pass"; readonly Fail: "fail"; }; export type GetIdentityProofingResultsResultNerm = typeof GetIdentityProofingResultsResultNerm[keyof typeof GetIdentityProofingResultsResultNerm]; /** * IscAccountsNERMApi - axios parameter creator * @export */ export declare const IscAccountsNERMApiAxiosParamCreator: (configuration?: Configuration) => { /** * Retrieve schema-mapped profiles collection. It returns a collection of stored profiles, optionally using schema-mapped field names if requested. * @summary Get Profiles * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {boolean} [useSchema] The use_schema parameter returns schema-mapped field names in the Profiles API response when set to true. * @param {boolean} [overrideSyncToggle] The override_sync_toggle parameter returns all non-employee and assignment profiles regardless of the sync status when set to true. * @param {GetSchemaMappedProfilesCollectionCategoryNerm} [category] Filters profiles by profile type category * @param {GetSchemaMappedProfilesCollectionStatusNerm} [status] The status of the profile. It can be multiple values with comma separated. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSchemaMappedProfilesCollection: (limit?: number, offset?: number, useSchema?: boolean, overrideSyncToggle?: boolean, category?: GetSchemaMappedProfilesCollectionCategoryNerm, status?: GetSchemaMappedProfilesCollectionStatusNerm, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * It returns a single stored profile, optionally with schema-mapped field names. * @summary Get Profile * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSingleSchemaMappedProfile: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Updates a profile only through ISC schema-mapped attributes, performs a reverse mapping to match the NERM attributes to update. * @summary Update Profile * @param {string} id ID of the object to retrieve, update, or delete * @param {UpdateProfileRequestNERM} [updateProfileRequestNERM] * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateProfile: (id: string, updateProfileRequestNERM?: UpdateProfileRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * IscAccountsNERMApi - functional programming interface * @export */ export declare const IscAccountsNERMApiFp: (configuration?: Configuration) => { /** * Retrieve schema-mapped profiles collection. It returns a collection of stored profiles, optionally using schema-mapped field names if requested. * @summary Get Profiles * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {boolean} [useSchema] The use_schema parameter returns schema-mapped field names in the Profiles API response when set to true. * @param {boolean} [overrideSyncToggle] The override_sync_toggle parameter returns all non-employee and assignment profiles regardless of the sync status when set to true. * @param {GetSchemaMappedProfilesCollectionCategoryNerm} [category] Filters profiles by profile type category * @param {GetSchemaMappedProfilesCollectionStatusNerm} [status] The status of the profile. It can be multiple values with comma separated. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSchemaMappedProfilesCollection(limit?: number, offset?: number, useSchema?: boolean, overrideSyncToggle?: boolean, category?: GetSchemaMappedProfilesCollectionCategoryNerm, status?: GetSchemaMappedProfilesCollectionStatusNerm, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * It returns a single stored profile, optionally with schema-mapped field names. * @summary Get Profile * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSingleSchemaMappedProfile(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates a profile only through ISC schema-mapped attributes, performs a reverse mapping to match the NERM attributes to update. * @summary Update Profile * @param {string} id ID of the object to retrieve, update, or delete * @param {UpdateProfileRequestNERM} [updateProfileRequestNERM] * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateProfile(id: string, updateProfileRequestNERM?: UpdateProfileRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * IscAccountsNERMApi - factory interface * @export */ export declare const IscAccountsNERMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Retrieve schema-mapped profiles collection. It returns a collection of stored profiles, optionally using schema-mapped field names if requested. * @summary Get Profiles * @param {IscAccountsNERMApiGetSchemaMappedProfilesCollectionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSchemaMappedProfilesCollection(requestParameters?: IscAccountsNERMApiGetSchemaMappedProfilesCollectionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * It returns a single stored profile, optionally with schema-mapped field names. * @summary Get Profile * @param {IscAccountsNERMApiGetSingleSchemaMappedProfileRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSingleSchemaMappedProfile(requestParameters: IscAccountsNERMApiGetSingleSchemaMappedProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Updates a profile only through ISC schema-mapped attributes, performs a reverse mapping to match the NERM attributes to update. * @summary Update Profile * @param {IscAccountsNERMApiUpdateProfileRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateProfile(requestParameters: IscAccountsNERMApiUpdateProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for getSchemaMappedProfilesCollection operation in IscAccountsNERMApi. * @export * @interface IscAccountsNERMApiGetSchemaMappedProfilesCollectionRequest */ export interface IscAccountsNERMApiGetSchemaMappedProfilesCollectionRequest { /** * The maximum number of items to return. * @type {number} * @memberof IscAccountsNERMApiGetSchemaMappedProfilesCollection */ readonly limit?: number; /** * The number of items to skip before starting to collect the result set. * @type {number} * @memberof IscAccountsNERMApiGetSchemaMappedProfilesCollection */ readonly offset?: number; /** * The use_schema parameter returns schema-mapped field names in the Profiles API response when set to true. * @type {boolean} * @memberof IscAccountsNERMApiGetSchemaMappedProfilesCollection */ readonly useSchema?: boolean; /** * The override_sync_toggle parameter returns all non-employee and assignment profiles regardless of the sync status when set to true. * @type {boolean} * @memberof IscAccountsNERMApiGetSchemaMappedProfilesCollection */ readonly overrideSyncToggle?: boolean; /** * Filters profiles by profile type category * @type {'non-employee' | 'assignment'} * @memberof IscAccountsNERMApiGetSchemaMappedProfilesCollection */ readonly category?: GetSchemaMappedProfilesCollectionCategoryNerm; /** * The status of the profile. It can be multiple values with comma separated. * @type {'active' | 'inactive' | 'on leave' | 'terminated'} * @memberof IscAccountsNERMApiGetSchemaMappedProfilesCollection */ readonly status?: GetSchemaMappedProfilesCollectionStatusNerm; } /** * Request parameters for getSingleSchemaMappedProfile operation in IscAccountsNERMApi. * @export * @interface IscAccountsNERMApiGetSingleSchemaMappedProfileRequest */ export interface IscAccountsNERMApiGetSingleSchemaMappedProfileRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof IscAccountsNERMApiGetSingleSchemaMappedProfile */ readonly id: string; } /** * Request parameters for updateProfile operation in IscAccountsNERMApi. * @export * @interface IscAccountsNERMApiUpdateProfileRequest */ export interface IscAccountsNERMApiUpdateProfileRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof IscAccountsNERMApiUpdateProfile */ readonly id: string; /** * * @type {UpdateProfileRequestNERM} * @memberof IscAccountsNERMApiUpdateProfile */ readonly updateProfileRequestNERM?: UpdateProfileRequestNERM; } /** * IscAccountsNERMApi - object-oriented interface * @export * @class IscAccountsNERMApi * @extends {BaseAPI} */ export declare class IscAccountsNERMApi extends BaseAPI { /** * Retrieve schema-mapped profiles collection. It returns a collection of stored profiles, optionally using schema-mapped field names if requested. * @summary Get Profiles * @param {IscAccountsNERMApiGetSchemaMappedProfilesCollectionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IscAccountsNERMApi */ getSchemaMappedProfilesCollection(requestParameters?: IscAccountsNERMApiGetSchemaMappedProfilesCollectionRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * It returns a single stored profile, optionally with schema-mapped field names. * @summary Get Profile * @param {IscAccountsNERMApiGetSingleSchemaMappedProfileRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IscAccountsNERMApi */ getSingleSchemaMappedProfile(requestParameters: IscAccountsNERMApiGetSingleSchemaMappedProfileRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Updates a profile only through ISC schema-mapped attributes, performs a reverse mapping to match the NERM attributes to update. * @summary Update Profile * @param {IscAccountsNERMApiUpdateProfileRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof IscAccountsNERMApi */ updateProfile(requestParameters: IscAccountsNERMApiUpdateProfileRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const GetSchemaMappedProfilesCollectionCategoryNerm: { readonly NonEmployee: "non-employee"; readonly Assignment: "assignment"; }; export type GetSchemaMappedProfilesCollectionCategoryNerm = typeof GetSchemaMappedProfilesCollectionCategoryNerm[keyof typeof GetSchemaMappedProfilesCollectionCategoryNerm]; /** * @export */ export declare const GetSchemaMappedProfilesCollectionStatusNerm: { readonly Active: "active"; readonly Inactive: "inactive"; readonly OnLeave: "on leave"; readonly Terminated: "terminated"; }; export type GetSchemaMappedProfilesCollectionStatusNerm = typeof GetSchemaMappedProfilesCollectionStatusNerm[keyof typeof GetSchemaMappedProfilesCollectionStatusNerm]; /** * JobStatusNERMApi - axios parameter creator * @export */ export declare const JobStatusNERMApiAxiosParamCreator: (configuration?: Configuration) => { /** * Retrieve the status of a bulk job * @summary Get bulk job status * @param {string} jobId The id of the job returned from a POST or PATCH endpoint that resulted in a job being created * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getJobStatus: (jobId: string, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * JobStatusNERMApi - functional programming interface * @export */ export declare const JobStatusNERMApiFp: (configuration?: Configuration) => { /** * Retrieve the status of a bulk job * @summary Get bulk job status * @param {string} jobId The id of the job returned from a POST or PATCH endpoint that resulted in a job being created * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getJobStatus(jobId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * JobStatusNERMApi - factory interface * @export */ export declare const JobStatusNERMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Retrieve the status of a bulk job * @summary Get bulk job status * @param {JobStatusNERMApiGetJobStatusRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getJobStatus(requestParameters: JobStatusNERMApiGetJobStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for getJobStatus operation in JobStatusNERMApi. * @export * @interface JobStatusNERMApiGetJobStatusRequest */ export interface JobStatusNERMApiGetJobStatusRequest { /** * The id of the job returned from a POST or PATCH endpoint that resulted in a job being created * @type {string} * @memberof JobStatusNERMApiGetJobStatus */ readonly jobId: string; } /** * JobStatusNERMApi - object-oriented interface * @export * @class JobStatusNERMApi * @extends {BaseAPI} */ export declare class JobStatusNERMApi extends BaseAPI { /** * Retrieve the status of a bulk job * @summary Get bulk job status * @param {JobStatusNERMApiGetJobStatusRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof JobStatusNERMApi */ getJobStatus(requestParameters: JobStatusNERMApiGetJobStatusRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * LanguagesNERMApi - axios parameter creator * @export */ export declare const LanguagesNERMApiAxiosParamCreator: (configuration?: Configuration) => { /** * Update a language by locale * @summary Update a language by locale * @param {string} languageLocale Language locale of the object * @param {PatchLanguageRequestNERM} patchLanguageRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchLanguage: (languageLocale: string, patchLanguageRequestNERM: PatchLanguageRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * LanguagesNERMApi - functional programming interface * @export */ export declare const LanguagesNERMApiFp: (configuration?: Configuration) => { /** * Update a language by locale * @summary Update a language by locale * @param {string} languageLocale Language locale of the object * @param {PatchLanguageRequestNERM} patchLanguageRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchLanguage(languageLocale: string, patchLanguageRequestNERM: PatchLanguageRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * LanguagesNERMApi - factory interface * @export */ export declare const LanguagesNERMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Update a language by locale * @summary Update a language by locale * @param {LanguagesNERMApiPatchLanguageRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchLanguage(requestParameters: LanguagesNERMApiPatchLanguageRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for patchLanguage operation in LanguagesNERMApi. * @export * @interface LanguagesNERMApiPatchLanguageRequest */ export interface LanguagesNERMApiPatchLanguageRequest { /** * Language locale of the object * @type {string} * @memberof LanguagesNERMApiPatchLanguage */ readonly languageLocale: string; /** * * @type {PatchLanguageRequestNERM} * @memberof LanguagesNERMApiPatchLanguage */ readonly patchLanguageRequestNERM: PatchLanguageRequestNERM; } /** * LanguagesNERMApi - object-oriented interface * @export * @class LanguagesNERMApi * @extends {BaseAPI} */ export declare class LanguagesNERMApi extends BaseAPI { /** * Update a language by locale * @summary Update a language by locale * @param {LanguagesNERMApiPatchLanguageRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof LanguagesNERMApi */ patchLanguage(requestParameters: LanguagesNERMApiPatchLanguageRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * PageContentTranslationsNERMApi - axios parameter creator * @export */ export declare const PageContentTranslationsNERMApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create a page content translation record. * @summary Create page content translation * @param {CreatePageContentTranslationRequestNERM} createPageContentTranslationRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createPageContentTranslation: (createPageContentTranslationRequestNERM: CreatePageContentTranslationRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Delete page content translation by id * @summary Delete page content translation * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deletePageContentTranslationById: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Delete page content translation by UID (user-specified identifier) * @summary Delete page content translation * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deletePageContentTranslationByUid: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This endpoint can retrieve page content translation data. * @summary Get page contents translation * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPageContentTranslation: (axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Info for a specific page content translation record by Id * @summary Find page content translation * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPageContentTranslationById: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Info for a specific page content translation record by UID (user-specified identifier) * @summary Find page content translation * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPageContentTranslationByUid: (uid?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update info for a specific page content translation record by id * @summary Update page content translation * @param {string} id ID of the object to retrieve, update, or delete * @param {UpdatePageContentTranslationByIdRequestNERM} updatePageContentTranslationByIdRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updatePageContentTranslationById: (id: string, updatePageContentTranslationByIdRequestNERM: UpdatePageContentTranslationByIdRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update info for a specific page content translation record by UID (user-specified identifier) * @summary Update page content translation * @param {UpdatePageContentTranslationByIdRequestNERM} updatePageContentTranslationByIdRequestNERM * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updatePageContentTranslationByUid: (updatePageContentTranslationByIdRequestNERM: UpdatePageContentTranslationByIdRequestNERM, uid?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * PageContentTranslationsNERMApi - functional programming interface * @export */ export declare const PageContentTranslationsNERMApiFp: (configuration?: Configuration) => { /** * Create a page content translation record. * @summary Create page content translation * @param {CreatePageContentTranslationRequestNERM} createPageContentTranslationRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createPageContentTranslation(createPageContentTranslationRequestNERM: CreatePageContentTranslationRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete page content translation by id * @summary Delete page content translation * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deletePageContentTranslationById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete page content translation by UID (user-specified identifier) * @summary Delete page content translation * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deletePageContentTranslationByUid(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This endpoint can retrieve page content translation data. * @summary Get page contents translation * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPageContentTranslation(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Info for a specific page content translation record by Id * @summary Find page content translation * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPageContentTranslationById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Info for a specific page content translation record by UID (user-specified identifier) * @summary Find page content translation * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPageContentTranslationByUid(uid?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update info for a specific page content translation record by id * @summary Update page content translation * @param {string} id ID of the object to retrieve, update, or delete * @param {UpdatePageContentTranslationByIdRequestNERM} updatePageContentTranslationByIdRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updatePageContentTranslationById(id: string, updatePageContentTranslationByIdRequestNERM: UpdatePageContentTranslationByIdRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update info for a specific page content translation record by UID (user-specified identifier) * @summary Update page content translation * @param {UpdatePageContentTranslationByIdRequestNERM} updatePageContentTranslationByIdRequestNERM * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updatePageContentTranslationByUid(updatePageContentTranslationByIdRequestNERM: UpdatePageContentTranslationByIdRequestNERM, uid?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * PageContentTranslationsNERMApi - factory interface * @export */ export declare const PageContentTranslationsNERMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create a page content translation record. * @summary Create page content translation * @param {PageContentTranslationsNERMApiCreatePageContentTranslationRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createPageContentTranslation(requestParameters: PageContentTranslationsNERMApiCreatePageContentTranslationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Delete page content translation by id * @summary Delete page content translation * @param {PageContentTranslationsNERMApiDeletePageContentTranslationByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deletePageContentTranslationById(requestParameters: PageContentTranslationsNERMApiDeletePageContentTranslationByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Delete page content translation by UID (user-specified identifier) * @summary Delete page content translation * @param {PageContentTranslationsNERMApiDeletePageContentTranslationByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deletePageContentTranslationByUid(requestParameters: PageContentTranslationsNERMApiDeletePageContentTranslationByUidRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This endpoint can retrieve page content translation data. * @summary Get page contents translation * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPageContentTranslation(axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Info for a specific page content translation record by Id * @summary Find page content translation * @param {PageContentTranslationsNERMApiGetPageContentTranslationByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPageContentTranslationById(requestParameters: PageContentTranslationsNERMApiGetPageContentTranslationByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Info for a specific page content translation record by UID (user-specified identifier) * @summary Find page content translation * @param {PageContentTranslationsNERMApiGetPageContentTranslationByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPageContentTranslationByUid(requestParameters?: PageContentTranslationsNERMApiGetPageContentTranslationByUidRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update info for a specific page content translation record by id * @summary Update page content translation * @param {PageContentTranslationsNERMApiUpdatePageContentTranslationByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updatePageContentTranslationById(requestParameters: PageContentTranslationsNERMApiUpdatePageContentTranslationByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update info for a specific page content translation record by UID (user-specified identifier) * @summary Update page content translation * @param {PageContentTranslationsNERMApiUpdatePageContentTranslationByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updatePageContentTranslationByUid(requestParameters: PageContentTranslationsNERMApiUpdatePageContentTranslationByUidRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createPageContentTranslation operation in PageContentTranslationsNERMApi. * @export * @interface PageContentTranslationsNERMApiCreatePageContentTranslationRequest */ export interface PageContentTranslationsNERMApiCreatePageContentTranslationRequest { /** * * @type {CreatePageContentTranslationRequestNERM} * @memberof PageContentTranslationsNERMApiCreatePageContentTranslation */ readonly createPageContentTranslationRequestNERM: CreatePageContentTranslationRequestNERM; } /** * Request parameters for deletePageContentTranslationById operation in PageContentTranslationsNERMApi. * @export * @interface PageContentTranslationsNERMApiDeletePageContentTranslationByIdRequest */ export interface PageContentTranslationsNERMApiDeletePageContentTranslationByIdRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof PageContentTranslationsNERMApiDeletePageContentTranslationById */ readonly id: string; } /** * Request parameters for deletePageContentTranslationByUid operation in PageContentTranslationsNERMApi. * @export * @interface PageContentTranslationsNERMApiDeletePageContentTranslationByUidRequest */ export interface PageContentTranslationsNERMApiDeletePageContentTranslationByUidRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof PageContentTranslationsNERMApiDeletePageContentTranslationByUid */ readonly id: string; } /** * Request parameters for getPageContentTranslationById operation in PageContentTranslationsNERMApi. * @export * @interface PageContentTranslationsNERMApiGetPageContentTranslationByIdRequest */ export interface PageContentTranslationsNERMApiGetPageContentTranslationByIdRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof PageContentTranslationsNERMApiGetPageContentTranslationById */ readonly id: string; } /** * Request parameters for getPageContentTranslationByUid operation in PageContentTranslationsNERMApi. * @export * @interface PageContentTranslationsNERMApiGetPageContentTranslationByUidRequest */ export interface PageContentTranslationsNERMApiGetPageContentTranslationByUidRequest { /** * UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @type {string} * @memberof PageContentTranslationsNERMApiGetPageContentTranslationByUid */ readonly uid?: string; } /** * Request parameters for updatePageContentTranslationById operation in PageContentTranslationsNERMApi. * @export * @interface PageContentTranslationsNERMApiUpdatePageContentTranslationByIdRequest */ export interface PageContentTranslationsNERMApiUpdatePageContentTranslationByIdRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof PageContentTranslationsNERMApiUpdatePageContentTranslationById */ readonly id: string; /** * * @type {UpdatePageContentTranslationByIdRequestNERM} * @memberof PageContentTranslationsNERMApiUpdatePageContentTranslationById */ readonly updatePageContentTranslationByIdRequestNERM: UpdatePageContentTranslationByIdRequestNERM; } /** * Request parameters for updatePageContentTranslationByUid operation in PageContentTranslationsNERMApi. * @export * @interface PageContentTranslationsNERMApiUpdatePageContentTranslationByUidRequest */ export interface PageContentTranslationsNERMApiUpdatePageContentTranslationByUidRequest { /** * * @type {UpdatePageContentTranslationByIdRequestNERM} * @memberof PageContentTranslationsNERMApiUpdatePageContentTranslationByUid */ readonly updatePageContentTranslationByIdRequestNERM: UpdatePageContentTranslationByIdRequestNERM; /** * UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @type {string} * @memberof PageContentTranslationsNERMApiUpdatePageContentTranslationByUid */ readonly uid?: string; } /** * PageContentTranslationsNERMApi - object-oriented interface * @export * @class PageContentTranslationsNERMApi * @extends {BaseAPI} */ export declare class PageContentTranslationsNERMApi extends BaseAPI { /** * Create a page content translation record. * @summary Create page content translation * @param {PageContentTranslationsNERMApiCreatePageContentTranslationRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PageContentTranslationsNERMApi */ createPageContentTranslation(requestParameters: PageContentTranslationsNERMApiCreatePageContentTranslationRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Delete page content translation by id * @summary Delete page content translation * @param {PageContentTranslationsNERMApiDeletePageContentTranslationByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PageContentTranslationsNERMApi */ deletePageContentTranslationById(requestParameters: PageContentTranslationsNERMApiDeletePageContentTranslationByIdRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Delete page content translation by UID (user-specified identifier) * @summary Delete page content translation * @param {PageContentTranslationsNERMApiDeletePageContentTranslationByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PageContentTranslationsNERMApi */ deletePageContentTranslationByUid(requestParameters: PageContentTranslationsNERMApiDeletePageContentTranslationByUidRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This endpoint can retrieve page content translation data. * @summary Get page contents translation * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PageContentTranslationsNERMApi */ getPageContentTranslation(axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Info for a specific page content translation record by Id * @summary Find page content translation * @param {PageContentTranslationsNERMApiGetPageContentTranslationByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PageContentTranslationsNERMApi */ getPageContentTranslationById(requestParameters: PageContentTranslationsNERMApiGetPageContentTranslationByIdRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Info for a specific page content translation record by UID (user-specified identifier) * @summary Find page content translation * @param {PageContentTranslationsNERMApiGetPageContentTranslationByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PageContentTranslationsNERMApi */ getPageContentTranslationByUid(requestParameters?: PageContentTranslationsNERMApiGetPageContentTranslationByUidRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update info for a specific page content translation record by id * @summary Update page content translation * @param {PageContentTranslationsNERMApiUpdatePageContentTranslationByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PageContentTranslationsNERMApi */ updatePageContentTranslationById(requestParameters: PageContentTranslationsNERMApiUpdatePageContentTranslationByIdRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update info for a specific page content translation record by UID (user-specified identifier) * @summary Update page content translation * @param {PageContentTranslationsNERMApiUpdatePageContentTranslationByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PageContentTranslationsNERMApi */ updatePageContentTranslationByUid(requestParameters: PageContentTranslationsNERMApiUpdatePageContentTranslationByUidRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * PageContentsNERMApi - axios parameter creator * @export */ export declare const PageContentsNERMApiAxiosParamCreator: (configuration?: Configuration) => { /** * This endpoint can create page content * @summary Create a page content entry * @param {CreatePageContentRequestNERM} createPageContentRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createPageContent: (createPageContentRequestNERM: CreatePageContentRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Delete page content by id * @summary Delete page content record * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deletePageContentById: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Delete page content by by UID (user-specified identifier) * @summary Delete page content record * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deletePageContentByUid: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Info for a specific page content record * @summary Find page content record * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPageContentById: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Info for a specific page content record by UID (user-specified identifier) * @summary Find a page content record * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPageContentByUid: (uid?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This endpoint can retrieve page content data. * @summary Get page contents data * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPageContents: (axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update info for a specific page content record by id * @summary Update page content record * @param {string} id ID of the object to retrieve, update, or delete * @param {CreatePageContentRequestNERM} createPageContentRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updatePageContentById: (id: string, createPageContentRequestNERM: CreatePageContentRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update info for a specific page content record by UID (user-specified identifier) * @summary Update page content record * @param {CreatePageContentRequestNERM} createPageContentRequestNERM * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updatePageContentByUid: (createPageContentRequestNERM: CreatePageContentRequestNERM, uid?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * PageContentsNERMApi - functional programming interface * @export */ export declare const PageContentsNERMApiFp: (configuration?: Configuration) => { /** * This endpoint can create page content * @summary Create a page content entry * @param {CreatePageContentRequestNERM} createPageContentRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createPageContent(createPageContentRequestNERM: CreatePageContentRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete page content by id * @summary Delete page content record * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deletePageContentById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete page content by by UID (user-specified identifier) * @summary Delete page content record * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deletePageContentByUid(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Info for a specific page content record * @summary Find page content record * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPageContentById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Info for a specific page content record by UID (user-specified identifier) * @summary Find a page content record * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPageContentByUid(uid?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This endpoint can retrieve page content data. * @summary Get page contents data * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPageContents(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update info for a specific page content record by id * @summary Update page content record * @param {string} id ID of the object to retrieve, update, or delete * @param {CreatePageContentRequestNERM} createPageContentRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updatePageContentById(id: string, createPageContentRequestNERM: CreatePageContentRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update info for a specific page content record by UID (user-specified identifier) * @summary Update page content record * @param {CreatePageContentRequestNERM} createPageContentRequestNERM * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updatePageContentByUid(createPageContentRequestNERM: CreatePageContentRequestNERM, uid?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * PageContentsNERMApi - factory interface * @export */ export declare const PageContentsNERMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * This endpoint can create page content * @summary Create a page content entry * @param {PageContentsNERMApiCreatePageContentRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createPageContent(requestParameters: PageContentsNERMApiCreatePageContentRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Delete page content by id * @summary Delete page content record * @param {PageContentsNERMApiDeletePageContentByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deletePageContentById(requestParameters: PageContentsNERMApiDeletePageContentByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Delete page content by by UID (user-specified identifier) * @summary Delete page content record * @param {PageContentsNERMApiDeletePageContentByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deletePageContentByUid(requestParameters: PageContentsNERMApiDeletePageContentByUidRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Info for a specific page content record * @summary Find page content record * @param {PageContentsNERMApiGetPageContentByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPageContentById(requestParameters: PageContentsNERMApiGetPageContentByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Info for a specific page content record by UID (user-specified identifier) * @summary Find a page content record * @param {PageContentsNERMApiGetPageContentByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPageContentByUid(requestParameters?: PageContentsNERMApiGetPageContentByUidRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This endpoint can retrieve page content data. * @summary Get page contents data * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPageContents(axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update info for a specific page content record by id * @summary Update page content record * @param {PageContentsNERMApiUpdatePageContentByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updatePageContentById(requestParameters: PageContentsNERMApiUpdatePageContentByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update info for a specific page content record by UID (user-specified identifier) * @summary Update page content record * @param {PageContentsNERMApiUpdatePageContentByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updatePageContentByUid(requestParameters: PageContentsNERMApiUpdatePageContentByUidRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createPageContent operation in PageContentsNERMApi. * @export * @interface PageContentsNERMApiCreatePageContentRequest */ export interface PageContentsNERMApiCreatePageContentRequest { /** * * @type {CreatePageContentRequestNERM} * @memberof PageContentsNERMApiCreatePageContent */ readonly createPageContentRequestNERM: CreatePageContentRequestNERM; } /** * Request parameters for deletePageContentById operation in PageContentsNERMApi. * @export * @interface PageContentsNERMApiDeletePageContentByIdRequest */ export interface PageContentsNERMApiDeletePageContentByIdRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof PageContentsNERMApiDeletePageContentById */ readonly id: string; } /** * Request parameters for deletePageContentByUid operation in PageContentsNERMApi. * @export * @interface PageContentsNERMApiDeletePageContentByUidRequest */ export interface PageContentsNERMApiDeletePageContentByUidRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof PageContentsNERMApiDeletePageContentByUid */ readonly id: string; } /** * Request parameters for getPageContentById operation in PageContentsNERMApi. * @export * @interface PageContentsNERMApiGetPageContentByIdRequest */ export interface PageContentsNERMApiGetPageContentByIdRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof PageContentsNERMApiGetPageContentById */ readonly id: string; } /** * Request parameters for getPageContentByUid operation in PageContentsNERMApi. * @export * @interface PageContentsNERMApiGetPageContentByUidRequest */ export interface PageContentsNERMApiGetPageContentByUidRequest { /** * UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @type {string} * @memberof PageContentsNERMApiGetPageContentByUid */ readonly uid?: string; } /** * Request parameters for updatePageContentById operation in PageContentsNERMApi. * @export * @interface PageContentsNERMApiUpdatePageContentByIdRequest */ export interface PageContentsNERMApiUpdatePageContentByIdRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof PageContentsNERMApiUpdatePageContentById */ readonly id: string; /** * * @type {CreatePageContentRequestNERM} * @memberof PageContentsNERMApiUpdatePageContentById */ readonly createPageContentRequestNERM: CreatePageContentRequestNERM; } /** * Request parameters for updatePageContentByUid operation in PageContentsNERMApi. * @export * @interface PageContentsNERMApiUpdatePageContentByUidRequest */ export interface PageContentsNERMApiUpdatePageContentByUidRequest { /** * * @type {CreatePageContentRequestNERM} * @memberof PageContentsNERMApiUpdatePageContentByUid */ readonly createPageContentRequestNERM: CreatePageContentRequestNERM; /** * UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @type {string} * @memberof PageContentsNERMApiUpdatePageContentByUid */ readonly uid?: string; } /** * PageContentsNERMApi - object-oriented interface * @export * @class PageContentsNERMApi * @extends {BaseAPI} */ export declare class PageContentsNERMApi extends BaseAPI { /** * This endpoint can create page content * @summary Create a page content entry * @param {PageContentsNERMApiCreatePageContentRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PageContentsNERMApi */ createPageContent(requestParameters: PageContentsNERMApiCreatePageContentRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Delete page content by id * @summary Delete page content record * @param {PageContentsNERMApiDeletePageContentByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PageContentsNERMApi */ deletePageContentById(requestParameters: PageContentsNERMApiDeletePageContentByIdRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Delete page content by by UID (user-specified identifier) * @summary Delete page content record * @param {PageContentsNERMApiDeletePageContentByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PageContentsNERMApi */ deletePageContentByUid(requestParameters: PageContentsNERMApiDeletePageContentByUidRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Info for a specific page content record * @summary Find page content record * @param {PageContentsNERMApiGetPageContentByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PageContentsNERMApi */ getPageContentById(requestParameters: PageContentsNERMApiGetPageContentByIdRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Info for a specific page content record by UID (user-specified identifier) * @summary Find a page content record * @param {PageContentsNERMApiGetPageContentByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PageContentsNERMApi */ getPageContentByUid(requestParameters?: PageContentsNERMApiGetPageContentByUidRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This endpoint can retrieve page content data. * @summary Get page contents data * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PageContentsNERMApi */ getPageContents(axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update info for a specific page content record by id * @summary Update page content record * @param {PageContentsNERMApiUpdatePageContentByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PageContentsNERMApi */ updatePageContentById(requestParameters: PageContentsNERMApiUpdatePageContentByIdRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update info for a specific page content record by UID (user-specified identifier) * @summary Update page content record * @param {PageContentsNERMApiUpdatePageContentByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PageContentsNERMApi */ updatePageContentByUid(requestParameters: PageContentsNERMApiUpdatePageContentByUidRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * PageElementsNERMApi - axios parameter creator * @export */ export declare const PageElementsNERMApiAxiosParamCreator: (configuration?: Configuration) => { /** * Creates a page element. * @summary Create a page element entry * @param {CreatePageElementRequestNERM} createPageElementRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createPageElement: (createPageElementRequestNERM: CreatePageElementRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Delete page element by id * @summary Delete page element * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deletePageElementById: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Delete page element by UID (user-specified identifier) * @summary Delete page element * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deletePageElementByUid: (uid?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Info for a specific page element record * @summary Find a page element * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPageElementById: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Info for a specific page element record by UID (user-specified identifier) * @summary Find page element * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPageElementByUid: (uid?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Retrieves page elements data. * @summary Get page element data * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPageElements: (axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update info for a specific page element record by id * @summary Update page element * @param {string} id ID of the object to retrieve, update, or delete * @param {CreatePageElementRequestNERM} createPageElementRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updatePageElementById: (id: string, createPageElementRequestNERM: CreatePageElementRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update info for a specific page element record by UID (user-specified identifier) * @summary Update page element * @param {CreatePageElementRequestNERM} createPageElementRequestNERM * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updatePageElementByUid: (createPageElementRequestNERM: CreatePageElementRequestNERM, uid?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * PageElementsNERMApi - functional programming interface * @export */ export declare const PageElementsNERMApiFp: (configuration?: Configuration) => { /** * Creates a page element. * @summary Create a page element entry * @param {CreatePageElementRequestNERM} createPageElementRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createPageElement(createPageElementRequestNERM: CreatePageElementRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete page element by id * @summary Delete page element * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deletePageElementById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete page element by UID (user-specified identifier) * @summary Delete page element * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deletePageElementByUid(uid?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Info for a specific page element record * @summary Find a page element * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPageElementById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Info for a specific page element record by UID (user-specified identifier) * @summary Find page element * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPageElementByUid(uid?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves page elements data. * @summary Get page element data * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPageElements(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update info for a specific page element record by id * @summary Update page element * @param {string} id ID of the object to retrieve, update, or delete * @param {CreatePageElementRequestNERM} createPageElementRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updatePageElementById(id: string, createPageElementRequestNERM: CreatePageElementRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update info for a specific page element record by UID (user-specified identifier) * @summary Update page element * @param {CreatePageElementRequestNERM} createPageElementRequestNERM * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updatePageElementByUid(createPageElementRequestNERM: CreatePageElementRequestNERM, uid?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * PageElementsNERMApi - factory interface * @export */ export declare const PageElementsNERMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Creates a page element. * @summary Create a page element entry * @param {PageElementsNERMApiCreatePageElementRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createPageElement(requestParameters: PageElementsNERMApiCreatePageElementRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Delete page element by id * @summary Delete page element * @param {PageElementsNERMApiDeletePageElementByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deletePageElementById(requestParameters: PageElementsNERMApiDeletePageElementByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Delete page element by UID (user-specified identifier) * @summary Delete page element * @param {PageElementsNERMApiDeletePageElementByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deletePageElementByUid(requestParameters?: PageElementsNERMApiDeletePageElementByUidRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Info for a specific page element record * @summary Find a page element * @param {PageElementsNERMApiGetPageElementByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPageElementById(requestParameters: PageElementsNERMApiGetPageElementByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Info for a specific page element record by UID (user-specified identifier) * @summary Find page element * @param {PageElementsNERMApiGetPageElementByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPageElementByUid(requestParameters?: PageElementsNERMApiGetPageElementByUidRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves page elements data. * @summary Get page element data * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getPageElements(axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update info for a specific page element record by id * @summary Update page element * @param {PageElementsNERMApiUpdatePageElementByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updatePageElementById(requestParameters: PageElementsNERMApiUpdatePageElementByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update info for a specific page element record by UID (user-specified identifier) * @summary Update page element * @param {PageElementsNERMApiUpdatePageElementByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updatePageElementByUid(requestParameters: PageElementsNERMApiUpdatePageElementByUidRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createPageElement operation in PageElementsNERMApi. * @export * @interface PageElementsNERMApiCreatePageElementRequest */ export interface PageElementsNERMApiCreatePageElementRequest { /** * * @type {CreatePageElementRequestNERM} * @memberof PageElementsNERMApiCreatePageElement */ readonly createPageElementRequestNERM: CreatePageElementRequestNERM; } /** * Request parameters for deletePageElementById operation in PageElementsNERMApi. * @export * @interface PageElementsNERMApiDeletePageElementByIdRequest */ export interface PageElementsNERMApiDeletePageElementByIdRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof PageElementsNERMApiDeletePageElementById */ readonly id: string; } /** * Request parameters for deletePageElementByUid operation in PageElementsNERMApi. * @export * @interface PageElementsNERMApiDeletePageElementByUidRequest */ export interface PageElementsNERMApiDeletePageElementByUidRequest { /** * UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @type {string} * @memberof PageElementsNERMApiDeletePageElementByUid */ readonly uid?: string; } /** * Request parameters for getPageElementById operation in PageElementsNERMApi. * @export * @interface PageElementsNERMApiGetPageElementByIdRequest */ export interface PageElementsNERMApiGetPageElementByIdRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof PageElementsNERMApiGetPageElementById */ readonly id: string; } /** * Request parameters for getPageElementByUid operation in PageElementsNERMApi. * @export * @interface PageElementsNERMApiGetPageElementByUidRequest */ export interface PageElementsNERMApiGetPageElementByUidRequest { /** * UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @type {string} * @memberof PageElementsNERMApiGetPageElementByUid */ readonly uid?: string; } /** * Request parameters for updatePageElementById operation in PageElementsNERMApi. * @export * @interface PageElementsNERMApiUpdatePageElementByIdRequest */ export interface PageElementsNERMApiUpdatePageElementByIdRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof PageElementsNERMApiUpdatePageElementById */ readonly id: string; /** * * @type {CreatePageElementRequestNERM} * @memberof PageElementsNERMApiUpdatePageElementById */ readonly createPageElementRequestNERM: CreatePageElementRequestNERM; } /** * Request parameters for updatePageElementByUid operation in PageElementsNERMApi. * @export * @interface PageElementsNERMApiUpdatePageElementByUidRequest */ export interface PageElementsNERMApiUpdatePageElementByUidRequest { /** * * @type {CreatePageElementRequestNERM} * @memberof PageElementsNERMApiUpdatePageElementByUid */ readonly createPageElementRequestNERM: CreatePageElementRequestNERM; /** * UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @type {string} * @memberof PageElementsNERMApiUpdatePageElementByUid */ readonly uid?: string; } /** * PageElementsNERMApi - object-oriented interface * @export * @class PageElementsNERMApi * @extends {BaseAPI} */ export declare class PageElementsNERMApi extends BaseAPI { /** * Creates a page element. * @summary Create a page element entry * @param {PageElementsNERMApiCreatePageElementRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PageElementsNERMApi */ createPageElement(requestParameters: PageElementsNERMApiCreatePageElementRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Delete page element by id * @summary Delete page element * @param {PageElementsNERMApiDeletePageElementByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PageElementsNERMApi */ deletePageElementById(requestParameters: PageElementsNERMApiDeletePageElementByIdRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Delete page element by UID (user-specified identifier) * @summary Delete page element * @param {PageElementsNERMApiDeletePageElementByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PageElementsNERMApi */ deletePageElementByUid(requestParameters?: PageElementsNERMApiDeletePageElementByUidRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Info for a specific page element record * @summary Find a page element * @param {PageElementsNERMApiGetPageElementByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PageElementsNERMApi */ getPageElementById(requestParameters: PageElementsNERMApiGetPageElementByIdRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Info for a specific page element record by UID (user-specified identifier) * @summary Find page element * @param {PageElementsNERMApiGetPageElementByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PageElementsNERMApi */ getPageElementByUid(requestParameters?: PageElementsNERMApiGetPageElementByUidRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Retrieves page elements data. * @summary Get page element data * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PageElementsNERMApi */ getPageElements(axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update info for a specific page element record by id * @summary Update page element * @param {PageElementsNERMApiUpdatePageElementByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PageElementsNERMApi */ updatePageElementById(requestParameters: PageElementsNERMApiUpdatePageElementByIdRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update info for a specific page element record by UID (user-specified identifier) * @summary Update page element * @param {PageElementsNERMApiUpdatePageElementByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PageElementsNERMApi */ updatePageElementByUid(requestParameters: PageElementsNERMApiUpdatePageElementByUidRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * PagesNERMApi - axios parameter creator * @export */ export declare const PagesNERMApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create a profile page * @summary Create a profile page * @param {CreateProfilePageRequestNERM} createProfilePageRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createProfilePage: (createProfilePageRequestNERM: CreateProfilePageRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a workflow page * @summary Create a workflow page * @param {CreateWorkflowPageRequestNERM} createWorkflowPageRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createWorkflowPage: (createWorkflowPageRequestNERM: CreateWorkflowPageRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * PagesNERMApi - functional programming interface * @export */ export declare const PagesNERMApiFp: (configuration?: Configuration) => { /** * Create a profile page * @summary Create a profile page * @param {CreateProfilePageRequestNERM} createProfilePageRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createProfilePage(createProfilePageRequestNERM: CreateProfilePageRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a workflow page * @summary Create a workflow page * @param {CreateWorkflowPageRequestNERM} createWorkflowPageRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createWorkflowPage(createWorkflowPageRequestNERM: CreateWorkflowPageRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * PagesNERMApi - factory interface * @export */ export declare const PagesNERMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create a profile page * @summary Create a profile page * @param {PagesNERMApiCreateProfilePageRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createProfilePage(requestParameters: PagesNERMApiCreateProfilePageRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a workflow page * @summary Create a workflow page * @param {PagesNERMApiCreateWorkflowPageRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createWorkflowPage(requestParameters: PagesNERMApiCreateWorkflowPageRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createProfilePage operation in PagesNERMApi. * @export * @interface PagesNERMApiCreateProfilePageRequest */ export interface PagesNERMApiCreateProfilePageRequest { /** * * @type {CreateProfilePageRequestNERM} * @memberof PagesNERMApiCreateProfilePage */ readonly createProfilePageRequestNERM: CreateProfilePageRequestNERM; } /** * Request parameters for createWorkflowPage operation in PagesNERMApi. * @export * @interface PagesNERMApiCreateWorkflowPageRequest */ export interface PagesNERMApiCreateWorkflowPageRequest { /** * * @type {CreateWorkflowPageRequestNERM} * @memberof PagesNERMApiCreateWorkflowPage */ readonly createWorkflowPageRequestNERM: CreateWorkflowPageRequestNERM; } /** * PagesNERMApi - object-oriented interface * @export * @class PagesNERMApi * @extends {BaseAPI} */ export declare class PagesNERMApi extends BaseAPI { /** * Create a profile page * @summary Create a profile page * @param {PagesNERMApiCreateProfilePageRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PagesNERMApi */ createProfilePage(requestParameters: PagesNERMApiCreateProfilePageRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a workflow page * @summary Create a workflow page * @param {PagesNERMApiCreateWorkflowPageRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PagesNERMApi */ createWorkflowPage(requestParameters: PagesNERMApiCreateWorkflowPageRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * PermissionsNERMApi - axios parameter creator * @export */ export declare const PermissionsNERMApiAxiosParamCreator: (configuration?: Configuration) => { /** * This endpoint can create permissions for Lifecycle, Consolidation, and Collaboration * @summary Create a permission * @param {CreatePermissionRequestNERM} createPermissionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createPermission: (createPermissionRequestNERM: CreatePermissionRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * PermissionsNERMApi - functional programming interface * @export */ export declare const PermissionsNERMApiFp: (configuration?: Configuration) => { /** * This endpoint can create permissions for Lifecycle, Consolidation, and Collaboration * @summary Create a permission * @param {CreatePermissionRequestNERM} createPermissionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createPermission(createPermissionRequestNERM: CreatePermissionRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * PermissionsNERMApi - factory interface * @export */ export declare const PermissionsNERMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * This endpoint can create permissions for Lifecycle, Consolidation, and Collaboration * @summary Create a permission * @param {PermissionsNERMApiCreatePermissionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createPermission(requestParameters: PermissionsNERMApiCreatePermissionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createPermission operation in PermissionsNERMApi. * @export * @interface PermissionsNERMApiCreatePermissionRequest */ export interface PermissionsNERMApiCreatePermissionRequest { /** * * @type {CreatePermissionRequestNERM} * @memberof PermissionsNERMApiCreatePermission */ readonly createPermissionRequestNERM: CreatePermissionRequestNERM; } /** * PermissionsNERMApi - object-oriented interface * @export * @class PermissionsNERMApi * @extends {BaseAPI} */ export declare class PermissionsNERMApi extends BaseAPI { /** * This endpoint can create permissions for Lifecycle, Consolidation, and Collaboration * @summary Create a permission * @param {PermissionsNERMApiCreatePermissionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof PermissionsNERMApi */ createPermission(requestParameters: PermissionsNERMApiCreatePermissionRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * ProfileTypeRolesNERMApi - axios parameter creator * @export */ export declare const ProfileTypeRolesNERMApiAxiosParamCreator: (configuration?: Configuration) => { /** * This endpoint can create a profile type role. NOTE- The ability to toggle Allow/Block is done through the Profile Type * @summary Create a profile type role * @param {CreateProfileTypeRoleRequestNERM} createProfileTypeRoleRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createProfileTypeRole: (createProfileTypeRoleRequestNERM: CreateProfileTypeRoleRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * ProfileTypeRolesNERMApi - functional programming interface * @export */ export declare const ProfileTypeRolesNERMApiFp: (configuration?: Configuration) => { /** * This endpoint can create a profile type role. NOTE- The ability to toggle Allow/Block is done through the Profile Type * @summary Create a profile type role * @param {CreateProfileTypeRoleRequestNERM} createProfileTypeRoleRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createProfileTypeRole(createProfileTypeRoleRequestNERM: CreateProfileTypeRoleRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ProfileTypeRolesNERMApi - factory interface * @export */ export declare const ProfileTypeRolesNERMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * This endpoint can create a profile type role. NOTE- The ability to toggle Allow/Block is done through the Profile Type * @summary Create a profile type role * @param {ProfileTypeRolesNERMApiCreateProfileTypeRoleRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createProfileTypeRole(requestParameters: ProfileTypeRolesNERMApiCreateProfileTypeRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createProfileTypeRole operation in ProfileTypeRolesNERMApi. * @export * @interface ProfileTypeRolesNERMApiCreateProfileTypeRoleRequest */ export interface ProfileTypeRolesNERMApiCreateProfileTypeRoleRequest { /** * * @type {CreateProfileTypeRoleRequestNERM} * @memberof ProfileTypeRolesNERMApiCreateProfileTypeRole */ readonly createProfileTypeRoleRequestNERM: CreateProfileTypeRoleRequestNERM; } /** * ProfileTypeRolesNERMApi - object-oriented interface * @export * @class ProfileTypeRolesNERMApi * @extends {BaseAPI} */ export declare class ProfileTypeRolesNERMApi extends BaseAPI { /** * This endpoint can create a profile type role. NOTE- The ability to toggle Allow/Block is done through the Profile Type * @summary Create a profile type role * @param {ProfileTypeRolesNERMApiCreateProfileTypeRoleRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ProfileTypeRolesNERMApi */ createProfileTypeRole(requestParameters: ProfileTypeRolesNERMApiCreateProfileTypeRoleRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * ProfileTypesNERMApi - axios parameter creator * @export */ export declare const ProfileTypesNERMApiAxiosParamCreator: (configuration?: Configuration) => { /** * Delete a profile type. All profiles of that type must first be destroyed before the profile type can be destroyed. * @summary Delete profile type * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteProfileTypeById: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Delete a profile type by UID (user-specified identifier). All profiles of that type must first be destroyed before the profile type can be destroyed. * @summary Delete profile type * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteProfileTypeByUid: (uid?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Find profile type by id * @summary Find profile type * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProfileTypeById: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Find profile type by UID (user-specified identifier) * @summary Find profile type * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProfileTypeByUid: (uid?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Get option based attribute values * @summary Get profile types * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {string} [order] The field to order results by. * @param {string} [name] object name for filtering * @param {boolean} [archived] Filter by archive status * @param {boolean} [metadata] Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProfileTypes: (limit?: number, offset?: number, order?: string, name?: string, archived?: boolean, metadata?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update a profile type by id * @summary Update a profile type * @param {string} id ID of the object to retrieve, update, or delete * @param {SubmitProfileTypeRequestNERM} submitProfileTypeRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchProfileTypeById: (id: string, submitProfileTypeRequestNERM: SubmitProfileTypeRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update a profile type by UID (user-specified identifier) * @summary Update a profile type * @param {SubmitProfileTypeRequestNERM} submitProfileTypeRequestNERM * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchProfileTypeByUid: (submitProfileTypeRequestNERM: SubmitProfileTypeRequestNERM, uid?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a profile type * @summary Create a profile type * @param {SubmitProfileTypeRequestNERM} submitProfileTypeRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitProfileType: (submitProfileTypeRequestNERM: SubmitProfileTypeRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * ProfileTypesNERMApi - functional programming interface * @export */ export declare const ProfileTypesNERMApiFp: (configuration?: Configuration) => { /** * Delete a profile type. All profiles of that type must first be destroyed before the profile type can be destroyed. * @summary Delete profile type * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteProfileTypeById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete a profile type by UID (user-specified identifier). All profiles of that type must first be destroyed before the profile type can be destroyed. * @summary Delete profile type * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteProfileTypeByUid(uid?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Find profile type by id * @summary Find profile type * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProfileTypeById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Find profile type by UID (user-specified identifier) * @summary Find profile type * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProfileTypeByUid(uid?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get option based attribute values * @summary Get profile types * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {string} [order] The field to order results by. * @param {string} [name] object name for filtering * @param {boolean} [archived] Filter by archive status * @param {boolean} [metadata] Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProfileTypes(limit?: number, offset?: number, order?: string, name?: string, archived?: boolean, metadata?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a profile type by id * @summary Update a profile type * @param {string} id ID of the object to retrieve, update, or delete * @param {SubmitProfileTypeRequestNERM} submitProfileTypeRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchProfileTypeById(id: string, submitProfileTypeRequestNERM: SubmitProfileTypeRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a profile type by UID (user-specified identifier) * @summary Update a profile type * @param {SubmitProfileTypeRequestNERM} submitProfileTypeRequestNERM * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchProfileTypeByUid(submitProfileTypeRequestNERM: SubmitProfileTypeRequestNERM, uid?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a profile type * @summary Create a profile type * @param {SubmitProfileTypeRequestNERM} submitProfileTypeRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitProfileType(submitProfileTypeRequestNERM: SubmitProfileTypeRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ProfileTypesNERMApi - factory interface * @export */ export declare const ProfileTypesNERMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Delete a profile type. All profiles of that type must first be destroyed before the profile type can be destroyed. * @summary Delete profile type * @param {ProfileTypesNERMApiDeleteProfileTypeByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteProfileTypeById(requestParameters: ProfileTypesNERMApiDeleteProfileTypeByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Delete a profile type by UID (user-specified identifier). All profiles of that type must first be destroyed before the profile type can be destroyed. * @summary Delete profile type * @param {ProfileTypesNERMApiDeleteProfileTypeByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteProfileTypeByUid(requestParameters?: ProfileTypesNERMApiDeleteProfileTypeByUidRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Find profile type by id * @summary Find profile type * @param {ProfileTypesNERMApiGetProfileTypeByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProfileTypeById(requestParameters: ProfileTypesNERMApiGetProfileTypeByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Find profile type by UID (user-specified identifier) * @summary Find profile type * @param {ProfileTypesNERMApiGetProfileTypeByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProfileTypeByUid(requestParameters?: ProfileTypesNERMApiGetProfileTypeByUidRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Get option based attribute values * @summary Get profile types * @param {ProfileTypesNERMApiGetProfileTypesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProfileTypes(requestParameters?: ProfileTypesNERMApiGetProfileTypesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update a profile type by id * @summary Update a profile type * @param {ProfileTypesNERMApiPatchProfileTypeByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchProfileTypeById(requestParameters: ProfileTypesNERMApiPatchProfileTypeByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update a profile type by UID (user-specified identifier) * @summary Update a profile type * @param {ProfileTypesNERMApiPatchProfileTypeByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchProfileTypeByUid(requestParameters: ProfileTypesNERMApiPatchProfileTypeByUidRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a profile type * @summary Create a profile type * @param {ProfileTypesNERMApiSubmitProfileTypeRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitProfileType(requestParameters: ProfileTypesNERMApiSubmitProfileTypeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for deleteProfileTypeById operation in ProfileTypesNERMApi. * @export * @interface ProfileTypesNERMApiDeleteProfileTypeByIdRequest */ export interface ProfileTypesNERMApiDeleteProfileTypeByIdRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof ProfileTypesNERMApiDeleteProfileTypeById */ readonly id: string; } /** * Request parameters for deleteProfileTypeByUid operation in ProfileTypesNERMApi. * @export * @interface ProfileTypesNERMApiDeleteProfileTypeByUidRequest */ export interface ProfileTypesNERMApiDeleteProfileTypeByUidRequest { /** * UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @type {string} * @memberof ProfileTypesNERMApiDeleteProfileTypeByUid */ readonly uid?: string; } /** * Request parameters for getProfileTypeById operation in ProfileTypesNERMApi. * @export * @interface ProfileTypesNERMApiGetProfileTypeByIdRequest */ export interface ProfileTypesNERMApiGetProfileTypeByIdRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof ProfileTypesNERMApiGetProfileTypeById */ readonly id: string; } /** * Request parameters for getProfileTypeByUid operation in ProfileTypesNERMApi. * @export * @interface ProfileTypesNERMApiGetProfileTypeByUidRequest */ export interface ProfileTypesNERMApiGetProfileTypeByUidRequest { /** * UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @type {string} * @memberof ProfileTypesNERMApiGetProfileTypeByUid */ readonly uid?: string; } /** * Request parameters for getProfileTypes operation in ProfileTypesNERMApi. * @export * @interface ProfileTypesNERMApiGetProfileTypesRequest */ export interface ProfileTypesNERMApiGetProfileTypesRequest { /** * The maximum number of items to return. * @type {number} * @memberof ProfileTypesNERMApiGetProfileTypes */ readonly limit?: number; /** * The number of items to skip before starting to collect the result set. * @type {number} * @memberof ProfileTypesNERMApiGetProfileTypes */ readonly offset?: number; /** * The field to order results by. * @type {string} * @memberof ProfileTypesNERMApiGetProfileTypes */ readonly order?: string; /** * object name for filtering * @type {string} * @memberof ProfileTypesNERMApiGetProfileTypes */ readonly name?: string; /** * Filter by archive status * @type {boolean} * @memberof ProfileTypesNERMApiGetProfileTypes */ readonly archived?: boolean; /** * Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @type {boolean} * @memberof ProfileTypesNERMApiGetProfileTypes */ readonly metadata?: boolean; } /** * Request parameters for patchProfileTypeById operation in ProfileTypesNERMApi. * @export * @interface ProfileTypesNERMApiPatchProfileTypeByIdRequest */ export interface ProfileTypesNERMApiPatchProfileTypeByIdRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof ProfileTypesNERMApiPatchProfileTypeById */ readonly id: string; /** * * @type {SubmitProfileTypeRequestNERM} * @memberof ProfileTypesNERMApiPatchProfileTypeById */ readonly submitProfileTypeRequestNERM: SubmitProfileTypeRequestNERM; } /** * Request parameters for patchProfileTypeByUid operation in ProfileTypesNERMApi. * @export * @interface ProfileTypesNERMApiPatchProfileTypeByUidRequest */ export interface ProfileTypesNERMApiPatchProfileTypeByUidRequest { /** * * @type {SubmitProfileTypeRequestNERM} * @memberof ProfileTypesNERMApiPatchProfileTypeByUid */ readonly submitProfileTypeRequestNERM: SubmitProfileTypeRequestNERM; /** * UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @type {string} * @memberof ProfileTypesNERMApiPatchProfileTypeByUid */ readonly uid?: string; } /** * Request parameters for submitProfileType operation in ProfileTypesNERMApi. * @export * @interface ProfileTypesNERMApiSubmitProfileTypeRequest */ export interface ProfileTypesNERMApiSubmitProfileTypeRequest { /** * * @type {SubmitProfileTypeRequestNERM} * @memberof ProfileTypesNERMApiSubmitProfileType */ readonly submitProfileTypeRequestNERM: SubmitProfileTypeRequestNERM; } /** * ProfileTypesNERMApi - object-oriented interface * @export * @class ProfileTypesNERMApi * @extends {BaseAPI} */ export declare class ProfileTypesNERMApi extends BaseAPI { /** * Delete a profile type. All profiles of that type must first be destroyed before the profile type can be destroyed. * @summary Delete profile type * @param {ProfileTypesNERMApiDeleteProfileTypeByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ProfileTypesNERMApi */ deleteProfileTypeById(requestParameters: ProfileTypesNERMApiDeleteProfileTypeByIdRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Delete a profile type by UID (user-specified identifier). All profiles of that type must first be destroyed before the profile type can be destroyed. * @summary Delete profile type * @param {ProfileTypesNERMApiDeleteProfileTypeByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ProfileTypesNERMApi */ deleteProfileTypeByUid(requestParameters?: ProfileTypesNERMApiDeleteProfileTypeByUidRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Find profile type by id * @summary Find profile type * @param {ProfileTypesNERMApiGetProfileTypeByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ProfileTypesNERMApi */ getProfileTypeById(requestParameters: ProfileTypesNERMApiGetProfileTypeByIdRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Find profile type by UID (user-specified identifier) * @summary Find profile type * @param {ProfileTypesNERMApiGetProfileTypeByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ProfileTypesNERMApi */ getProfileTypeByUid(requestParameters?: ProfileTypesNERMApiGetProfileTypeByUidRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Get option based attribute values * @summary Get profile types * @param {ProfileTypesNERMApiGetProfileTypesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ProfileTypesNERMApi */ getProfileTypes(requestParameters?: ProfileTypesNERMApiGetProfileTypesRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update a profile type by id * @summary Update a profile type * @param {ProfileTypesNERMApiPatchProfileTypeByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ProfileTypesNERMApi */ patchProfileTypeById(requestParameters: ProfileTypesNERMApiPatchProfileTypeByIdRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update a profile type by UID (user-specified identifier) * @summary Update a profile type * @param {ProfileTypesNERMApiPatchProfileTypeByUidRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ProfileTypesNERMApi */ patchProfileTypeByUid(requestParameters: ProfileTypesNERMApiPatchProfileTypeByUidRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a profile type * @summary Create a profile type * @param {ProfileTypesNERMApiSubmitProfileTypeRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ProfileTypesNERMApi */ submitProfileType(requestParameters: ProfileTypesNERMApiSubmitProfileTypeRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * ProfilesNERMApi - axios parameter creator * @export */ export declare const ProfilesNERMApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create multiple profiles * @summary Create multiple profiles * @param {CreateProfilesRequestNERM} createProfilesRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createProfiles: (createProfilesRequestNERM: CreateProfilesRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Delete a single profile * @summary Delete a single profile * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteProfileById: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Delete multiple profiles * @summary Delete multiple profiles * @param {CreateProfilesRequestNERM} createProfilesRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteProfiles: (createProfilesRequestNERM: CreateProfilesRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Retrieves the URL of the profile avatar * @summary Retrieves profile avatar URL * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProfileAvatar: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Find profile by id * @summary Find profile by id * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProfileById: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Retrieves the URL of an attachment attribute value from a profile * @summary Retrieves profile attribute attachment URL * @param {string} id ID of the object to retrieve, update, or delete * @param {string} attributeId The id of the attachment attribute * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProfileUpload: (id: string, attributeId: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Get profiles * @summary Get profiles * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {string} [order] The field to order results by. * @param {boolean} [excludeAttributes] Allows for optimization by not returning the associated attribute data for the returned profiles * @param {string} [name] object name for filtering * @param {string} [profileTypeId] Profile Type ID for filtering * @param {GetProfilesStatusNerm} [status] status value for filtering * @param {boolean} [metadata] Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @param {string} [afterId] Represents the ID where the query should begin from. If blank, it represents the first ID. When used, forces sorting by ID ascending and does not allow use of `offset`. When `after_id` is specified it changes the mode of the API such that any filter parameters other than `profile_type_id`, `limit`, and `offset` are not supported and will be either silently ignored or result in an HTTP 400 error. For example you can not include an `after_id` along with an `archived=false` in the same request. Can be used alongside `metadata` parameter. * @param {string} [updatedAfter] Adds support for filtering profiles based on the date of the latest modification made on them. Can be used alongside the after_id parameter. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProfiles: (limit?: number, offset?: number, order?: string, excludeAttributes?: boolean, name?: string, profileTypeId?: string, status?: GetProfilesStatusNerm, metadata?: boolean, afterId?: string, updatedAfter?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update a profile by id * @summary Update a profile by id * @param {string} id ID of the object to retrieve, update, or delete * @param {SubmitProfileRequestNERM} submitProfileRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchProfileById: (id: string, submitProfileRequestNERM: SubmitProfileRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update multiple profiles * @summary Update multiple profiles * @param {CreateProfilesRequestNERM} createProfilesRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchProfiles: (createProfilesRequestNERM: CreateProfilesRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a profile * @summary Create a profile * @param {SubmitProfileRequestNERM} submitProfileRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitProfile: (submitProfileRequestNERM: SubmitProfileRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Uploads a new profile avatar * @summary Uploads new profile avatar * @param {string} id ID of the object to retrieve, update, or delete * @param {File} [file] * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitProfileAvatar: (id: string, file?: File, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Uploads a new attachment attribute value to a profile. The upload must be a FORM data type; this is not a JSON API. The upload must include the binary content of the payload under the \'file\' named form element. The upload must not attempt to include the file name or its content type as a other form or JSON as parameters. The upload must not attempt to upload the file body as the POST body payload; it has to arrive as a FORM parameter. Do not use a `File/Binary` payload type for the POST operation in your API client. * @summary Uploads profile attachment attribute * @param {string} id ID of the object to retrieve, update, or delete * @param {string} attributeId The id of the attachment attribute * @param {File} [file] * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitProfileUpload: (id: string, attributeId: string, file?: File, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * ProfilesNERMApi - functional programming interface * @export */ export declare const ProfilesNERMApiFp: (configuration?: Configuration) => { /** * Create multiple profiles * @summary Create multiple profiles * @param {CreateProfilesRequestNERM} createProfilesRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createProfiles(createProfilesRequestNERM: CreateProfilesRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete a single profile * @summary Delete a single profile * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteProfileById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete multiple profiles * @summary Delete multiple profiles * @param {CreateProfilesRequestNERM} createProfilesRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteProfiles(createProfilesRequestNERM: CreateProfilesRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves the URL of the profile avatar * @summary Retrieves profile avatar URL * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProfileAvatar(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Find profile by id * @summary Find profile by id * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProfileById(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves the URL of an attachment attribute value from a profile * @summary Retrieves profile attribute attachment URL * @param {string} id ID of the object to retrieve, update, or delete * @param {string} attributeId The id of the attachment attribute * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProfileUpload(id: string, attributeId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get profiles * @summary Get profiles * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {string} [order] The field to order results by. * @param {boolean} [excludeAttributes] Allows for optimization by not returning the associated attribute data for the returned profiles * @param {string} [name] object name for filtering * @param {string} [profileTypeId] Profile Type ID for filtering * @param {GetProfilesStatusNerm} [status] status value for filtering * @param {boolean} [metadata] Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @param {string} [afterId] Represents the ID where the query should begin from. If blank, it represents the first ID. When used, forces sorting by ID ascending and does not allow use of `offset`. When `after_id` is specified it changes the mode of the API such that any filter parameters other than `profile_type_id`, `limit`, and `offset` are not supported and will be either silently ignored or result in an HTTP 400 error. For example you can not include an `after_id` along with an `archived=false` in the same request. Can be used alongside `metadata` parameter. * @param {string} [updatedAfter] Adds support for filtering profiles based on the date of the latest modification made on them. Can be used alongside the after_id parameter. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProfiles(limit?: number, offset?: number, order?: string, excludeAttributes?: boolean, name?: string, profileTypeId?: string, status?: GetProfilesStatusNerm, metadata?: boolean, afterId?: string, updatedAfter?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a profile by id * @summary Update a profile by id * @param {string} id ID of the object to retrieve, update, or delete * @param {SubmitProfileRequestNERM} submitProfileRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchProfileById(id: string, submitProfileRequestNERM: SubmitProfileRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update multiple profiles * @summary Update multiple profiles * @param {CreateProfilesRequestNERM} createProfilesRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchProfiles(createProfilesRequestNERM: CreateProfilesRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a profile * @summary Create a profile * @param {SubmitProfileRequestNERM} submitProfileRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitProfile(submitProfileRequestNERM: SubmitProfileRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Uploads a new profile avatar * @summary Uploads new profile avatar * @param {string} id ID of the object to retrieve, update, or delete * @param {File} [file] * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitProfileAvatar(id: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Uploads a new attachment attribute value to a profile. The upload must be a FORM data type; this is not a JSON API. The upload must include the binary content of the payload under the \'file\' named form element. The upload must not attempt to include the file name or its content type as a other form or JSON as parameters. The upload must not attempt to upload the file body as the POST body payload; it has to arrive as a FORM parameter. Do not use a `File/Binary` payload type for the POST operation in your API client. * @summary Uploads profile attachment attribute * @param {string} id ID of the object to retrieve, update, or delete * @param {string} attributeId The id of the attachment attribute * @param {File} [file] * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitProfileUpload(id: string, attributeId: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ProfilesNERMApi - factory interface * @export */ export declare const ProfilesNERMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create multiple profiles * @summary Create multiple profiles * @param {ProfilesNERMApiCreateProfilesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createProfiles(requestParameters: ProfilesNERMApiCreateProfilesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Delete a single profile * @summary Delete a single profile * @param {ProfilesNERMApiDeleteProfileByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteProfileById(requestParameters: ProfilesNERMApiDeleteProfileByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Delete multiple profiles * @summary Delete multiple profiles * @param {ProfilesNERMApiDeleteProfilesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteProfiles(requestParameters: ProfilesNERMApiDeleteProfilesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves the URL of the profile avatar * @summary Retrieves profile avatar URL * @param {ProfilesNERMApiGetProfileAvatarRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProfileAvatar(requestParameters: ProfilesNERMApiGetProfileAvatarRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Find profile by id * @summary Find profile by id * @param {ProfilesNERMApiGetProfileByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProfileById(requestParameters: ProfilesNERMApiGetProfileByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves the URL of an attachment attribute value from a profile * @summary Retrieves profile attribute attachment URL * @param {ProfilesNERMApiGetProfileUploadRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProfileUpload(requestParameters: ProfilesNERMApiGetProfileUploadRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Get profiles * @summary Get profiles * @param {ProfilesNERMApiGetProfilesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProfiles(requestParameters?: ProfilesNERMApiGetProfilesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update a profile by id * @summary Update a profile by id * @param {ProfilesNERMApiPatchProfileByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchProfileById(requestParameters: ProfilesNERMApiPatchProfileByIdRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update multiple profiles * @summary Update multiple profiles * @param {ProfilesNERMApiPatchProfilesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchProfiles(requestParameters: ProfilesNERMApiPatchProfilesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a profile * @summary Create a profile * @param {ProfilesNERMApiSubmitProfileRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitProfile(requestParameters: ProfilesNERMApiSubmitProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Uploads a new profile avatar * @summary Uploads new profile avatar * @param {ProfilesNERMApiSubmitProfileAvatarRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitProfileAvatar(requestParameters: ProfilesNERMApiSubmitProfileAvatarRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Uploads a new attachment attribute value to a profile. The upload must be a FORM data type; this is not a JSON API. The upload must include the binary content of the payload under the \'file\' named form element. The upload must not attempt to include the file name or its content type as a other form or JSON as parameters. The upload must not attempt to upload the file body as the POST body payload; it has to arrive as a FORM parameter. Do not use a `File/Binary` payload type for the POST operation in your API client. * @summary Uploads profile attachment attribute * @param {ProfilesNERMApiSubmitProfileUploadRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitProfileUpload(requestParameters: ProfilesNERMApiSubmitProfileUploadRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createProfiles operation in ProfilesNERMApi. * @export * @interface ProfilesNERMApiCreateProfilesRequest */ export interface ProfilesNERMApiCreateProfilesRequest { /** * * @type {CreateProfilesRequestNERM} * @memberof ProfilesNERMApiCreateProfiles */ readonly createProfilesRequestNERM: CreateProfilesRequestNERM; } /** * Request parameters for deleteProfileById operation in ProfilesNERMApi. * @export * @interface ProfilesNERMApiDeleteProfileByIdRequest */ export interface ProfilesNERMApiDeleteProfileByIdRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof ProfilesNERMApiDeleteProfileById */ readonly id: string; } /** * Request parameters for deleteProfiles operation in ProfilesNERMApi. * @export * @interface ProfilesNERMApiDeleteProfilesRequest */ export interface ProfilesNERMApiDeleteProfilesRequest { /** * * @type {CreateProfilesRequestNERM} * @memberof ProfilesNERMApiDeleteProfiles */ readonly createProfilesRequestNERM: CreateProfilesRequestNERM; } /** * Request parameters for getProfileAvatar operation in ProfilesNERMApi. * @export * @interface ProfilesNERMApiGetProfileAvatarRequest */ export interface ProfilesNERMApiGetProfileAvatarRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof ProfilesNERMApiGetProfileAvatar */ readonly id: string; } /** * Request parameters for getProfileById operation in ProfilesNERMApi. * @export * @interface ProfilesNERMApiGetProfileByIdRequest */ export interface ProfilesNERMApiGetProfileByIdRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof ProfilesNERMApiGetProfileById */ readonly id: string; } /** * Request parameters for getProfileUpload operation in ProfilesNERMApi. * @export * @interface ProfilesNERMApiGetProfileUploadRequest */ export interface ProfilesNERMApiGetProfileUploadRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof ProfilesNERMApiGetProfileUpload */ readonly id: string; /** * The id of the attachment attribute * @type {string} * @memberof ProfilesNERMApiGetProfileUpload */ readonly attributeId: string; } /** * Request parameters for getProfiles operation in ProfilesNERMApi. * @export * @interface ProfilesNERMApiGetProfilesRequest */ export interface ProfilesNERMApiGetProfilesRequest { /** * The maximum number of items to return. * @type {number} * @memberof ProfilesNERMApiGetProfiles */ readonly limit?: number; /** * The number of items to skip before starting to collect the result set. * @type {number} * @memberof ProfilesNERMApiGetProfiles */ readonly offset?: number; /** * The field to order results by. * @type {string} * @memberof ProfilesNERMApiGetProfiles */ readonly order?: string; /** * Allows for optimization by not returning the associated attribute data for the returned profiles * @type {boolean} * @memberof ProfilesNERMApiGetProfiles */ readonly excludeAttributes?: boolean; /** * object name for filtering * @type {string} * @memberof ProfilesNERMApiGetProfiles */ readonly name?: string; /** * Profile Type ID for filtering * @type {string} * @memberof ProfilesNERMApiGetProfiles */ readonly profileTypeId?: string; /** * status value for filtering * @type {'Active' | 'Inactive' | 'On Leave' | 'Terminated'} * @memberof ProfilesNERMApiGetProfiles */ readonly status?: GetProfilesStatusNerm; /** * Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @type {boolean} * @memberof ProfilesNERMApiGetProfiles */ readonly metadata?: boolean; /** * Represents the ID where the query should begin from. If blank, it represents the first ID. When used, forces sorting by ID ascending and does not allow use of `offset`. When `after_id` is specified it changes the mode of the API such that any filter parameters other than `profile_type_id`, `limit`, and `offset` are not supported and will be either silently ignored or result in an HTTP 400 error. For example you can not include an `after_id` along with an `archived=false` in the same request. Can be used alongside `metadata` parameter. * @type {string} * @memberof ProfilesNERMApiGetProfiles */ readonly afterId?: string; /** * Adds support for filtering profiles based on the date of the latest modification made on them. Can be used alongside the after_id parameter. * @type {string} * @memberof ProfilesNERMApiGetProfiles */ readonly updatedAfter?: string; } /** * Request parameters for patchProfileById operation in ProfilesNERMApi. * @export * @interface ProfilesNERMApiPatchProfileByIdRequest */ export interface ProfilesNERMApiPatchProfileByIdRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof ProfilesNERMApiPatchProfileById */ readonly id: string; /** * * @type {SubmitProfileRequestNERM} * @memberof ProfilesNERMApiPatchProfileById */ readonly submitProfileRequestNERM: SubmitProfileRequestNERM; } /** * Request parameters for patchProfiles operation in ProfilesNERMApi. * @export * @interface ProfilesNERMApiPatchProfilesRequest */ export interface ProfilesNERMApiPatchProfilesRequest { /** * * @type {CreateProfilesRequestNERM} * @memberof ProfilesNERMApiPatchProfiles */ readonly createProfilesRequestNERM: CreateProfilesRequestNERM; } /** * Request parameters for submitProfile operation in ProfilesNERMApi. * @export * @interface ProfilesNERMApiSubmitProfileRequest */ export interface ProfilesNERMApiSubmitProfileRequest { /** * * @type {SubmitProfileRequestNERM} * @memberof ProfilesNERMApiSubmitProfile */ readonly submitProfileRequestNERM: SubmitProfileRequestNERM; } /** * Request parameters for submitProfileAvatar operation in ProfilesNERMApi. * @export * @interface ProfilesNERMApiSubmitProfileAvatarRequest */ export interface ProfilesNERMApiSubmitProfileAvatarRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof ProfilesNERMApiSubmitProfileAvatar */ readonly id: string; /** * * @type {File} * @memberof ProfilesNERMApiSubmitProfileAvatar */ readonly file?: File; } /** * Request parameters for submitProfileUpload operation in ProfilesNERMApi. * @export * @interface ProfilesNERMApiSubmitProfileUploadRequest */ export interface ProfilesNERMApiSubmitProfileUploadRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof ProfilesNERMApiSubmitProfileUpload */ readonly id: string; /** * The id of the attachment attribute * @type {string} * @memberof ProfilesNERMApiSubmitProfileUpload */ readonly attributeId: string; /** * * @type {File} * @memberof ProfilesNERMApiSubmitProfileUpload */ readonly file?: File; } /** * ProfilesNERMApi - object-oriented interface * @export * @class ProfilesNERMApi * @extends {BaseAPI} */ export declare class ProfilesNERMApi extends BaseAPI { /** * Create multiple profiles * @summary Create multiple profiles * @param {ProfilesNERMApiCreateProfilesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ProfilesNERMApi */ createProfiles(requestParameters: ProfilesNERMApiCreateProfilesRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Delete a single profile * @summary Delete a single profile * @param {ProfilesNERMApiDeleteProfileByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ProfilesNERMApi */ deleteProfileById(requestParameters: ProfilesNERMApiDeleteProfileByIdRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Delete multiple profiles * @summary Delete multiple profiles * @param {ProfilesNERMApiDeleteProfilesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ProfilesNERMApi */ deleteProfiles(requestParameters: ProfilesNERMApiDeleteProfilesRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Retrieves the URL of the profile avatar * @summary Retrieves profile avatar URL * @param {ProfilesNERMApiGetProfileAvatarRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ProfilesNERMApi */ getProfileAvatar(requestParameters: ProfilesNERMApiGetProfileAvatarRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Find profile by id * @summary Find profile by id * @param {ProfilesNERMApiGetProfileByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ProfilesNERMApi */ getProfileById(requestParameters: ProfilesNERMApiGetProfileByIdRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Retrieves the URL of an attachment attribute value from a profile * @summary Retrieves profile attribute attachment URL * @param {ProfilesNERMApiGetProfileUploadRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ProfilesNERMApi */ getProfileUpload(requestParameters: ProfilesNERMApiGetProfileUploadRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Get profiles * @summary Get profiles * @param {ProfilesNERMApiGetProfilesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ProfilesNERMApi */ getProfiles(requestParameters?: ProfilesNERMApiGetProfilesRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update a profile by id * @summary Update a profile by id * @param {ProfilesNERMApiPatchProfileByIdRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ProfilesNERMApi */ patchProfileById(requestParameters: ProfilesNERMApiPatchProfileByIdRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update multiple profiles * @summary Update multiple profiles * @param {ProfilesNERMApiPatchProfilesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ProfilesNERMApi */ patchProfiles(requestParameters: ProfilesNERMApiPatchProfilesRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a profile * @summary Create a profile * @param {ProfilesNERMApiSubmitProfileRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ProfilesNERMApi */ submitProfile(requestParameters: ProfilesNERMApiSubmitProfileRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Uploads a new profile avatar * @summary Uploads new profile avatar * @param {ProfilesNERMApiSubmitProfileAvatarRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ProfilesNERMApi */ submitProfileAvatar(requestParameters: ProfilesNERMApiSubmitProfileAvatarRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Uploads a new attachment attribute value to a profile. The upload must be a FORM data type; this is not a JSON API. The upload must include the binary content of the payload under the \'file\' named form element. The upload must not attempt to include the file name or its content type as a other form or JSON as parameters. The upload must not attempt to upload the file body as the POST body payload; it has to arrive as a FORM parameter. Do not use a `File/Binary` payload type for the POST operation in your API client. * @summary Uploads profile attachment attribute * @param {ProfilesNERMApiSubmitProfileUploadRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ProfilesNERMApi */ submitProfileUpload(requestParameters: ProfilesNERMApiSubmitProfileUploadRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const GetProfilesStatusNerm: { readonly Active: "Active"; readonly Inactive: "Inactive"; readonly OnLeave: "On Leave"; readonly Terminated: "Terminated"; }; export type GetProfilesStatusNerm = typeof GetProfilesStatusNerm[keyof typeof GetProfilesStatusNerm]; /** * RiskLevelsNERMApi - axios parameter creator * @export */ export declare const RiskLevelsNERMApiAxiosParamCreator: (configuration?: Configuration) => { /** * Find risk level data by id * @summary Find risk level data * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRiskLevel: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This endpoint can retrieve risk level data in bulk from Lifecycle * @summary Get risk level data * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {string} [order] The field to order results by. * @param {string} [label] The attribute label to filter by * @param {boolean} [metadata] Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRiskLevels: (limit?: number, offset?: number, order?: string, label?: string, metadata?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * RiskLevelsNERMApi - functional programming interface * @export */ export declare const RiskLevelsNERMApiFp: (configuration?: Configuration) => { /** * Find risk level data by id * @summary Find risk level data * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRiskLevel(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This endpoint can retrieve risk level data in bulk from Lifecycle * @summary Get risk level data * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {string} [order] The field to order results by. * @param {string} [label] The attribute label to filter by * @param {boolean} [metadata] Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRiskLevels(limit?: number, offset?: number, order?: string, label?: string, metadata?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * RiskLevelsNERMApi - factory interface * @export */ export declare const RiskLevelsNERMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Find risk level data by id * @summary Find risk level data * @param {RiskLevelsNERMApiGetRiskLevelRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRiskLevel(requestParameters: RiskLevelsNERMApiGetRiskLevelRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This endpoint can retrieve risk level data in bulk from Lifecycle * @summary Get risk level data * @param {RiskLevelsNERMApiGetRiskLevelsRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRiskLevels(requestParameters?: RiskLevelsNERMApiGetRiskLevelsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for getRiskLevel operation in RiskLevelsNERMApi. * @export * @interface RiskLevelsNERMApiGetRiskLevelRequest */ export interface RiskLevelsNERMApiGetRiskLevelRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof RiskLevelsNERMApiGetRiskLevel */ readonly id: string; } /** * Request parameters for getRiskLevels operation in RiskLevelsNERMApi. * @export * @interface RiskLevelsNERMApiGetRiskLevelsRequest */ export interface RiskLevelsNERMApiGetRiskLevelsRequest { /** * The maximum number of items to return. * @type {number} * @memberof RiskLevelsNERMApiGetRiskLevels */ readonly limit?: number; /** * The number of items to skip before starting to collect the result set. * @type {number} * @memberof RiskLevelsNERMApiGetRiskLevels */ readonly offset?: number; /** * The field to order results by. * @type {string} * @memberof RiskLevelsNERMApiGetRiskLevels */ readonly order?: string; /** * The attribute label to filter by * @type {string} * @memberof RiskLevelsNERMApiGetRiskLevels */ readonly label?: string; /** * Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @type {boolean} * @memberof RiskLevelsNERMApiGetRiskLevels */ readonly metadata?: boolean; } /** * RiskLevelsNERMApi - object-oriented interface * @export * @class RiskLevelsNERMApi * @extends {BaseAPI} */ export declare class RiskLevelsNERMApi extends BaseAPI { /** * Find risk level data by id * @summary Find risk level data * @param {RiskLevelsNERMApiGetRiskLevelRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof RiskLevelsNERMApi */ getRiskLevel(requestParameters: RiskLevelsNERMApiGetRiskLevelRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This endpoint can retrieve risk level data in bulk from Lifecycle * @summary Get risk level data * @param {RiskLevelsNERMApiGetRiskLevelsRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof RiskLevelsNERMApi */ getRiskLevels(requestParameters?: RiskLevelsNERMApiGetRiskLevelsRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * RiskScoresNERMApi - axios parameter creator * @export */ export declare const RiskScoresNERMApiAxiosParamCreator: (configuration?: Configuration) => { /** * Find risk score data by id * @summary Find risk score data * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRiskScore: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This endpoint can retrieve risk score data in bulk from Lifecycle * @summary Get risk score data * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {string} [order] The field to order results by. * @param {string} [objectId] ID of an object for filtering. Used along with object_type * @param {GetRiskScoresObjectTypeNerm} [objectType] Type of object that object_id represents * @param {string} [overallRiskLevelId] Overall risk level to filter by * @param {string} [impactRiskLevelId] Impact risk level to filter by * @param {string} [probabilityRiskLevelId] Probability risk level to filter by * @param {boolean} [metadata] Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRiskScores: (limit?: number, offset?: number, order?: string, objectId?: string, objectType?: GetRiskScoresObjectTypeNerm, overallRiskLevelId?: string, impactRiskLevelId?: string, probabilityRiskLevelId?: string, metadata?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * RiskScoresNERMApi - functional programming interface * @export */ export declare const RiskScoresNERMApiFp: (configuration?: Configuration) => { /** * Find risk score data by id * @summary Find risk score data * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRiskScore(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This endpoint can retrieve risk score data in bulk from Lifecycle * @summary Get risk score data * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {string} [order] The field to order results by. * @param {string} [objectId] ID of an object for filtering. Used along with object_type * @param {GetRiskScoresObjectTypeNerm} [objectType] Type of object that object_id represents * @param {string} [overallRiskLevelId] Overall risk level to filter by * @param {string} [impactRiskLevelId] Impact risk level to filter by * @param {string} [probabilityRiskLevelId] Probability risk level to filter by * @param {boolean} [metadata] Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRiskScores(limit?: number, offset?: number, order?: string, objectId?: string, objectType?: GetRiskScoresObjectTypeNerm, overallRiskLevelId?: string, impactRiskLevelId?: string, probabilityRiskLevelId?: string, metadata?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * RiskScoresNERMApi - factory interface * @export */ export declare const RiskScoresNERMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Find risk score data by id * @summary Find risk score data * @param {RiskScoresNERMApiGetRiskScoreRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRiskScore(requestParameters: RiskScoresNERMApiGetRiskScoreRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This endpoint can retrieve risk score data in bulk from Lifecycle * @summary Get risk score data * @param {RiskScoresNERMApiGetRiskScoresRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRiskScores(requestParameters?: RiskScoresNERMApiGetRiskScoresRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for getRiskScore operation in RiskScoresNERMApi. * @export * @interface RiskScoresNERMApiGetRiskScoreRequest */ export interface RiskScoresNERMApiGetRiskScoreRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof RiskScoresNERMApiGetRiskScore */ readonly id: string; } /** * Request parameters for getRiskScores operation in RiskScoresNERMApi. * @export * @interface RiskScoresNERMApiGetRiskScoresRequest */ export interface RiskScoresNERMApiGetRiskScoresRequest { /** * The maximum number of items to return. * @type {number} * @memberof RiskScoresNERMApiGetRiskScores */ readonly limit?: number; /** * The number of items to skip before starting to collect the result set. * @type {number} * @memberof RiskScoresNERMApiGetRiskScores */ readonly offset?: number; /** * The field to order results by. * @type {string} * @memberof RiskScoresNERMApiGetRiskScores */ readonly order?: string; /** * ID of an object for filtering. Used along with object_type * @type {string} * @memberof RiskScoresNERMApiGetRiskScores */ readonly objectId?: string; /** * Type of object that object_id represents * @type {'Profile' | 'WorkflowSession'} * @memberof RiskScoresNERMApiGetRiskScores */ readonly objectType?: GetRiskScoresObjectTypeNerm; /** * Overall risk level to filter by * @type {string} * @memberof RiskScoresNERMApiGetRiskScores */ readonly overallRiskLevelId?: string; /** * Impact risk level to filter by * @type {string} * @memberof RiskScoresNERMApiGetRiskScores */ readonly impactRiskLevelId?: string; /** * Probability risk level to filter by * @type {string} * @memberof RiskScoresNERMApiGetRiskScores */ readonly probabilityRiskLevelId?: string; /** * Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @type {boolean} * @memberof RiskScoresNERMApiGetRiskScores */ readonly metadata?: boolean; } /** * RiskScoresNERMApi - object-oriented interface * @export * @class RiskScoresNERMApi * @extends {BaseAPI} */ export declare class RiskScoresNERMApi extends BaseAPI { /** * Find risk score data by id * @summary Find risk score data * @param {RiskScoresNERMApiGetRiskScoreRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof RiskScoresNERMApi */ getRiskScore(requestParameters: RiskScoresNERMApiGetRiskScoreRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This endpoint can retrieve risk score data in bulk from Lifecycle * @summary Get risk score data * @param {RiskScoresNERMApiGetRiskScoresRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof RiskScoresNERMApi */ getRiskScores(requestParameters?: RiskScoresNERMApiGetRiskScoresRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const GetRiskScoresObjectTypeNerm: { readonly Profile: "Profile"; readonly WorkflowSession: "WorkflowSession"; }; export type GetRiskScoresObjectTypeNerm = typeof GetRiskScoresObjectTypeNerm[keyof typeof GetRiskScoresObjectTypeNerm]; /** * RoleProfilesNERMApi - axios parameter creator * @export */ export declare const RoleProfilesNERMApiAxiosParamCreator: (configuration?: Configuration) => { /** * Delete a role profile assignment * @summary Delete a role profile assignment * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteRoleProfile: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Find role-profile contributor relationship by id * @summary Find role-profile contributor relationship * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRoleProfile: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Get role-profile contributor relationships * @summary Get role-profile contributor relationships * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {string} [order] The field to order results by. * @param {string} [roleId] The ID of a role for filtering * @param {string} [profileId] Profile ID to filter by * @param {boolean} [metadata] Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRoleProfiles: (limit?: number, offset?: number, order?: string, roleId?: string, profileId?: string, metadata?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update a role-profile contributor relationship by id * @summary Update a role-profile contributor relationship * @param {string} id ID of the object to retrieve, update, or delete * @param {SubmitRoleProfileRequestNERM} submitRoleProfileRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchRoleProfile: (id: string, submitRoleProfileRequestNERM: SubmitRoleProfileRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update multiple role-profile contributor relationships * @summary Update multiple role-profile contributor relationships * @param {SubmitRoleProfilesRequestNERM} submitRoleProfilesRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchRoleProfiles: (submitRoleProfilesRequestNERM: SubmitRoleProfilesRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a role-profile contributor relationship * @summary Create a role-profile contributor relationship * @param {SubmitRoleProfileRequestNERM} submitRoleProfileRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitRoleProfile: (submitRoleProfileRequestNERM: SubmitRoleProfileRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create multiple role-profile contributor relationships * @summary Create multiple role-profile contributor relationships * @param {SubmitRoleProfilesRequestNERM} submitRoleProfilesRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitRoleProfiles: (submitRoleProfilesRequestNERM: SubmitRoleProfilesRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * RoleProfilesNERMApi - functional programming interface * @export */ export declare const RoleProfilesNERMApiFp: (configuration?: Configuration) => { /** * Delete a role profile assignment * @summary Delete a role profile assignment * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteRoleProfile(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Find role-profile contributor relationship by id * @summary Find role-profile contributor relationship * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRoleProfile(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get role-profile contributor relationships * @summary Get role-profile contributor relationships * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {string} [order] The field to order results by. * @param {string} [roleId] The ID of a role for filtering * @param {string} [profileId] Profile ID to filter by * @param {boolean} [metadata] Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRoleProfiles(limit?: number, offset?: number, order?: string, roleId?: string, profileId?: string, metadata?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a role-profile contributor relationship by id * @summary Update a role-profile contributor relationship * @param {string} id ID of the object to retrieve, update, or delete * @param {SubmitRoleProfileRequestNERM} submitRoleProfileRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchRoleProfile(id: string, submitRoleProfileRequestNERM: SubmitRoleProfileRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update multiple role-profile contributor relationships * @summary Update multiple role-profile contributor relationships * @param {SubmitRoleProfilesRequestNERM} submitRoleProfilesRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchRoleProfiles(submitRoleProfilesRequestNERM: SubmitRoleProfilesRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a role-profile contributor relationship * @summary Create a role-profile contributor relationship * @param {SubmitRoleProfileRequestNERM} submitRoleProfileRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitRoleProfile(submitRoleProfileRequestNERM: SubmitRoleProfileRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create multiple role-profile contributor relationships * @summary Create multiple role-profile contributor relationships * @param {SubmitRoleProfilesRequestNERM} submitRoleProfilesRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitRoleProfiles(submitRoleProfilesRequestNERM: SubmitRoleProfilesRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * RoleProfilesNERMApi - factory interface * @export */ export declare const RoleProfilesNERMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Delete a role profile assignment * @summary Delete a role profile assignment * @param {RoleProfilesNERMApiDeleteRoleProfileRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteRoleProfile(requestParameters: RoleProfilesNERMApiDeleteRoleProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Find role-profile contributor relationship by id * @summary Find role-profile contributor relationship * @param {RoleProfilesNERMApiGetRoleProfileRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRoleProfile(requestParameters: RoleProfilesNERMApiGetRoleProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Get role-profile contributor relationships * @summary Get role-profile contributor relationships * @param {RoleProfilesNERMApiGetRoleProfilesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRoleProfiles(requestParameters?: RoleProfilesNERMApiGetRoleProfilesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update a role-profile contributor relationship by id * @summary Update a role-profile contributor relationship * @param {RoleProfilesNERMApiPatchRoleProfileRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchRoleProfile(requestParameters: RoleProfilesNERMApiPatchRoleProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update multiple role-profile contributor relationships * @summary Update multiple role-profile contributor relationships * @param {RoleProfilesNERMApiPatchRoleProfilesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchRoleProfiles(requestParameters: RoleProfilesNERMApiPatchRoleProfilesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a role-profile contributor relationship * @summary Create a role-profile contributor relationship * @param {RoleProfilesNERMApiSubmitRoleProfileRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitRoleProfile(requestParameters: RoleProfilesNERMApiSubmitRoleProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create multiple role-profile contributor relationships * @summary Create multiple role-profile contributor relationships * @param {RoleProfilesNERMApiSubmitRoleProfilesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitRoleProfiles(requestParameters: RoleProfilesNERMApiSubmitRoleProfilesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for deleteRoleProfile operation in RoleProfilesNERMApi. * @export * @interface RoleProfilesNERMApiDeleteRoleProfileRequest */ export interface RoleProfilesNERMApiDeleteRoleProfileRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof RoleProfilesNERMApiDeleteRoleProfile */ readonly id: string; } /** * Request parameters for getRoleProfile operation in RoleProfilesNERMApi. * @export * @interface RoleProfilesNERMApiGetRoleProfileRequest */ export interface RoleProfilesNERMApiGetRoleProfileRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof RoleProfilesNERMApiGetRoleProfile */ readonly id: string; } /** * Request parameters for getRoleProfiles operation in RoleProfilesNERMApi. * @export * @interface RoleProfilesNERMApiGetRoleProfilesRequest */ export interface RoleProfilesNERMApiGetRoleProfilesRequest { /** * The maximum number of items to return. * @type {number} * @memberof RoleProfilesNERMApiGetRoleProfiles */ readonly limit?: number; /** * The number of items to skip before starting to collect the result set. * @type {number} * @memberof RoleProfilesNERMApiGetRoleProfiles */ readonly offset?: number; /** * The field to order results by. * @type {string} * @memberof RoleProfilesNERMApiGetRoleProfiles */ readonly order?: string; /** * The ID of a role for filtering * @type {string} * @memberof RoleProfilesNERMApiGetRoleProfiles */ readonly roleId?: string; /** * Profile ID to filter by * @type {string} * @memberof RoleProfilesNERMApiGetRoleProfiles */ readonly profileId?: string; /** * Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @type {boolean} * @memberof RoleProfilesNERMApiGetRoleProfiles */ readonly metadata?: boolean; } /** * Request parameters for patchRoleProfile operation in RoleProfilesNERMApi. * @export * @interface RoleProfilesNERMApiPatchRoleProfileRequest */ export interface RoleProfilesNERMApiPatchRoleProfileRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof RoleProfilesNERMApiPatchRoleProfile */ readonly id: string; /** * * @type {SubmitRoleProfileRequestNERM} * @memberof RoleProfilesNERMApiPatchRoleProfile */ readonly submitRoleProfileRequestNERM: SubmitRoleProfileRequestNERM; } /** * Request parameters for patchRoleProfiles operation in RoleProfilesNERMApi. * @export * @interface RoleProfilesNERMApiPatchRoleProfilesRequest */ export interface RoleProfilesNERMApiPatchRoleProfilesRequest { /** * * @type {SubmitRoleProfilesRequestNERM} * @memberof RoleProfilesNERMApiPatchRoleProfiles */ readonly submitRoleProfilesRequestNERM: SubmitRoleProfilesRequestNERM; } /** * Request parameters for submitRoleProfile operation in RoleProfilesNERMApi. * @export * @interface RoleProfilesNERMApiSubmitRoleProfileRequest */ export interface RoleProfilesNERMApiSubmitRoleProfileRequest { /** * * @type {SubmitRoleProfileRequestNERM} * @memberof RoleProfilesNERMApiSubmitRoleProfile */ readonly submitRoleProfileRequestNERM: SubmitRoleProfileRequestNERM; } /** * Request parameters for submitRoleProfiles operation in RoleProfilesNERMApi. * @export * @interface RoleProfilesNERMApiSubmitRoleProfilesRequest */ export interface RoleProfilesNERMApiSubmitRoleProfilesRequest { /** * * @type {SubmitRoleProfilesRequestNERM} * @memberof RoleProfilesNERMApiSubmitRoleProfiles */ readonly submitRoleProfilesRequestNERM: SubmitRoleProfilesRequestNERM; } /** * RoleProfilesNERMApi - object-oriented interface * @export * @class RoleProfilesNERMApi * @extends {BaseAPI} */ export declare class RoleProfilesNERMApi extends BaseAPI { /** * Delete a role profile assignment * @summary Delete a role profile assignment * @param {RoleProfilesNERMApiDeleteRoleProfileRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof RoleProfilesNERMApi */ deleteRoleProfile(requestParameters: RoleProfilesNERMApiDeleteRoleProfileRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Find role-profile contributor relationship by id * @summary Find role-profile contributor relationship * @param {RoleProfilesNERMApiGetRoleProfileRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof RoleProfilesNERMApi */ getRoleProfile(requestParameters: RoleProfilesNERMApiGetRoleProfileRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Get role-profile contributor relationships * @summary Get role-profile contributor relationships * @param {RoleProfilesNERMApiGetRoleProfilesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof RoleProfilesNERMApi */ getRoleProfiles(requestParameters?: RoleProfilesNERMApiGetRoleProfilesRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update a role-profile contributor relationship by id * @summary Update a role-profile contributor relationship * @param {RoleProfilesNERMApiPatchRoleProfileRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof RoleProfilesNERMApi */ patchRoleProfile(requestParameters: RoleProfilesNERMApiPatchRoleProfileRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update multiple role-profile contributor relationships * @summary Update multiple role-profile contributor relationships * @param {RoleProfilesNERMApiPatchRoleProfilesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof RoleProfilesNERMApi */ patchRoleProfiles(requestParameters: RoleProfilesNERMApiPatchRoleProfilesRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a role-profile contributor relationship * @summary Create a role-profile contributor relationship * @param {RoleProfilesNERMApiSubmitRoleProfileRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof RoleProfilesNERMApi */ submitRoleProfile(requestParameters: RoleProfilesNERMApiSubmitRoleProfileRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create multiple role-profile contributor relationships * @summary Create multiple role-profile contributor relationships * @param {RoleProfilesNERMApiSubmitRoleProfilesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof RoleProfilesNERMApi */ submitRoleProfiles(requestParameters: RoleProfilesNERMApiSubmitRoleProfilesRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * RolesNERMApi - axios parameter creator * @export */ export declare const RolesNERMApiAxiosParamCreator: (configuration?: Configuration) => { /** * Info for a specific user role * @summary Find role by id * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRole: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This endpoint can retrieve roles from NERM. Optionally you can provide parameters to filter results. * @summary Get roles * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {string} [order] The field to order results by. * @param {boolean} [metadata] Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @param {GetRolesTypeNerm} [type] Filter roles by type. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRoles: (limit?: number, offset?: number, order?: string, metadata?: boolean, type?: GetRolesTypeNerm, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update an existing role * @summary Update an existing role * @param {string} id ID of the object to retrieve, update, or delete * @param {SubmitRoleRequestNERM} submitRoleRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchRole: (id: string, submitRoleRequestNERM: SubmitRoleRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update multiple users * @summary Update multiple roles * @param {SubmitRolesRequestNERM} submitRolesRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchRoles: (submitRolesRequestNERM: SubmitRolesRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a new role * @summary Create a new role * @param {SubmitRoleRequestNERM} submitRoleRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitRole: (submitRoleRequestNERM: SubmitRoleRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create multiple new users * @summary Create multiple new roles * @param {SubmitRolesRequestNERM} submitRolesRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitRoles: (submitRolesRequestNERM: SubmitRolesRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * RolesNERMApi - functional programming interface * @export */ export declare const RolesNERMApiFp: (configuration?: Configuration) => { /** * Info for a specific user role * @summary Find role by id * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRole(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This endpoint can retrieve roles from NERM. Optionally you can provide parameters to filter results. * @summary Get roles * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {string} [order] The field to order results by. * @param {boolean} [metadata] Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @param {GetRolesTypeNerm} [type] Filter roles by type. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRoles(limit?: number, offset?: number, order?: string, metadata?: boolean, type?: GetRolesTypeNerm, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update an existing role * @summary Update an existing role * @param {string} id ID of the object to retrieve, update, or delete * @param {SubmitRoleRequestNERM} submitRoleRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchRole(id: string, submitRoleRequestNERM: SubmitRoleRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update multiple users * @summary Update multiple roles * @param {SubmitRolesRequestNERM} submitRolesRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchRoles(submitRolesRequestNERM: SubmitRolesRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a new role * @summary Create a new role * @param {SubmitRoleRequestNERM} submitRoleRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitRole(submitRoleRequestNERM: SubmitRoleRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create multiple new users * @summary Create multiple new roles * @param {SubmitRolesRequestNERM} submitRolesRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitRoles(submitRolesRequestNERM: SubmitRolesRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * RolesNERMApi - factory interface * @export */ export declare const RolesNERMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Info for a specific user role * @summary Find role by id * @param {RolesNERMApiGetRoleRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRole(requestParameters: RolesNERMApiGetRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This endpoint can retrieve roles from NERM. Optionally you can provide parameters to filter results. * @summary Get roles * @param {RolesNERMApiGetRolesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getRoles(requestParameters?: RolesNERMApiGetRolesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update an existing role * @summary Update an existing role * @param {RolesNERMApiPatchRoleRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchRole(requestParameters: RolesNERMApiPatchRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update multiple users * @summary Update multiple roles * @param {RolesNERMApiPatchRolesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchRoles(requestParameters: RolesNERMApiPatchRolesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a new role * @summary Create a new role * @param {RolesNERMApiSubmitRoleRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitRole(requestParameters: RolesNERMApiSubmitRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create multiple new users * @summary Create multiple new roles * @param {RolesNERMApiSubmitRolesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitRoles(requestParameters: RolesNERMApiSubmitRolesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for getRole operation in RolesNERMApi. * @export * @interface RolesNERMApiGetRoleRequest */ export interface RolesNERMApiGetRoleRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof RolesNERMApiGetRole */ readonly id: string; } /** * Request parameters for getRoles operation in RolesNERMApi. * @export * @interface RolesNERMApiGetRolesRequest */ export interface RolesNERMApiGetRolesRequest { /** * The maximum number of items to return. * @type {number} * @memberof RolesNERMApiGetRoles */ readonly limit?: number; /** * The number of items to skip before starting to collect the result set. * @type {number} * @memberof RolesNERMApiGetRoles */ readonly offset?: number; /** * The field to order results by. * @type {string} * @memberof RolesNERMApiGetRoles */ readonly order?: string; /** * Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @type {boolean} * @memberof RolesNERMApiGetRoles */ readonly metadata?: boolean; /** * Filter roles by type. * @type {'NeprofileRole' | 'NeaccessRole' | 'IdproxyRole'} * @memberof RolesNERMApiGetRoles */ readonly type?: GetRolesTypeNerm; } /** * Request parameters for patchRole operation in RolesNERMApi. * @export * @interface RolesNERMApiPatchRoleRequest */ export interface RolesNERMApiPatchRoleRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof RolesNERMApiPatchRole */ readonly id: string; /** * * @type {SubmitRoleRequestNERM} * @memberof RolesNERMApiPatchRole */ readonly submitRoleRequestNERM: SubmitRoleRequestNERM; } /** * Request parameters for patchRoles operation in RolesNERMApi. * @export * @interface RolesNERMApiPatchRolesRequest */ export interface RolesNERMApiPatchRolesRequest { /** * * @type {SubmitRolesRequestNERM} * @memberof RolesNERMApiPatchRoles */ readonly submitRolesRequestNERM: SubmitRolesRequestNERM; } /** * Request parameters for submitRole operation in RolesNERMApi. * @export * @interface RolesNERMApiSubmitRoleRequest */ export interface RolesNERMApiSubmitRoleRequest { /** * * @type {SubmitRoleRequestNERM} * @memberof RolesNERMApiSubmitRole */ readonly submitRoleRequestNERM: SubmitRoleRequestNERM; } /** * Request parameters for submitRoles operation in RolesNERMApi. * @export * @interface RolesNERMApiSubmitRolesRequest */ export interface RolesNERMApiSubmitRolesRequest { /** * * @type {SubmitRolesRequestNERM} * @memberof RolesNERMApiSubmitRoles */ readonly submitRolesRequestNERM: SubmitRolesRequestNERM; } /** * RolesNERMApi - object-oriented interface * @export * @class RolesNERMApi * @extends {BaseAPI} */ export declare class RolesNERMApi extends BaseAPI { /** * Info for a specific user role * @summary Find role by id * @param {RolesNERMApiGetRoleRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof RolesNERMApi */ getRole(requestParameters: RolesNERMApiGetRoleRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This endpoint can retrieve roles from NERM. Optionally you can provide parameters to filter results. * @summary Get roles * @param {RolesNERMApiGetRolesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof RolesNERMApi */ getRoles(requestParameters?: RolesNERMApiGetRolesRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update an existing role * @summary Update an existing role * @param {RolesNERMApiPatchRoleRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof RolesNERMApi */ patchRole(requestParameters: RolesNERMApiPatchRoleRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update multiple users * @summary Update multiple roles * @param {RolesNERMApiPatchRolesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof RolesNERMApi */ patchRoles(requestParameters: RolesNERMApiPatchRolesRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a new role * @summary Create a new role * @param {RolesNERMApiSubmitRoleRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof RolesNERMApi */ submitRole(requestParameters: RolesNERMApiSubmitRoleRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create multiple new users * @summary Create multiple new roles * @param {RolesNERMApiSubmitRolesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof RolesNERMApi */ submitRoles(requestParameters: RolesNERMApiSubmitRolesRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const GetRolesTypeNerm: { readonly NeprofileRole: "NeprofileRole"; readonly NeaccessRole: "NeaccessRole"; readonly IdproxyRole: "IdproxyRole"; }; export type GetRolesTypeNerm = typeof GetRolesTypeNerm[keyof typeof GetRolesTypeNerm]; /** * SyncedAttributesNERMApi - axios parameter creator * @export */ export declare const SyncedAttributesNERMApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create synced attribute * @summary Create a synced attribute * @param {SyncedAttribute1NERM} syncedAttribute1NERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createSyncedAttribute: (syncedAttribute1NERM: SyncedAttribute1NERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Delete a synced attribute. * @summary Delete synced attribute * @param {string} [profileTypeId] Profile Type ID for filtering * @param {string} [neAttributeId] ID of an attribute for filtering * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteSyncedAttribute: (profileTypeId?: string, neAttributeId?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Get ne attributes and synced attribute relationship to profile type. * @summary profile_types/ne_attributes synced status * @param {string} [profileTypeId] Profile Type ID for filtering * @param {GetProfileTypeAttributesActiveFilterNerm} [activeFilter] Filter for profile type synced attributes * @param {string} [search] Filter by string * @param {number} [page] Pagination items per page * @param {GetProfileTypeAttributesSortParameterNERM} [sort] How records should be sorted * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProfileTypeAttributes: (profileTypeId?: string, activeFilter?: GetProfileTypeAttributesActiveFilterNerm, search?: string, page?: number, sort?: GetProfileTypeAttributesSortParameterNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * SyncedAttributesNERMApi - functional programming interface * @export */ export declare const SyncedAttributesNERMApiFp: (configuration?: Configuration) => { /** * Create synced attribute * @summary Create a synced attribute * @param {SyncedAttribute1NERM} syncedAttribute1NERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createSyncedAttribute(syncedAttribute1NERM: SyncedAttribute1NERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete a synced attribute. * @summary Delete synced attribute * @param {string} [profileTypeId] Profile Type ID for filtering * @param {string} [neAttributeId] ID of an attribute for filtering * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteSyncedAttribute(profileTypeId?: string, neAttributeId?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get ne attributes and synced attribute relationship to profile type. * @summary profile_types/ne_attributes synced status * @param {string} [profileTypeId] Profile Type ID for filtering * @param {GetProfileTypeAttributesActiveFilterNerm} [activeFilter] Filter for profile type synced attributes * @param {string} [search] Filter by string * @param {number} [page] Pagination items per page * @param {GetProfileTypeAttributesSortParameterNERM} [sort] How records should be sorted * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProfileTypeAttributes(profileTypeId?: string, activeFilter?: GetProfileTypeAttributesActiveFilterNerm, search?: string, page?: number, sort?: GetProfileTypeAttributesSortParameterNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * SyncedAttributesNERMApi - factory interface * @export */ export declare const SyncedAttributesNERMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create synced attribute * @summary Create a synced attribute * @param {SyncedAttributesNERMApiCreateSyncedAttributeRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createSyncedAttribute(requestParameters: SyncedAttributesNERMApiCreateSyncedAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Delete a synced attribute. * @summary Delete synced attribute * @param {SyncedAttributesNERMApiDeleteSyncedAttributeRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteSyncedAttribute(requestParameters?: SyncedAttributesNERMApiDeleteSyncedAttributeRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Get ne attributes and synced attribute relationship to profile type. * @summary profile_types/ne_attributes synced status * @param {SyncedAttributesNERMApiGetProfileTypeAttributesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getProfileTypeAttributes(requestParameters?: SyncedAttributesNERMApiGetProfileTypeAttributesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createSyncedAttribute operation in SyncedAttributesNERMApi. * @export * @interface SyncedAttributesNERMApiCreateSyncedAttributeRequest */ export interface SyncedAttributesNERMApiCreateSyncedAttributeRequest { /** * * @type {SyncedAttribute1NERM} * @memberof SyncedAttributesNERMApiCreateSyncedAttribute */ readonly syncedAttribute1NERM: SyncedAttribute1NERM; } /** * Request parameters for deleteSyncedAttribute operation in SyncedAttributesNERMApi. * @export * @interface SyncedAttributesNERMApiDeleteSyncedAttributeRequest */ export interface SyncedAttributesNERMApiDeleteSyncedAttributeRequest { /** * Profile Type ID for filtering * @type {string} * @memberof SyncedAttributesNERMApiDeleteSyncedAttribute */ readonly profileTypeId?: string; /** * ID of an attribute for filtering * @type {string} * @memberof SyncedAttributesNERMApiDeleteSyncedAttribute */ readonly neAttributeId?: string; } /** * Request parameters for getProfileTypeAttributes operation in SyncedAttributesNERMApi. * @export * @interface SyncedAttributesNERMApiGetProfileTypeAttributesRequest */ export interface SyncedAttributesNERMApiGetProfileTypeAttributesRequest { /** * Profile Type ID for filtering * @type {string} * @memberof SyncedAttributesNERMApiGetProfileTypeAttributes */ readonly profileTypeId?: string; /** * Filter for profile type synced attributes * @type {'synced' | 'unsynced' | 'all'} * @memberof SyncedAttributesNERMApiGetProfileTypeAttributes */ readonly activeFilter?: GetProfileTypeAttributesActiveFilterNerm; /** * Filter by string * @type {string} * @memberof SyncedAttributesNERMApiGetProfileTypeAttributes */ readonly search?: string; /** * Pagination items per page * @type {number} * @memberof SyncedAttributesNERMApiGetProfileTypeAttributes */ readonly page?: number; /** * How records should be sorted * @type {GetProfileTypeAttributesSortParameterNERM} * @memberof SyncedAttributesNERMApiGetProfileTypeAttributes */ readonly sort?: GetProfileTypeAttributesSortParameterNERM; } /** * SyncedAttributesNERMApi - object-oriented interface * @export * @class SyncedAttributesNERMApi * @extends {BaseAPI} */ export declare class SyncedAttributesNERMApi extends BaseAPI { /** * Create synced attribute * @summary Create a synced attribute * @param {SyncedAttributesNERMApiCreateSyncedAttributeRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SyncedAttributesNERMApi */ createSyncedAttribute(requestParameters: SyncedAttributesNERMApiCreateSyncedAttributeRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Delete a synced attribute. * @summary Delete synced attribute * @param {SyncedAttributesNERMApiDeleteSyncedAttributeRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SyncedAttributesNERMApi */ deleteSyncedAttribute(requestParameters?: SyncedAttributesNERMApiDeleteSyncedAttributeRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Get ne attributes and synced attribute relationship to profile type. * @summary profile_types/ne_attributes synced status * @param {SyncedAttributesNERMApiGetProfileTypeAttributesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SyncedAttributesNERMApi */ getProfileTypeAttributes(requestParameters?: SyncedAttributesNERMApiGetProfileTypeAttributesRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const GetProfileTypeAttributesActiveFilterNerm: { readonly Synced: "synced"; readonly Unsynced: "unsynced"; readonly All: "all"; }; export type GetProfileTypeAttributesActiveFilterNerm = typeof GetProfileTypeAttributesActiveFilterNerm[keyof typeof GetProfileTypeAttributesActiveFilterNerm]; /** * SystemRolePermissionsNERMApi - axios parameter creator * @export */ export declare const SystemRolePermissionsNERMApiAxiosParamCreator: (configuration?: Configuration) => { /** * This endpoint can create system role permissions for Lifecycle System Roles * @summary Create a system role permission * @param {CreateSystemRolePermissionRequestNERM} createSystemRolePermissionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createSystemRolePermission: (createSystemRolePermissionRequestNERM: CreateSystemRolePermissionRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * SystemRolePermissionsNERMApi - functional programming interface * @export */ export declare const SystemRolePermissionsNERMApiFp: (configuration?: Configuration) => { /** * This endpoint can create system role permissions for Lifecycle System Roles * @summary Create a system role permission * @param {CreateSystemRolePermissionRequestNERM} createSystemRolePermissionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createSystemRolePermission(createSystemRolePermissionRequestNERM: CreateSystemRolePermissionRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * SystemRolePermissionsNERMApi - factory interface * @export */ export declare const SystemRolePermissionsNERMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * This endpoint can create system role permissions for Lifecycle System Roles * @summary Create a system role permission * @param {SystemRolePermissionsNERMApiCreateSystemRolePermissionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createSystemRolePermission(requestParameters: SystemRolePermissionsNERMApiCreateSystemRolePermissionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createSystemRolePermission operation in SystemRolePermissionsNERMApi. * @export * @interface SystemRolePermissionsNERMApiCreateSystemRolePermissionRequest */ export interface SystemRolePermissionsNERMApiCreateSystemRolePermissionRequest { /** * * @type {CreateSystemRolePermissionRequestNERM} * @memberof SystemRolePermissionsNERMApiCreateSystemRolePermission */ readonly createSystemRolePermissionRequestNERM: CreateSystemRolePermissionRequestNERM; } /** * SystemRolePermissionsNERMApi - object-oriented interface * @export * @class SystemRolePermissionsNERMApi * @extends {BaseAPI} */ export declare class SystemRolePermissionsNERMApi extends BaseAPI { /** * This endpoint can create system role permissions for Lifecycle System Roles * @summary Create a system role permission * @param {SystemRolePermissionsNERMApiCreateSystemRolePermissionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SystemRolePermissionsNERMApi */ createSystemRolePermission(requestParameters: SystemRolePermissionsNERMApiCreateSystemRolePermissionRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * SystemRolesNERMApi - axios parameter creator * @export */ export declare const SystemRolesNERMApiAxiosParamCreator: (configuration?: Configuration) => { /** * This endpoint can retrieve system roles from NERM. Optionally you can provide parameters to filter results. * @summary Get system roles * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {string} [order] The field to order results by. * @param {boolean} [metadata] Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSystemRoles: (limit?: number, offset?: number, order?: string, metadata?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * SystemRolesNERMApi - functional programming interface * @export */ export declare const SystemRolesNERMApiFp: (configuration?: Configuration) => { /** * This endpoint can retrieve system roles from NERM. Optionally you can provide parameters to filter results. * @summary Get system roles * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {string} [order] The field to order results by. * @param {boolean} [metadata] Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSystemRoles(limit?: number, offset?: number, order?: string, metadata?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * SystemRolesNERMApi - factory interface * @export */ export declare const SystemRolesNERMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * This endpoint can retrieve system roles from NERM. Optionally you can provide parameters to filter results. * @summary Get system roles * @param {SystemRolesNERMApiGetSystemRolesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getSystemRoles(requestParameters?: SystemRolesNERMApiGetSystemRolesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for getSystemRoles operation in SystemRolesNERMApi. * @export * @interface SystemRolesNERMApiGetSystemRolesRequest */ export interface SystemRolesNERMApiGetSystemRolesRequest { /** * The maximum number of items to return. * @type {number} * @memberof SystemRolesNERMApiGetSystemRoles */ readonly limit?: number; /** * The number of items to skip before starting to collect the result set. * @type {number} * @memberof SystemRolesNERMApiGetSystemRoles */ readonly offset?: number; /** * The field to order results by. * @type {string} * @memberof SystemRolesNERMApiGetSystemRoles */ readonly order?: string; /** * Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @type {boolean} * @memberof SystemRolesNERMApiGetSystemRoles */ readonly metadata?: boolean; } /** * SystemRolesNERMApi - object-oriented interface * @export * @class SystemRolesNERMApi * @extends {BaseAPI} */ export declare class SystemRolesNERMApi extends BaseAPI { /** * This endpoint can retrieve system roles from NERM. Optionally you can provide parameters to filter results. * @summary Get system roles * @param {SystemRolesNERMApiGetSystemRolesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof SystemRolesNERMApi */ getSystemRoles(requestParameters?: SystemRolesNERMApiGetSystemRolesRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * UserManagersNERMApi - axios parameter creator * @export */ export declare const UserManagersNERMApiAxiosParamCreator: (configuration?: Configuration) => { /** * Info for a specific user-manager relationship * @summary Find user-manager relationship * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getUserManager: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This endpoint can retrieve user-manager relationships from Lifecycle or you can search for user-manager relationships using parameters * @summary Get user-manager relationships * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {string} [order] The field to order results by. * @param {string} [userId] The ID of a user for filtering * @param {string} [managerId] The ID of a user for filtering * @param {boolean} [metadata] Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getUserManagers: (limit?: number, offset?: number, order?: string, userId?: string, managerId?: string, metadata?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update a user-manager relationship by id * @summary Update a user-manager relationship * @param {string} id ID of the object to retrieve, update, or delete * @param {SubmitUserManagerRequestNERM} submitUserManagerRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchUserManager: (id: string, submitUserManagerRequestNERM: SubmitUserManagerRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update multiple user-manager relationships * @summary Update multiple user-manager relationships * @param {SubmitUserManagersRequestNERM} submitUserManagersRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchUserManagers: (submitUserManagersRequestNERM: SubmitUserManagersRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a new user-manager relationship * @summary Create a new user-manager relationship * @param {SubmitUserManagerRequestNERM} submitUserManagerRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitUserManager: (submitUserManagerRequestNERM: SubmitUserManagerRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create multiple new user-manager relationships * @summary Create multiple new user-manager relationships * @param {SubmitUserManagersRequestNERM} submitUserManagersRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitUserManagers: (submitUserManagersRequestNERM: SubmitUserManagersRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * UserManagersNERMApi - functional programming interface * @export */ export declare const UserManagersNERMApiFp: (configuration?: Configuration) => { /** * Info for a specific user-manager relationship * @summary Find user-manager relationship * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getUserManager(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This endpoint can retrieve user-manager relationships from Lifecycle or you can search for user-manager relationships using parameters * @summary Get user-manager relationships * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {string} [order] The field to order results by. * @param {string} [userId] The ID of a user for filtering * @param {string} [managerId] The ID of a user for filtering * @param {boolean} [metadata] Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getUserManagers(limit?: number, offset?: number, order?: string, userId?: string, managerId?: string, metadata?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a user-manager relationship by id * @summary Update a user-manager relationship * @param {string} id ID of the object to retrieve, update, or delete * @param {SubmitUserManagerRequestNERM} submitUserManagerRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchUserManager(id: string, submitUserManagerRequestNERM: SubmitUserManagerRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update multiple user-manager relationships * @summary Update multiple user-manager relationships * @param {SubmitUserManagersRequestNERM} submitUserManagersRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchUserManagers(submitUserManagersRequestNERM: SubmitUserManagersRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a new user-manager relationship * @summary Create a new user-manager relationship * @param {SubmitUserManagerRequestNERM} submitUserManagerRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitUserManager(submitUserManagerRequestNERM: SubmitUserManagerRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create multiple new user-manager relationships * @summary Create multiple new user-manager relationships * @param {SubmitUserManagersRequestNERM} submitUserManagersRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitUserManagers(submitUserManagersRequestNERM: SubmitUserManagersRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * UserManagersNERMApi - factory interface * @export */ export declare const UserManagersNERMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Info for a specific user-manager relationship * @summary Find user-manager relationship * @param {UserManagersNERMApiGetUserManagerRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getUserManager(requestParameters: UserManagersNERMApiGetUserManagerRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This endpoint can retrieve user-manager relationships from Lifecycle or you can search for user-manager relationships using parameters * @summary Get user-manager relationships * @param {UserManagersNERMApiGetUserManagersRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getUserManagers(requestParameters?: UserManagersNERMApiGetUserManagersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update a user-manager relationship by id * @summary Update a user-manager relationship * @param {UserManagersNERMApiPatchUserManagerRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchUserManager(requestParameters: UserManagersNERMApiPatchUserManagerRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update multiple user-manager relationships * @summary Update multiple user-manager relationships * @param {UserManagersNERMApiPatchUserManagersRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchUserManagers(requestParameters: UserManagersNERMApiPatchUserManagersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a new user-manager relationship * @summary Create a new user-manager relationship * @param {UserManagersNERMApiSubmitUserManagerRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitUserManager(requestParameters: UserManagersNERMApiSubmitUserManagerRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create multiple new user-manager relationships * @summary Create multiple new user-manager relationships * @param {UserManagersNERMApiSubmitUserManagersRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitUserManagers(requestParameters: UserManagersNERMApiSubmitUserManagersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for getUserManager operation in UserManagersNERMApi. * @export * @interface UserManagersNERMApiGetUserManagerRequest */ export interface UserManagersNERMApiGetUserManagerRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof UserManagersNERMApiGetUserManager */ readonly id: string; } /** * Request parameters for getUserManagers operation in UserManagersNERMApi. * @export * @interface UserManagersNERMApiGetUserManagersRequest */ export interface UserManagersNERMApiGetUserManagersRequest { /** * The maximum number of items to return. * @type {number} * @memberof UserManagersNERMApiGetUserManagers */ readonly limit?: number; /** * The number of items to skip before starting to collect the result set. * @type {number} * @memberof UserManagersNERMApiGetUserManagers */ readonly offset?: number; /** * The field to order results by. * @type {string} * @memberof UserManagersNERMApiGetUserManagers */ readonly order?: string; /** * The ID of a user for filtering * @type {string} * @memberof UserManagersNERMApiGetUserManagers */ readonly userId?: string; /** * The ID of a user for filtering * @type {string} * @memberof UserManagersNERMApiGetUserManagers */ readonly managerId?: string; /** * Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @type {boolean} * @memberof UserManagersNERMApiGetUserManagers */ readonly metadata?: boolean; } /** * Request parameters for patchUserManager operation in UserManagersNERMApi. * @export * @interface UserManagersNERMApiPatchUserManagerRequest */ export interface UserManagersNERMApiPatchUserManagerRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof UserManagersNERMApiPatchUserManager */ readonly id: string; /** * * @type {SubmitUserManagerRequestNERM} * @memberof UserManagersNERMApiPatchUserManager */ readonly submitUserManagerRequestNERM: SubmitUserManagerRequestNERM; } /** * Request parameters for patchUserManagers operation in UserManagersNERMApi. * @export * @interface UserManagersNERMApiPatchUserManagersRequest */ export interface UserManagersNERMApiPatchUserManagersRequest { /** * * @type {SubmitUserManagersRequestNERM} * @memberof UserManagersNERMApiPatchUserManagers */ readonly submitUserManagersRequestNERM: SubmitUserManagersRequestNERM; } /** * Request parameters for submitUserManager operation in UserManagersNERMApi. * @export * @interface UserManagersNERMApiSubmitUserManagerRequest */ export interface UserManagersNERMApiSubmitUserManagerRequest { /** * * @type {SubmitUserManagerRequestNERM} * @memberof UserManagersNERMApiSubmitUserManager */ readonly submitUserManagerRequestNERM: SubmitUserManagerRequestNERM; } /** * Request parameters for submitUserManagers operation in UserManagersNERMApi. * @export * @interface UserManagersNERMApiSubmitUserManagersRequest */ export interface UserManagersNERMApiSubmitUserManagersRequest { /** * * @type {SubmitUserManagersRequestNERM} * @memberof UserManagersNERMApiSubmitUserManagers */ readonly submitUserManagersRequestNERM: SubmitUserManagersRequestNERM; } /** * UserManagersNERMApi - object-oriented interface * @export * @class UserManagersNERMApi * @extends {BaseAPI} */ export declare class UserManagersNERMApi extends BaseAPI { /** * Info for a specific user-manager relationship * @summary Find user-manager relationship * @param {UserManagersNERMApiGetUserManagerRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof UserManagersNERMApi */ getUserManager(requestParameters: UserManagersNERMApiGetUserManagerRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This endpoint can retrieve user-manager relationships from Lifecycle or you can search for user-manager relationships using parameters * @summary Get user-manager relationships * @param {UserManagersNERMApiGetUserManagersRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof UserManagersNERMApi */ getUserManagers(requestParameters?: UserManagersNERMApiGetUserManagersRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update a user-manager relationship by id * @summary Update a user-manager relationship * @param {UserManagersNERMApiPatchUserManagerRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof UserManagersNERMApi */ patchUserManager(requestParameters: UserManagersNERMApiPatchUserManagerRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update multiple user-manager relationships * @summary Update multiple user-manager relationships * @param {UserManagersNERMApiPatchUserManagersRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof UserManagersNERMApi */ patchUserManagers(requestParameters: UserManagersNERMApiPatchUserManagersRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a new user-manager relationship * @summary Create a new user-manager relationship * @param {UserManagersNERMApiSubmitUserManagerRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof UserManagersNERMApi */ submitUserManager(requestParameters: UserManagersNERMApiSubmitUserManagerRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create multiple new user-manager relationships * @summary Create multiple new user-manager relationships * @param {UserManagersNERMApiSubmitUserManagersRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof UserManagersNERMApi */ submitUserManagers(requestParameters: UserManagersNERMApiSubmitUserManagersRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * UserProfilesNERMApi - axios parameter creator * @export */ export declare const UserProfilesNERMApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create multiple user-profile contributor relationships * @summary Create multiple user-profile contributor relationships * @param {CreateUserProfilesRequestNERM} createUserProfilesRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createUserProfiles: (createUserProfilesRequestNERM: CreateUserProfilesRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Delete a user profile assignment * @summary Delete a user profile assignment * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteUserProfile: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Delete multiple user-profile contributor relationships * @summary Delete multiple user-profile contributor relationships * @param {CreateUserProfilesRequestNERM} createUserProfilesRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteUserProfiles: (createUserProfilesRequestNERM: CreateUserProfilesRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Find user-profile contributor relationship by id * @summary Find user-profile contributor relationship * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getUserProfile: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Get user-profile contributor relationships * @summary Get user-profile contributor relationships * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {string} [order] The field to order results by. * @param {string} [userId] The ID of a user for filtering * @param {string} [neAttributeId] ID of an attribute for filtering * @param {string} [profileId] Profile ID to filter by * @param {GetUserProfilesRelationshipTypeNerm} [relationshipType] Type of user contributor relationship to filter by * @param {boolean} [metadata] Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getUserProfiles: (limit?: number, offset?: number, order?: string, userId?: string, neAttributeId?: string, profileId?: string, relationshipType?: GetUserProfilesRelationshipTypeNerm, metadata?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update a user-profile contributor relationship by id * @summary Update a user-profile contributor relationship * @param {string} id ID of the object to retrieve, update, or delete * @param {SubmitUserProfileRequestNERM} submitUserProfileRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchUserProfile: (id: string, submitUserProfileRequestNERM: SubmitUserProfileRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update multiple user-profile contributor relationships * @summary Update multiple user-profile contributor relationships * @param {CreateUserProfilesRequestNERM} createUserProfilesRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchUserProfiles: (createUserProfilesRequestNERM: CreateUserProfilesRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a user-profile contributor relationship * @summary Create a user-profile contributor relationship * @param {SubmitUserProfileRequestNERM} submitUserProfileRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitUserProfile: (submitUserProfileRequestNERM: SubmitUserProfileRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * UserProfilesNERMApi - functional programming interface * @export */ export declare const UserProfilesNERMApiFp: (configuration?: Configuration) => { /** * Create multiple user-profile contributor relationships * @summary Create multiple user-profile contributor relationships * @param {CreateUserProfilesRequestNERM} createUserProfilesRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createUserProfiles(createUserProfilesRequestNERM: CreateUserProfilesRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete a user profile assignment * @summary Delete a user profile assignment * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteUserProfile(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete multiple user-profile contributor relationships * @summary Delete multiple user-profile contributor relationships * @param {CreateUserProfilesRequestNERM} createUserProfilesRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteUserProfiles(createUserProfilesRequestNERM: CreateUserProfilesRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Find user-profile contributor relationship by id * @summary Find user-profile contributor relationship * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getUserProfile(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get user-profile contributor relationships * @summary Get user-profile contributor relationships * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {string} [order] The field to order results by. * @param {string} [userId] The ID of a user for filtering * @param {string} [neAttributeId] ID of an attribute for filtering * @param {string} [profileId] Profile ID to filter by * @param {GetUserProfilesRelationshipTypeNerm} [relationshipType] Type of user contributor relationship to filter by * @param {boolean} [metadata] Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getUserProfiles(limit?: number, offset?: number, order?: string, userId?: string, neAttributeId?: string, profileId?: string, relationshipType?: GetUserProfilesRelationshipTypeNerm, metadata?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a user-profile contributor relationship by id * @summary Update a user-profile contributor relationship * @param {string} id ID of the object to retrieve, update, or delete * @param {SubmitUserProfileRequestNERM} submitUserProfileRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchUserProfile(id: string, submitUserProfileRequestNERM: SubmitUserProfileRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update multiple user-profile contributor relationships * @summary Update multiple user-profile contributor relationships * @param {CreateUserProfilesRequestNERM} createUserProfilesRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchUserProfiles(createUserProfilesRequestNERM: CreateUserProfilesRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a user-profile contributor relationship * @summary Create a user-profile contributor relationship * @param {SubmitUserProfileRequestNERM} submitUserProfileRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitUserProfile(submitUserProfileRequestNERM: SubmitUserProfileRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * UserProfilesNERMApi - factory interface * @export */ export declare const UserProfilesNERMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create multiple user-profile contributor relationships * @summary Create multiple user-profile contributor relationships * @param {UserProfilesNERMApiCreateUserProfilesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createUserProfiles(requestParameters: UserProfilesNERMApiCreateUserProfilesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Delete a user profile assignment * @summary Delete a user profile assignment * @param {UserProfilesNERMApiDeleteUserProfileRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteUserProfile(requestParameters: UserProfilesNERMApiDeleteUserProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Delete multiple user-profile contributor relationships * @summary Delete multiple user-profile contributor relationships * @param {UserProfilesNERMApiDeleteUserProfilesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteUserProfiles(requestParameters: UserProfilesNERMApiDeleteUserProfilesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Find user-profile contributor relationship by id * @summary Find user-profile contributor relationship * @param {UserProfilesNERMApiGetUserProfileRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getUserProfile(requestParameters: UserProfilesNERMApiGetUserProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Get user-profile contributor relationships * @summary Get user-profile contributor relationships * @param {UserProfilesNERMApiGetUserProfilesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getUserProfiles(requestParameters?: UserProfilesNERMApiGetUserProfilesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update a user-profile contributor relationship by id * @summary Update a user-profile contributor relationship * @param {UserProfilesNERMApiPatchUserProfileRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchUserProfile(requestParameters: UserProfilesNERMApiPatchUserProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update multiple user-profile contributor relationships * @summary Update multiple user-profile contributor relationships * @param {UserProfilesNERMApiPatchUserProfilesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchUserProfiles(requestParameters: UserProfilesNERMApiPatchUserProfilesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a user-profile contributor relationship * @summary Create a user-profile contributor relationship * @param {UserProfilesNERMApiSubmitUserProfileRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitUserProfile(requestParameters: UserProfilesNERMApiSubmitUserProfileRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createUserProfiles operation in UserProfilesNERMApi. * @export * @interface UserProfilesNERMApiCreateUserProfilesRequest */ export interface UserProfilesNERMApiCreateUserProfilesRequest { /** * * @type {CreateUserProfilesRequestNERM} * @memberof UserProfilesNERMApiCreateUserProfiles */ readonly createUserProfilesRequestNERM: CreateUserProfilesRequestNERM; } /** * Request parameters for deleteUserProfile operation in UserProfilesNERMApi. * @export * @interface UserProfilesNERMApiDeleteUserProfileRequest */ export interface UserProfilesNERMApiDeleteUserProfileRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof UserProfilesNERMApiDeleteUserProfile */ readonly id: string; } /** * Request parameters for deleteUserProfiles operation in UserProfilesNERMApi. * @export * @interface UserProfilesNERMApiDeleteUserProfilesRequest */ export interface UserProfilesNERMApiDeleteUserProfilesRequest { /** * * @type {CreateUserProfilesRequestNERM} * @memberof UserProfilesNERMApiDeleteUserProfiles */ readonly createUserProfilesRequestNERM: CreateUserProfilesRequestNERM; } /** * Request parameters for getUserProfile operation in UserProfilesNERMApi. * @export * @interface UserProfilesNERMApiGetUserProfileRequest */ export interface UserProfilesNERMApiGetUserProfileRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof UserProfilesNERMApiGetUserProfile */ readonly id: string; } /** * Request parameters for getUserProfiles operation in UserProfilesNERMApi. * @export * @interface UserProfilesNERMApiGetUserProfilesRequest */ export interface UserProfilesNERMApiGetUserProfilesRequest { /** * The maximum number of items to return. * @type {number} * @memberof UserProfilesNERMApiGetUserProfiles */ readonly limit?: number; /** * The number of items to skip before starting to collect the result set. * @type {number} * @memberof UserProfilesNERMApiGetUserProfiles */ readonly offset?: number; /** * The field to order results by. * @type {string} * @memberof UserProfilesNERMApiGetUserProfiles */ readonly order?: string; /** * The ID of a user for filtering * @type {string} * @memberof UserProfilesNERMApiGetUserProfiles */ readonly userId?: string; /** * ID of an attribute for filtering * @type {string} * @memberof UserProfilesNERMApiGetUserProfiles */ readonly neAttributeId?: string; /** * Profile ID to filter by * @type {string} * @memberof UserProfilesNERMApiGetUserProfiles */ readonly profileId?: string; /** * Type of user contributor relationship to filter by * @type {'owner' | 'contributor'} * @memberof UserProfilesNERMApiGetUserProfiles */ readonly relationshipType?: GetUserProfilesRelationshipTypeNerm; /** * Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @type {boolean} * @memberof UserProfilesNERMApiGetUserProfiles */ readonly metadata?: boolean; } /** * Request parameters for patchUserProfile operation in UserProfilesNERMApi. * @export * @interface UserProfilesNERMApiPatchUserProfileRequest */ export interface UserProfilesNERMApiPatchUserProfileRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof UserProfilesNERMApiPatchUserProfile */ readonly id: string; /** * * @type {SubmitUserProfileRequestNERM} * @memberof UserProfilesNERMApiPatchUserProfile */ readonly submitUserProfileRequestNERM: SubmitUserProfileRequestNERM; } /** * Request parameters for patchUserProfiles operation in UserProfilesNERMApi. * @export * @interface UserProfilesNERMApiPatchUserProfilesRequest */ export interface UserProfilesNERMApiPatchUserProfilesRequest { /** * * @type {CreateUserProfilesRequestNERM} * @memberof UserProfilesNERMApiPatchUserProfiles */ readonly createUserProfilesRequestNERM: CreateUserProfilesRequestNERM; } /** * Request parameters for submitUserProfile operation in UserProfilesNERMApi. * @export * @interface UserProfilesNERMApiSubmitUserProfileRequest */ export interface UserProfilesNERMApiSubmitUserProfileRequest { /** * * @type {SubmitUserProfileRequestNERM} * @memberof UserProfilesNERMApiSubmitUserProfile */ readonly submitUserProfileRequestNERM: SubmitUserProfileRequestNERM; } /** * UserProfilesNERMApi - object-oriented interface * @export * @class UserProfilesNERMApi * @extends {BaseAPI} */ export declare class UserProfilesNERMApi extends BaseAPI { /** * Create multiple user-profile contributor relationships * @summary Create multiple user-profile contributor relationships * @param {UserProfilesNERMApiCreateUserProfilesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof UserProfilesNERMApi */ createUserProfiles(requestParameters: UserProfilesNERMApiCreateUserProfilesRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Delete a user profile assignment * @summary Delete a user profile assignment * @param {UserProfilesNERMApiDeleteUserProfileRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof UserProfilesNERMApi */ deleteUserProfile(requestParameters: UserProfilesNERMApiDeleteUserProfileRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Delete multiple user-profile contributor relationships * @summary Delete multiple user-profile contributor relationships * @param {UserProfilesNERMApiDeleteUserProfilesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof UserProfilesNERMApi */ deleteUserProfiles(requestParameters: UserProfilesNERMApiDeleteUserProfilesRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Find user-profile contributor relationship by id * @summary Find user-profile contributor relationship * @param {UserProfilesNERMApiGetUserProfileRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof UserProfilesNERMApi */ getUserProfile(requestParameters: UserProfilesNERMApiGetUserProfileRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Get user-profile contributor relationships * @summary Get user-profile contributor relationships * @param {UserProfilesNERMApiGetUserProfilesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof UserProfilesNERMApi */ getUserProfiles(requestParameters?: UserProfilesNERMApiGetUserProfilesRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update a user-profile contributor relationship by id * @summary Update a user-profile contributor relationship * @param {UserProfilesNERMApiPatchUserProfileRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof UserProfilesNERMApi */ patchUserProfile(requestParameters: UserProfilesNERMApiPatchUserProfileRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update multiple user-profile contributor relationships * @summary Update multiple user-profile contributor relationships * @param {UserProfilesNERMApiPatchUserProfilesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof UserProfilesNERMApi */ patchUserProfiles(requestParameters: UserProfilesNERMApiPatchUserProfilesRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a user-profile contributor relationship * @summary Create a user-profile contributor relationship * @param {UserProfilesNERMApiSubmitUserProfileRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof UserProfilesNERMApi */ submitUserProfile(requestParameters: UserProfilesNERMApiSubmitUserProfileRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const GetUserProfilesRelationshipTypeNerm: { readonly Owner: "owner"; readonly Contributor: "contributor"; }; export type GetUserProfilesRelationshipTypeNerm = typeof GetUserProfilesRelationshipTypeNerm[keyof typeof GetUserProfilesRelationshipTypeNerm]; /** * UserRolesNERMApi - axios parameter creator * @export */ export declare const UserRolesNERMApiAxiosParamCreator: (configuration?: Configuration) => { /** * Delete a user role assignment * @summary Delete a user role assignment * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteUserRole: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Info for a specific user role pairing * @summary Find user role pairing * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getUserRole: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This endpoint can retrieve user role pairings from Lifecycle or you can search for user role pairings using parameters * @summary Get user role pairings * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {string} [order] The field to order results by. * @param {string} [userId] The ID of a user for filtering * @param {string} [roleId] The ID of a role for filtering * @param {boolean} [metadata] Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getUserRoles: (limit?: number, offset?: number, order?: string, userId?: string, roleId?: string, metadata?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update a user role pairing by id * @summary Update a user role pairing * @param {string} id ID of the object to retrieve, update, or delete * @param {SubmitUserRoleRequestNERM} submitUserRoleRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchUserRole: (id: string, submitUserRoleRequestNERM: SubmitUserRoleRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update multiple user role pairings * @summary Update multiple user role pairings * @param {SubmitUserRolesRequestNERM} submitUserRolesRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchUserRoles: (submitUserRolesRequestNERM: SubmitUserRolesRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Assign a new role to a user * @summary Assign new role to user * @param {SubmitUserRoleRequestNERM} submitUserRoleRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitUserRole: (submitUserRoleRequestNERM: SubmitUserRoleRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create multiple new user role pairings * @summary Create new user role pairings * @param {SubmitUserRolesRequestNERM} submitUserRolesRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitUserRoles: (submitUserRolesRequestNERM: SubmitUserRolesRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * UserRolesNERMApi - functional programming interface * @export */ export declare const UserRolesNERMApiFp: (configuration?: Configuration) => { /** * Delete a user role assignment * @summary Delete a user role assignment * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteUserRole(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Info for a specific user role pairing * @summary Find user role pairing * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getUserRole(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This endpoint can retrieve user role pairings from Lifecycle or you can search for user role pairings using parameters * @summary Get user role pairings * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {string} [order] The field to order results by. * @param {string} [userId] The ID of a user for filtering * @param {string} [roleId] The ID of a role for filtering * @param {boolean} [metadata] Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getUserRoles(limit?: number, offset?: number, order?: string, userId?: string, roleId?: string, metadata?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a user role pairing by id * @summary Update a user role pairing * @param {string} id ID of the object to retrieve, update, or delete * @param {SubmitUserRoleRequestNERM} submitUserRoleRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchUserRole(id: string, submitUserRoleRequestNERM: SubmitUserRoleRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update multiple user role pairings * @summary Update multiple user role pairings * @param {SubmitUserRolesRequestNERM} submitUserRolesRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchUserRoles(submitUserRolesRequestNERM: SubmitUserRolesRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Assign a new role to a user * @summary Assign new role to user * @param {SubmitUserRoleRequestNERM} submitUserRoleRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitUserRole(submitUserRoleRequestNERM: SubmitUserRoleRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create multiple new user role pairings * @summary Create new user role pairings * @param {SubmitUserRolesRequestNERM} submitUserRolesRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitUserRoles(submitUserRolesRequestNERM: SubmitUserRolesRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * UserRolesNERMApi - factory interface * @export */ export declare const UserRolesNERMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Delete a user role assignment * @summary Delete a user role assignment * @param {UserRolesNERMApiDeleteUserRoleRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteUserRole(requestParameters: UserRolesNERMApiDeleteUserRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Info for a specific user role pairing * @summary Find user role pairing * @param {UserRolesNERMApiGetUserRoleRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getUserRole(requestParameters: UserRolesNERMApiGetUserRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This endpoint can retrieve user role pairings from Lifecycle or you can search for user role pairings using parameters * @summary Get user role pairings * @param {UserRolesNERMApiGetUserRolesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getUserRoles(requestParameters?: UserRolesNERMApiGetUserRolesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update a user role pairing by id * @summary Update a user role pairing * @param {UserRolesNERMApiPatchUserRoleRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchUserRole(requestParameters: UserRolesNERMApiPatchUserRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update multiple user role pairings * @summary Update multiple user role pairings * @param {UserRolesNERMApiPatchUserRolesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchUserRoles(requestParameters: UserRolesNERMApiPatchUserRolesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Assign a new role to a user * @summary Assign new role to user * @param {UserRolesNERMApiSubmitUserRoleRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitUserRole(requestParameters: UserRolesNERMApiSubmitUserRoleRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create multiple new user role pairings * @summary Create new user role pairings * @param {UserRolesNERMApiSubmitUserRolesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitUserRoles(requestParameters: UserRolesNERMApiSubmitUserRolesRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for deleteUserRole operation in UserRolesNERMApi. * @export * @interface UserRolesNERMApiDeleteUserRoleRequest */ export interface UserRolesNERMApiDeleteUserRoleRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof UserRolesNERMApiDeleteUserRole */ readonly id: string; } /** * Request parameters for getUserRole operation in UserRolesNERMApi. * @export * @interface UserRolesNERMApiGetUserRoleRequest */ export interface UserRolesNERMApiGetUserRoleRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof UserRolesNERMApiGetUserRole */ readonly id: string; } /** * Request parameters for getUserRoles operation in UserRolesNERMApi. * @export * @interface UserRolesNERMApiGetUserRolesRequest */ export interface UserRolesNERMApiGetUserRolesRequest { /** * The maximum number of items to return. * @type {number} * @memberof UserRolesNERMApiGetUserRoles */ readonly limit?: number; /** * The number of items to skip before starting to collect the result set. * @type {number} * @memberof UserRolesNERMApiGetUserRoles */ readonly offset?: number; /** * The field to order results by. * @type {string} * @memberof UserRolesNERMApiGetUserRoles */ readonly order?: string; /** * The ID of a user for filtering * @type {string} * @memberof UserRolesNERMApiGetUserRoles */ readonly userId?: string; /** * The ID of a role for filtering * @type {string} * @memberof UserRolesNERMApiGetUserRoles */ readonly roleId?: string; /** * Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @type {boolean} * @memberof UserRolesNERMApiGetUserRoles */ readonly metadata?: boolean; } /** * Request parameters for patchUserRole operation in UserRolesNERMApi. * @export * @interface UserRolesNERMApiPatchUserRoleRequest */ export interface UserRolesNERMApiPatchUserRoleRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof UserRolesNERMApiPatchUserRole */ readonly id: string; /** * * @type {SubmitUserRoleRequestNERM} * @memberof UserRolesNERMApiPatchUserRole */ readonly submitUserRoleRequestNERM: SubmitUserRoleRequestNERM; } /** * Request parameters for patchUserRoles operation in UserRolesNERMApi. * @export * @interface UserRolesNERMApiPatchUserRolesRequest */ export interface UserRolesNERMApiPatchUserRolesRequest { /** * * @type {SubmitUserRolesRequestNERM} * @memberof UserRolesNERMApiPatchUserRoles */ readonly submitUserRolesRequestNERM: SubmitUserRolesRequestNERM; } /** * Request parameters for submitUserRole operation in UserRolesNERMApi. * @export * @interface UserRolesNERMApiSubmitUserRoleRequest */ export interface UserRolesNERMApiSubmitUserRoleRequest { /** * * @type {SubmitUserRoleRequestNERM} * @memberof UserRolesNERMApiSubmitUserRole */ readonly submitUserRoleRequestNERM: SubmitUserRoleRequestNERM; } /** * Request parameters for submitUserRoles operation in UserRolesNERMApi. * @export * @interface UserRolesNERMApiSubmitUserRolesRequest */ export interface UserRolesNERMApiSubmitUserRolesRequest { /** * * @type {SubmitUserRolesRequestNERM} * @memberof UserRolesNERMApiSubmitUserRoles */ readonly submitUserRolesRequestNERM: SubmitUserRolesRequestNERM; } /** * UserRolesNERMApi - object-oriented interface * @export * @class UserRolesNERMApi * @extends {BaseAPI} */ export declare class UserRolesNERMApi extends BaseAPI { /** * Delete a user role assignment * @summary Delete a user role assignment * @param {UserRolesNERMApiDeleteUserRoleRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof UserRolesNERMApi */ deleteUserRole(requestParameters: UserRolesNERMApiDeleteUserRoleRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Info for a specific user role pairing * @summary Find user role pairing * @param {UserRolesNERMApiGetUserRoleRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof UserRolesNERMApi */ getUserRole(requestParameters: UserRolesNERMApiGetUserRoleRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This endpoint can retrieve user role pairings from Lifecycle or you can search for user role pairings using parameters * @summary Get user role pairings * @param {UserRolesNERMApiGetUserRolesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof UserRolesNERMApi */ getUserRoles(requestParameters?: UserRolesNERMApiGetUserRolesRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update a user role pairing by id * @summary Update a user role pairing * @param {UserRolesNERMApiPatchUserRoleRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof UserRolesNERMApi */ patchUserRole(requestParameters: UserRolesNERMApiPatchUserRoleRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update multiple user role pairings * @summary Update multiple user role pairings * @param {UserRolesNERMApiPatchUserRolesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof UserRolesNERMApi */ patchUserRoles(requestParameters: UserRolesNERMApiPatchUserRolesRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Assign a new role to a user * @summary Assign new role to user * @param {UserRolesNERMApiSubmitUserRoleRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof UserRolesNERMApi */ submitUserRole(requestParameters: UserRolesNERMApiSubmitUserRoleRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create multiple new user role pairings * @summary Create new user role pairings * @param {UserRolesNERMApiSubmitUserRolesRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof UserRolesNERMApi */ submitUserRoles(requestParameters: UserRolesNERMApiSubmitUserRolesRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * UsersNERMApi - axios parameter creator * @export */ export declare const UsersNERMApiAxiosParamCreator: (configuration?: Configuration) => { /** * Delete a user * @summary Delete a user * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteUser: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Info for a specific user * @summary Find user by id * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getUser: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Retrieves the URL of the user avatar * @summary Retrieves URL user avatar * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getUserAvatar: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This endpoint can retrieve users from Lifecycle or you can search for users using parameters * @summary Get users * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {string} [order] The field to order results by. * @param {string} [name] object name for filtering * @param {string} [login] The user login to search by * @param {string} [title] The user title to search by * @param {GetUsersUserStatusNerm} [userStatus] user status value for filtering * @param {GetUsersTypeNerm} [type] user type * @param {string} [email] The user email to search by * @param {boolean} [metadata] Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @param {string} [sailpointIdentityId] SailPoint identity ID * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getUsers: (limit?: number, offset?: number, order?: string, name?: string, login?: string, title?: string, userStatus?: GetUsersUserStatusNerm, type?: GetUsersTypeNerm, email?: string, metadata?: boolean, sailpointIdentityId?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update a user by id * @summary Update a user by id * @param {string} id ID of the object to retrieve, update, or delete * @param {SubmitUserRequestNERM} submitUserRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchUser: (id: string, submitUserRequestNERM: SubmitUserRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update multiple users * @summary Update multiple users * @param {SubmitUsersRequestNERM} submitUsersRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchUsers: (submitUsersRequestNERM: SubmitUsersRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a new user * @summary Create a new user * @param {SubmitUserRequestNERM} submitUserRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitUser: (submitUserRequestNERM: SubmitUserRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Uploads a new user avatar * @summary Uploads new user avatar * @param {string} id ID of the object to retrieve, update, or delete * @param {File} [file] * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitUserAvatar: (id: string, file?: File, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create multiple new users * @summary Create multiple new users * @param {SubmitUsersRequestNERM} submitUsersRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitUsers: (submitUsersRequestNERM: SubmitUsersRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * UsersNERMApi - functional programming interface * @export */ export declare const UsersNERMApiFp: (configuration?: Configuration) => { /** * Delete a user * @summary Delete a user * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteUser(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Info for a specific user * @summary Find user by id * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getUser(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves the URL of the user avatar * @summary Retrieves URL user avatar * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getUserAvatar(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This endpoint can retrieve users from Lifecycle or you can search for users using parameters * @summary Get users * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {string} [order] The field to order results by. * @param {string} [name] object name for filtering * @param {string} [login] The user login to search by * @param {string} [title] The user title to search by * @param {GetUsersUserStatusNerm} [userStatus] user status value for filtering * @param {GetUsersTypeNerm} [type] user type * @param {string} [email] The user email to search by * @param {boolean} [metadata] Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @param {string} [sailpointIdentityId] SailPoint identity ID * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getUsers(limit?: number, offset?: number, order?: string, name?: string, login?: string, title?: string, userStatus?: GetUsersUserStatusNerm, type?: GetUsersTypeNerm, email?: string, metadata?: boolean, sailpointIdentityId?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a user by id * @summary Update a user by id * @param {string} id ID of the object to retrieve, update, or delete * @param {SubmitUserRequestNERM} submitUserRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchUser(id: string, submitUserRequestNERM: SubmitUserRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update multiple users * @summary Update multiple users * @param {SubmitUsersRequestNERM} submitUsersRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchUsers(submitUsersRequestNERM: SubmitUsersRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a new user * @summary Create a new user * @param {SubmitUserRequestNERM} submitUserRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitUser(submitUserRequestNERM: SubmitUserRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Uploads a new user avatar * @summary Uploads new user avatar * @param {string} id ID of the object to retrieve, update, or delete * @param {File} [file] * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitUserAvatar(id: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create multiple new users * @summary Create multiple new users * @param {SubmitUsersRequestNERM} submitUsersRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitUsers(submitUsersRequestNERM: SubmitUsersRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * UsersNERMApi - factory interface * @export */ export declare const UsersNERMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Delete a user * @summary Delete a user * @param {UsersNERMApiDeleteUserRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteUser(requestParameters: UsersNERMApiDeleteUserRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Info for a specific user * @summary Find user by id * @param {UsersNERMApiGetUserRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getUser(requestParameters: UsersNERMApiGetUserRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves the URL of the user avatar * @summary Retrieves URL user avatar * @param {UsersNERMApiGetUserAvatarRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getUserAvatar(requestParameters: UsersNERMApiGetUserAvatarRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This endpoint can retrieve users from Lifecycle or you can search for users using parameters * @summary Get users * @param {UsersNERMApiGetUsersRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getUsers(requestParameters?: UsersNERMApiGetUsersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update a user by id * @summary Update a user by id * @param {UsersNERMApiPatchUserRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchUser(requestParameters: UsersNERMApiPatchUserRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update multiple users * @summary Update multiple users * @param {UsersNERMApiPatchUsersRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchUsers(requestParameters: UsersNERMApiPatchUsersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a new user * @summary Create a new user * @param {UsersNERMApiSubmitUserRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitUser(requestParameters: UsersNERMApiSubmitUserRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Uploads a new user avatar * @summary Uploads new user avatar * @param {UsersNERMApiSubmitUserAvatarRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitUserAvatar(requestParameters: UsersNERMApiSubmitUserAvatarRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create multiple new users * @summary Create multiple new users * @param {UsersNERMApiSubmitUsersRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitUsers(requestParameters: UsersNERMApiSubmitUsersRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for deleteUser operation in UsersNERMApi. * @export * @interface UsersNERMApiDeleteUserRequest */ export interface UsersNERMApiDeleteUserRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof UsersNERMApiDeleteUser */ readonly id: string; } /** * Request parameters for getUser operation in UsersNERMApi. * @export * @interface UsersNERMApiGetUserRequest */ export interface UsersNERMApiGetUserRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof UsersNERMApiGetUser */ readonly id: string; } /** * Request parameters for getUserAvatar operation in UsersNERMApi. * @export * @interface UsersNERMApiGetUserAvatarRequest */ export interface UsersNERMApiGetUserAvatarRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof UsersNERMApiGetUserAvatar */ readonly id: string; } /** * Request parameters for getUsers operation in UsersNERMApi. * @export * @interface UsersNERMApiGetUsersRequest */ export interface UsersNERMApiGetUsersRequest { /** * The maximum number of items to return. * @type {number} * @memberof UsersNERMApiGetUsers */ readonly limit?: number; /** * The number of items to skip before starting to collect the result set. * @type {number} * @memberof UsersNERMApiGetUsers */ readonly offset?: number; /** * The field to order results by. * @type {string} * @memberof UsersNERMApiGetUsers */ readonly order?: string; /** * object name for filtering * @type {string} * @memberof UsersNERMApiGetUsers */ readonly name?: string; /** * The user login to search by * @type {string} * @memberof UsersNERMApiGetUsers */ readonly login?: string; /** * The user title to search by * @type {string} * @memberof UsersNERMApiGetUsers */ readonly title?: string; /** * user status value for filtering * @type {'Active' | 'Pending' | 'Disabled'} * @memberof UsersNERMApiGetUsers */ readonly userStatus?: GetUsersUserStatusNerm; /** * user type * @type {'NeprofileUser' | 'NeaccessUser'} * @memberof UsersNERMApiGetUsers */ readonly type?: GetUsersTypeNerm; /** * The user email to search by * @type {string} * @memberof UsersNERMApiGetUsers */ readonly email?: string; /** * Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @type {boolean} * @memberof UsersNERMApiGetUsers */ readonly metadata?: boolean; /** * SailPoint identity ID * @type {string} * @memberof UsersNERMApiGetUsers */ readonly sailpointIdentityId?: string; } /** * Request parameters for patchUser operation in UsersNERMApi. * @export * @interface UsersNERMApiPatchUserRequest */ export interface UsersNERMApiPatchUserRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof UsersNERMApiPatchUser */ readonly id: string; /** * * @type {SubmitUserRequestNERM} * @memberof UsersNERMApiPatchUser */ readonly submitUserRequestNERM: SubmitUserRequestNERM; } /** * Request parameters for patchUsers operation in UsersNERMApi. * @export * @interface UsersNERMApiPatchUsersRequest */ export interface UsersNERMApiPatchUsersRequest { /** * * @type {SubmitUsersRequestNERM} * @memberof UsersNERMApiPatchUsers */ readonly submitUsersRequestNERM: SubmitUsersRequestNERM; } /** * Request parameters for submitUser operation in UsersNERMApi. * @export * @interface UsersNERMApiSubmitUserRequest */ export interface UsersNERMApiSubmitUserRequest { /** * * @type {SubmitUserRequestNERM} * @memberof UsersNERMApiSubmitUser */ readonly submitUserRequestNERM: SubmitUserRequestNERM; } /** * Request parameters for submitUserAvatar operation in UsersNERMApi. * @export * @interface UsersNERMApiSubmitUserAvatarRequest */ export interface UsersNERMApiSubmitUserAvatarRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof UsersNERMApiSubmitUserAvatar */ readonly id: string; /** * * @type {File} * @memberof UsersNERMApiSubmitUserAvatar */ readonly file?: File; } /** * Request parameters for submitUsers operation in UsersNERMApi. * @export * @interface UsersNERMApiSubmitUsersRequest */ export interface UsersNERMApiSubmitUsersRequest { /** * * @type {SubmitUsersRequestNERM} * @memberof UsersNERMApiSubmitUsers */ readonly submitUsersRequestNERM: SubmitUsersRequestNERM; } /** * UsersNERMApi - object-oriented interface * @export * @class UsersNERMApi * @extends {BaseAPI} */ export declare class UsersNERMApi extends BaseAPI { /** * Delete a user * @summary Delete a user * @param {UsersNERMApiDeleteUserRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof UsersNERMApi */ deleteUser(requestParameters: UsersNERMApiDeleteUserRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Info for a specific user * @summary Find user by id * @param {UsersNERMApiGetUserRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof UsersNERMApi */ getUser(requestParameters: UsersNERMApiGetUserRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Retrieves the URL of the user avatar * @summary Retrieves URL user avatar * @param {UsersNERMApiGetUserAvatarRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof UsersNERMApi */ getUserAvatar(requestParameters: UsersNERMApiGetUserAvatarRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This endpoint can retrieve users from Lifecycle or you can search for users using parameters * @summary Get users * @param {UsersNERMApiGetUsersRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof UsersNERMApi */ getUsers(requestParameters?: UsersNERMApiGetUsersRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update a user by id * @summary Update a user by id * @param {UsersNERMApiPatchUserRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof UsersNERMApi */ patchUser(requestParameters: UsersNERMApiPatchUserRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update multiple users * @summary Update multiple users * @param {UsersNERMApiPatchUsersRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof UsersNERMApi */ patchUsers(requestParameters: UsersNERMApiPatchUsersRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a new user * @summary Create a new user * @param {UsersNERMApiSubmitUserRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof UsersNERMApi */ submitUser(requestParameters: UsersNERMApiSubmitUserRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Uploads a new user avatar * @summary Uploads new user avatar * @param {UsersNERMApiSubmitUserAvatarRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof UsersNERMApi */ submitUserAvatar(requestParameters: UsersNERMApiSubmitUserAvatarRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create multiple new users * @summary Create multiple new users * @param {UsersNERMApiSubmitUsersRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof UsersNERMApi */ submitUsers(requestParameters: UsersNERMApiSubmitUsersRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const GetUsersUserStatusNerm: { readonly Active: "Active"; readonly Pending: "Pending"; readonly Disabled: "Disabled"; }; export type GetUsersUserStatusNerm = typeof GetUsersUserStatusNerm[keyof typeof GetUsersUserStatusNerm]; /** * @export */ export declare const GetUsersTypeNerm: { readonly NeprofileUser: "NeprofileUser"; readonly NeaccessUser: "NeaccessUser"; }; export type GetUsersTypeNerm = typeof GetUsersTypeNerm[keyof typeof GetUsersTypeNerm]; /** * WorkflowActionPerformerNERMApi - axios parameter creator * @export */ export declare const WorkflowActionPerformerNERMApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create a workflow action performer for an existing workflow action * @summary Create a workflow action performer * @param {CreateWorkflowActionPerformerRequestNERM} createWorkflowActionPerformerRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createWorkflowActionPerformer: (createWorkflowActionPerformerRequestNERM: CreateWorkflowActionPerformerRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * WorkflowActionPerformerNERMApi - functional programming interface * @export */ export declare const WorkflowActionPerformerNERMApiFp: (configuration?: Configuration) => { /** * Create a workflow action performer for an existing workflow action * @summary Create a workflow action performer * @param {CreateWorkflowActionPerformerRequestNERM} createWorkflowActionPerformerRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createWorkflowActionPerformer(createWorkflowActionPerformerRequestNERM: CreateWorkflowActionPerformerRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * WorkflowActionPerformerNERMApi - factory interface * @export */ export declare const WorkflowActionPerformerNERMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create a workflow action performer for an existing workflow action * @summary Create a workflow action performer * @param {WorkflowActionPerformerNERMApiCreateWorkflowActionPerformerRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createWorkflowActionPerformer(requestParameters: WorkflowActionPerformerNERMApiCreateWorkflowActionPerformerRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createWorkflowActionPerformer operation in WorkflowActionPerformerNERMApi. * @export * @interface WorkflowActionPerformerNERMApiCreateWorkflowActionPerformerRequest */ export interface WorkflowActionPerformerNERMApiCreateWorkflowActionPerformerRequest { /** * * @type {CreateWorkflowActionPerformerRequestNERM} * @memberof WorkflowActionPerformerNERMApiCreateWorkflowActionPerformer */ readonly createWorkflowActionPerformerRequestNERM: CreateWorkflowActionPerformerRequestNERM; } /** * WorkflowActionPerformerNERMApi - object-oriented interface * @export * @class WorkflowActionPerformerNERMApi * @extends {BaseAPI} */ export declare class WorkflowActionPerformerNERMApi extends BaseAPI { /** * Create a workflow action performer for an existing workflow action * @summary Create a workflow action performer * @param {WorkflowActionPerformerNERMApiCreateWorkflowActionPerformerRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowActionPerformerNERMApi */ createWorkflowActionPerformer(requestParameters: WorkflowActionPerformerNERMApiCreateWorkflowActionPerformerRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * WorkflowActionsNERMApi - axios parameter creator * @export */ export declare const WorkflowActionsNERMApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create an approval action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performers, workflow_action_roles, workflow_action_performer_notification_email, workflow_action_approval_email, workflow_action_rejection_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create an approval action * @param {CreateApprovalActionRequestNERM} createApprovalActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createApprovalAction: (createApprovalActionRequestNERM: CreateApprovalActionRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create an ask security question action * @summary Create ask security question action * @param {CreateAskSecurityQuestionActionRequestNERM} createAskSecurityQuestionActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createAskSecurityQuestionAction: (createAskSecurityQuestionActionRequestNERM: CreateAskSecurityQuestionActionRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create an auto assign action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_roles. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create an auto assign action * @param {CreateAutoAssignActionRequestNERM} createAutoAssignActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createAutoAssignAction: (createAutoAssignActionRequestNERM: CreateAutoAssignActionRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a batch update action * @summary Create a batch update action * @param {CreateBatchUpdateActionRequestNERM} createBatchUpdateActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createBatchUpdateAction: (createBatchUpdateActionRequestNERM: CreateBatchUpdateActionRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a close session action * @summary Create a close session action * @param {CreateCloseSessionActionRequestNERM} createCloseSessionActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createCloseSessionAction: (createCloseSessionActionRequestNERM: CreateCloseSessionActionRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a contributors action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performers, workflow_action_roles, workflow_action_performer_notification_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a contributors action * @param {CreateContributorsActionRequestNERM} createContributorsActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createContributorsAction: (createContributorsActionRequestNERM: CreateContributorsActionRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a create profile action * @summary Create a create profile action * @param {CreateCreateProfileActionRequestNERM} createCreateProfileActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createCreateProfileAction: (createCreateProfileActionRequestNERM: CreateCreateProfileActionRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a duplicate prevention action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - duplicatation_prevention_attributes, workflow_action_performers, workflow_action_roles, workflow_action_performer_notification_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a duplicate prevention action * @param {CreateDuplicatePreventionActionRequestNERM} createDuplicatePreventionActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createDuplicatePreventionAction: (createDuplicatePreventionActionRequestNERM: CreateDuplicatePreventionActionRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create an email verification action * @summary Create an email verification action * @param {CreateEmailVerificationActionRequestNERM} createEmailVerificationActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createEmailVerificationAction: (createEmailVerificationActionRequestNERM: CreateEmailVerificationActionRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a fulfillment action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performers, workflow_action_roles, workflow_action_performer_notification_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a fulfillment action * @param {CreateFulfillmentActionRequestNERM} createFulfillmentActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createFulfillmentAction: (createFulfillmentActionRequestNERM: CreateFulfillmentActionRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create an identity proofing action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - identity_proofing_action_configuration, identity_proofing_action_mappings. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create an identity proofing action * @param {CreateIdentityProofingActionRequestNERM} createIdentityProofingActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createIdentityProofingAction: (createIdentityProofingActionRequestNERM: CreateIdentityProofingActionRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create an invitation action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_pause_action. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create an invitation action * @param {CreateInvitationActionRequestNERM} createInvitationActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createInvitationAction: (createInvitationActionRequestNERM: CreateInvitationActionRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a ldap action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performers, workflow_action_roles. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a ldap action * @param {CreateLdapActionRequestNERM} createLdapActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createLdapAction: (createLdapActionRequestNERM: CreateLdapActionRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a notification action * @summary Create a notification action * @param {CreateNotificationActionRequestNERM} createNotificationActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createNotificationAction: (createNotificationActionRequestNERM: CreateNotificationActionRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a password reset action * @summary Create a password reset action * @param {CreatePasswordResetActionRequestNERM} createPasswordResetActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createPasswordResetAction: (createPasswordResetActionRequestNERM: CreatePasswordResetActionRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a profile check action * @summary Create a profile check action * @param {CreateProfileCheckActionRequestNERM} createProfileCheckActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createProfileCheckAction: (createProfileCheckActionRequestNERM: CreateProfileCheckActionRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a profile select action * @summary Create a profile select action * @param {CreateProfileSelectActionRequestNERM} createProfileSelectActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createProfileSelectAction: (createProfileSelectActionRequestNERM: CreateProfileSelectActionRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a request action * @summary Create a request action * @param {CreateRequestActionRequestNERM} createRequestActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createRequestAction: (createRequestActionRequestNERM: CreateRequestActionRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a REST API action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - rest_api_action_configuration, api_configuration_attributes. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a REST API action * @param {CreateRestApiActionRequestNERM} createRestApiActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createRestApiAction: (createRestApiActionRequestNERM: CreateRestApiActionRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a review action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performer_notification_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a review action * @param {CreateReviewActionRequestNERM} createReviewActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createReviewAction: (createReviewActionRequestNERM: CreateReviewActionRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a run workflow action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - configuration_profile_attribute. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a run workflow action * @param {CreateRunWorkflowActionRequestNERM} createRunWorkflowActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createRunWorkflowAction: (createRunWorkflowActionRequestNERM: CreateRunWorkflowActionRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a set attributes action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_set_attributes. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a set attributes action * @param {CreateSetAttributesActionRequestNERM} createSetAttributesActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createSetAttributesAction: (createSetAttributesActionRequestNERM: CreateSetAttributesActionRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a set security question action * @summary Create set security question action * @param {CreateSetSecurityQuestionActionRequestNERM} createSetSecurityQuestionActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createSetSecurityQuestionAction: (createSetSecurityQuestionActionRequestNERM: CreateSetSecurityQuestionActionRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a SOAP API action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - soap_api_action_configuration, api_configuration_attributes. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a SOAP API action * @param {CreateSoapApiActionRequestNERM} createSoapApiActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createSoapApiAction: (createSoapApiActionRequestNERM: CreateSoapApiActionRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a status change action * @summary Create a status change action * @param {CreateStatusChangeActionRequestNERM} createStatusChangeActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createStatusChangeAction: (createStatusChangeActionRequestNERM: CreateStatusChangeActionRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create an unassign action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_roles. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create an unassign action * @param {CreateUnassignActionRequestNERM} createUnassignActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createUnassignAction: (createUnassignActionRequestNERM: CreateUnassignActionRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create an update profile action * @summary Create an update profile action * @param {CreateUpdateProfileActionRequestNERM} createUpdateProfileActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createUpdateProfileAction: (createUpdateProfileActionRequestNERM: CreateUpdateProfileActionRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a username password action * @summary Create a username password action * @param {CreateUsernamePasswordActionRequestNERM} createUsernamePasswordActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createUsernamePasswordAction: (createUsernamePasswordActionRequestNERM: CreateUsernamePasswordActionRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This endpoint can retrieve workflow actions * @summary Get Workflow Actions * @param {string} [workflowId] Workflow ID for filtering * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getWorkflowActions: (workflowId?: string, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * WorkflowActionsNERMApi - functional programming interface * @export */ export declare const WorkflowActionsNERMApiFp: (configuration?: Configuration) => { /** * Create an approval action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performers, workflow_action_roles, workflow_action_performer_notification_email, workflow_action_approval_email, workflow_action_rejection_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create an approval action * @param {CreateApprovalActionRequestNERM} createApprovalActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createApprovalAction(createApprovalActionRequestNERM: CreateApprovalActionRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create an ask security question action * @summary Create ask security question action * @param {CreateAskSecurityQuestionActionRequestNERM} createAskSecurityQuestionActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createAskSecurityQuestionAction(createAskSecurityQuestionActionRequestNERM: CreateAskSecurityQuestionActionRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create an auto assign action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_roles. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create an auto assign action * @param {CreateAutoAssignActionRequestNERM} createAutoAssignActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createAutoAssignAction(createAutoAssignActionRequestNERM: CreateAutoAssignActionRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a batch update action * @summary Create a batch update action * @param {CreateBatchUpdateActionRequestNERM} createBatchUpdateActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createBatchUpdateAction(createBatchUpdateActionRequestNERM: CreateBatchUpdateActionRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a close session action * @summary Create a close session action * @param {CreateCloseSessionActionRequestNERM} createCloseSessionActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createCloseSessionAction(createCloseSessionActionRequestNERM: CreateCloseSessionActionRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a contributors action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performers, workflow_action_roles, workflow_action_performer_notification_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a contributors action * @param {CreateContributorsActionRequestNERM} createContributorsActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createContributorsAction(createContributorsActionRequestNERM: CreateContributorsActionRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a create profile action * @summary Create a create profile action * @param {CreateCreateProfileActionRequestNERM} createCreateProfileActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createCreateProfileAction(createCreateProfileActionRequestNERM: CreateCreateProfileActionRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a duplicate prevention action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - duplicatation_prevention_attributes, workflow_action_performers, workflow_action_roles, workflow_action_performer_notification_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a duplicate prevention action * @param {CreateDuplicatePreventionActionRequestNERM} createDuplicatePreventionActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createDuplicatePreventionAction(createDuplicatePreventionActionRequestNERM: CreateDuplicatePreventionActionRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create an email verification action * @summary Create an email verification action * @param {CreateEmailVerificationActionRequestNERM} createEmailVerificationActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createEmailVerificationAction(createEmailVerificationActionRequestNERM: CreateEmailVerificationActionRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a fulfillment action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performers, workflow_action_roles, workflow_action_performer_notification_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a fulfillment action * @param {CreateFulfillmentActionRequestNERM} createFulfillmentActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createFulfillmentAction(createFulfillmentActionRequestNERM: CreateFulfillmentActionRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create an identity proofing action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - identity_proofing_action_configuration, identity_proofing_action_mappings. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create an identity proofing action * @param {CreateIdentityProofingActionRequestNERM} createIdentityProofingActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createIdentityProofingAction(createIdentityProofingActionRequestNERM: CreateIdentityProofingActionRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create an invitation action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_pause_action. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create an invitation action * @param {CreateInvitationActionRequestNERM} createInvitationActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createInvitationAction(createInvitationActionRequestNERM: CreateInvitationActionRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a ldap action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performers, workflow_action_roles. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a ldap action * @param {CreateLdapActionRequestNERM} createLdapActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createLdapAction(createLdapActionRequestNERM: CreateLdapActionRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a notification action * @summary Create a notification action * @param {CreateNotificationActionRequestNERM} createNotificationActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createNotificationAction(createNotificationActionRequestNERM: CreateNotificationActionRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a password reset action * @summary Create a password reset action * @param {CreatePasswordResetActionRequestNERM} createPasswordResetActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createPasswordResetAction(createPasswordResetActionRequestNERM: CreatePasswordResetActionRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a profile check action * @summary Create a profile check action * @param {CreateProfileCheckActionRequestNERM} createProfileCheckActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createProfileCheckAction(createProfileCheckActionRequestNERM: CreateProfileCheckActionRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a profile select action * @summary Create a profile select action * @param {CreateProfileSelectActionRequestNERM} createProfileSelectActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createProfileSelectAction(createProfileSelectActionRequestNERM: CreateProfileSelectActionRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a request action * @summary Create a request action * @param {CreateRequestActionRequestNERM} createRequestActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createRequestAction(createRequestActionRequestNERM: CreateRequestActionRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a REST API action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - rest_api_action_configuration, api_configuration_attributes. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a REST API action * @param {CreateRestApiActionRequestNERM} createRestApiActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createRestApiAction(createRestApiActionRequestNERM: CreateRestApiActionRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a review action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performer_notification_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a review action * @param {CreateReviewActionRequestNERM} createReviewActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createReviewAction(createReviewActionRequestNERM: CreateReviewActionRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a run workflow action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - configuration_profile_attribute. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a run workflow action * @param {CreateRunWorkflowActionRequestNERM} createRunWorkflowActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createRunWorkflowAction(createRunWorkflowActionRequestNERM: CreateRunWorkflowActionRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a set attributes action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_set_attributes. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a set attributes action * @param {CreateSetAttributesActionRequestNERM} createSetAttributesActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createSetAttributesAction(createSetAttributesActionRequestNERM: CreateSetAttributesActionRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a set security question action * @summary Create set security question action * @param {CreateSetSecurityQuestionActionRequestNERM} createSetSecurityQuestionActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createSetSecurityQuestionAction(createSetSecurityQuestionActionRequestNERM: CreateSetSecurityQuestionActionRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a SOAP API action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - soap_api_action_configuration, api_configuration_attributes. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a SOAP API action * @param {CreateSoapApiActionRequestNERM} createSoapApiActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createSoapApiAction(createSoapApiActionRequestNERM: CreateSoapApiActionRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a status change action * @summary Create a status change action * @param {CreateStatusChangeActionRequestNERM} createStatusChangeActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createStatusChangeAction(createStatusChangeActionRequestNERM: CreateStatusChangeActionRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create an unassign action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_roles. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create an unassign action * @param {CreateUnassignActionRequestNERM} createUnassignActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createUnassignAction(createUnassignActionRequestNERM: CreateUnassignActionRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create an update profile action * @summary Create an update profile action * @param {CreateUpdateProfileActionRequestNERM} createUpdateProfileActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createUpdateProfileAction(createUpdateProfileActionRequestNERM: CreateUpdateProfileActionRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a username password action * @summary Create a username password action * @param {CreateUsernamePasswordActionRequestNERM} createUsernamePasswordActionRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createUsernamePasswordAction(createUsernamePasswordActionRequestNERM: CreateUsernamePasswordActionRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This endpoint can retrieve workflow actions * @summary Get Workflow Actions * @param {string} [workflowId] Workflow ID for filtering * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getWorkflowActions(workflowId?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * WorkflowActionsNERMApi - factory interface * @export */ export declare const WorkflowActionsNERMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create an approval action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performers, workflow_action_roles, workflow_action_performer_notification_email, workflow_action_approval_email, workflow_action_rejection_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create an approval action * @param {WorkflowActionsNERMApiCreateApprovalActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createApprovalAction(requestParameters: WorkflowActionsNERMApiCreateApprovalActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create an ask security question action * @summary Create ask security question action * @param {WorkflowActionsNERMApiCreateAskSecurityQuestionActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createAskSecurityQuestionAction(requestParameters: WorkflowActionsNERMApiCreateAskSecurityQuestionActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create an auto assign action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_roles. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create an auto assign action * @param {WorkflowActionsNERMApiCreateAutoAssignActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createAutoAssignAction(requestParameters: WorkflowActionsNERMApiCreateAutoAssignActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a batch update action * @summary Create a batch update action * @param {WorkflowActionsNERMApiCreateBatchUpdateActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createBatchUpdateAction(requestParameters: WorkflowActionsNERMApiCreateBatchUpdateActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a close session action * @summary Create a close session action * @param {WorkflowActionsNERMApiCreateCloseSessionActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createCloseSessionAction(requestParameters: WorkflowActionsNERMApiCreateCloseSessionActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a contributors action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performers, workflow_action_roles, workflow_action_performer_notification_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a contributors action * @param {WorkflowActionsNERMApiCreateContributorsActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createContributorsAction(requestParameters: WorkflowActionsNERMApiCreateContributorsActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a create profile action * @summary Create a create profile action * @param {WorkflowActionsNERMApiCreateCreateProfileActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createCreateProfileAction(requestParameters: WorkflowActionsNERMApiCreateCreateProfileActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a duplicate prevention action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - duplicatation_prevention_attributes, workflow_action_performers, workflow_action_roles, workflow_action_performer_notification_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a duplicate prevention action * @param {WorkflowActionsNERMApiCreateDuplicatePreventionActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createDuplicatePreventionAction(requestParameters: WorkflowActionsNERMApiCreateDuplicatePreventionActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create an email verification action * @summary Create an email verification action * @param {WorkflowActionsNERMApiCreateEmailVerificationActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createEmailVerificationAction(requestParameters: WorkflowActionsNERMApiCreateEmailVerificationActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a fulfillment action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performers, workflow_action_roles, workflow_action_performer_notification_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a fulfillment action * @param {WorkflowActionsNERMApiCreateFulfillmentActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createFulfillmentAction(requestParameters: WorkflowActionsNERMApiCreateFulfillmentActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create an identity proofing action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - identity_proofing_action_configuration, identity_proofing_action_mappings. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create an identity proofing action * @param {WorkflowActionsNERMApiCreateIdentityProofingActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createIdentityProofingAction(requestParameters: WorkflowActionsNERMApiCreateIdentityProofingActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create an invitation action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_pause_action. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create an invitation action * @param {WorkflowActionsNERMApiCreateInvitationActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createInvitationAction(requestParameters: WorkflowActionsNERMApiCreateInvitationActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a ldap action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performers, workflow_action_roles. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a ldap action * @param {WorkflowActionsNERMApiCreateLdapActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createLdapAction(requestParameters: WorkflowActionsNERMApiCreateLdapActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a notification action * @summary Create a notification action * @param {WorkflowActionsNERMApiCreateNotificationActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createNotificationAction(requestParameters: WorkflowActionsNERMApiCreateNotificationActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a password reset action * @summary Create a password reset action * @param {WorkflowActionsNERMApiCreatePasswordResetActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createPasswordResetAction(requestParameters: WorkflowActionsNERMApiCreatePasswordResetActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a profile check action * @summary Create a profile check action * @param {WorkflowActionsNERMApiCreateProfileCheckActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createProfileCheckAction(requestParameters: WorkflowActionsNERMApiCreateProfileCheckActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a profile select action * @summary Create a profile select action * @param {WorkflowActionsNERMApiCreateProfileSelectActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createProfileSelectAction(requestParameters: WorkflowActionsNERMApiCreateProfileSelectActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a request action * @summary Create a request action * @param {WorkflowActionsNERMApiCreateRequestActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createRequestAction(requestParameters: WorkflowActionsNERMApiCreateRequestActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a REST API action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - rest_api_action_configuration, api_configuration_attributes. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a REST API action * @param {WorkflowActionsNERMApiCreateRestApiActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createRestApiAction(requestParameters: WorkflowActionsNERMApiCreateRestApiActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a review action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performer_notification_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a review action * @param {WorkflowActionsNERMApiCreateReviewActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createReviewAction(requestParameters: WorkflowActionsNERMApiCreateReviewActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a run workflow action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - configuration_profile_attribute. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a run workflow action * @param {WorkflowActionsNERMApiCreateRunWorkflowActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createRunWorkflowAction(requestParameters: WorkflowActionsNERMApiCreateRunWorkflowActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a set attributes action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_set_attributes. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a set attributes action * @param {WorkflowActionsNERMApiCreateSetAttributesActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createSetAttributesAction(requestParameters: WorkflowActionsNERMApiCreateSetAttributesActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a set security question action * @summary Create set security question action * @param {WorkflowActionsNERMApiCreateSetSecurityQuestionActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createSetSecurityQuestionAction(requestParameters: WorkflowActionsNERMApiCreateSetSecurityQuestionActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a SOAP API action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - soap_api_action_configuration, api_configuration_attributes. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a SOAP API action * @param {WorkflowActionsNERMApiCreateSoapApiActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createSoapApiAction(requestParameters: WorkflowActionsNERMApiCreateSoapApiActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a status change action * @summary Create a status change action * @param {WorkflowActionsNERMApiCreateStatusChangeActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createStatusChangeAction(requestParameters: WorkflowActionsNERMApiCreateStatusChangeActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create an unassign action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_roles. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create an unassign action * @param {WorkflowActionsNERMApiCreateUnassignActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createUnassignAction(requestParameters: WorkflowActionsNERMApiCreateUnassignActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create an update profile action * @summary Create an update profile action * @param {WorkflowActionsNERMApiCreateUpdateProfileActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createUpdateProfileAction(requestParameters: WorkflowActionsNERMApiCreateUpdateProfileActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a username password action * @summary Create a username password action * @param {WorkflowActionsNERMApiCreateUsernamePasswordActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createUsernamePasswordAction(requestParameters: WorkflowActionsNERMApiCreateUsernamePasswordActionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This endpoint can retrieve workflow actions * @summary Get Workflow Actions * @param {WorkflowActionsNERMApiGetWorkflowActionsRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getWorkflowActions(requestParameters?: WorkflowActionsNERMApiGetWorkflowActionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createApprovalAction operation in WorkflowActionsNERMApi. * @export * @interface WorkflowActionsNERMApiCreateApprovalActionRequest */ export interface WorkflowActionsNERMApiCreateApprovalActionRequest { /** * * @type {CreateApprovalActionRequestNERM} * @memberof WorkflowActionsNERMApiCreateApprovalAction */ readonly createApprovalActionRequestNERM: CreateApprovalActionRequestNERM; } /** * Request parameters for createAskSecurityQuestionAction operation in WorkflowActionsNERMApi. * @export * @interface WorkflowActionsNERMApiCreateAskSecurityQuestionActionRequest */ export interface WorkflowActionsNERMApiCreateAskSecurityQuestionActionRequest { /** * * @type {CreateAskSecurityQuestionActionRequestNERM} * @memberof WorkflowActionsNERMApiCreateAskSecurityQuestionAction */ readonly createAskSecurityQuestionActionRequestNERM: CreateAskSecurityQuestionActionRequestNERM; } /** * Request parameters for createAutoAssignAction operation in WorkflowActionsNERMApi. * @export * @interface WorkflowActionsNERMApiCreateAutoAssignActionRequest */ export interface WorkflowActionsNERMApiCreateAutoAssignActionRequest { /** * * @type {CreateAutoAssignActionRequestNERM} * @memberof WorkflowActionsNERMApiCreateAutoAssignAction */ readonly createAutoAssignActionRequestNERM: CreateAutoAssignActionRequestNERM; } /** * Request parameters for createBatchUpdateAction operation in WorkflowActionsNERMApi. * @export * @interface WorkflowActionsNERMApiCreateBatchUpdateActionRequest */ export interface WorkflowActionsNERMApiCreateBatchUpdateActionRequest { /** * * @type {CreateBatchUpdateActionRequestNERM} * @memberof WorkflowActionsNERMApiCreateBatchUpdateAction */ readonly createBatchUpdateActionRequestNERM: CreateBatchUpdateActionRequestNERM; } /** * Request parameters for createCloseSessionAction operation in WorkflowActionsNERMApi. * @export * @interface WorkflowActionsNERMApiCreateCloseSessionActionRequest */ export interface WorkflowActionsNERMApiCreateCloseSessionActionRequest { /** * * @type {CreateCloseSessionActionRequestNERM} * @memberof WorkflowActionsNERMApiCreateCloseSessionAction */ readonly createCloseSessionActionRequestNERM: CreateCloseSessionActionRequestNERM; } /** * Request parameters for createContributorsAction operation in WorkflowActionsNERMApi. * @export * @interface WorkflowActionsNERMApiCreateContributorsActionRequest */ export interface WorkflowActionsNERMApiCreateContributorsActionRequest { /** * * @type {CreateContributorsActionRequestNERM} * @memberof WorkflowActionsNERMApiCreateContributorsAction */ readonly createContributorsActionRequestNERM: CreateContributorsActionRequestNERM; } /** * Request parameters for createCreateProfileAction operation in WorkflowActionsNERMApi. * @export * @interface WorkflowActionsNERMApiCreateCreateProfileActionRequest */ export interface WorkflowActionsNERMApiCreateCreateProfileActionRequest { /** * * @type {CreateCreateProfileActionRequestNERM} * @memberof WorkflowActionsNERMApiCreateCreateProfileAction */ readonly createCreateProfileActionRequestNERM: CreateCreateProfileActionRequestNERM; } /** * Request parameters for createDuplicatePreventionAction operation in WorkflowActionsNERMApi. * @export * @interface WorkflowActionsNERMApiCreateDuplicatePreventionActionRequest */ export interface WorkflowActionsNERMApiCreateDuplicatePreventionActionRequest { /** * * @type {CreateDuplicatePreventionActionRequestNERM} * @memberof WorkflowActionsNERMApiCreateDuplicatePreventionAction */ readonly createDuplicatePreventionActionRequestNERM: CreateDuplicatePreventionActionRequestNERM; } /** * Request parameters for createEmailVerificationAction operation in WorkflowActionsNERMApi. * @export * @interface WorkflowActionsNERMApiCreateEmailVerificationActionRequest */ export interface WorkflowActionsNERMApiCreateEmailVerificationActionRequest { /** * * @type {CreateEmailVerificationActionRequestNERM} * @memberof WorkflowActionsNERMApiCreateEmailVerificationAction */ readonly createEmailVerificationActionRequestNERM: CreateEmailVerificationActionRequestNERM; } /** * Request parameters for createFulfillmentAction operation in WorkflowActionsNERMApi. * @export * @interface WorkflowActionsNERMApiCreateFulfillmentActionRequest */ export interface WorkflowActionsNERMApiCreateFulfillmentActionRequest { /** * * @type {CreateFulfillmentActionRequestNERM} * @memberof WorkflowActionsNERMApiCreateFulfillmentAction */ readonly createFulfillmentActionRequestNERM: CreateFulfillmentActionRequestNERM; } /** * Request parameters for createIdentityProofingAction operation in WorkflowActionsNERMApi. * @export * @interface WorkflowActionsNERMApiCreateIdentityProofingActionRequest */ export interface WorkflowActionsNERMApiCreateIdentityProofingActionRequest { /** * * @type {CreateIdentityProofingActionRequestNERM} * @memberof WorkflowActionsNERMApiCreateIdentityProofingAction */ readonly createIdentityProofingActionRequestNERM: CreateIdentityProofingActionRequestNERM; } /** * Request parameters for createInvitationAction operation in WorkflowActionsNERMApi. * @export * @interface WorkflowActionsNERMApiCreateInvitationActionRequest */ export interface WorkflowActionsNERMApiCreateInvitationActionRequest { /** * * @type {CreateInvitationActionRequestNERM} * @memberof WorkflowActionsNERMApiCreateInvitationAction */ readonly createInvitationActionRequestNERM: CreateInvitationActionRequestNERM; } /** * Request parameters for createLdapAction operation in WorkflowActionsNERMApi. * @export * @interface WorkflowActionsNERMApiCreateLdapActionRequest */ export interface WorkflowActionsNERMApiCreateLdapActionRequest { /** * * @type {CreateLdapActionRequestNERM} * @memberof WorkflowActionsNERMApiCreateLdapAction */ readonly createLdapActionRequestNERM: CreateLdapActionRequestNERM; } /** * Request parameters for createNotificationAction operation in WorkflowActionsNERMApi. * @export * @interface WorkflowActionsNERMApiCreateNotificationActionRequest */ export interface WorkflowActionsNERMApiCreateNotificationActionRequest { /** * * @type {CreateNotificationActionRequestNERM} * @memberof WorkflowActionsNERMApiCreateNotificationAction */ readonly createNotificationActionRequestNERM: CreateNotificationActionRequestNERM; } /** * Request parameters for createPasswordResetAction operation in WorkflowActionsNERMApi. * @export * @interface WorkflowActionsNERMApiCreatePasswordResetActionRequest */ export interface WorkflowActionsNERMApiCreatePasswordResetActionRequest { /** * * @type {CreatePasswordResetActionRequestNERM} * @memberof WorkflowActionsNERMApiCreatePasswordResetAction */ readonly createPasswordResetActionRequestNERM: CreatePasswordResetActionRequestNERM; } /** * Request parameters for createProfileCheckAction operation in WorkflowActionsNERMApi. * @export * @interface WorkflowActionsNERMApiCreateProfileCheckActionRequest */ export interface WorkflowActionsNERMApiCreateProfileCheckActionRequest { /** * * @type {CreateProfileCheckActionRequestNERM} * @memberof WorkflowActionsNERMApiCreateProfileCheckAction */ readonly createProfileCheckActionRequestNERM: CreateProfileCheckActionRequestNERM; } /** * Request parameters for createProfileSelectAction operation in WorkflowActionsNERMApi. * @export * @interface WorkflowActionsNERMApiCreateProfileSelectActionRequest */ export interface WorkflowActionsNERMApiCreateProfileSelectActionRequest { /** * * @type {CreateProfileSelectActionRequestNERM} * @memberof WorkflowActionsNERMApiCreateProfileSelectAction */ readonly createProfileSelectActionRequestNERM: CreateProfileSelectActionRequestNERM; } /** * Request parameters for createRequestAction operation in WorkflowActionsNERMApi. * @export * @interface WorkflowActionsNERMApiCreateRequestActionRequest */ export interface WorkflowActionsNERMApiCreateRequestActionRequest { /** * * @type {CreateRequestActionRequestNERM} * @memberof WorkflowActionsNERMApiCreateRequestAction */ readonly createRequestActionRequestNERM: CreateRequestActionRequestNERM; } /** * Request parameters for createRestApiAction operation in WorkflowActionsNERMApi. * @export * @interface WorkflowActionsNERMApiCreateRestApiActionRequest */ export interface WorkflowActionsNERMApiCreateRestApiActionRequest { /** * * @type {CreateRestApiActionRequestNERM} * @memberof WorkflowActionsNERMApiCreateRestApiAction */ readonly createRestApiActionRequestNERM: CreateRestApiActionRequestNERM; } /** * Request parameters for createReviewAction operation in WorkflowActionsNERMApi. * @export * @interface WorkflowActionsNERMApiCreateReviewActionRequest */ export interface WorkflowActionsNERMApiCreateReviewActionRequest { /** * * @type {CreateReviewActionRequestNERM} * @memberof WorkflowActionsNERMApiCreateReviewAction */ readonly createReviewActionRequestNERM: CreateReviewActionRequestNERM; } /** * Request parameters for createRunWorkflowAction operation in WorkflowActionsNERMApi. * @export * @interface WorkflowActionsNERMApiCreateRunWorkflowActionRequest */ export interface WorkflowActionsNERMApiCreateRunWorkflowActionRequest { /** * * @type {CreateRunWorkflowActionRequestNERM} * @memberof WorkflowActionsNERMApiCreateRunWorkflowAction */ readonly createRunWorkflowActionRequestNERM: CreateRunWorkflowActionRequestNERM; } /** * Request parameters for createSetAttributesAction operation in WorkflowActionsNERMApi. * @export * @interface WorkflowActionsNERMApiCreateSetAttributesActionRequest */ export interface WorkflowActionsNERMApiCreateSetAttributesActionRequest { /** * * @type {CreateSetAttributesActionRequestNERM} * @memberof WorkflowActionsNERMApiCreateSetAttributesAction */ readonly createSetAttributesActionRequestNERM: CreateSetAttributesActionRequestNERM; } /** * Request parameters for createSetSecurityQuestionAction operation in WorkflowActionsNERMApi. * @export * @interface WorkflowActionsNERMApiCreateSetSecurityQuestionActionRequest */ export interface WorkflowActionsNERMApiCreateSetSecurityQuestionActionRequest { /** * * @type {CreateSetSecurityQuestionActionRequestNERM} * @memberof WorkflowActionsNERMApiCreateSetSecurityQuestionAction */ readonly createSetSecurityQuestionActionRequestNERM: CreateSetSecurityQuestionActionRequestNERM; } /** * Request parameters for createSoapApiAction operation in WorkflowActionsNERMApi. * @export * @interface WorkflowActionsNERMApiCreateSoapApiActionRequest */ export interface WorkflowActionsNERMApiCreateSoapApiActionRequest { /** * * @type {CreateSoapApiActionRequestNERM} * @memberof WorkflowActionsNERMApiCreateSoapApiAction */ readonly createSoapApiActionRequestNERM: CreateSoapApiActionRequestNERM; } /** * Request parameters for createStatusChangeAction operation in WorkflowActionsNERMApi. * @export * @interface WorkflowActionsNERMApiCreateStatusChangeActionRequest */ export interface WorkflowActionsNERMApiCreateStatusChangeActionRequest { /** * * @type {CreateStatusChangeActionRequestNERM} * @memberof WorkflowActionsNERMApiCreateStatusChangeAction */ readonly createStatusChangeActionRequestNERM: CreateStatusChangeActionRequestNERM; } /** * Request parameters for createUnassignAction operation in WorkflowActionsNERMApi. * @export * @interface WorkflowActionsNERMApiCreateUnassignActionRequest */ export interface WorkflowActionsNERMApiCreateUnassignActionRequest { /** * * @type {CreateUnassignActionRequestNERM} * @memberof WorkflowActionsNERMApiCreateUnassignAction */ readonly createUnassignActionRequestNERM: CreateUnassignActionRequestNERM; } /** * Request parameters for createUpdateProfileAction operation in WorkflowActionsNERMApi. * @export * @interface WorkflowActionsNERMApiCreateUpdateProfileActionRequest */ export interface WorkflowActionsNERMApiCreateUpdateProfileActionRequest { /** * * @type {CreateUpdateProfileActionRequestNERM} * @memberof WorkflowActionsNERMApiCreateUpdateProfileAction */ readonly createUpdateProfileActionRequestNERM: CreateUpdateProfileActionRequestNERM; } /** * Request parameters for createUsernamePasswordAction operation in WorkflowActionsNERMApi. * @export * @interface WorkflowActionsNERMApiCreateUsernamePasswordActionRequest */ export interface WorkflowActionsNERMApiCreateUsernamePasswordActionRequest { /** * * @type {CreateUsernamePasswordActionRequestNERM} * @memberof WorkflowActionsNERMApiCreateUsernamePasswordAction */ readonly createUsernamePasswordActionRequestNERM: CreateUsernamePasswordActionRequestNERM; } /** * Request parameters for getWorkflowActions operation in WorkflowActionsNERMApi. * @export * @interface WorkflowActionsNERMApiGetWorkflowActionsRequest */ export interface WorkflowActionsNERMApiGetWorkflowActionsRequest { /** * Workflow ID for filtering * @type {string} * @memberof WorkflowActionsNERMApiGetWorkflowActions */ readonly workflowId?: string; } /** * WorkflowActionsNERMApi - object-oriented interface * @export * @class WorkflowActionsNERMApi * @extends {BaseAPI} */ export declare class WorkflowActionsNERMApi extends BaseAPI { /** * Create an approval action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performers, workflow_action_roles, workflow_action_performer_notification_email, workflow_action_approval_email, workflow_action_rejection_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create an approval action * @param {WorkflowActionsNERMApiCreateApprovalActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowActionsNERMApi */ createApprovalAction(requestParameters: WorkflowActionsNERMApiCreateApprovalActionRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create an ask security question action * @summary Create ask security question action * @param {WorkflowActionsNERMApiCreateAskSecurityQuestionActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowActionsNERMApi */ createAskSecurityQuestionAction(requestParameters: WorkflowActionsNERMApiCreateAskSecurityQuestionActionRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create an auto assign action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_roles. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create an auto assign action * @param {WorkflowActionsNERMApiCreateAutoAssignActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowActionsNERMApi */ createAutoAssignAction(requestParameters: WorkflowActionsNERMApiCreateAutoAssignActionRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a batch update action * @summary Create a batch update action * @param {WorkflowActionsNERMApiCreateBatchUpdateActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowActionsNERMApi */ createBatchUpdateAction(requestParameters: WorkflowActionsNERMApiCreateBatchUpdateActionRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a close session action * @summary Create a close session action * @param {WorkflowActionsNERMApiCreateCloseSessionActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowActionsNERMApi */ createCloseSessionAction(requestParameters: WorkflowActionsNERMApiCreateCloseSessionActionRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a contributors action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performers, workflow_action_roles, workflow_action_performer_notification_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a contributors action * @param {WorkflowActionsNERMApiCreateContributorsActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowActionsNERMApi */ createContributorsAction(requestParameters: WorkflowActionsNERMApiCreateContributorsActionRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a create profile action * @summary Create a create profile action * @param {WorkflowActionsNERMApiCreateCreateProfileActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowActionsNERMApi */ createCreateProfileAction(requestParameters: WorkflowActionsNERMApiCreateCreateProfileActionRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a duplicate prevention action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - duplicatation_prevention_attributes, workflow_action_performers, workflow_action_roles, workflow_action_performer_notification_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a duplicate prevention action * @param {WorkflowActionsNERMApiCreateDuplicatePreventionActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowActionsNERMApi */ createDuplicatePreventionAction(requestParameters: WorkflowActionsNERMApiCreateDuplicatePreventionActionRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create an email verification action * @summary Create an email verification action * @param {WorkflowActionsNERMApiCreateEmailVerificationActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowActionsNERMApi */ createEmailVerificationAction(requestParameters: WorkflowActionsNERMApiCreateEmailVerificationActionRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a fulfillment action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performers, workflow_action_roles, workflow_action_performer_notification_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a fulfillment action * @param {WorkflowActionsNERMApiCreateFulfillmentActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowActionsNERMApi */ createFulfillmentAction(requestParameters: WorkflowActionsNERMApiCreateFulfillmentActionRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create an identity proofing action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - identity_proofing_action_configuration, identity_proofing_action_mappings. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create an identity proofing action * @param {WorkflowActionsNERMApiCreateIdentityProofingActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowActionsNERMApi */ createIdentityProofingAction(requestParameters: WorkflowActionsNERMApiCreateIdentityProofingActionRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create an invitation action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_pause_action. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create an invitation action * @param {WorkflowActionsNERMApiCreateInvitationActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowActionsNERMApi */ createInvitationAction(requestParameters: WorkflowActionsNERMApiCreateInvitationActionRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a ldap action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performers, workflow_action_roles. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a ldap action * @param {WorkflowActionsNERMApiCreateLdapActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowActionsNERMApi */ createLdapAction(requestParameters: WorkflowActionsNERMApiCreateLdapActionRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a notification action * @summary Create a notification action * @param {WorkflowActionsNERMApiCreateNotificationActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowActionsNERMApi */ createNotificationAction(requestParameters: WorkflowActionsNERMApiCreateNotificationActionRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a password reset action * @summary Create a password reset action * @param {WorkflowActionsNERMApiCreatePasswordResetActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowActionsNERMApi */ createPasswordResetAction(requestParameters: WorkflowActionsNERMApiCreatePasswordResetActionRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a profile check action * @summary Create a profile check action * @param {WorkflowActionsNERMApiCreateProfileCheckActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowActionsNERMApi */ createProfileCheckAction(requestParameters: WorkflowActionsNERMApiCreateProfileCheckActionRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a profile select action * @summary Create a profile select action * @param {WorkflowActionsNERMApiCreateProfileSelectActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowActionsNERMApi */ createProfileSelectAction(requestParameters: WorkflowActionsNERMApiCreateProfileSelectActionRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a request action * @summary Create a request action * @param {WorkflowActionsNERMApiCreateRequestActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowActionsNERMApi */ createRequestAction(requestParameters: WorkflowActionsNERMApiCreateRequestActionRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a REST API action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - rest_api_action_configuration, api_configuration_attributes. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a REST API action * @param {WorkflowActionsNERMApiCreateRestApiActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowActionsNERMApi */ createRestApiAction(requestParameters: WorkflowActionsNERMApiCreateRestApiActionRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a review action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performer_notification_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a review action * @param {WorkflowActionsNERMApiCreateReviewActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowActionsNERMApi */ createReviewAction(requestParameters: WorkflowActionsNERMApiCreateReviewActionRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a run workflow action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - configuration_profile_attribute. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a run workflow action * @param {WorkflowActionsNERMApiCreateRunWorkflowActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowActionsNERMApi */ createRunWorkflowAction(requestParameters: WorkflowActionsNERMApiCreateRunWorkflowActionRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a set attributes action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_set_attributes. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a set attributes action * @param {WorkflowActionsNERMApiCreateSetAttributesActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowActionsNERMApi */ createSetAttributesAction(requestParameters: WorkflowActionsNERMApiCreateSetAttributesActionRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a set security question action * @summary Create set security question action * @param {WorkflowActionsNERMApiCreateSetSecurityQuestionActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowActionsNERMApi */ createSetSecurityQuestionAction(requestParameters: WorkflowActionsNERMApiCreateSetSecurityQuestionActionRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a SOAP API action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - soap_api_action_configuration, api_configuration_attributes. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create a SOAP API action * @param {WorkflowActionsNERMApiCreateSoapApiActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowActionsNERMApi */ createSoapApiAction(requestParameters: WorkflowActionsNERMApiCreateSoapApiActionRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a status change action * @summary Create a status change action * @param {WorkflowActionsNERMApiCreateStatusChangeActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowActionsNERMApi */ createStatusChangeAction(requestParameters: WorkflowActionsNERMApiCreateStatusChangeActionRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create an unassign action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_roles. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI). * @summary Create an unassign action * @param {WorkflowActionsNERMApiCreateUnassignActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowActionsNERMApi */ createUnassignAction(requestParameters: WorkflowActionsNERMApiCreateUnassignActionRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create an update profile action * @summary Create an update profile action * @param {WorkflowActionsNERMApiCreateUpdateProfileActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowActionsNERMApi */ createUpdateProfileAction(requestParameters: WorkflowActionsNERMApiCreateUpdateProfileActionRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a username password action * @summary Create a username password action * @param {WorkflowActionsNERMApiCreateUsernamePasswordActionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowActionsNERMApi */ createUsernamePasswordAction(requestParameters: WorkflowActionsNERMApiCreateUsernamePasswordActionRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This endpoint can retrieve workflow actions * @summary Get Workflow Actions * @param {WorkflowActionsNERMApiGetWorkflowActionsRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowActionsNERMApi */ getWorkflowActions(requestParameters?: WorkflowActionsNERMApiGetWorkflowActionsRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * WorkflowSessionsNERMApi - axios parameter creator * @export */ export declare const WorkflowSessionsNERMApiAxiosParamCreator: (configuration?: Configuration) => { /** * Find workflow session by id * @summary Find workflow session * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getWorkflowSession: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Retrieves the URL of an attachment attribute value from a workflow session * @summary Retrieves workflow session attachment URL * @param {string} id ID of the object to retrieve, update, or delete * @param {string} attributeId The id of the attachment attribute * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getWorkflowSessionUpload: (id: string, attributeId: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Get workflow sessions * @summary Get workflow sessions * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {string} [order] The field to order results by. * @param {string} [profileId] Profile ID to filter by * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {string} [workflowId] Workflow ID for filtering * @param {string} [requesterId] Requester ID for filtering * @param {GetWorkflowSessionsStatusNerm} [status] filter by workflow session status * @param {boolean} [metadata] Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getWorkflowSessions: (limit?: number, offset?: number, order?: string, profileId?: string, uid?: string, workflowId?: string, requesterId?: string, status?: GetWorkflowSessionsStatusNerm, metadata?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Update a workflow session by id * @summary Update a workflow session * @param {string} id ID of the object to retrieve, update, or delete * @param {SubmitWorkflowSessionRequestNERM} submitWorkflowSessionRequestNERM * @param {boolean} [run] Will run the created/updated workflow session if successful * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchWorkflowSession: (id: string, submitWorkflowSessionRequestNERM: SubmitWorkflowSessionRequestNERM, run?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a workflow session * @summary Create a workflow session * @param {SubmitWorkflowSessionRequestNERM} submitWorkflowSessionRequestNERM * @param {boolean} [run] Will run the created/updated workflow session if successful * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitWorkflowSession: (submitWorkflowSessionRequestNERM: SubmitWorkflowSessionRequestNERM, run?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Uploads a new attachment attribute value to a workflow session. The upload must be a FORM data type; this is not a JSON API. The upload must include the binary content of the payload under the \'file\' named form element. The upload must not attempt to include the file name or its content type as a other form or JSON as parameters. The upload must not attempt to upload the file body as the POST body payload; it has to arrive as a FORM parameter. Do not use a `File/Binary` payload type for the POST operation in your API client. * @summary Uploads workflow session attachment * @param {string} id ID of the object to retrieve, update, or delete * @param {string} attributeId The id of the attachment attribute * @param {File} [file] * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitWorkflowSessionUpload: (id: string, attributeId: string, file?: File, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * WorkflowSessionsNERMApi - functional programming interface * @export */ export declare const WorkflowSessionsNERMApiFp: (configuration?: Configuration) => { /** * Find workflow session by id * @summary Find workflow session * @param {string} id ID of the object to retrieve, update, or delete * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getWorkflowSession(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves the URL of an attachment attribute value from a workflow session * @summary Retrieves workflow session attachment URL * @param {string} id ID of the object to retrieve, update, or delete * @param {string} attributeId The id of the attachment attribute * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getWorkflowSessionUpload(id: string, attributeId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get workflow sessions * @summary Get workflow sessions * @param {number} [limit] The maximum number of items to return. * @param {number} [offset] The number of items to skip before starting to collect the result set. * @param {string} [order] The field to order results by. * @param {string} [profileId] Profile ID to filter by * @param {string} [uid] UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @param {string} [workflowId] Workflow ID for filtering * @param {string} [requesterId] Requester ID for filtering * @param {GetWorkflowSessionsStatusNerm} [status] filter by workflow session status * @param {boolean} [metadata] Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getWorkflowSessions(limit?: number, offset?: number, order?: string, profileId?: string, uid?: string, workflowId?: string, requesterId?: string, status?: GetWorkflowSessionsStatusNerm, metadata?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update a workflow session by id * @summary Update a workflow session * @param {string} id ID of the object to retrieve, update, or delete * @param {SubmitWorkflowSessionRequestNERM} submitWorkflowSessionRequestNERM * @param {boolean} [run] Will run the created/updated workflow session if successful * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchWorkflowSession(id: string, submitWorkflowSessionRequestNERM: SubmitWorkflowSessionRequestNERM, run?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a workflow session * @summary Create a workflow session * @param {SubmitWorkflowSessionRequestNERM} submitWorkflowSessionRequestNERM * @param {boolean} [run] Will run the created/updated workflow session if successful * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitWorkflowSession(submitWorkflowSessionRequestNERM: SubmitWorkflowSessionRequestNERM, run?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Uploads a new attachment attribute value to a workflow session. The upload must be a FORM data type; this is not a JSON API. The upload must include the binary content of the payload under the \'file\' named form element. The upload must not attempt to include the file name or its content type as a other form or JSON as parameters. The upload must not attempt to upload the file body as the POST body payload; it has to arrive as a FORM parameter. Do not use a `File/Binary` payload type for the POST operation in your API client. * @summary Uploads workflow session attachment * @param {string} id ID of the object to retrieve, update, or delete * @param {string} attributeId The id of the attachment attribute * @param {File} [file] * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitWorkflowSessionUpload(id: string, attributeId: string, file?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * WorkflowSessionsNERMApi - factory interface * @export */ export declare const WorkflowSessionsNERMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Find workflow session by id * @summary Find workflow session * @param {WorkflowSessionsNERMApiGetWorkflowSessionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getWorkflowSession(requestParameters: WorkflowSessionsNERMApiGetWorkflowSessionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves the URL of an attachment attribute value from a workflow session * @summary Retrieves workflow session attachment URL * @param {WorkflowSessionsNERMApiGetWorkflowSessionUploadRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getWorkflowSessionUpload(requestParameters: WorkflowSessionsNERMApiGetWorkflowSessionUploadRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Get workflow sessions * @summary Get workflow sessions * @param {WorkflowSessionsNERMApiGetWorkflowSessionsRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getWorkflowSessions(requestParameters?: WorkflowSessionsNERMApiGetWorkflowSessionsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Update a workflow session by id * @summary Update a workflow session * @param {WorkflowSessionsNERMApiPatchWorkflowSessionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchWorkflowSession(requestParameters: WorkflowSessionsNERMApiPatchWorkflowSessionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a workflow session * @summary Create a workflow session * @param {WorkflowSessionsNERMApiSubmitWorkflowSessionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitWorkflowSession(requestParameters: WorkflowSessionsNERMApiSubmitWorkflowSessionRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Uploads a new attachment attribute value to a workflow session. The upload must be a FORM data type; this is not a JSON API. The upload must include the binary content of the payload under the \'file\' named form element. The upload must not attempt to include the file name or its content type as a other form or JSON as parameters. The upload must not attempt to upload the file body as the POST body payload; it has to arrive as a FORM parameter. Do not use a `File/Binary` payload type for the POST operation in your API client. * @summary Uploads workflow session attachment * @param {WorkflowSessionsNERMApiSubmitWorkflowSessionUploadRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ submitWorkflowSessionUpload(requestParameters: WorkflowSessionsNERMApiSubmitWorkflowSessionUploadRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for getWorkflowSession operation in WorkflowSessionsNERMApi. * @export * @interface WorkflowSessionsNERMApiGetWorkflowSessionRequest */ export interface WorkflowSessionsNERMApiGetWorkflowSessionRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof WorkflowSessionsNERMApiGetWorkflowSession */ readonly id: string; } /** * Request parameters for getWorkflowSessionUpload operation in WorkflowSessionsNERMApi. * @export * @interface WorkflowSessionsNERMApiGetWorkflowSessionUploadRequest */ export interface WorkflowSessionsNERMApiGetWorkflowSessionUploadRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof WorkflowSessionsNERMApiGetWorkflowSessionUpload */ readonly id: string; /** * The id of the attachment attribute * @type {string} * @memberof WorkflowSessionsNERMApiGetWorkflowSessionUpload */ readonly attributeId: string; } /** * Request parameters for getWorkflowSessions operation in WorkflowSessionsNERMApi. * @export * @interface WorkflowSessionsNERMApiGetWorkflowSessionsRequest */ export interface WorkflowSessionsNERMApiGetWorkflowSessionsRequest { /** * The maximum number of items to return. * @type {number} * @memberof WorkflowSessionsNERMApiGetWorkflowSessions */ readonly limit?: number; /** * The number of items to skip before starting to collect the result set. * @type {number} * @memberof WorkflowSessionsNERMApiGetWorkflowSessions */ readonly offset?: number; /** * The field to order results by. * @type {string} * @memberof WorkflowSessionsNERMApiGetWorkflowSessions */ readonly order?: string; /** * Profile ID to filter by * @type {string} * @memberof WorkflowSessionsNERMApiGetWorkflowSessions */ readonly profileId?: string; /** * UID of the object to retrieve, update, or delete. A UID or \"specified identifier\" is a string typically in \"snake_case\" format that provides a human-readable description of the record. They are commonly used to ensure sandbox, qa, staging and production tenants have the identical configuration items loaded. Every record has a UID assigned when persisted. When not specified the system assigns one by default. A default value looks like a 32 character string of random hexadecimal characters. * @type {string} * @memberof WorkflowSessionsNERMApiGetWorkflowSessions */ readonly uid?: string; /** * Workflow ID for filtering * @type {string} * @memberof WorkflowSessionsNERMApiGetWorkflowSessions */ readonly workflowId?: string; /** * Requester ID for filtering * @type {string} * @memberof WorkflowSessionsNERMApiGetWorkflowSessions */ readonly requesterId?: string; /** * filter by workflow session status * @type {'waiting on workflow' | 'identity proofing completed' | 'new' | 'closing' | 'pending request' | 'requested' | 'pending approval' | 'approved' | 'pending notification' | 'notified' | 'pending review' | 'reviewed' | 'pending trigger' | 'stored procedure' | 'pending status change' | 'status changed' | 'pending update' | 'non employee updated' | 'non employee created' | 'pending creation' | 'rejected' | 'pending assignment' | 'assigned' | 'default' | 'failed' | 'un assigned' | 'auto assigned' | 'ldap provided' | 'pending ldap' | 'pending fulfillment' | 'pending stored procedure' | 'pending courion add' | 'fulfilled' | 'pending courion update' | 'courion add' | 'pending courion_extend' | 'courion update' | 'pending courion terminate' | 'courion extend' | 'pending profile select' | 'courion terminate' | 'batch completed' | 'profiles selected' | 'answered questions' | 'pending questions' | 'attempting to start workflow' | 'started workflow' | 'profile check complete' | 'completed' | 'processing' | 'pending set attribute' | 'invitation sent' | 'action skipped' | 'api request sent' | 'attribute set' | 'disabled' | 'duplicates resolved' | 'soap request sent' | 'checking for duplicates' | 'pending identity proofing' | 'closed' | 'workflow changed'} * @memberof WorkflowSessionsNERMApiGetWorkflowSessions */ readonly status?: GetWorkflowSessionsStatusNerm; /** * Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last \"page\"). * @type {boolean} * @memberof WorkflowSessionsNERMApiGetWorkflowSessions */ readonly metadata?: boolean; } /** * Request parameters for patchWorkflowSession operation in WorkflowSessionsNERMApi. * @export * @interface WorkflowSessionsNERMApiPatchWorkflowSessionRequest */ export interface WorkflowSessionsNERMApiPatchWorkflowSessionRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof WorkflowSessionsNERMApiPatchWorkflowSession */ readonly id: string; /** * * @type {SubmitWorkflowSessionRequestNERM} * @memberof WorkflowSessionsNERMApiPatchWorkflowSession */ readonly submitWorkflowSessionRequestNERM: SubmitWorkflowSessionRequestNERM; /** * Will run the created/updated workflow session if successful * @type {boolean} * @memberof WorkflowSessionsNERMApiPatchWorkflowSession */ readonly run?: boolean; } /** * Request parameters for submitWorkflowSession operation in WorkflowSessionsNERMApi. * @export * @interface WorkflowSessionsNERMApiSubmitWorkflowSessionRequest */ export interface WorkflowSessionsNERMApiSubmitWorkflowSessionRequest { /** * * @type {SubmitWorkflowSessionRequestNERM} * @memberof WorkflowSessionsNERMApiSubmitWorkflowSession */ readonly submitWorkflowSessionRequestNERM: SubmitWorkflowSessionRequestNERM; /** * Will run the created/updated workflow session if successful * @type {boolean} * @memberof WorkflowSessionsNERMApiSubmitWorkflowSession */ readonly run?: boolean; } /** * Request parameters for submitWorkflowSessionUpload operation in WorkflowSessionsNERMApi. * @export * @interface WorkflowSessionsNERMApiSubmitWorkflowSessionUploadRequest */ export interface WorkflowSessionsNERMApiSubmitWorkflowSessionUploadRequest { /** * ID of the object to retrieve, update, or delete * @type {string} * @memberof WorkflowSessionsNERMApiSubmitWorkflowSessionUpload */ readonly id: string; /** * The id of the attachment attribute * @type {string} * @memberof WorkflowSessionsNERMApiSubmitWorkflowSessionUpload */ readonly attributeId: string; /** * * @type {File} * @memberof WorkflowSessionsNERMApiSubmitWorkflowSessionUpload */ readonly file?: File; } /** * WorkflowSessionsNERMApi - object-oriented interface * @export * @class WorkflowSessionsNERMApi * @extends {BaseAPI} */ export declare class WorkflowSessionsNERMApi extends BaseAPI { /** * Find workflow session by id * @summary Find workflow session * @param {WorkflowSessionsNERMApiGetWorkflowSessionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowSessionsNERMApi */ getWorkflowSession(requestParameters: WorkflowSessionsNERMApiGetWorkflowSessionRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Retrieves the URL of an attachment attribute value from a workflow session * @summary Retrieves workflow session attachment URL * @param {WorkflowSessionsNERMApiGetWorkflowSessionUploadRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowSessionsNERMApi */ getWorkflowSessionUpload(requestParameters: WorkflowSessionsNERMApiGetWorkflowSessionUploadRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Get workflow sessions * @summary Get workflow sessions * @param {WorkflowSessionsNERMApiGetWorkflowSessionsRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowSessionsNERMApi */ getWorkflowSessions(requestParameters?: WorkflowSessionsNERMApiGetWorkflowSessionsRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Update a workflow session by id * @summary Update a workflow session * @param {WorkflowSessionsNERMApiPatchWorkflowSessionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowSessionsNERMApi */ patchWorkflowSession(requestParameters: WorkflowSessionsNERMApiPatchWorkflowSessionRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a workflow session * @summary Create a workflow session * @param {WorkflowSessionsNERMApiSubmitWorkflowSessionRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowSessionsNERMApi */ submitWorkflowSession(requestParameters: WorkflowSessionsNERMApiSubmitWorkflowSessionRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Uploads a new attachment attribute value to a workflow session. The upload must be a FORM data type; this is not a JSON API. The upload must include the binary content of the payload under the \'file\' named form element. The upload must not attempt to include the file name or its content type as a other form or JSON as parameters. The upload must not attempt to upload the file body as the POST body payload; it has to arrive as a FORM parameter. Do not use a `File/Binary` payload type for the POST operation in your API client. * @summary Uploads workflow session attachment * @param {WorkflowSessionsNERMApiSubmitWorkflowSessionUploadRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowSessionsNERMApi */ submitWorkflowSessionUpload(requestParameters: WorkflowSessionsNERMApiSubmitWorkflowSessionUploadRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const GetWorkflowSessionsStatusNerm: { readonly WaitingOnWorkflow: "waiting on workflow"; readonly IdentityProofingCompleted: "identity proofing completed"; readonly New: "new"; readonly Closing: "closing"; readonly PendingRequest: "pending request"; readonly Requested: "requested"; readonly PendingApproval: "pending approval"; readonly Approved: "approved"; readonly PendingNotification: "pending notification"; readonly Notified: "notified"; readonly PendingReview: "pending review"; readonly Reviewed: "reviewed"; readonly PendingTrigger: "pending trigger"; readonly StoredProcedure: "stored procedure"; readonly PendingStatusChange: "pending status change"; readonly StatusChanged: "status changed"; readonly PendingUpdate: "pending update"; readonly NonEmployeeUpdated: "non employee updated"; readonly NonEmployeeCreated: "non employee created"; readonly PendingCreation: "pending creation"; readonly Rejected: "rejected"; readonly PendingAssignment: "pending assignment"; readonly Assigned: "assigned"; readonly Default: "default"; readonly Failed: "failed"; readonly UnAssigned: "un assigned"; readonly AutoAssigned: "auto assigned"; readonly LdapProvided: "ldap provided"; readonly PendingLdap: "pending ldap"; readonly PendingFulfillment: "pending fulfillment"; readonly PendingStoredProcedure: "pending stored procedure"; readonly PendingCourionAdd: "pending courion add"; readonly Fulfilled: "fulfilled"; readonly PendingCourionUpdate: "pending courion update"; readonly CourionAdd: "courion add"; readonly PendingCourionExtend: "pending courion_extend"; readonly CourionUpdate: "courion update"; readonly PendingCourionTerminate: "pending courion terminate"; readonly CourionExtend: "courion extend"; readonly PendingProfileSelect: "pending profile select"; readonly CourionTerminate: "courion terminate"; readonly BatchCompleted: "batch completed"; readonly ProfilesSelected: "profiles selected"; readonly AnsweredQuestions: "answered questions"; readonly PendingQuestions: "pending questions"; readonly AttemptingToStartWorkflow: "attempting to start workflow"; readonly StartedWorkflow: "started workflow"; readonly ProfileCheckComplete: "profile check complete"; readonly Completed: "completed"; readonly Processing: "processing"; readonly PendingSetAttribute: "pending set attribute"; readonly InvitationSent: "invitation sent"; readonly ActionSkipped: "action skipped"; readonly ApiRequestSent: "api request sent"; readonly AttributeSet: "attribute set"; readonly Disabled: "disabled"; readonly DuplicatesResolved: "duplicates resolved"; readonly SoapRequestSent: "soap request sent"; readonly CheckingForDuplicates: "checking for duplicates"; readonly PendingIdentityProofing: "pending identity proofing"; readonly Closed: "closed"; readonly WorkflowChanged: "workflow changed"; }; export type GetWorkflowSessionsStatusNerm = typeof GetWorkflowSessionsStatusNerm[keyof typeof GetWorkflowSessionsStatusNerm]; /** * WorkflowsNERMApi - axios parameter creator * @export */ export declare const WorkflowsNERMApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create an automated workflow * @summary Create an automated workflow * @param {CreateAutomatedWorkflowRequestNERM} createAutomatedWorkflowRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createAutomatedWorkflow: (createAutomatedWorkflowRequestNERM: CreateAutomatedWorkflowRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a batch workflow * @summary Create a batch workflow * @param {CreateBatchWorkflowRequestNERM} createBatchWorkflowRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createBatchWorkflow: (createBatchWorkflowRequestNERM: CreateBatchWorkflowRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a create workflow * @summary Create a create workflow * @param {CreateCreateWorkflowRequestNERM} createCreateWorkflowRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createCreateWorkflow: (createCreateWorkflowRequestNERM: CreateCreateWorkflowRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a login workflow * @summary Create a login workflow * @param {CreateLoginWorkflowRequestNERM} createLoginWorkflowRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createLoginWorkflow: (createLoginWorkflowRequestNERM: CreateLoginWorkflowRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a password reset workflow * @summary Create a password reset workflow * @param {CreateLoginWorkflowRequestNERM} createLoginWorkflowRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createPasswordUpdateWorkflow: (createLoginWorkflowRequestNERM: CreateLoginWorkflowRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create a registration workflow * @summary Create a registration workflow * @param {CreateCreateWorkflowRequestNERM} createCreateWorkflowRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createRegistrationWorkflow: (createCreateWorkflowRequestNERM: CreateCreateWorkflowRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Create an update workflow * @summary Create an update workflow * @param {CreateUpdateWorkflowRequestNERM} createUpdateWorkflowRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createUpdateWorkflow: (createUpdateWorkflowRequestNERM: CreateUpdateWorkflowRequestNERM, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * WorkflowsNERMApi - functional programming interface * @export */ export declare const WorkflowsNERMApiFp: (configuration?: Configuration) => { /** * Create an automated workflow * @summary Create an automated workflow * @param {CreateAutomatedWorkflowRequestNERM} createAutomatedWorkflowRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createAutomatedWorkflow(createAutomatedWorkflowRequestNERM: CreateAutomatedWorkflowRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a batch workflow * @summary Create a batch workflow * @param {CreateBatchWorkflowRequestNERM} createBatchWorkflowRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createBatchWorkflow(createBatchWorkflowRequestNERM: CreateBatchWorkflowRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a create workflow * @summary Create a create workflow * @param {CreateCreateWorkflowRequestNERM} createCreateWorkflowRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createCreateWorkflow(createCreateWorkflowRequestNERM: CreateCreateWorkflowRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a login workflow * @summary Create a login workflow * @param {CreateLoginWorkflowRequestNERM} createLoginWorkflowRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createLoginWorkflow(createLoginWorkflowRequestNERM: CreateLoginWorkflowRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a password reset workflow * @summary Create a password reset workflow * @param {CreateLoginWorkflowRequestNERM} createLoginWorkflowRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createPasswordUpdateWorkflow(createLoginWorkflowRequestNERM: CreateLoginWorkflowRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a registration workflow * @summary Create a registration workflow * @param {CreateCreateWorkflowRequestNERM} createCreateWorkflowRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createRegistrationWorkflow(createCreateWorkflowRequestNERM: CreateCreateWorkflowRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create an update workflow * @summary Create an update workflow * @param {CreateUpdateWorkflowRequestNERM} createUpdateWorkflowRequestNERM * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createUpdateWorkflow(createUpdateWorkflowRequestNERM: CreateUpdateWorkflowRequestNERM, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * WorkflowsNERMApi - factory interface * @export */ export declare const WorkflowsNERMApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create an automated workflow * @summary Create an automated workflow * @param {WorkflowsNERMApiCreateAutomatedWorkflowRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createAutomatedWorkflow(requestParameters: WorkflowsNERMApiCreateAutomatedWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a batch workflow * @summary Create a batch workflow * @param {WorkflowsNERMApiCreateBatchWorkflowRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createBatchWorkflow(requestParameters: WorkflowsNERMApiCreateBatchWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a create workflow * @summary Create a create workflow * @param {WorkflowsNERMApiCreateCreateWorkflowRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createCreateWorkflow(requestParameters: WorkflowsNERMApiCreateCreateWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a login workflow * @summary Create a login workflow * @param {WorkflowsNERMApiCreateLoginWorkflowRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createLoginWorkflow(requestParameters: WorkflowsNERMApiCreateLoginWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a password reset workflow * @summary Create a password reset workflow * @param {WorkflowsNERMApiCreatePasswordUpdateWorkflowRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createPasswordUpdateWorkflow(requestParameters: WorkflowsNERMApiCreatePasswordUpdateWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create a registration workflow * @summary Create a registration workflow * @param {WorkflowsNERMApiCreateRegistrationWorkflowRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createRegistrationWorkflow(requestParameters: WorkflowsNERMApiCreateRegistrationWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Create an update workflow * @summary Create an update workflow * @param {WorkflowsNERMApiCreateUpdateWorkflowRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createUpdateWorkflow(requestParameters: WorkflowsNERMApiCreateUpdateWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createAutomatedWorkflow operation in WorkflowsNERMApi. * @export * @interface WorkflowsNERMApiCreateAutomatedWorkflowRequest */ export interface WorkflowsNERMApiCreateAutomatedWorkflowRequest { /** * * @type {CreateAutomatedWorkflowRequestNERM} * @memberof WorkflowsNERMApiCreateAutomatedWorkflow */ readonly createAutomatedWorkflowRequestNERM: CreateAutomatedWorkflowRequestNERM; } /** * Request parameters for createBatchWorkflow operation in WorkflowsNERMApi. * @export * @interface WorkflowsNERMApiCreateBatchWorkflowRequest */ export interface WorkflowsNERMApiCreateBatchWorkflowRequest { /** * * @type {CreateBatchWorkflowRequestNERM} * @memberof WorkflowsNERMApiCreateBatchWorkflow */ readonly createBatchWorkflowRequestNERM: CreateBatchWorkflowRequestNERM; } /** * Request parameters for createCreateWorkflow operation in WorkflowsNERMApi. * @export * @interface WorkflowsNERMApiCreateCreateWorkflowRequest */ export interface WorkflowsNERMApiCreateCreateWorkflowRequest { /** * * @type {CreateCreateWorkflowRequestNERM} * @memberof WorkflowsNERMApiCreateCreateWorkflow */ readonly createCreateWorkflowRequestNERM: CreateCreateWorkflowRequestNERM; } /** * Request parameters for createLoginWorkflow operation in WorkflowsNERMApi. * @export * @interface WorkflowsNERMApiCreateLoginWorkflowRequest */ export interface WorkflowsNERMApiCreateLoginWorkflowRequest { /** * * @type {CreateLoginWorkflowRequestNERM} * @memberof WorkflowsNERMApiCreateLoginWorkflow */ readonly createLoginWorkflowRequestNERM: CreateLoginWorkflowRequestNERM; } /** * Request parameters for createPasswordUpdateWorkflow operation in WorkflowsNERMApi. * @export * @interface WorkflowsNERMApiCreatePasswordUpdateWorkflowRequest */ export interface WorkflowsNERMApiCreatePasswordUpdateWorkflowRequest { /** * * @type {CreateLoginWorkflowRequestNERM} * @memberof WorkflowsNERMApiCreatePasswordUpdateWorkflow */ readonly createLoginWorkflowRequestNERM: CreateLoginWorkflowRequestNERM; } /** * Request parameters for createRegistrationWorkflow operation in WorkflowsNERMApi. * @export * @interface WorkflowsNERMApiCreateRegistrationWorkflowRequest */ export interface WorkflowsNERMApiCreateRegistrationWorkflowRequest { /** * * @type {CreateCreateWorkflowRequestNERM} * @memberof WorkflowsNERMApiCreateRegistrationWorkflow */ readonly createCreateWorkflowRequestNERM: CreateCreateWorkflowRequestNERM; } /** * Request parameters for createUpdateWorkflow operation in WorkflowsNERMApi. * @export * @interface WorkflowsNERMApiCreateUpdateWorkflowRequest */ export interface WorkflowsNERMApiCreateUpdateWorkflowRequest { /** * * @type {CreateUpdateWorkflowRequestNERM} * @memberof WorkflowsNERMApiCreateUpdateWorkflow */ readonly createUpdateWorkflowRequestNERM: CreateUpdateWorkflowRequestNERM; } /** * WorkflowsNERMApi - object-oriented interface * @export * @class WorkflowsNERMApi * @extends {BaseAPI} */ export declare class WorkflowsNERMApi extends BaseAPI { /** * Create an automated workflow * @summary Create an automated workflow * @param {WorkflowsNERMApiCreateAutomatedWorkflowRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowsNERMApi */ createAutomatedWorkflow(requestParameters: WorkflowsNERMApiCreateAutomatedWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a batch workflow * @summary Create a batch workflow * @param {WorkflowsNERMApiCreateBatchWorkflowRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowsNERMApi */ createBatchWorkflow(requestParameters: WorkflowsNERMApiCreateBatchWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a create workflow * @summary Create a create workflow * @param {WorkflowsNERMApiCreateCreateWorkflowRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowsNERMApi */ createCreateWorkflow(requestParameters: WorkflowsNERMApiCreateCreateWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a login workflow * @summary Create a login workflow * @param {WorkflowsNERMApiCreateLoginWorkflowRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowsNERMApi */ createLoginWorkflow(requestParameters: WorkflowsNERMApiCreateLoginWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a password reset workflow * @summary Create a password reset workflow * @param {WorkflowsNERMApiCreatePasswordUpdateWorkflowRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowsNERMApi */ createPasswordUpdateWorkflow(requestParameters: WorkflowsNERMApiCreatePasswordUpdateWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create a registration workflow * @summary Create a registration workflow * @param {WorkflowsNERMApiCreateRegistrationWorkflowRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowsNERMApi */ createRegistrationWorkflow(requestParameters: WorkflowsNERMApiCreateRegistrationWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Create an update workflow * @summary Create an update workflow * @param {WorkflowsNERMApiCreateUpdateWorkflowRequest} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof WorkflowsNERMApi */ createUpdateWorkflow(requestParameters: WorkflowsNERMApiCreateUpdateWorkflowRequest, axiosOptions?: RawAxiosRequestConfig): Promise>; }