/* tslint:disable */ /* eslint-disable */ /** * Identity Security Cloud API - Non-Employee Lifecycle Management * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. * * The version of the OpenAPI document: v1 * * * 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 globalAxios from 'axios'; // Some imports not used depending on template conditions // @ts-ignore import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common'; import type { RequestArgs } from './base'; // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base'; /** * Enum representing the non-employee request approval status * @export * @enum {string} */ export const ApprovalStatus = { Approved: 'APPROVED', Rejected: 'REJECTED', Pending: 'PENDING', NotReady: 'NOT_READY', Cancelled: 'CANCELLED' } as const; export type ApprovalStatus = typeof ApprovalStatus[keyof typeof ApprovalStatus]; /** * * @export * @interface ArrayInner */ export interface ArrayInner { } /** * * @export * @interface DeleteNonEmployeeRecordsInBulkV1Request */ export interface DeleteNonEmployeeRecordsInBulkV1Request { /** * List of non-employee ids. * @type {Array} * @memberof DeleteNonEmployeeRecordsInBulkV1Request */ 'ids': Array; } /** * * @export * @interface ErrorMessageDto */ export interface ErrorMessageDto { /** * The locale for the message text, a BCP 47 language tag. * @type {string} * @memberof ErrorMessageDto */ 'locale'?: string | null; /** * * @type {LocaleOrigin} * @memberof ErrorMessageDto */ 'localeOrigin'?: LocaleOrigin | null; /** * Actual text of the error message in the indicated locale. * @type {string} * @memberof ErrorMessageDto */ 'text'?: string; } /** * * @export * @interface ErrorResponseDto */ export interface ErrorResponseDto { /** * Fine-grained error code providing more detail of the error. * @type {string} * @memberof ErrorResponseDto */ 'detailCode'?: string; /** * Unique tracking id for the error. * @type {string} * @memberof ErrorResponseDto */ 'trackingId'?: string; /** * Generic localized reason for error * @type {Array} * @memberof ErrorResponseDto */ 'messages'?: Array; /** * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field * @type {Array} * @memberof ErrorResponseDto */ 'causes'?: Array; } /** * * @export * @interface ImportNonEmployeeRecordsInBulkV1Request */ export interface ImportNonEmployeeRecordsInBulkV1Request { /** * * @type {File} * @memberof ImportNonEmployeeRecordsInBulkV1Request */ 'data': File; } /** * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) * @export * @interface JsonPatchOperation */ export interface JsonPatchOperation { /** * The operation to be performed * @type {string} * @memberof JsonPatchOperation */ 'op': JsonPatchOperationOpEnum; /** * A string JSON Pointer representing the target path to an element to be affected by the operation * @type {string} * @memberof JsonPatchOperation */ 'path': string; /** * * @type {JsonPatchOperationValue} * @memberof JsonPatchOperation */ 'value'?: JsonPatchOperationValue; } export const JsonPatchOperationOpEnum = { Add: 'add', Remove: 'remove', Replace: 'replace', Move: 'move', Copy: 'copy', Test: 'test' } as const; export type JsonPatchOperationOpEnum = typeof JsonPatchOperationOpEnum[keyof typeof JsonPatchOperationOpEnum]; /** * @type JsonPatchOperationValue * The value to be used for the operation, required for \"add\" and \"replace\" operations * @export */ export type JsonPatchOperationValue = Array | boolean | number | object | string; /** * * @export * @interface ListNonEmployeeRecordsV1401Response */ export interface ListNonEmployeeRecordsV1401Response { /** * A message describing the error * @type {any} * @memberof ListNonEmployeeRecordsV1401Response */ 'error'?: any; } /** * * @export * @interface ListNonEmployeeRecordsV1429Response */ export interface ListNonEmployeeRecordsV1429Response { /** * A message describing the error * @type {any} * @memberof ListNonEmployeeRecordsV1429Response */ 'message'?: any; } /** * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. * @export * @enum {string} */ export const LocaleOrigin = { Default: 'DEFAULT', Request: 'REQUEST' } as const; export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin]; /** * * @export * @interface NonEmployeeApprovalDecision */ export interface NonEmployeeApprovalDecision { /** * Comment on the approval item. * @type {string} * @memberof NonEmployeeApprovalDecision */ 'comment'?: string; } /** * * @export * @interface NonEmployeeApprovalItem */ export interface NonEmployeeApprovalItem { /** * Non-Employee approval item id * @type {string} * @memberof NonEmployeeApprovalItem */ 'id'?: string; /** * * @type {NonEmployeeIdentityReferenceWithId} * @memberof NonEmployeeApprovalItem */ 'approver'?: NonEmployeeIdentityReferenceWithId; /** * Requested identity account name * @type {string} * @memberof NonEmployeeApprovalItem */ 'accountName'?: string; /** * * @type {ApprovalStatus} * @memberof NonEmployeeApprovalItem */ 'approvalStatus'?: ApprovalStatus; /** * Approval order * @type {number} * @memberof NonEmployeeApprovalItem */ 'approvalOrder'?: number; /** * comment of approver * @type {string} * @memberof NonEmployeeApprovalItem */ 'comment'?: string; /** * When the request was last modified. * @type {string} * @memberof NonEmployeeApprovalItem */ 'modified'?: string; /** * When the request was created. * @type {string} * @memberof NonEmployeeApprovalItem */ 'created'?: string; /** * * @type {NonEmployeeRequestLite} * @memberof NonEmployeeApprovalItem */ 'nonEmployeeRequest'?: NonEmployeeRequestLite; } /** * * @export * @interface NonEmployeeApprovalItemBase */ export interface NonEmployeeApprovalItemBase { /** * Non-Employee approval item id * @type {string} * @memberof NonEmployeeApprovalItemBase */ 'id'?: string; /** * * @type {NonEmployeeIdentityReferenceWithId} * @memberof NonEmployeeApprovalItemBase */ 'approver'?: NonEmployeeIdentityReferenceWithId; /** * Requested identity account name * @type {string} * @memberof NonEmployeeApprovalItemBase */ 'accountName'?: string; /** * * @type {ApprovalStatus} * @memberof NonEmployeeApprovalItemBase */ 'approvalStatus'?: ApprovalStatus; /** * Approval order * @type {number} * @memberof NonEmployeeApprovalItemBase */ 'approvalOrder'?: number; /** * comment of approver * @type {string} * @memberof NonEmployeeApprovalItemBase */ 'comment'?: string; /** * When the request was last modified. * @type {string} * @memberof NonEmployeeApprovalItemBase */ 'modified'?: string; /** * When the request was created. * @type {string} * @memberof NonEmployeeApprovalItemBase */ 'created'?: string; } /** * * @export * @interface NonEmployeeApprovalItemDetail */ export interface NonEmployeeApprovalItemDetail { /** * Non-Employee approval item id * @type {string} * @memberof NonEmployeeApprovalItemDetail */ 'id'?: string; /** * * @type {NonEmployeeIdentityReferenceWithId} * @memberof NonEmployeeApprovalItemDetail */ 'approver'?: NonEmployeeIdentityReferenceWithId; /** * Requested identity account name * @type {string} * @memberof NonEmployeeApprovalItemDetail */ 'accountName'?: string; /** * * @type {ApprovalStatus} * @memberof NonEmployeeApprovalItemDetail */ 'approvalStatus'?: ApprovalStatus; /** * Approval order * @type {number} * @memberof NonEmployeeApprovalItemDetail */ 'approvalOrder'?: number; /** * comment of approver * @type {string} * @memberof NonEmployeeApprovalItemDetail */ 'comment'?: string; /** * When the request was last modified. * @type {string} * @memberof NonEmployeeApprovalItemDetail */ 'modified'?: string; /** * When the request was created. * @type {string} * @memberof NonEmployeeApprovalItemDetail */ 'created'?: string; /** * * @type {NonEmployeeRequestWithoutApprovalItem} * @memberof NonEmployeeApprovalItemDetail */ 'nonEmployeeRequest'?: NonEmployeeRequestWithoutApprovalItem; } /** * * @export * @interface NonEmployeeApprovalSummary */ export interface NonEmployeeApprovalSummary { /** * The number of approved non-employee approval requests. * @type {number} * @memberof NonEmployeeApprovalSummary */ 'approved'?: number; /** * The number of pending non-employee approval requests. * @type {number} * @memberof NonEmployeeApprovalSummary */ 'pending'?: number; /** * The number of rejected non-employee approval requests. * @type {number} * @memberof NonEmployeeApprovalSummary */ 'rejected'?: number; } /** * * @export * @interface NonEmployeeBulkUploadJob */ export interface NonEmployeeBulkUploadJob { /** * The bulk upload job\'s ID. (UUID) * @type {string} * @memberof NonEmployeeBulkUploadJob */ 'id'?: string; /** * The ID of the source to bulk-upload non-employees to. (UUID) * @type {string} * @memberof NonEmployeeBulkUploadJob */ 'sourceId'?: string; /** * The date-time the job was submitted. * @type {string} * @memberof NonEmployeeBulkUploadJob */ 'created'?: string; /** * The date-time that the job was last updated. * @type {string} * @memberof NonEmployeeBulkUploadJob */ 'modified'?: string; /** * Returns the following values indicating the progress or result of the bulk upload job. \"PENDING\" means the job is queued and waiting to be processed. \"IN_PROGRESS\" means the job is currently being processed. \"COMPLETED\" means the job has been completed without any errors. \"ERROR\" means the job failed to process with errors. * @type {string} * @memberof NonEmployeeBulkUploadJob */ 'status'?: NonEmployeeBulkUploadJobStatusEnum; } export const NonEmployeeBulkUploadJobStatusEnum = { Pending: 'PENDING', InProgress: 'IN_PROGRESS', Completed: 'COMPLETED', Error: 'ERROR' } as const; export type NonEmployeeBulkUploadJobStatusEnum = typeof NonEmployeeBulkUploadJobStatusEnum[keyof typeof NonEmployeeBulkUploadJobStatusEnum]; /** * * @export * @interface NonEmployeeBulkUploadStatus */ export interface NonEmployeeBulkUploadStatus { /** * Returns the following values indicating the progress or result of the bulk upload job. \"PENDING\" means the job is queued and waiting to be processed. \"IN_PROGRESS\" means the job is currently being processed. \"COMPLETED\" means the job has been completed without any errors. \"ERROR\" means the job failed to process with errors. null means job has been submitted to the source. * @type {string} * @memberof NonEmployeeBulkUploadStatus */ 'status'?: NonEmployeeBulkUploadStatusStatusEnum; } export const NonEmployeeBulkUploadStatusStatusEnum = { Pending: 'PENDING', InProgress: 'IN_PROGRESS', Completed: 'COMPLETED', Error: 'ERROR' } as const; export type NonEmployeeBulkUploadStatusStatusEnum = typeof NonEmployeeBulkUploadStatusStatusEnum[keyof typeof NonEmployeeBulkUploadStatusStatusEnum]; /** * Identifies if the identity is a normal identity or a governance group * @export * @enum {string} */ export const NonEmployeeIdentityDtoType = { GovernanceGroup: 'GOVERNANCE_GROUP', Identity: 'IDENTITY' } as const; export type NonEmployeeIdentityDtoType = typeof NonEmployeeIdentityDtoType[keyof typeof NonEmployeeIdentityDtoType]; /** * * @export * @interface NonEmployeeIdentityReferenceWithId */ export interface NonEmployeeIdentityReferenceWithId { /** * * @type {NonEmployeeIdentityDtoType} * @memberof NonEmployeeIdentityReferenceWithId */ 'type'?: NonEmployeeIdentityDtoType; /** * Identity id * @type {string} * @memberof NonEmployeeIdentityReferenceWithId */ 'id'?: string; } /** * * @export * @interface NonEmployeeIdnUserRequest */ export interface NonEmployeeIdnUserRequest { /** * Identity id. * @type {string} * @memberof NonEmployeeIdnUserRequest */ 'id': string; } /** * * @export * @interface NonEmployeeRecord */ export interface NonEmployeeRecord { /** * Non-Employee record id. * @type {string} * @memberof NonEmployeeRecord */ 'id'?: string; /** * Requested identity account name. * @type {string} * @memberof NonEmployeeRecord */ 'accountName'?: string; /** * Non-Employee\'s first name. * @type {string} * @memberof NonEmployeeRecord */ 'firstName'?: string; /** * Non-Employee\'s last name. * @type {string} * @memberof NonEmployeeRecord */ 'lastName'?: string; /** * Non-Employee\'s email. * @type {string} * @memberof NonEmployeeRecord */ 'email'?: string; /** * Non-Employee\'s phone. * @type {string} * @memberof NonEmployeeRecord */ 'phone'?: string; /** * The account ID of a valid identity to serve as this non-employee\'s manager. * @type {string} * @memberof NonEmployeeRecord */ 'manager'?: string; /** * Non-Employee\'s source id. * @type {string} * @memberof NonEmployeeRecord */ 'sourceId'?: string; /** * Additional attributes for a non-employee. Up to 10 custom attributes can be added. * @type {{ [key: string]: string; }} * @memberof NonEmployeeRecord */ 'data'?: { [key: string]: string; }; /** * Non-Employee employment start date. * @type {string} * @memberof NonEmployeeRecord */ 'startDate'?: string; /** * Non-Employee employment end date. * @type {string} * @memberof NonEmployeeRecord */ 'endDate'?: string; /** * When the request was last modified. * @type {string} * @memberof NonEmployeeRecord */ 'modified'?: string; /** * When the request was created. * @type {string} * @memberof NonEmployeeRecord */ 'created'?: string; } /** * * @export * @interface NonEmployeeRejectApprovalDecision */ export interface NonEmployeeRejectApprovalDecision { /** * Comment on the approval item. * @type {string} * @memberof NonEmployeeRejectApprovalDecision */ 'comment': string; } /** * * @export * @interface NonEmployeeRequest */ export interface NonEmployeeRequest { /** * Non-Employee source id. * @type {string} * @memberof NonEmployeeRequest */ 'id'?: string; /** * Source Id associated with this non-employee source. * @type {string} * @memberof NonEmployeeRequest */ 'sourceId'?: string; /** * Source name associated with this non-employee source. * @type {string} * @memberof NonEmployeeRequest */ 'name'?: string; /** * Source description associated with this non-employee source. * @type {string} * @memberof NonEmployeeRequest */ 'description'?: string; /** * Requested identity account name. * @type {string} * @memberof NonEmployeeRequest */ 'accountName'?: string; /** * Non-Employee\'s first name. * @type {string} * @memberof NonEmployeeRequest */ 'firstName'?: string; /** * Non-Employee\'s last name. * @type {string} * @memberof NonEmployeeRequest */ 'lastName'?: string; /** * Non-Employee\'s email. * @type {string} * @memberof NonEmployeeRequest */ 'email'?: string; /** * Non-Employee\'s phone. * @type {string} * @memberof NonEmployeeRequest */ 'phone'?: string; /** * The account ID of a valid identity to serve as this non-employee\'s manager. * @type {string} * @memberof NonEmployeeRequest */ 'manager'?: string; /** * * @type {NonEmployeeSourceLite} * @memberof NonEmployeeRequest */ 'nonEmployeeSource'?: NonEmployeeSourceLite; /** * Additional attributes for a non-employee. Up to 10 custom attributes can be added. * @type {{ [key: string]: string; }} * @memberof NonEmployeeRequest */ 'data'?: { [key: string]: string; }; /** * List of approval item for the request * @type {Array} * @memberof NonEmployeeRequest */ 'approvalItems'?: Array; /** * * @type {ApprovalStatus} * @memberof NonEmployeeRequest */ 'approvalStatus'?: ApprovalStatus; /** * Comment of requester * @type {string} * @memberof NonEmployeeRequest */ 'comment'?: string; /** * When the request was completely approved. * @type {string} * @memberof NonEmployeeRequest */ 'completionDate'?: string; /** * Non-Employee employment start date. * @type {string} * @memberof NonEmployeeRequest */ 'startDate'?: string; /** * Non-Employee employment end date. * @type {string} * @memberof NonEmployeeRequest */ 'endDate'?: string; /** * When the request was last modified. * @type {string} * @memberof NonEmployeeRequest */ 'modified'?: string; /** * When the request was created. * @type {string} * @memberof NonEmployeeRequest */ 'created'?: string; } /** * * @export * @interface NonEmployeeRequestBody */ export interface NonEmployeeRequestBody { /** * Requested identity account name. * @type {string} * @memberof NonEmployeeRequestBody */ 'accountName': string; /** * Non-Employee\'s first name. * @type {string} * @memberof NonEmployeeRequestBody */ 'firstName': string; /** * Non-Employee\'s last name. * @type {string} * @memberof NonEmployeeRequestBody */ 'lastName': string; /** * Non-Employee\'s email. * @type {string} * @memberof NonEmployeeRequestBody */ 'email': string; /** * Non-Employee\'s phone. * @type {string} * @memberof NonEmployeeRequestBody */ 'phone': string; /** * The account ID of a valid identity to serve as this non-employee\'s manager. * @type {string} * @memberof NonEmployeeRequestBody */ 'manager': string; /** * Non-Employee\'s source id. * @type {string} * @memberof NonEmployeeRequestBody */ 'sourceId': string; /** * Additional attributes for a non-employee. Up to 10 custom attributes can be added. * @type {{ [key: string]: string; }} * @memberof NonEmployeeRequestBody */ 'data'?: { [key: string]: string; }; /** * Non-Employee employment start date. * @type {string} * @memberof NonEmployeeRequestBody */ 'startDate': string; /** * Non-Employee employment end date. * @type {string} * @memberof NonEmployeeRequestBody */ 'endDate': string; } /** * * @export * @interface NonEmployeeRequestLite */ export interface NonEmployeeRequestLite { /** * Non-Employee request id. * @type {string} * @memberof NonEmployeeRequestLite */ 'id'?: string; /** * * @type {NonEmployeeIdentityReferenceWithId} * @memberof NonEmployeeRequestLite */ 'requester'?: NonEmployeeIdentityReferenceWithId; } /** * * @export * @interface NonEmployeeRequestSummary */ export interface NonEmployeeRequestSummary { /** * The number of approved non-employee requests on all sources that *requested-for* user manages. * @type {number} * @memberof NonEmployeeRequestSummary */ 'approved'?: number; /** * The number of rejected non-employee requests on all sources that *requested-for* user manages. * @type {number} * @memberof NonEmployeeRequestSummary */ 'rejected'?: number; /** * The number of pending non-employee requests on all sources that *requested-for* user manages. * @type {number} * @memberof NonEmployeeRequestSummary */ 'pending'?: number; /** * The number of non-employee records on all sources that *requested-for* user manages. * @type {number} * @memberof NonEmployeeRequestSummary */ 'nonEmployeeCount'?: number; } /** * * @export * @interface NonEmployeeRequestWithoutApprovalItem */ export interface NonEmployeeRequestWithoutApprovalItem { /** * Non-Employee request id. * @type {string} * @memberof NonEmployeeRequestWithoutApprovalItem */ 'id'?: string; /** * * @type {NonEmployeeIdentityReferenceWithId} * @memberof NonEmployeeRequestWithoutApprovalItem */ 'requester'?: NonEmployeeIdentityReferenceWithId; /** * Requested identity account name. * @type {string} * @memberof NonEmployeeRequestWithoutApprovalItem */ 'accountName'?: string; /** * Non-Employee\'s first name. * @type {string} * @memberof NonEmployeeRequestWithoutApprovalItem */ 'firstName'?: string; /** * Non-Employee\'s last name. * @type {string} * @memberof NonEmployeeRequestWithoutApprovalItem */ 'lastName'?: string; /** * Non-Employee\'s email. * @type {string} * @memberof NonEmployeeRequestWithoutApprovalItem */ 'email'?: string; /** * Non-Employee\'s phone. * @type {string} * @memberof NonEmployeeRequestWithoutApprovalItem */ 'phone'?: string; /** * The account ID of a valid identity to serve as this non-employee\'s manager. * @type {string} * @memberof NonEmployeeRequestWithoutApprovalItem */ 'manager'?: string; /** * * @type {NonEmployeeSourceLiteWithSchemaAttributes} * @memberof NonEmployeeRequestWithoutApprovalItem */ 'nonEmployeeSource'?: NonEmployeeSourceLiteWithSchemaAttributes; /** * Additional attributes for a non-employee. Up to 10 custom attributes can be added. * @type {{ [key: string]: string; }} * @memberof NonEmployeeRequestWithoutApprovalItem */ 'data'?: { [key: string]: string; }; /** * * @type {ApprovalStatus} * @memberof NonEmployeeRequestWithoutApprovalItem */ 'approvalStatus'?: ApprovalStatus; /** * Comment of requester * @type {string} * @memberof NonEmployeeRequestWithoutApprovalItem */ 'comment'?: string; /** * When the request was completely approved. * @type {string} * @memberof NonEmployeeRequestWithoutApprovalItem */ 'completionDate'?: string; /** * Non-Employee employment start date. * @type {string} * @memberof NonEmployeeRequestWithoutApprovalItem */ 'startDate'?: string; /** * Non-Employee employment end date. * @type {string} * @memberof NonEmployeeRequestWithoutApprovalItem */ 'endDate'?: string; /** * When the request was last modified. * @type {string} * @memberof NonEmployeeRequestWithoutApprovalItem */ 'modified'?: string; /** * When the request was created. * @type {string} * @memberof NonEmployeeRequestWithoutApprovalItem */ 'created'?: string; } /** * * @export * @interface NonEmployeeSchemaAttribute */ export interface NonEmployeeSchemaAttribute { /** * Schema Attribute Id * @type {string} * @memberof NonEmployeeSchemaAttribute */ 'id'?: string; /** * True if this schema attribute is mandatory on all non-employees sources. * @type {boolean} * @memberof NonEmployeeSchemaAttribute */ 'system'?: boolean; /** * When the schema attribute was last modified. * @type {string} * @memberof NonEmployeeSchemaAttribute */ 'modified'?: string; /** * When the schema attribute was created. * @type {string} * @memberof NonEmployeeSchemaAttribute */ 'created'?: string; /** * * @type {NonEmployeeSchemaAttributeType} * @memberof NonEmployeeSchemaAttribute */ 'type': NonEmployeeSchemaAttributeType; /** * Label displayed on the UI for this schema attribute. * @type {string} * @memberof NonEmployeeSchemaAttribute */ 'label': string; /** * The technical name of the attribute. Must be unique per source. * @type {string} * @memberof NonEmployeeSchemaAttribute */ 'technicalName': string; /** * help text displayed by UI. * @type {string} * @memberof NonEmployeeSchemaAttribute */ 'helpText'?: string; /** * Hint text that fills UI box. * @type {string} * @memberof NonEmployeeSchemaAttribute */ 'placeholder'?: string; /** * If true, the schema attribute is required for all non-employees in the source * @type {boolean} * @memberof NonEmployeeSchemaAttribute */ 'required'?: boolean; } /** * * @export * @interface NonEmployeeSchemaAttributeBody */ export interface NonEmployeeSchemaAttributeBody { /** * Type of the attribute. Only type \'TEXT\' is supported for custom attributes. * @type {string} * @memberof NonEmployeeSchemaAttributeBody */ 'type': string; /** * Label displayed on the UI for this schema attribute. * @type {string} * @memberof NonEmployeeSchemaAttributeBody */ 'label': string; /** * The technical name of the attribute. Must be unique per source. * @type {string} * @memberof NonEmployeeSchemaAttributeBody */ 'technicalName': string; /** * help text displayed by UI. * @type {string} * @memberof NonEmployeeSchemaAttributeBody */ 'helpText'?: string; /** * Hint text that fills UI box. * @type {string} * @memberof NonEmployeeSchemaAttributeBody */ 'placeholder'?: string; /** * If true, the schema attribute is required for all non-employees in the source * @type {boolean} * @memberof NonEmployeeSchemaAttributeBody */ 'required'?: boolean; } /** * Enum representing the type of data a schema attribute accepts. * @export * @enum {string} */ export const NonEmployeeSchemaAttributeType = { Text: 'TEXT', Date: 'DATE', Identity: 'IDENTITY' } as const; export type NonEmployeeSchemaAttributeType = typeof NonEmployeeSchemaAttributeType[keyof typeof NonEmployeeSchemaAttributeType]; /** * * @export * @interface NonEmployeeSource */ export interface NonEmployeeSource { /** * Non-Employee source id. * @type {string} * @memberof NonEmployeeSource */ 'id'?: string; /** * Source Id associated with this non-employee source. * @type {string} * @memberof NonEmployeeSource */ 'sourceId'?: string; /** * Source name associated with this non-employee source. * @type {string} * @memberof NonEmployeeSource */ 'name'?: string; /** * Source description associated with this non-employee source. * @type {string} * @memberof NonEmployeeSource */ 'description'?: string; /** * List of approvers * @type {Array} * @memberof NonEmployeeSource */ 'approvers'?: Array; /** * List of account managers * @type {Array} * @memberof NonEmployeeSource */ 'accountManagers'?: Array; /** * When the request was last modified. * @type {string} * @memberof NonEmployeeSource */ 'modified'?: string; /** * When the request was created. * @type {string} * @memberof NonEmployeeSource */ 'created'?: string; } /** * * @export * @interface NonEmployeeSourceLite */ export interface NonEmployeeSourceLite { /** * Non-Employee source id. * @type {string} * @memberof NonEmployeeSourceLite */ 'id'?: string; /** * Source Id associated with this non-employee source. * @type {string} * @memberof NonEmployeeSourceLite */ 'sourceId'?: string; /** * Source name associated with this non-employee source. * @type {string} * @memberof NonEmployeeSourceLite */ 'name'?: string; /** * Source description associated with this non-employee source. * @type {string} * @memberof NonEmployeeSourceLite */ 'description'?: string; } /** * * @export * @interface NonEmployeeSourceLiteWithSchemaAttributes */ export interface NonEmployeeSourceLiteWithSchemaAttributes { /** * Non-Employee source id. * @type {string} * @memberof NonEmployeeSourceLiteWithSchemaAttributes */ 'id'?: string; /** * Source Id associated with this non-employee source. * @type {string} * @memberof NonEmployeeSourceLiteWithSchemaAttributes */ 'sourceId'?: string; /** * Source name associated with this non-employee source. * @type {string} * @memberof NonEmployeeSourceLiteWithSchemaAttributes */ 'name'?: string; /** * Source description associated with this non-employee source. * @type {string} * @memberof NonEmployeeSourceLiteWithSchemaAttributes */ 'description'?: string; /** * List of schema attributes associated with this non-employee source. * @type {Array} * @memberof NonEmployeeSourceLiteWithSchemaAttributes */ 'schemaAttributes'?: Array; } /** * * @export * @interface NonEmployeeSourceRequestBody */ export interface NonEmployeeSourceRequestBody { /** * Name of non-employee source. * @type {string} * @memberof NonEmployeeSourceRequestBody */ 'name': string; /** * Description of non-employee source. * @type {string} * @memberof NonEmployeeSourceRequestBody */ 'description': string; /** * * @type {NonEmployeeIdnUserRequest} * @memberof NonEmployeeSourceRequestBody */ 'owner': NonEmployeeIdnUserRequest; /** * The ID for the management workgroup that contains source sub-admins * @type {string} * @memberof NonEmployeeSourceRequestBody */ 'managementWorkgroup'?: string; /** * List of approvers. * @type {Array} * @memberof NonEmployeeSourceRequestBody */ 'approvers'?: Array; /** * List of account managers. * @type {Array} * @memberof NonEmployeeSourceRequestBody */ 'accountManagers'?: Array; } /** * * @export * @interface NonEmployeeSourceWithCloudExternalId */ export interface NonEmployeeSourceWithCloudExternalId { /** * Non-Employee source id. * @type {string} * @memberof NonEmployeeSourceWithCloudExternalId */ 'id'?: string; /** * Source Id associated with this non-employee source. * @type {string} * @memberof NonEmployeeSourceWithCloudExternalId */ 'sourceId'?: string; /** * Source name associated with this non-employee source. * @type {string} * @memberof NonEmployeeSourceWithCloudExternalId */ 'name'?: string; /** * Source description associated with this non-employee source. * @type {string} * @memberof NonEmployeeSourceWithCloudExternalId */ 'description'?: string; /** * List of approvers * @type {Array} * @memberof NonEmployeeSourceWithCloudExternalId */ 'approvers'?: Array; /** * List of account managers * @type {Array} * @memberof NonEmployeeSourceWithCloudExternalId */ 'accountManagers'?: Array; /** * When the request was last modified. * @type {string} * @memberof NonEmployeeSourceWithCloudExternalId */ 'modified'?: string; /** * When the request was created. * @type {string} * @memberof NonEmployeeSourceWithCloudExternalId */ 'created'?: string; /** * Legacy ID used for sources from the V1 API. This attribute will be removed from a future version of the API and will not be considered a breaking change. No clients should rely on this ID always being present. * @type {string} * @memberof NonEmployeeSourceWithCloudExternalId */ 'cloudExternalId'?: string; } /** * * @export * @interface NonEmployeeSourceWithNECount */ export interface NonEmployeeSourceWithNECount { /** * Non-Employee source id. * @type {string} * @memberof NonEmployeeSourceWithNECount */ 'id'?: string; /** * Source Id associated with this non-employee source. * @type {string} * @memberof NonEmployeeSourceWithNECount */ 'sourceId'?: string; /** * Source name associated with this non-employee source. * @type {string} * @memberof NonEmployeeSourceWithNECount */ 'name'?: string; /** * Source description associated with this non-employee source. * @type {string} * @memberof NonEmployeeSourceWithNECount */ 'description'?: string; /** * List of approvers * @type {Array} * @memberof NonEmployeeSourceWithNECount */ 'approvers'?: Array; /** * List of account managers * @type {Array} * @memberof NonEmployeeSourceWithNECount */ 'accountManagers'?: Array; /** * When the request was last modified. * @type {string} * @memberof NonEmployeeSourceWithNECount */ 'modified'?: string; /** * When the request was created. * @type {string} * @memberof NonEmployeeSourceWithNECount */ 'created'?: string; /** * Number of non-employee records associated with this source. This value is \'NULL\' by default. To get the non-employee count, you must set the `non-employee-count` flag in your request to \'true\'. * @type {number} * @memberof NonEmployeeSourceWithNECount */ 'nonEmployeeCount'?: number | null; } /** * NonEmployeeLifecycleManagementApi - axios parameter creator * @export */ export const NonEmployeeLifecycleManagementApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. * @summary Approve a non-employee request * @param {string} id Non-Employee approval item id (UUID) * @param {NonEmployeeApprovalDecision} nonEmployeeApprovalDecision * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ approveNonEmployeeRequestV1: async (id: string, nonEmployeeApprovalDecision: NonEmployeeApprovalDecision, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('approveNonEmployeeRequestV1', 'id', id) // verify required parameter 'nonEmployeeApprovalDecision' is not null or undefined assertParamExists('approveNonEmployeeRequestV1', 'nonEmployeeApprovalDecision', nonEmployeeApprovalDecision) const localVarPath = `/non-employee-approvals/v1/{id}/approve` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeApprovalDecision, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This request will create a non-employee record. Requires role context of `idn:nesr:create` * @summary Create non-employee record * @param {NonEmployeeRequestBody} nonEmployeeRequestBody Non-Employee record creation request body. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createNonEmployeeRecordV1: async (nonEmployeeRequestBody: NonEmployeeRequestBody, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'nonEmployeeRequestBody' is not null or undefined assertParamExists('createNonEmployeeRecordV1', 'nonEmployeeRequestBody', nonEmployeeRequestBody) const localVarPath = `/non-employee-records/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeRequestBody, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. * @summary Create non-employee request * @param {NonEmployeeRequestBody} nonEmployeeRequestBody Non-Employee creation request body * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createNonEmployeeRequestV1: async (nonEmployeeRequestBody: NonEmployeeRequestBody, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'nonEmployeeRequestBody' is not null or undefined assertParamExists('createNonEmployeeRequestV1', 'nonEmployeeRequestBody', nonEmployeeRequestBody) const localVarPath = `/non-employee-requests/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeRequestBody, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a \"400.1.409 Reference conflict\" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a \"400.1.4 Limit violation\" response. Requires role context of `idn:nesr:create` * @summary Create a new schema attribute for non-employee source * @param {string} sourceId The Source id * @param {NonEmployeeSchemaAttributeBody} nonEmployeeSchemaAttributeBody * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createNonEmployeeSourceSchemaAttributesV1: async (sourceId: string, nonEmployeeSchemaAttributeBody: NonEmployeeSchemaAttributeBody, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'sourceId' is not null or undefined assertParamExists('createNonEmployeeSourceSchemaAttributesV1', 'sourceId', sourceId) // verify required parameter 'nonEmployeeSchemaAttributeBody' is not null or undefined assertParamExists('createNonEmployeeSourceSchemaAttributesV1', 'nonEmployeeSchemaAttributeBody', nonEmployeeSchemaAttributeBody) const localVarPath = `/non-employee-sources/v1/{sourceId}/schema-attributes` .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeSchemaAttributeBody, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Create a non-employee source. * @summary Create non-employee source * @param {NonEmployeeSourceRequestBody} nonEmployeeSourceRequestBody Non-Employee source creation request body. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createNonEmployeeSourceV1: async (nonEmployeeSourceRequestBody: NonEmployeeSourceRequestBody, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'nonEmployeeSourceRequestBody' is not null or undefined assertParamExists('createNonEmployeeSourceV1', 'nonEmployeeSourceRequestBody', nonEmployeeSourceRequestBody) const localVarPath = `/non-employee-sources/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeSourceRequestBody, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This request will delete a non-employee record. Requires role context of `idn:nesr:delete` * @summary Delete non-employee record * @param {string} id Non-Employee record id (UUID) * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteNonEmployeeRecordV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('deleteNonEmployeeRecordV1', 'id', id) const localVarPath = `/non-employee-records/v1/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` * @summary Delete multiple non-employee records * @param {DeleteNonEmployeeRecordsInBulkV1Request} deleteNonEmployeeRecordsInBulkV1Request Non-Employee bulk delete request body. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteNonEmployeeRecordsInBulkV1: async (deleteNonEmployeeRecordsInBulkV1Request: DeleteNonEmployeeRecordsInBulkV1Request, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'deleteNonEmployeeRecordsInBulkV1Request' is not null or undefined assertParamExists('deleteNonEmployeeRecordsInBulkV1', 'deleteNonEmployeeRecordsInBulkV1Request', deleteNonEmployeeRecordsInBulkV1Request) const localVarPath = `/non-employee-records/v1/bulk-delete`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(deleteNonEmployeeRecordsInBulkV1Request, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This request will delete a non-employee request. Requires role context of `idn:nesr:delete` * @summary Delete non-employee request * @param {string} id Non-Employee request id in the UUID format * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteNonEmployeeRequestV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('deleteNonEmployeeRequestV1', 'id', id) const localVarPath = `/non-employee-requests/v1/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This end-point deletes a specific schema attribute for a non-employee source. Requires role context of `idn:nesr:delete` * @summary Delete a schema attribute for non-employee source * @param {string} attributeId The Schema Attribute Id (UUID) * @param {string} sourceId The Source id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteNonEmployeeSchemaAttributeV1: async (attributeId: string, sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'attributeId' is not null or undefined assertParamExists('deleteNonEmployeeSchemaAttributeV1', 'attributeId', attributeId) // verify required parameter 'sourceId' is not null or undefined assertParamExists('deleteNonEmployeeSchemaAttributeV1', 'sourceId', sourceId) const localVarPath = `/non-employee-sources/v1/{sourceId}/schema-attributes/{attributeId}` .replace(`{${"attributeId"}}`, encodeURIComponent(String(attributeId))) .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` * @summary Delete all custom schema attributes for non-employee source * @param {string} sourceId The Source id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteNonEmployeeSourceSchemaAttributesV1: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'sourceId' is not null or undefined assertParamExists('deleteNonEmployeeSourceSchemaAttributesV1', 'sourceId', sourceId) const localVarPath = `/non-employee-sources/v1/{sourceId}/schema-attributes` .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. * @summary Delete non-employee source * @param {string} sourceId Source Id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteNonEmployeeSourceV1: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'sourceId' is not null or undefined assertParamExists('deleteNonEmployeeSourceV1', 'sourceId', sourceId) const localVarPath = `/non-employee-sources/v1/{sourceId}` .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` * @summary Exports non-employee records to csv * @param {string} id Source Id (UUID) * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ exportNonEmployeeRecordsV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('exportNonEmployeeRecordsV1', 'id', id) const localVarPath = `/non-employee-sources/v1/{id}/non-employees/download` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` * @summary Exports source schema template * @param {string} id Source Id (UUID) * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ exportNonEmployeeSourceSchemaTemplateV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('exportNonEmployeeSourceSchemaTemplateV1', 'id', id) const localVarPath = `/non-employee-sources/v1/{id}/schema-attributes-template/download` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver\'s id. 2. The current user is an approver, in which case \"me\" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. * @summary Get summary of non-employee approval requests * @param {string} requestedFor The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getNonEmployeeApprovalSummaryV1: async (requestedFor: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'requestedFor' is not null or undefined assertParamExists('getNonEmployeeApprovalSummaryV1', 'requestedFor', requestedFor) const localVarPath = `/non-employee-approvals/v1/summary/{requested-for}` .replace(`{${"requested-for"}}`, encodeURIComponent(String(requestedFor))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Gets a non-employee approval item detail. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get any approval. 2. The user owns the requested approval. * @summary Get a non-employee approval item detail * @param {string} id Non-Employee approval item id (UUID) * @param {boolean} [includeDetail] The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getNonEmployeeApprovalV1: async (id: string, includeDetail?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getNonEmployeeApprovalV1', 'id', id) const localVarPath = `/non-employee-approvals/v1/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (includeDetail !== undefined) { localVarQueryParameter['include-detail'] = includeDetail; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. Requires role context of `idn:nesr:read` * @summary Obtain the status of bulk upload on the source * @param {string} id Source ID (UUID) * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getNonEmployeeBulkUploadStatusV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getNonEmployeeBulkUploadStatusV1', 'id', id) const localVarPath = `/non-employee-sources/v1/{id}/non-employee-bulk-upload/status` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This gets a non-employee record. Requires role context of `idn:nesr:read` * @summary Get a non-employee record * @param {string} id Non-Employee record id (UUID) * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getNonEmployeeRecordV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getNonEmployeeRecordV1', 'id', id) const localVarPath = `/non-employee-records/v1/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. * @summary Get summary of non-employee requests * @param {string} requestedFor The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getNonEmployeeRequestSummaryV1: async (requestedFor: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'requestedFor' is not null or undefined assertParamExists('getNonEmployeeRequestSummaryV1', 'requestedFor', requestedFor) const localVarPath = `/non-employee-requests/v1/summary/{requested-for}` .replace(`{${"requested-for"}}`, encodeURIComponent(String(requestedFor))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This gets a non-employee request. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in this case the user can get the non-employee request for any user. 2. The user must be the owner of the non-employee request. * @summary Get a non-employee request * @param {string} id Non-Employee request id (UUID) * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getNonEmployeeRequestV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getNonEmployeeRequestV1', 'id', id) const localVarPath = `/non-employee-requests/v1/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. * @summary Get schema attribute non-employee source * @param {string} attributeId The Schema Attribute Id (UUID) * @param {string} sourceId The Source id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getNonEmployeeSchemaAttributeV1: async (attributeId: string, sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'attributeId' is not null or undefined assertParamExists('getNonEmployeeSchemaAttributeV1', 'attributeId', attributeId) // verify required parameter 'sourceId' is not null or undefined assertParamExists('getNonEmployeeSchemaAttributeV1', 'sourceId', sourceId) const localVarPath = `/non-employee-sources/v1/{sourceId}/schema-attributes/{attributeId}` .replace(`{${"attributeId"}}`, encodeURIComponent(String(attributeId))) .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. * @summary List schema attributes non-employee source * @param {string} sourceId The Source id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getNonEmployeeSourceSchemaAttributesV1: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'sourceId' is not null or undefined assertParamExists('getNonEmployeeSourceSchemaAttributesV1', 'sourceId', sourceId) const localVarPath = `/non-employee-sources/v1/{sourceId}/schema-attributes` .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This gets a non-employee source. There are two contextual uses for the requested-for path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request any source. 2. The current user is an account manager, in which case the user can only request sources that they own. * @summary Get a non-employee source * @param {string} sourceId Source Id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getNonEmployeeSourceV1: async (sourceId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'sourceId' is not null or undefined assertParamExists('getNonEmployeeSourceV1', 'sourceId', sourceId) const localVarPath = `/non-employee-sources/v1/{sourceId}` .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` * @summary Imports, or updates, non-employee records * @param {string} id Source Id (UUID) * @param {File} data * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ importNonEmployeeRecordsInBulkV1: async (id: string, data: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('importNonEmployeeRecordsInBulkV1', 'id', id) // verify required parameter 'data' is not null or undefined assertParamExists('importNonEmployeeRecordsInBulkV1', 'data', data) const localVarPath = `/non-employee-sources/v1/{id}/non-employee-bulk-upload` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); if (data !== undefined) { localVarFormParams.append('data', data as any); } localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = localVarFormParams; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This gets a list of non-employee approval requests. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can list the approvals for any approver. 2. The user owns the requested approval. * @summary Get list of non-employee approval requests * @param {string} [requestedFor] The identity for whom the request was made. *me* indicates the current user. * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listNonEmployeeApprovalsV1: async (requestedFor?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/non-employee-approvals/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (requestedFor !== undefined) { localVarQueryParameter['requested-for'] = requestedFor; } if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } if (count !== undefined) { localVarQueryParameter['count'] = count; } if (filters !== undefined) { localVarQueryParameter['filters'] = filters; } if (sorters !== undefined) { localVarQueryParameter['sorters'] = sorters; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This gets a list of non-employee records. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. * @summary List non-employee records * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listNonEmployeeRecordsV1: async (limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/non-employee-records/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } if (count !== undefined) { localVarQueryParameter['count'] = count; } if (sorters !== undefined) { localVarQueryParameter['sorters'] = sorters; } if (filters !== undefined) { localVarQueryParameter['filters'] = filters; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a list non-employee requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages. * @summary List non-employee requests * @param {string} requestedFor The identity for whom the request was made. *me* indicates the current user. * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listNonEmployeeRequestsV1: async (requestedFor: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'requestedFor' is not null or undefined assertParamExists('listNonEmployeeRequestsV1', 'requestedFor', requestedFor) const localVarPath = `/non-employee-requests/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } if (count !== undefined) { localVarQueryParameter['count'] = count; } if (requestedFor !== undefined) { localVarQueryParameter['requested-for'] = requestedFor; } if (sorters !== undefined) { localVarQueryParameter['sorters'] = sorters; } if (filters !== undefined) { localVarQueryParameter['filters'] = filters; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager\'s `id`. 2. If the current user is an account manager, the user should provide \'me\' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. * @summary List non-employee sources * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [requestedFor] Identity the request was made for. Use \'me\' to indicate the current user. * @param {boolean} [nonEmployeeCount] Flag that determines whether the API will return a non-employee count associated with the source. * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listNonEmployeeSourcesV1: async (limit?: number, offset?: number, count?: boolean, requestedFor?: string, nonEmployeeCount?: boolean, sorters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/non-employee-sources/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (offset !== undefined) { localVarQueryParameter['offset'] = offset; } if (count !== undefined) { localVarQueryParameter['count'] = count; } if (requestedFor !== undefined) { localVarQueryParameter['requested-for'] = requestedFor; } if (nonEmployeeCount !== undefined) { localVarQueryParameter['non-employee-count'] = nonEmployeeCount; } if (sorters !== undefined) { localVarQueryParameter['sorters'] = sorters; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This request will patch a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. * @summary Patch non-employee record * @param {string} id Non-employee record id (UUID) * @param {Array} jsonPatchOperation A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchNonEmployeeRecordV1: async (id: string, jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('patchNonEmployeeRecordV1', 'id', id) // verify required parameter 'jsonPatchOperation' is not null or undefined assertParamExists('patchNonEmployeeRecordV1', 'jsonPatchOperation', jsonPatchOperation) const localVarPath = `/non-employee-records/v1/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperation, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This end-point patches a specific schema attribute for a non-employee SourceId. Requires role context of `idn:nesr:update` * @summary Patch a schema attribute for non-employee source * @param {string} attributeId The Schema Attribute Id (UUID) * @param {string} sourceId The Source id * @param {Array} jsonPatchOperation A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update \':\' \'label\', \'helpText\', \'placeholder\', \'required\'. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchNonEmployeeSchemaAttributeV1: async (attributeId: string, sourceId: string, jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'attributeId' is not null or undefined assertParamExists('patchNonEmployeeSchemaAttributeV1', 'attributeId', attributeId) // verify required parameter 'sourceId' is not null or undefined assertParamExists('patchNonEmployeeSchemaAttributeV1', 'sourceId', sourceId) // verify required parameter 'jsonPatchOperation' is not null or undefined assertParamExists('patchNonEmployeeSchemaAttributeV1', 'jsonPatchOperation', jsonPatchOperation) const localVarPath = `/non-employee-sources/v1/{sourceId}/schema-attributes/{attributeId}` .replace(`{${"attributeId"}}`, encodeURIComponent(String(attributeId))) .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperation, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. * @summary Patch a non-employee source * @param {string} sourceId Source Id * @param {Array} jsonPatchOperation A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchNonEmployeeSourceV1: async (sourceId: string, jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'sourceId' is not null or undefined assertParamExists('patchNonEmployeeSourceV1', 'sourceId', sourceId) // verify required parameter 'jsonPatchOperation' is not null or undefined assertParamExists('patchNonEmployeeSourceV1', 'jsonPatchOperation', jsonPatchOperation) const localVarPath = `/non-employee-sources/v1/{sourceId}` .replace(`{${"sourceId"}}`, encodeURIComponent(String(sourceId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperation, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This endpoint will reject an approval item request and notify user. The current user must be the requested approver. * @summary Reject a non-employee request * @param {string} id Non-Employee approval item id (UUID) * @param {NonEmployeeRejectApprovalDecision} nonEmployeeRejectApprovalDecision * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ rejectNonEmployeeRequestV1: async (id: string, nonEmployeeRejectApprovalDecision: NonEmployeeRejectApprovalDecision, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('rejectNonEmployeeRequestV1', 'id', id) // verify required parameter 'nonEmployeeRejectApprovalDecision' is not null or undefined assertParamExists('rejectNonEmployeeRequestV1', 'nonEmployeeRejectApprovalDecision', nonEmployeeRejectApprovalDecision) const localVarPath = `/non-employee-approvals/v1/{id}/reject` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeRejectApprovalDecision, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This request will update a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. * @summary Update non-employee record * @param {string} id Non-employee record id (UUID) * @param {NonEmployeeRequestBody} nonEmployeeRequestBody Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateNonEmployeeRecordV1: async (id: string, nonEmployeeRequestBody: NonEmployeeRequestBody, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('updateNonEmployeeRecordV1', 'id', id) // verify required parameter 'nonEmployeeRequestBody' is not null or undefined assertParamExists('updateNonEmployeeRecordV1', 'nonEmployeeRequestBody', nonEmployeeRequestBody) const localVarPath = `/non-employee-records/v1/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(nonEmployeeRequestBody, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, } }; /** * NonEmployeeLifecycleManagementApi - functional programming interface * @export */ export const NonEmployeeLifecycleManagementApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = NonEmployeeLifecycleManagementApiAxiosParamCreator(configuration) return { /** * Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. * @summary Approve a non-employee request * @param {string} id Non-Employee approval item id (UUID) * @param {NonEmployeeApprovalDecision} nonEmployeeApprovalDecision * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async approveNonEmployeeRequestV1(id: string, nonEmployeeApprovalDecision: NonEmployeeApprovalDecision, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.approveNonEmployeeRequestV1(id, nonEmployeeApprovalDecision, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.approveNonEmployeeRequestV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This request will create a non-employee record. Requires role context of `idn:nesr:create` * @summary Create non-employee record * @param {NonEmployeeRequestBody} nonEmployeeRequestBody Non-Employee record creation request body. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async createNonEmployeeRecordV1(nonEmployeeRequestBody: NonEmployeeRequestBody, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.createNonEmployeeRecordV1(nonEmployeeRequestBody, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.createNonEmployeeRecordV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. * @summary Create non-employee request * @param {NonEmployeeRequestBody} nonEmployeeRequestBody Non-Employee creation request body * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async createNonEmployeeRequestV1(nonEmployeeRequestBody: NonEmployeeRequestBody, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.createNonEmployeeRequestV1(nonEmployeeRequestBody, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.createNonEmployeeRequestV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a \"400.1.409 Reference conflict\" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a \"400.1.4 Limit violation\" response. Requires role context of `idn:nesr:create` * @summary Create a new schema attribute for non-employee source * @param {string} sourceId The Source id * @param {NonEmployeeSchemaAttributeBody} nonEmployeeSchemaAttributeBody * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async createNonEmployeeSourceSchemaAttributesV1(sourceId: string, nonEmployeeSchemaAttributeBody: NonEmployeeSchemaAttributeBody, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.createNonEmployeeSourceSchemaAttributesV1(sourceId, nonEmployeeSchemaAttributeBody, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.createNonEmployeeSourceSchemaAttributesV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Create a non-employee source. * @summary Create non-employee source * @param {NonEmployeeSourceRequestBody} nonEmployeeSourceRequestBody Non-Employee source creation request body. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async createNonEmployeeSourceV1(nonEmployeeSourceRequestBody: NonEmployeeSourceRequestBody, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.createNonEmployeeSourceV1(nonEmployeeSourceRequestBody, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.createNonEmployeeSourceV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This request will delete a non-employee record. Requires role context of `idn:nesr:delete` * @summary Delete non-employee record * @param {string} id Non-Employee record id (UUID) * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async deleteNonEmployeeRecordV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeRecordV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.deleteNonEmployeeRecordV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` * @summary Delete multiple non-employee records * @param {DeleteNonEmployeeRecordsInBulkV1Request} deleteNonEmployeeRecordsInBulkV1Request Non-Employee bulk delete request body. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async deleteNonEmployeeRecordsInBulkV1(deleteNonEmployeeRecordsInBulkV1Request: DeleteNonEmployeeRecordsInBulkV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeRecordsInBulkV1(deleteNonEmployeeRecordsInBulkV1Request, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.deleteNonEmployeeRecordsInBulkV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This request will delete a non-employee request. Requires role context of `idn:nesr:delete` * @summary Delete non-employee request * @param {string} id Non-Employee request id in the UUID format * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async deleteNonEmployeeRequestV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeRequestV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.deleteNonEmployeeRequestV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This end-point deletes a specific schema attribute for a non-employee source. Requires role context of `idn:nesr:delete` * @summary Delete a schema attribute for non-employee source * @param {string} attributeId The Schema Attribute Id (UUID) * @param {string} sourceId The Source id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async deleteNonEmployeeSchemaAttributeV1(attributeId: string, sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeSchemaAttributeV1(attributeId, sourceId, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.deleteNonEmployeeSchemaAttributeV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` * @summary Delete all custom schema attributes for non-employee source * @param {string} sourceId The Source id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async deleteNonEmployeeSourceSchemaAttributesV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeSourceSchemaAttributesV1(sourceId, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.deleteNonEmployeeSourceSchemaAttributesV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. * @summary Delete non-employee source * @param {string} sourceId Source Id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async deleteNonEmployeeSourceV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNonEmployeeSourceV1(sourceId, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.deleteNonEmployeeSourceV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` * @summary Exports non-employee records to csv * @param {string} id Source Id (UUID) * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async exportNonEmployeeRecordsV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.exportNonEmployeeRecordsV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.exportNonEmployeeRecordsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` * @summary Exports source schema template * @param {string} id Source Id (UUID) * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async exportNonEmployeeSourceSchemaTemplateV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.exportNonEmployeeSourceSchemaTemplateV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.exportNonEmployeeSourceSchemaTemplateV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver\'s id. 2. The current user is an approver, in which case \"me\" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. * @summary Get summary of non-employee approval requests * @param {string} requestedFor The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getNonEmployeeApprovalSummaryV1(requestedFor: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeApprovalSummaryV1(requestedFor, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.getNonEmployeeApprovalSummaryV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Gets a non-employee approval item detail. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get any approval. 2. The user owns the requested approval. * @summary Get a non-employee approval item detail * @param {string} id Non-Employee approval item id (UUID) * @param {boolean} [includeDetail] The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getNonEmployeeApprovalV1(id: string, includeDetail?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeApprovalV1(id, includeDetail, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.getNonEmployeeApprovalV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. Requires role context of `idn:nesr:read` * @summary Obtain the status of bulk upload on the source * @param {string} id Source ID (UUID) * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getNonEmployeeBulkUploadStatusV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeBulkUploadStatusV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.getNonEmployeeBulkUploadStatusV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This gets a non-employee record. Requires role context of `idn:nesr:read` * @summary Get a non-employee record * @param {string} id Non-Employee record id (UUID) * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getNonEmployeeRecordV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeRecordV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.getNonEmployeeRecordV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. * @summary Get summary of non-employee requests * @param {string} requestedFor The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getNonEmployeeRequestSummaryV1(requestedFor: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeRequestSummaryV1(requestedFor, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.getNonEmployeeRequestSummaryV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This gets a non-employee request. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in this case the user can get the non-employee request for any user. 2. The user must be the owner of the non-employee request. * @summary Get a non-employee request * @param {string} id Non-Employee request id (UUID) * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getNonEmployeeRequestV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeRequestV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.getNonEmployeeRequestV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. * @summary Get schema attribute non-employee source * @param {string} attributeId The Schema Attribute Id (UUID) * @param {string} sourceId The Source id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getNonEmployeeSchemaAttributeV1(attributeId: string, sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeSchemaAttributeV1(attributeId, sourceId, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.getNonEmployeeSchemaAttributeV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. * @summary List schema attributes non-employee source * @param {string} sourceId The Source id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getNonEmployeeSourceSchemaAttributesV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeSourceSchemaAttributesV1(sourceId, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.getNonEmployeeSourceSchemaAttributesV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This gets a non-employee source. There are two contextual uses for the requested-for path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request any source. 2. The current user is an account manager, in which case the user can only request sources that they own. * @summary Get a non-employee source * @param {string} sourceId Source Id * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getNonEmployeeSourceV1(sourceId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getNonEmployeeSourceV1(sourceId, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.getNonEmployeeSourceV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` * @summary Imports, or updates, non-employee records * @param {string} id Source Id (UUID) * @param {File} data * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async importNonEmployeeRecordsInBulkV1(id: string, data: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.importNonEmployeeRecordsInBulkV1(id, data, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.importNonEmployeeRecordsInBulkV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This gets a list of non-employee approval requests. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can list the approvals for any approver. 2. The user owns the requested approval. * @summary Get list of non-employee approval requests * @param {string} [requestedFor] The identity for whom the request was made. *me* indicates the current user. * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listNonEmployeeApprovalsV1(requestedFor?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listNonEmployeeApprovalsV1(requestedFor, limit, offset, count, filters, sorters, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.listNonEmployeeApprovalsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This gets a list of non-employee records. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. * @summary List non-employee records * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listNonEmployeeRecordsV1(limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listNonEmployeeRecordsV1(limit, offset, count, sorters, filters, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.listNonEmployeeRecordsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a list non-employee requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages. * @summary List non-employee requests * @param {string} requestedFor The identity for whom the request was made. *me* indicates the current user. * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listNonEmployeeRequestsV1(requestedFor: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listNonEmployeeRequestsV1(requestedFor, limit, offset, count, sorters, filters, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.listNonEmployeeRequestsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager\'s `id`. 2. If the current user is an account manager, the user should provide \'me\' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. * @summary List non-employee sources * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {string} [requestedFor] Identity the request was made for. Use \'me\' to indicate the current user. * @param {boolean} [nonEmployeeCount] Flag that determines whether the API will return a non-employee count associated with the source. * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listNonEmployeeSourcesV1(limit?: number, offset?: number, count?: boolean, requestedFor?: string, nonEmployeeCount?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listNonEmployeeSourcesV1(limit, offset, count, requestedFor, nonEmployeeCount, sorters, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.listNonEmployeeSourcesV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This request will patch a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. * @summary Patch non-employee record * @param {string} id Non-employee record id (UUID) * @param {Array} jsonPatchOperation A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async patchNonEmployeeRecordV1(id: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.patchNonEmployeeRecordV1(id, jsonPatchOperation, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.patchNonEmployeeRecordV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This end-point patches a specific schema attribute for a non-employee SourceId. Requires role context of `idn:nesr:update` * @summary Patch a schema attribute for non-employee source * @param {string} attributeId The Schema Attribute Id (UUID) * @param {string} sourceId The Source id * @param {Array} jsonPatchOperation A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update \':\' \'label\', \'helpText\', \'placeholder\', \'required\'. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async patchNonEmployeeSchemaAttributeV1(attributeId: string, sourceId: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.patchNonEmployeeSchemaAttributeV1(attributeId, sourceId, jsonPatchOperation, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.patchNonEmployeeSchemaAttributeV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. * @summary Patch a non-employee source * @param {string} sourceId Source Id * @param {Array} jsonPatchOperation A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async patchNonEmployeeSourceV1(sourceId: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.patchNonEmployeeSourceV1(sourceId, jsonPatchOperation, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.patchNonEmployeeSourceV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This endpoint will reject an approval item request and notify user. The current user must be the requested approver. * @summary Reject a non-employee request * @param {string} id Non-Employee approval item id (UUID) * @param {NonEmployeeRejectApprovalDecision} nonEmployeeRejectApprovalDecision * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async rejectNonEmployeeRequestV1(id: string, nonEmployeeRejectApprovalDecision: NonEmployeeRejectApprovalDecision, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.rejectNonEmployeeRequestV1(id, nonEmployeeRejectApprovalDecision, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.rejectNonEmployeeRequestV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This request will update a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. * @summary Update non-employee record * @param {string} id Non-employee record id (UUID) * @param {NonEmployeeRequestBody} nonEmployeeRequestBody Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async updateNonEmployeeRecordV1(id: string, nonEmployeeRequestBody: NonEmployeeRequestBody, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.updateNonEmployeeRecordV1(id, nonEmployeeRequestBody, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NonEmployeeLifecycleManagementApi.updateNonEmployeeRecordV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, } }; /** * NonEmployeeLifecycleManagementApi - factory interface * @export */ export const NonEmployeeLifecycleManagementApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = NonEmployeeLifecycleManagementApiFp(configuration) return { /** * Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. * @summary Approve a non-employee request * @param {NonEmployeeLifecycleManagementApiApproveNonEmployeeRequestV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ approveNonEmployeeRequestV1(requestParameters: NonEmployeeLifecycleManagementApiApproveNonEmployeeRequestV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.approveNonEmployeeRequestV1(requestParameters.id, requestParameters.nonEmployeeApprovalDecision, axiosOptions).then((request) => request(axios, basePath)); }, /** * This request will create a non-employee record. Requires role context of `idn:nesr:create` * @summary Create non-employee record * @param {NonEmployeeLifecycleManagementApiCreateNonEmployeeRecordV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createNonEmployeeRecordV1(requestParameters: NonEmployeeLifecycleManagementApiCreateNonEmployeeRecordV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.createNonEmployeeRecordV1(requestParameters.nonEmployeeRequestBody, axiosOptions).then((request) => request(axios, basePath)); }, /** * This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. * @summary Create non-employee request * @param {NonEmployeeLifecycleManagementApiCreateNonEmployeeRequestV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createNonEmployeeRequestV1(requestParameters: NonEmployeeLifecycleManagementApiCreateNonEmployeeRequestV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.createNonEmployeeRequestV1(requestParameters.nonEmployeeRequestBody, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a \"400.1.409 Reference conflict\" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a \"400.1.4 Limit violation\" response. Requires role context of `idn:nesr:create` * @summary Create a new schema attribute for non-employee source * @param {NonEmployeeLifecycleManagementApiCreateNonEmployeeSourceSchemaAttributesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createNonEmployeeSourceSchemaAttributesV1(requestParameters: NonEmployeeLifecycleManagementApiCreateNonEmployeeSourceSchemaAttributesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.createNonEmployeeSourceSchemaAttributesV1(requestParameters.sourceId, requestParameters.nonEmployeeSchemaAttributeBody, axiosOptions).then((request) => request(axios, basePath)); }, /** * Create a non-employee source. * @summary Create non-employee source * @param {NonEmployeeLifecycleManagementApiCreateNonEmployeeSourceV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createNonEmployeeSourceV1(requestParameters: NonEmployeeLifecycleManagementApiCreateNonEmployeeSourceV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.createNonEmployeeSourceV1(requestParameters.nonEmployeeSourceRequestBody, axiosOptions).then((request) => request(axios, basePath)); }, /** * This request will delete a non-employee record. Requires role context of `idn:nesr:delete` * @summary Delete non-employee record * @param {NonEmployeeLifecycleManagementApiDeleteNonEmployeeRecordV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteNonEmployeeRecordV1(requestParameters: NonEmployeeLifecycleManagementApiDeleteNonEmployeeRecordV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.deleteNonEmployeeRecordV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` * @summary Delete multiple non-employee records * @param {NonEmployeeLifecycleManagementApiDeleteNonEmployeeRecordsInBulkV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteNonEmployeeRecordsInBulkV1(requestParameters: NonEmployeeLifecycleManagementApiDeleteNonEmployeeRecordsInBulkV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.deleteNonEmployeeRecordsInBulkV1(requestParameters.deleteNonEmployeeRecordsInBulkV1Request, axiosOptions).then((request) => request(axios, basePath)); }, /** * This request will delete a non-employee request. Requires role context of `idn:nesr:delete` * @summary Delete non-employee request * @param {NonEmployeeLifecycleManagementApiDeleteNonEmployeeRequestV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteNonEmployeeRequestV1(requestParameters: NonEmployeeLifecycleManagementApiDeleteNonEmployeeRequestV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.deleteNonEmployeeRequestV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * This end-point deletes a specific schema attribute for a non-employee source. Requires role context of `idn:nesr:delete` * @summary Delete a schema attribute for non-employee source * @param {NonEmployeeLifecycleManagementApiDeleteNonEmployeeSchemaAttributeV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteNonEmployeeSchemaAttributeV1(requestParameters: NonEmployeeLifecycleManagementApiDeleteNonEmployeeSchemaAttributeV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.deleteNonEmployeeSchemaAttributeV1(requestParameters.attributeId, requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); }, /** * This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` * @summary Delete all custom schema attributes for non-employee source * @param {NonEmployeeLifecycleManagementApiDeleteNonEmployeeSourceSchemaAttributesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteNonEmployeeSourceSchemaAttributesV1(requestParameters: NonEmployeeLifecycleManagementApiDeleteNonEmployeeSourceSchemaAttributesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.deleteNonEmployeeSourceSchemaAttributesV1(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); }, /** * This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. * @summary Delete non-employee source * @param {NonEmployeeLifecycleManagementApiDeleteNonEmployeeSourceV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteNonEmployeeSourceV1(requestParameters: NonEmployeeLifecycleManagementApiDeleteNonEmployeeSourceV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.deleteNonEmployeeSourceV1(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); }, /** * This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` * @summary Exports non-employee records to csv * @param {NonEmployeeLifecycleManagementApiExportNonEmployeeRecordsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ exportNonEmployeeRecordsV1(requestParameters: NonEmployeeLifecycleManagementApiExportNonEmployeeRecordsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.exportNonEmployeeRecordsV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` * @summary Exports source schema template * @param {NonEmployeeLifecycleManagementApiExportNonEmployeeSourceSchemaTemplateV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ exportNonEmployeeSourceSchemaTemplateV1(requestParameters: NonEmployeeLifecycleManagementApiExportNonEmployeeSourceSchemaTemplateV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.exportNonEmployeeSourceSchemaTemplateV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver\'s id. 2. The current user is an approver, in which case \"me\" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. * @summary Get summary of non-employee approval requests * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeApprovalSummaryV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getNonEmployeeApprovalSummaryV1(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeApprovalSummaryV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getNonEmployeeApprovalSummaryV1(requestParameters.requestedFor, axiosOptions).then((request) => request(axios, basePath)); }, /** * Gets a non-employee approval item detail. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get any approval. 2. The user owns the requested approval. * @summary Get a non-employee approval item detail * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeApprovalV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getNonEmployeeApprovalV1(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeApprovalV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getNonEmployeeApprovalV1(requestParameters.id, requestParameters.includeDetail, axiosOptions).then((request) => request(axios, basePath)); }, /** * The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. Requires role context of `idn:nesr:read` * @summary Obtain the status of bulk upload on the source * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeBulkUploadStatusV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getNonEmployeeBulkUploadStatusV1(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeBulkUploadStatusV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getNonEmployeeBulkUploadStatusV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * This gets a non-employee record. Requires role context of `idn:nesr:read` * @summary Get a non-employee record * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeRecordV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getNonEmployeeRecordV1(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeRecordV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getNonEmployeeRecordV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. * @summary Get summary of non-employee requests * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeRequestSummaryV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getNonEmployeeRequestSummaryV1(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeRequestSummaryV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getNonEmployeeRequestSummaryV1(requestParameters.requestedFor, axiosOptions).then((request) => request(axios, basePath)); }, /** * This gets a non-employee request. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in this case the user can get the non-employee request for any user. 2. The user must be the owner of the non-employee request. * @summary Get a non-employee request * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeRequestV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getNonEmployeeRequestV1(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeRequestV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getNonEmployeeRequestV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. * @summary Get schema attribute non-employee source * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeSchemaAttributeV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getNonEmployeeSchemaAttributeV1(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeSchemaAttributeV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getNonEmployeeSchemaAttributeV1(requestParameters.attributeId, requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. * @summary List schema attributes non-employee source * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeSourceSchemaAttributesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getNonEmployeeSourceSchemaAttributesV1(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeSourceSchemaAttributesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.getNonEmployeeSourceSchemaAttributesV1(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); }, /** * This gets a non-employee source. There are two contextual uses for the requested-for path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request any source. 2. The current user is an account manager, in which case the user can only request sources that they own. * @summary Get a non-employee source * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeSourceV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getNonEmployeeSourceV1(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeSourceV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getNonEmployeeSourceV1(requestParameters.sourceId, axiosOptions).then((request) => request(axios, basePath)); }, /** * This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` * @summary Imports, or updates, non-employee records * @param {NonEmployeeLifecycleManagementApiImportNonEmployeeRecordsInBulkV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ importNonEmployeeRecordsInBulkV1(requestParameters: NonEmployeeLifecycleManagementApiImportNonEmployeeRecordsInBulkV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.importNonEmployeeRecordsInBulkV1(requestParameters.id, requestParameters.data, axiosOptions).then((request) => request(axios, basePath)); }, /** * This gets a list of non-employee approval requests. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can list the approvals for any approver. 2. The user owns the requested approval. * @summary Get list of non-employee approval requests * @param {NonEmployeeLifecycleManagementApiListNonEmployeeApprovalsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listNonEmployeeApprovalsV1(requestParameters: NonEmployeeLifecycleManagementApiListNonEmployeeApprovalsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listNonEmployeeApprovalsV1(requestParameters.requestedFor, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); }, /** * This gets a list of non-employee records. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. * @summary List non-employee records * @param {NonEmployeeLifecycleManagementApiListNonEmployeeRecordsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listNonEmployeeRecordsV1(requestParameters: NonEmployeeLifecycleManagementApiListNonEmployeeRecordsV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listNonEmployeeRecordsV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); }, /** * This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a list non-employee requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages. * @summary List non-employee requests * @param {NonEmployeeLifecycleManagementApiListNonEmployeeRequestsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listNonEmployeeRequestsV1(requestParameters: NonEmployeeLifecycleManagementApiListNonEmployeeRequestsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listNonEmployeeRequestsV1(requestParameters.requestedFor, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath)); }, /** * Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager\'s `id`. 2. If the current user is an account manager, the user should provide \'me\' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. * @summary List non-employee sources * @param {NonEmployeeLifecycleManagementApiListNonEmployeeSourcesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listNonEmployeeSourcesV1(requestParameters: NonEmployeeLifecycleManagementApiListNonEmployeeSourcesV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listNonEmployeeSourcesV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.requestedFor, requestParameters.nonEmployeeCount, requestParameters.sorters, axiosOptions).then((request) => request(axios, basePath)); }, /** * This request will patch a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. * @summary Patch non-employee record * @param {NonEmployeeLifecycleManagementApiPatchNonEmployeeRecordV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchNonEmployeeRecordV1(requestParameters: NonEmployeeLifecycleManagementApiPatchNonEmployeeRecordV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.patchNonEmployeeRecordV1(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); }, /** * This end-point patches a specific schema attribute for a non-employee SourceId. Requires role context of `idn:nesr:update` * @summary Patch a schema attribute for non-employee source * @param {NonEmployeeLifecycleManagementApiPatchNonEmployeeSchemaAttributeV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchNonEmployeeSchemaAttributeV1(requestParameters: NonEmployeeLifecycleManagementApiPatchNonEmployeeSchemaAttributeV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.patchNonEmployeeSchemaAttributeV1(requestParameters.attributeId, requestParameters.sourceId, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); }, /** * patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. * @summary Patch a non-employee source * @param {NonEmployeeLifecycleManagementApiPatchNonEmployeeSourceV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchNonEmployeeSourceV1(requestParameters: NonEmployeeLifecycleManagementApiPatchNonEmployeeSourceV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.patchNonEmployeeSourceV1(requestParameters.sourceId, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); }, /** * This endpoint will reject an approval item request and notify user. The current user must be the requested approver. * @summary Reject a non-employee request * @param {NonEmployeeLifecycleManagementApiRejectNonEmployeeRequestV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ rejectNonEmployeeRequestV1(requestParameters: NonEmployeeLifecycleManagementApiRejectNonEmployeeRequestV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.rejectNonEmployeeRequestV1(requestParameters.id, requestParameters.nonEmployeeRejectApprovalDecision, axiosOptions).then((request) => request(axios, basePath)); }, /** * This request will update a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. * @summary Update non-employee record * @param {NonEmployeeLifecycleManagementApiUpdateNonEmployeeRecordV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateNonEmployeeRecordV1(requestParameters: NonEmployeeLifecycleManagementApiUpdateNonEmployeeRecordV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.updateNonEmployeeRecordV1(requestParameters.id, requestParameters.nonEmployeeRequestBody, axiosOptions).then((request) => request(axios, basePath)); }, }; }; /** * Request parameters for approveNonEmployeeRequestV1 operation in NonEmployeeLifecycleManagementApi. * @export * @interface NonEmployeeLifecycleManagementApiApproveNonEmployeeRequestV1Request */ export interface NonEmployeeLifecycleManagementApiApproveNonEmployeeRequestV1Request { /** * Non-Employee approval item id (UUID) * @type {string} * @memberof NonEmployeeLifecycleManagementApiApproveNonEmployeeRequestV1 */ readonly id: string /** * * @type {NonEmployeeApprovalDecision} * @memberof NonEmployeeLifecycleManagementApiApproveNonEmployeeRequestV1 */ readonly nonEmployeeApprovalDecision: NonEmployeeApprovalDecision } /** * Request parameters for createNonEmployeeRecordV1 operation in NonEmployeeLifecycleManagementApi. * @export * @interface NonEmployeeLifecycleManagementApiCreateNonEmployeeRecordV1Request */ export interface NonEmployeeLifecycleManagementApiCreateNonEmployeeRecordV1Request { /** * Non-Employee record creation request body. * @type {NonEmployeeRequestBody} * @memberof NonEmployeeLifecycleManagementApiCreateNonEmployeeRecordV1 */ readonly nonEmployeeRequestBody: NonEmployeeRequestBody } /** * Request parameters for createNonEmployeeRequestV1 operation in NonEmployeeLifecycleManagementApi. * @export * @interface NonEmployeeLifecycleManagementApiCreateNonEmployeeRequestV1Request */ export interface NonEmployeeLifecycleManagementApiCreateNonEmployeeRequestV1Request { /** * Non-Employee creation request body * @type {NonEmployeeRequestBody} * @memberof NonEmployeeLifecycleManagementApiCreateNonEmployeeRequestV1 */ readonly nonEmployeeRequestBody: NonEmployeeRequestBody } /** * Request parameters for createNonEmployeeSourceSchemaAttributesV1 operation in NonEmployeeLifecycleManagementApi. * @export * @interface NonEmployeeLifecycleManagementApiCreateNonEmployeeSourceSchemaAttributesV1Request */ export interface NonEmployeeLifecycleManagementApiCreateNonEmployeeSourceSchemaAttributesV1Request { /** * The Source id * @type {string} * @memberof NonEmployeeLifecycleManagementApiCreateNonEmployeeSourceSchemaAttributesV1 */ readonly sourceId: string /** * * @type {NonEmployeeSchemaAttributeBody} * @memberof NonEmployeeLifecycleManagementApiCreateNonEmployeeSourceSchemaAttributesV1 */ readonly nonEmployeeSchemaAttributeBody: NonEmployeeSchemaAttributeBody } /** * Request parameters for createNonEmployeeSourceV1 operation in NonEmployeeLifecycleManagementApi. * @export * @interface NonEmployeeLifecycleManagementApiCreateNonEmployeeSourceV1Request */ export interface NonEmployeeLifecycleManagementApiCreateNonEmployeeSourceV1Request { /** * Non-Employee source creation request body. * @type {NonEmployeeSourceRequestBody} * @memberof NonEmployeeLifecycleManagementApiCreateNonEmployeeSourceV1 */ readonly nonEmployeeSourceRequestBody: NonEmployeeSourceRequestBody } /** * Request parameters for deleteNonEmployeeRecordV1 operation in NonEmployeeLifecycleManagementApi. * @export * @interface NonEmployeeLifecycleManagementApiDeleteNonEmployeeRecordV1Request */ export interface NonEmployeeLifecycleManagementApiDeleteNonEmployeeRecordV1Request { /** * Non-Employee record id (UUID) * @type {string} * @memberof NonEmployeeLifecycleManagementApiDeleteNonEmployeeRecordV1 */ readonly id: string } /** * Request parameters for deleteNonEmployeeRecordsInBulkV1 operation in NonEmployeeLifecycleManagementApi. * @export * @interface NonEmployeeLifecycleManagementApiDeleteNonEmployeeRecordsInBulkV1Request */ export interface NonEmployeeLifecycleManagementApiDeleteNonEmployeeRecordsInBulkV1Request { /** * Non-Employee bulk delete request body. * @type {DeleteNonEmployeeRecordsInBulkV1Request} * @memberof NonEmployeeLifecycleManagementApiDeleteNonEmployeeRecordsInBulkV1 */ readonly deleteNonEmployeeRecordsInBulkV1Request: DeleteNonEmployeeRecordsInBulkV1Request } /** * Request parameters for deleteNonEmployeeRequestV1 operation in NonEmployeeLifecycleManagementApi. * @export * @interface NonEmployeeLifecycleManagementApiDeleteNonEmployeeRequestV1Request */ export interface NonEmployeeLifecycleManagementApiDeleteNonEmployeeRequestV1Request { /** * Non-Employee request id in the UUID format * @type {string} * @memberof NonEmployeeLifecycleManagementApiDeleteNonEmployeeRequestV1 */ readonly id: string } /** * Request parameters for deleteNonEmployeeSchemaAttributeV1 operation in NonEmployeeLifecycleManagementApi. * @export * @interface NonEmployeeLifecycleManagementApiDeleteNonEmployeeSchemaAttributeV1Request */ export interface NonEmployeeLifecycleManagementApiDeleteNonEmployeeSchemaAttributeV1Request { /** * The Schema Attribute Id (UUID) * @type {string} * @memberof NonEmployeeLifecycleManagementApiDeleteNonEmployeeSchemaAttributeV1 */ readonly attributeId: string /** * The Source id * @type {string} * @memberof NonEmployeeLifecycleManagementApiDeleteNonEmployeeSchemaAttributeV1 */ readonly sourceId: string } /** * Request parameters for deleteNonEmployeeSourceSchemaAttributesV1 operation in NonEmployeeLifecycleManagementApi. * @export * @interface NonEmployeeLifecycleManagementApiDeleteNonEmployeeSourceSchemaAttributesV1Request */ export interface NonEmployeeLifecycleManagementApiDeleteNonEmployeeSourceSchemaAttributesV1Request { /** * The Source id * @type {string} * @memberof NonEmployeeLifecycleManagementApiDeleteNonEmployeeSourceSchemaAttributesV1 */ readonly sourceId: string } /** * Request parameters for deleteNonEmployeeSourceV1 operation in NonEmployeeLifecycleManagementApi. * @export * @interface NonEmployeeLifecycleManagementApiDeleteNonEmployeeSourceV1Request */ export interface NonEmployeeLifecycleManagementApiDeleteNonEmployeeSourceV1Request { /** * Source Id * @type {string} * @memberof NonEmployeeLifecycleManagementApiDeleteNonEmployeeSourceV1 */ readonly sourceId: string } /** * Request parameters for exportNonEmployeeRecordsV1 operation in NonEmployeeLifecycleManagementApi. * @export * @interface NonEmployeeLifecycleManagementApiExportNonEmployeeRecordsV1Request */ export interface NonEmployeeLifecycleManagementApiExportNonEmployeeRecordsV1Request { /** * Source Id (UUID) * @type {string} * @memberof NonEmployeeLifecycleManagementApiExportNonEmployeeRecordsV1 */ readonly id: string } /** * Request parameters for exportNonEmployeeSourceSchemaTemplateV1 operation in NonEmployeeLifecycleManagementApi. * @export * @interface NonEmployeeLifecycleManagementApiExportNonEmployeeSourceSchemaTemplateV1Request */ export interface NonEmployeeLifecycleManagementApiExportNonEmployeeSourceSchemaTemplateV1Request { /** * Source Id (UUID) * @type {string} * @memberof NonEmployeeLifecycleManagementApiExportNonEmployeeSourceSchemaTemplateV1 */ readonly id: string } /** * Request parameters for getNonEmployeeApprovalSummaryV1 operation in NonEmployeeLifecycleManagementApi. * @export * @interface NonEmployeeLifecycleManagementApiGetNonEmployeeApprovalSummaryV1Request */ export interface NonEmployeeLifecycleManagementApiGetNonEmployeeApprovalSummaryV1Request { /** * The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. * @type {string} * @memberof NonEmployeeLifecycleManagementApiGetNonEmployeeApprovalSummaryV1 */ readonly requestedFor: string } /** * Request parameters for getNonEmployeeApprovalV1 operation in NonEmployeeLifecycleManagementApi. * @export * @interface NonEmployeeLifecycleManagementApiGetNonEmployeeApprovalV1Request */ export interface NonEmployeeLifecycleManagementApiGetNonEmployeeApprovalV1Request { /** * Non-Employee approval item id (UUID) * @type {string} * @memberof NonEmployeeLifecycleManagementApiGetNonEmployeeApprovalV1 */ readonly id: string /** * The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* * @type {boolean} * @memberof NonEmployeeLifecycleManagementApiGetNonEmployeeApprovalV1 */ readonly includeDetail?: boolean } /** * Request parameters for getNonEmployeeBulkUploadStatusV1 operation in NonEmployeeLifecycleManagementApi. * @export * @interface NonEmployeeLifecycleManagementApiGetNonEmployeeBulkUploadStatusV1Request */ export interface NonEmployeeLifecycleManagementApiGetNonEmployeeBulkUploadStatusV1Request { /** * Source ID (UUID) * @type {string} * @memberof NonEmployeeLifecycleManagementApiGetNonEmployeeBulkUploadStatusV1 */ readonly id: string } /** * Request parameters for getNonEmployeeRecordV1 operation in NonEmployeeLifecycleManagementApi. * @export * @interface NonEmployeeLifecycleManagementApiGetNonEmployeeRecordV1Request */ export interface NonEmployeeLifecycleManagementApiGetNonEmployeeRecordV1Request { /** * Non-Employee record id (UUID) * @type {string} * @memberof NonEmployeeLifecycleManagementApiGetNonEmployeeRecordV1 */ readonly id: string } /** * Request parameters for getNonEmployeeRequestSummaryV1 operation in NonEmployeeLifecycleManagementApi. * @export * @interface NonEmployeeLifecycleManagementApiGetNonEmployeeRequestSummaryV1Request */ export interface NonEmployeeLifecycleManagementApiGetNonEmployeeRequestSummaryV1Request { /** * The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. * @type {string} * @memberof NonEmployeeLifecycleManagementApiGetNonEmployeeRequestSummaryV1 */ readonly requestedFor: string } /** * Request parameters for getNonEmployeeRequestV1 operation in NonEmployeeLifecycleManagementApi. * @export * @interface NonEmployeeLifecycleManagementApiGetNonEmployeeRequestV1Request */ export interface NonEmployeeLifecycleManagementApiGetNonEmployeeRequestV1Request { /** * Non-Employee request id (UUID) * @type {string} * @memberof NonEmployeeLifecycleManagementApiGetNonEmployeeRequestV1 */ readonly id: string } /** * Request parameters for getNonEmployeeSchemaAttributeV1 operation in NonEmployeeLifecycleManagementApi. * @export * @interface NonEmployeeLifecycleManagementApiGetNonEmployeeSchemaAttributeV1Request */ export interface NonEmployeeLifecycleManagementApiGetNonEmployeeSchemaAttributeV1Request { /** * The Schema Attribute Id (UUID) * @type {string} * @memberof NonEmployeeLifecycleManagementApiGetNonEmployeeSchemaAttributeV1 */ readonly attributeId: string /** * The Source id * @type {string} * @memberof NonEmployeeLifecycleManagementApiGetNonEmployeeSchemaAttributeV1 */ readonly sourceId: string } /** * Request parameters for getNonEmployeeSourceSchemaAttributesV1 operation in NonEmployeeLifecycleManagementApi. * @export * @interface NonEmployeeLifecycleManagementApiGetNonEmployeeSourceSchemaAttributesV1Request */ export interface NonEmployeeLifecycleManagementApiGetNonEmployeeSourceSchemaAttributesV1Request { /** * The Source id * @type {string} * @memberof NonEmployeeLifecycleManagementApiGetNonEmployeeSourceSchemaAttributesV1 */ readonly sourceId: string } /** * Request parameters for getNonEmployeeSourceV1 operation in NonEmployeeLifecycleManagementApi. * @export * @interface NonEmployeeLifecycleManagementApiGetNonEmployeeSourceV1Request */ export interface NonEmployeeLifecycleManagementApiGetNonEmployeeSourceV1Request { /** * Source Id * @type {string} * @memberof NonEmployeeLifecycleManagementApiGetNonEmployeeSourceV1 */ readonly sourceId: string } /** * Request parameters for importNonEmployeeRecordsInBulkV1 operation in NonEmployeeLifecycleManagementApi. * @export * @interface NonEmployeeLifecycleManagementApiImportNonEmployeeRecordsInBulkV1Request */ export interface NonEmployeeLifecycleManagementApiImportNonEmployeeRecordsInBulkV1Request { /** * Source Id (UUID) * @type {string} * @memberof NonEmployeeLifecycleManagementApiImportNonEmployeeRecordsInBulkV1 */ readonly id: string /** * * @type {File} * @memberof NonEmployeeLifecycleManagementApiImportNonEmployeeRecordsInBulkV1 */ readonly data: File } /** * Request parameters for listNonEmployeeApprovalsV1 operation in NonEmployeeLifecycleManagementApi. * @export * @interface NonEmployeeLifecycleManagementApiListNonEmployeeApprovalsV1Request */ export interface NonEmployeeLifecycleManagementApiListNonEmployeeApprovalsV1Request { /** * The identity for whom the request was made. *me* indicates the current user. * @type {string} * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeApprovalsV1 */ readonly requestedFor?: string /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeApprovalsV1 */ readonly limit?: number /** * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeApprovalsV1 */ readonly offset?: number /** * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {boolean} * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeApprovalsV1 */ readonly count?: boolean /** * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* * @type {string} * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeApprovalsV1 */ readonly filters?: string /** * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** * @type {string} * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeApprovalsV1 */ readonly sorters?: string } /** * Request parameters for listNonEmployeeRecordsV1 operation in NonEmployeeLifecycleManagementApi. * @export * @interface NonEmployeeLifecycleManagementApiListNonEmployeeRecordsV1Request */ export interface NonEmployeeLifecycleManagementApiListNonEmployeeRecordsV1Request { /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeRecordsV1 */ readonly limit?: number /** * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeRecordsV1 */ readonly offset?: number /** * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {boolean} * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeRecordsV1 */ readonly count?: boolean /** * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** * @type {string} * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeRecordsV1 */ readonly sorters?: string /** * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* * @type {string} * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeRecordsV1 */ readonly filters?: string } /** * Request parameters for listNonEmployeeRequestsV1 operation in NonEmployeeLifecycleManagementApi. * @export * @interface NonEmployeeLifecycleManagementApiListNonEmployeeRequestsV1Request */ export interface NonEmployeeLifecycleManagementApiListNonEmployeeRequestsV1Request { /** * The identity for whom the request was made. *me* indicates the current user. * @type {string} * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeRequestsV1 */ readonly requestedFor: string /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeRequestsV1 */ readonly limit?: number /** * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeRequestsV1 */ readonly offset?: number /** * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {boolean} * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeRequestsV1 */ readonly count?: boolean /** * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** * @type {string} * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeRequestsV1 */ readonly sorters?: string /** * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* * @type {string} * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeRequestsV1 */ readonly filters?: string } /** * Request parameters for listNonEmployeeSourcesV1 operation in NonEmployeeLifecycleManagementApi. * @export * @interface NonEmployeeLifecycleManagementApiListNonEmployeeSourcesV1Request */ export interface NonEmployeeLifecycleManagementApiListNonEmployeeSourcesV1Request { /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeSourcesV1 */ readonly limit?: number /** * Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeSourcesV1 */ readonly offset?: number /** * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {boolean} * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeSourcesV1 */ readonly count?: boolean /** * Identity the request was made for. Use \'me\' to indicate the current user. * @type {string} * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeSourcesV1 */ readonly requestedFor?: string /** * Flag that determines whether the API will return a non-employee count associated with the source. * @type {boolean} * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeSourcesV1 */ readonly nonEmployeeCount?: boolean /** * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** * @type {string} * @memberof NonEmployeeLifecycleManagementApiListNonEmployeeSourcesV1 */ readonly sorters?: string } /** * Request parameters for patchNonEmployeeRecordV1 operation in NonEmployeeLifecycleManagementApi. * @export * @interface NonEmployeeLifecycleManagementApiPatchNonEmployeeRecordV1Request */ export interface NonEmployeeLifecycleManagementApiPatchNonEmployeeRecordV1Request { /** * Non-employee record id (UUID) * @type {string} * @memberof NonEmployeeLifecycleManagementApiPatchNonEmployeeRecordV1 */ readonly id: string /** * A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. * @type {Array} * @memberof NonEmployeeLifecycleManagementApiPatchNonEmployeeRecordV1 */ readonly jsonPatchOperation: Array } /** * Request parameters for patchNonEmployeeSchemaAttributeV1 operation in NonEmployeeLifecycleManagementApi. * @export * @interface NonEmployeeLifecycleManagementApiPatchNonEmployeeSchemaAttributeV1Request */ export interface NonEmployeeLifecycleManagementApiPatchNonEmployeeSchemaAttributeV1Request { /** * The Schema Attribute Id (UUID) * @type {string} * @memberof NonEmployeeLifecycleManagementApiPatchNonEmployeeSchemaAttributeV1 */ readonly attributeId: string /** * The Source id * @type {string} * @memberof NonEmployeeLifecycleManagementApiPatchNonEmployeeSchemaAttributeV1 */ readonly sourceId: string /** * A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update \':\' \'label\', \'helpText\', \'placeholder\', \'required\'. * @type {Array} * @memberof NonEmployeeLifecycleManagementApiPatchNonEmployeeSchemaAttributeV1 */ readonly jsonPatchOperation: Array } /** * Request parameters for patchNonEmployeeSourceV1 operation in NonEmployeeLifecycleManagementApi. * @export * @interface NonEmployeeLifecycleManagementApiPatchNonEmployeeSourceV1Request */ export interface NonEmployeeLifecycleManagementApiPatchNonEmployeeSourceV1Request { /** * Source Id * @type {string} * @memberof NonEmployeeLifecycleManagementApiPatchNonEmployeeSourceV1 */ readonly sourceId: string /** * A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. * @type {Array} * @memberof NonEmployeeLifecycleManagementApiPatchNonEmployeeSourceV1 */ readonly jsonPatchOperation: Array } /** * Request parameters for rejectNonEmployeeRequestV1 operation in NonEmployeeLifecycleManagementApi. * @export * @interface NonEmployeeLifecycleManagementApiRejectNonEmployeeRequestV1Request */ export interface NonEmployeeLifecycleManagementApiRejectNonEmployeeRequestV1Request { /** * Non-Employee approval item id (UUID) * @type {string} * @memberof NonEmployeeLifecycleManagementApiRejectNonEmployeeRequestV1 */ readonly id: string /** * * @type {NonEmployeeRejectApprovalDecision} * @memberof NonEmployeeLifecycleManagementApiRejectNonEmployeeRequestV1 */ readonly nonEmployeeRejectApprovalDecision: NonEmployeeRejectApprovalDecision } /** * Request parameters for updateNonEmployeeRecordV1 operation in NonEmployeeLifecycleManagementApi. * @export * @interface NonEmployeeLifecycleManagementApiUpdateNonEmployeeRecordV1Request */ export interface NonEmployeeLifecycleManagementApiUpdateNonEmployeeRecordV1Request { /** * Non-employee record id (UUID) * @type {string} * @memberof NonEmployeeLifecycleManagementApiUpdateNonEmployeeRecordV1 */ readonly id: string /** * Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. * @type {NonEmployeeRequestBody} * @memberof NonEmployeeLifecycleManagementApiUpdateNonEmployeeRecordV1 */ readonly nonEmployeeRequestBody: NonEmployeeRequestBody } /** * NonEmployeeLifecycleManagementApi - object-oriented interface * @export * @class NonEmployeeLifecycleManagementApi * @extends {BaseAPI} */ export class NonEmployeeLifecycleManagementApi extends BaseAPI { /** * Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. * @summary Approve a non-employee request * @param {NonEmployeeLifecycleManagementApiApproveNonEmployeeRequestV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NonEmployeeLifecycleManagementApi */ public approveNonEmployeeRequestV1(requestParameters: NonEmployeeLifecycleManagementApiApproveNonEmployeeRequestV1Request, axiosOptions?: RawAxiosRequestConfig) { return NonEmployeeLifecycleManagementApiFp(this.configuration).approveNonEmployeeRequestV1(requestParameters.id, requestParameters.nonEmployeeApprovalDecision, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This request will create a non-employee record. Requires role context of `idn:nesr:create` * @summary Create non-employee record * @param {NonEmployeeLifecycleManagementApiCreateNonEmployeeRecordV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NonEmployeeLifecycleManagementApi */ public createNonEmployeeRecordV1(requestParameters: NonEmployeeLifecycleManagementApiCreateNonEmployeeRecordV1Request, axiosOptions?: RawAxiosRequestConfig) { return NonEmployeeLifecycleManagementApiFp(this.configuration).createNonEmployeeRecordV1(requestParameters.nonEmployeeRequestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. * @summary Create non-employee request * @param {NonEmployeeLifecycleManagementApiCreateNonEmployeeRequestV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NonEmployeeLifecycleManagementApi */ public createNonEmployeeRequestV1(requestParameters: NonEmployeeLifecycleManagementApiCreateNonEmployeeRequestV1Request, axiosOptions?: RawAxiosRequestConfig) { return NonEmployeeLifecycleManagementApiFp(this.configuration).createNonEmployeeRequestV1(requestParameters.nonEmployeeRequestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a \"400.1.409 Reference conflict\" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a \"400.1.4 Limit violation\" response. Requires role context of `idn:nesr:create` * @summary Create a new schema attribute for non-employee source * @param {NonEmployeeLifecycleManagementApiCreateNonEmployeeSourceSchemaAttributesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NonEmployeeLifecycleManagementApi */ public createNonEmployeeSourceSchemaAttributesV1(requestParameters: NonEmployeeLifecycleManagementApiCreateNonEmployeeSourceSchemaAttributesV1Request, axiosOptions?: RawAxiosRequestConfig) { return NonEmployeeLifecycleManagementApiFp(this.configuration).createNonEmployeeSourceSchemaAttributesV1(requestParameters.sourceId, requestParameters.nonEmployeeSchemaAttributeBody, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Create a non-employee source. * @summary Create non-employee source * @param {NonEmployeeLifecycleManagementApiCreateNonEmployeeSourceV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NonEmployeeLifecycleManagementApi */ public createNonEmployeeSourceV1(requestParameters: NonEmployeeLifecycleManagementApiCreateNonEmployeeSourceV1Request, axiosOptions?: RawAxiosRequestConfig) { return NonEmployeeLifecycleManagementApiFp(this.configuration).createNonEmployeeSourceV1(requestParameters.nonEmployeeSourceRequestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This request will delete a non-employee record. Requires role context of `idn:nesr:delete` * @summary Delete non-employee record * @param {NonEmployeeLifecycleManagementApiDeleteNonEmployeeRecordV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NonEmployeeLifecycleManagementApi */ public deleteNonEmployeeRecordV1(requestParameters: NonEmployeeLifecycleManagementApiDeleteNonEmployeeRecordV1Request, axiosOptions?: RawAxiosRequestConfig) { return NonEmployeeLifecycleManagementApiFp(this.configuration).deleteNonEmployeeRecordV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` * @summary Delete multiple non-employee records * @param {NonEmployeeLifecycleManagementApiDeleteNonEmployeeRecordsInBulkV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NonEmployeeLifecycleManagementApi */ public deleteNonEmployeeRecordsInBulkV1(requestParameters: NonEmployeeLifecycleManagementApiDeleteNonEmployeeRecordsInBulkV1Request, axiosOptions?: RawAxiosRequestConfig) { return NonEmployeeLifecycleManagementApiFp(this.configuration).deleteNonEmployeeRecordsInBulkV1(requestParameters.deleteNonEmployeeRecordsInBulkV1Request, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This request will delete a non-employee request. Requires role context of `idn:nesr:delete` * @summary Delete non-employee request * @param {NonEmployeeLifecycleManagementApiDeleteNonEmployeeRequestV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NonEmployeeLifecycleManagementApi */ public deleteNonEmployeeRequestV1(requestParameters: NonEmployeeLifecycleManagementApiDeleteNonEmployeeRequestV1Request, axiosOptions?: RawAxiosRequestConfig) { return NonEmployeeLifecycleManagementApiFp(this.configuration).deleteNonEmployeeRequestV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This end-point deletes a specific schema attribute for a non-employee source. Requires role context of `idn:nesr:delete` * @summary Delete a schema attribute for non-employee source * @param {NonEmployeeLifecycleManagementApiDeleteNonEmployeeSchemaAttributeV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NonEmployeeLifecycleManagementApi */ public deleteNonEmployeeSchemaAttributeV1(requestParameters: NonEmployeeLifecycleManagementApiDeleteNonEmployeeSchemaAttributeV1Request, axiosOptions?: RawAxiosRequestConfig) { return NonEmployeeLifecycleManagementApiFp(this.configuration).deleteNonEmployeeSchemaAttributeV1(requestParameters.attributeId, requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` * @summary Delete all custom schema attributes for non-employee source * @param {NonEmployeeLifecycleManagementApiDeleteNonEmployeeSourceSchemaAttributesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NonEmployeeLifecycleManagementApi */ public deleteNonEmployeeSourceSchemaAttributesV1(requestParameters: NonEmployeeLifecycleManagementApiDeleteNonEmployeeSourceSchemaAttributesV1Request, axiosOptions?: RawAxiosRequestConfig) { return NonEmployeeLifecycleManagementApiFp(this.configuration).deleteNonEmployeeSourceSchemaAttributesV1(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. * @summary Delete non-employee source * @param {NonEmployeeLifecycleManagementApiDeleteNonEmployeeSourceV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NonEmployeeLifecycleManagementApi */ public deleteNonEmployeeSourceV1(requestParameters: NonEmployeeLifecycleManagementApiDeleteNonEmployeeSourceV1Request, axiosOptions?: RawAxiosRequestConfig) { return NonEmployeeLifecycleManagementApiFp(this.configuration).deleteNonEmployeeSourceV1(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` * @summary Exports non-employee records to csv * @param {NonEmployeeLifecycleManagementApiExportNonEmployeeRecordsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NonEmployeeLifecycleManagementApi */ public exportNonEmployeeRecordsV1(requestParameters: NonEmployeeLifecycleManagementApiExportNonEmployeeRecordsV1Request, axiosOptions?: RawAxiosRequestConfig) { return NonEmployeeLifecycleManagementApiFp(this.configuration).exportNonEmployeeRecordsV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` * @summary Exports source schema template * @param {NonEmployeeLifecycleManagementApiExportNonEmployeeSourceSchemaTemplateV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NonEmployeeLifecycleManagementApi */ public exportNonEmployeeSourceSchemaTemplateV1(requestParameters: NonEmployeeLifecycleManagementApiExportNonEmployeeSourceSchemaTemplateV1Request, axiosOptions?: RawAxiosRequestConfig) { return NonEmployeeLifecycleManagementApiFp(this.configuration).exportNonEmployeeSourceSchemaTemplateV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver\'s id. 2. The current user is an approver, in which case \"me\" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. * @summary Get summary of non-employee approval requests * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeApprovalSummaryV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NonEmployeeLifecycleManagementApi */ public getNonEmployeeApprovalSummaryV1(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeApprovalSummaryV1Request, axiosOptions?: RawAxiosRequestConfig) { return NonEmployeeLifecycleManagementApiFp(this.configuration).getNonEmployeeApprovalSummaryV1(requestParameters.requestedFor, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Gets a non-employee approval item detail. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get any approval. 2. The user owns the requested approval. * @summary Get a non-employee approval item detail * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeApprovalV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NonEmployeeLifecycleManagementApi */ public getNonEmployeeApprovalV1(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeApprovalV1Request, axiosOptions?: RawAxiosRequestConfig) { return NonEmployeeLifecycleManagementApiFp(this.configuration).getNonEmployeeApprovalV1(requestParameters.id, requestParameters.includeDetail, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. Requires role context of `idn:nesr:read` * @summary Obtain the status of bulk upload on the source * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeBulkUploadStatusV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NonEmployeeLifecycleManagementApi */ public getNonEmployeeBulkUploadStatusV1(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeBulkUploadStatusV1Request, axiosOptions?: RawAxiosRequestConfig) { return NonEmployeeLifecycleManagementApiFp(this.configuration).getNonEmployeeBulkUploadStatusV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This gets a non-employee record. Requires role context of `idn:nesr:read` * @summary Get a non-employee record * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeRecordV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NonEmployeeLifecycleManagementApi */ public getNonEmployeeRecordV1(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeRecordV1Request, axiosOptions?: RawAxiosRequestConfig) { return NonEmployeeLifecycleManagementApiFp(this.configuration).getNonEmployeeRecordV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. * @summary Get summary of non-employee requests * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeRequestSummaryV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NonEmployeeLifecycleManagementApi */ public getNonEmployeeRequestSummaryV1(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeRequestSummaryV1Request, axiosOptions?: RawAxiosRequestConfig) { return NonEmployeeLifecycleManagementApiFp(this.configuration).getNonEmployeeRequestSummaryV1(requestParameters.requestedFor, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This gets a non-employee request. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in this case the user can get the non-employee request for any user. 2. The user must be the owner of the non-employee request. * @summary Get a non-employee request * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeRequestV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NonEmployeeLifecycleManagementApi */ public getNonEmployeeRequestV1(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeRequestV1Request, axiosOptions?: RawAxiosRequestConfig) { return NonEmployeeLifecycleManagementApiFp(this.configuration).getNonEmployeeRequestV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. * @summary Get schema attribute non-employee source * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeSchemaAttributeV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NonEmployeeLifecycleManagementApi */ public getNonEmployeeSchemaAttributeV1(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeSchemaAttributeV1Request, axiosOptions?: RawAxiosRequestConfig) { return NonEmployeeLifecycleManagementApiFp(this.configuration).getNonEmployeeSchemaAttributeV1(requestParameters.attributeId, requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. * @summary List schema attributes non-employee source * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeSourceSchemaAttributesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NonEmployeeLifecycleManagementApi */ public getNonEmployeeSourceSchemaAttributesV1(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeSourceSchemaAttributesV1Request, axiosOptions?: RawAxiosRequestConfig) { return NonEmployeeLifecycleManagementApiFp(this.configuration).getNonEmployeeSourceSchemaAttributesV1(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This gets a non-employee source. There are two contextual uses for the requested-for path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request any source. 2. The current user is an account manager, in which case the user can only request sources that they own. * @summary Get a non-employee source * @param {NonEmployeeLifecycleManagementApiGetNonEmployeeSourceV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NonEmployeeLifecycleManagementApi */ public getNonEmployeeSourceV1(requestParameters: NonEmployeeLifecycleManagementApiGetNonEmployeeSourceV1Request, axiosOptions?: RawAxiosRequestConfig) { return NonEmployeeLifecycleManagementApiFp(this.configuration).getNonEmployeeSourceV1(requestParameters.sourceId, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` * @summary Imports, or updates, non-employee records * @param {NonEmployeeLifecycleManagementApiImportNonEmployeeRecordsInBulkV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NonEmployeeLifecycleManagementApi */ public importNonEmployeeRecordsInBulkV1(requestParameters: NonEmployeeLifecycleManagementApiImportNonEmployeeRecordsInBulkV1Request, axiosOptions?: RawAxiosRequestConfig) { return NonEmployeeLifecycleManagementApiFp(this.configuration).importNonEmployeeRecordsInBulkV1(requestParameters.id, requestParameters.data, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This gets a list of non-employee approval requests. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can list the approvals for any approver. 2. The user owns the requested approval. * @summary Get list of non-employee approval requests * @param {NonEmployeeLifecycleManagementApiListNonEmployeeApprovalsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NonEmployeeLifecycleManagementApi */ public listNonEmployeeApprovalsV1(requestParameters: NonEmployeeLifecycleManagementApiListNonEmployeeApprovalsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return NonEmployeeLifecycleManagementApiFp(this.configuration).listNonEmployeeApprovalsV1(requestParameters.requestedFor, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.filters, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This gets a list of non-employee records. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. * @summary List non-employee records * @param {NonEmployeeLifecycleManagementApiListNonEmployeeRecordsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NonEmployeeLifecycleManagementApi */ public listNonEmployeeRecordsV1(requestParameters: NonEmployeeLifecycleManagementApiListNonEmployeeRecordsV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return NonEmployeeLifecycleManagementApiFp(this.configuration).listNonEmployeeRecordsV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or she may request a list non-employee requests assigned to a particular account manager by passing in that manager\'s id. 2. The current user is an account manager, in which case \"me\" should be provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages. * @summary List non-employee requests * @param {NonEmployeeLifecycleManagementApiListNonEmployeeRequestsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NonEmployeeLifecycleManagementApi */ public listNonEmployeeRequestsV1(requestParameters: NonEmployeeLifecycleManagementApiListNonEmployeeRequestsV1Request, axiosOptions?: RawAxiosRequestConfig) { return NonEmployeeLifecycleManagementApiFp(this.configuration).listNonEmployeeRequestsV1(requestParameters.requestedFor, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager\'s `id`. 2. If the current user is an account manager, the user should provide \'me\' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. * @summary List non-employee sources * @param {NonEmployeeLifecycleManagementApiListNonEmployeeSourcesV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NonEmployeeLifecycleManagementApi */ public listNonEmployeeSourcesV1(requestParameters: NonEmployeeLifecycleManagementApiListNonEmployeeSourcesV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return NonEmployeeLifecycleManagementApiFp(this.configuration).listNonEmployeeSourcesV1(requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.requestedFor, requestParameters.nonEmployeeCount, requestParameters.sorters, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This request will patch a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. * @summary Patch non-employee record * @param {NonEmployeeLifecycleManagementApiPatchNonEmployeeRecordV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NonEmployeeLifecycleManagementApi */ public patchNonEmployeeRecordV1(requestParameters: NonEmployeeLifecycleManagementApiPatchNonEmployeeRecordV1Request, axiosOptions?: RawAxiosRequestConfig) { return NonEmployeeLifecycleManagementApiFp(this.configuration).patchNonEmployeeRecordV1(requestParameters.id, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This end-point patches a specific schema attribute for a non-employee SourceId. Requires role context of `idn:nesr:update` * @summary Patch a schema attribute for non-employee source * @param {NonEmployeeLifecycleManagementApiPatchNonEmployeeSchemaAttributeV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NonEmployeeLifecycleManagementApi */ public patchNonEmployeeSchemaAttributeV1(requestParameters: NonEmployeeLifecycleManagementApiPatchNonEmployeeSchemaAttributeV1Request, axiosOptions?: RawAxiosRequestConfig) { return NonEmployeeLifecycleManagementApiFp(this.configuration).patchNonEmployeeSchemaAttributeV1(requestParameters.attributeId, requestParameters.sourceId, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. * @summary Patch a non-employee source * @param {NonEmployeeLifecycleManagementApiPatchNonEmployeeSourceV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NonEmployeeLifecycleManagementApi */ public patchNonEmployeeSourceV1(requestParameters: NonEmployeeLifecycleManagementApiPatchNonEmployeeSourceV1Request, axiosOptions?: RawAxiosRequestConfig) { return NonEmployeeLifecycleManagementApiFp(this.configuration).patchNonEmployeeSourceV1(requestParameters.sourceId, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This endpoint will reject an approval item request and notify user. The current user must be the requested approver. * @summary Reject a non-employee request * @param {NonEmployeeLifecycleManagementApiRejectNonEmployeeRequestV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NonEmployeeLifecycleManagementApi */ public rejectNonEmployeeRequestV1(requestParameters: NonEmployeeLifecycleManagementApiRejectNonEmployeeRequestV1Request, axiosOptions?: RawAxiosRequestConfig) { return NonEmployeeLifecycleManagementApiFp(this.configuration).rejectNonEmployeeRequestV1(requestParameters.id, requestParameters.nonEmployeeRejectApprovalDecision, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This request will update a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they update all available fields. 2. The user is owner of the source, in this case they can only update the end date. * @summary Update non-employee record * @param {NonEmployeeLifecycleManagementApiUpdateNonEmployeeRecordV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof NonEmployeeLifecycleManagementApi */ public updateNonEmployeeRecordV1(requestParameters: NonEmployeeLifecycleManagementApiUpdateNonEmployeeRecordV1Request, axiosOptions?: RawAxiosRequestConfig) { return NonEmployeeLifecycleManagementApiFp(this.configuration).updateNonEmployeeRecordV1(requestParameters.id, requestParameters.nonEmployeeRequestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); } }