Api/FlySharePointProjectApi.ps1
|
# # Fly SDK API # No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # Version: 1.0 # Contact: support@avepoint.com # Generated by OpenAPI Generator: https://openapi-generator.tech # <# .SYNOPSIS Add SharePoint project mappings into target project .DESCRIPTION No description available. .PARAMETER ProjectId The GUID of the project to add into .PARAMETER SharePointMappingCreationModel A list of project mappings to add .PARAMETER ReturnType Select the return type (optional): text/plain, application/json, text/json, application/*+json .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS Boolean #> function Add-FlySharePointMappings { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${ProjectId}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject[]] ${SharePointMappingCreationModel}, [String] [ValidateSet("text/plain", "application/json", "text/json", "application/*+json")] $ReturnType, [Switch] $WithHttpInfo ) Process { 'Calling method: Add-FlySharePointMappings' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-FlyConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('text/plain', 'application/json', 'text/json', 'application/*+json') if ($ReturnType) { # use the return type (MIME) provided by the user $LocalVarAccepts = @($ReturnType) } # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/projects/sharepoint/{projectId}/mappings' if (!$ProjectId) { throw "Error! The required parameter `ProjectId` missing when calling addSharePointMappings." } $LocalVarUri = $LocalVarUri.replace('{projectId}', [System.Web.HTTPUtility]::UrlEncode($ProjectId)) if (!$SharePointMappingCreationModel) { throw "Error! The required parameter `SharePointMappingCreationModel` missing when calling addSharePointMappings." } $LocalVarBodyParameter = ConvertTo-Json $SharePointMappingCreationModel -Depth 100 if ($Configuration["AccessToken"]) { $LocalVarHeaderParameters['Authorization'] = "Bearer " + $Configuration["AccessToken"] Write-Verbose ("Using Bearer authentication in {0}" -f $MyInvocation.MyCommand) } $LocalVarResult = Invoke-FlyApiClient -Method 'POST' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "Boolean" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Move SharePoint project mappings into another SharePoint project .DESCRIPTION No description available. .PARAMETER ProjectId The GUID of the project(move from) .PARAMETER MoveMappingSettingsModel No description available. .PARAMETER ReturnType Select the return type (optional): text/plain, application/json, text/json, application/*+json .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS Boolean #> function Move-FlySharePointMappings { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${ProjectId}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${MoveMappingSettingsModel}, [String] [ValidateSet("text/plain", "application/json", "text/json", "application/*+json")] $ReturnType, [Switch] $WithHttpInfo ) Process { 'Calling method: Move-FlySharePointMappings' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-FlyConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('text/plain', 'application/json', 'text/json', 'application/*+json') if ($ReturnType) { # use the return type (MIME) provided by the user $LocalVarAccepts = @($ReturnType) } # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/projects/sharepoint/{projectId}/movemappings' if (!$ProjectId) { throw "Error! The required parameter `ProjectId` missing when calling moveSharePointMappings." } $LocalVarUri = $LocalVarUri.replace('{projectId}', [System.Web.HTTPUtility]::UrlEncode($ProjectId)) $LocalVarBodyParameter = ConvertTo-Json $MoveMappingSettingsModel -Depth 100 if ($Configuration["AccessToken"]) { $LocalVarHeaderParameters['Authorization'] = "Bearer " + $Configuration["AccessToken"] Write-Verbose ("Using Bearer authentication in {0}" -f $MyInvocation.MyCommand) } $LocalVarResult = Invoke-FlyApiClient -Method 'POST' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "Boolean" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Start a migration job against the selected project mappings. .DESCRIPTION No description available. .PARAMETER ProjectId Identifier of the project containing the selected mappings .PARAMETER MigrationJobSettingsModel Job configuration information. .PARAMETER ReturnType Select the return type (optional): text/plain, application/json, text/json, application/*+json .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS Boolean #> function Start-FlySharePointMigrationJob { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${ProjectId}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${MigrationJobSettingsModel}, [String] [ValidateSet("text/plain", "application/json", "text/json", "application/*+json")] $ReturnType, [Switch] $WithHttpInfo ) Process { 'Calling method: Start-FlySharePointMigrationJob' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-FlyConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('text/plain', 'application/json', 'text/json', 'application/*+json') if ($ReturnType) { # use the return type (MIME) provided by the user $LocalVarAccepts = @($ReturnType) } # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/projects/sharepoint/{projectId}/migrations' if (!$ProjectId) { throw "Error! The required parameter `ProjectId` missing when calling startSharePointMigrationJob." } $LocalVarUri = $LocalVarUri.replace('{projectId}', [System.Web.HTTPUtility]::UrlEncode($ProjectId)) if (!$MigrationJobSettingsModel) { throw "Error! The required parameter `MigrationJobSettingsModel` missing when calling startSharePointMigrationJob." } $LocalVarBodyParameter = ConvertTo-Json $MigrationJobSettingsModel -Depth 100 if ($Configuration["AccessToken"]) { $LocalVarHeaderParameters['Authorization'] = "Bearer " + $Configuration["AccessToken"] Write-Verbose ("Using Bearer authentication in {0}" -f $MyInvocation.MyCommand) } $LocalVarResult = Invoke-FlyApiClient -Method 'POST' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "Boolean" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Start a pre-scan job against the selected project mappings. .DESCRIPTION No description available. .PARAMETER ProjectId Identifier of the project containing the selected mappings .PARAMETER ProjectMappingOperationModel Job configuration information. .PARAMETER ReturnType Select the return type (optional): text/plain, application/json, text/json, application/*+json .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS Boolean #> function Start-FlySharePointPreScanJob { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${ProjectId}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${ProjectMappingOperationModel}, [String] [ValidateSet("text/plain", "application/json", "text/json", "application/*+json")] $ReturnType, [Switch] $WithHttpInfo ) Process { 'Calling method: Start-FlySharePointPreScanJob' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-FlyConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('text/plain', 'application/json', 'text/json', 'application/*+json') if ($ReturnType) { # use the return type (MIME) provided by the user $LocalVarAccepts = @($ReturnType) } # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/projects/sharepoint/{projectId}/assessments' if (!$ProjectId) { throw "Error! The required parameter `ProjectId` missing when calling startSharePointPreScanJob." } $LocalVarUri = $LocalVarUri.replace('{projectId}', [System.Web.HTTPUtility]::UrlEncode($ProjectId)) if (!$ProjectMappingOperationModel) { throw "Error! The required parameter `ProjectMappingOperationModel` missing when calling startSharePointPreScanJob." } $LocalVarBodyParameter = ConvertTo-Json $ProjectMappingOperationModel -Depth 100 if ($Configuration["AccessToken"]) { $LocalVarHeaderParameters['Authorization'] = "Bearer " + $Configuration["AccessToken"] Write-Verbose ("Using Bearer authentication in {0}" -f $MyInvocation.MyCommand) } $LocalVarResult = Invoke-FlyApiClient -Method 'POST' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "Boolean" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Start a report collection job against the selected project mappings. .DESCRIPTION No description available. .PARAMETER ProjectId Identifier of the project containing the selected mappings .PARAMETER GenerateReportSettingsModel Job configuration information. .PARAMETER ReturnType Select the return type (optional): text/plain, application/json, text/json, application/*+json .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS String #> function Start-FlySharePointReportJob { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${ProjectId}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${GenerateReportSettingsModel}, [String] [ValidateSet("text/plain", "application/json", "text/json", "application/*+json")] $ReturnType, [Switch] $WithHttpInfo ) Process { 'Calling method: Start-FlySharePointReportJob' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-FlyConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('text/plain', 'application/json', 'text/json', 'application/*+json') if ($ReturnType) { # use the return type (MIME) provided by the user $LocalVarAccepts = @($ReturnType) } # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/projects/sharepoint/{projectId}/reports/generate' if (!$ProjectId) { throw "Error! The required parameter `ProjectId` missing when calling startSharePointReportJob." } $LocalVarUri = $LocalVarUri.replace('{projectId}', [System.Web.HTTPUtility]::UrlEncode($ProjectId)) if (!$GenerateReportSettingsModel) { throw "Error! The required parameter `GenerateReportSettingsModel` missing when calling startSharePointReportJob." } $LocalVarBodyParameter = ConvertTo-Json $GenerateReportSettingsModel -Depth 100 if ($Configuration["AccessToken"]) { $LocalVarHeaderParameters['Authorization'] = "Bearer " + $Configuration["AccessToken"] Write-Verbose ("Using Bearer authentication in {0}" -f $MyInvocation.MyCommand) } $LocalVarResult = Invoke-FlyApiClient -Method 'POST' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "String" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Start a verification operation against the selected project mappings. .DESCRIPTION No description available. .PARAMETER ProjectId Identifier of the project containing the selected mappings .PARAMETER ProjectMappingOperationModel Job configuration information. .PARAMETER ReturnType Select the return type (optional): text/plain, application/json, text/json, application/*+json .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS Boolean #> function Start-FlySharePointVerificationJob { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${ProjectId}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${ProjectMappingOperationModel}, [String] [ValidateSet("text/plain", "application/json", "text/json", "application/*+json")] $ReturnType, [Switch] $WithHttpInfo ) Process { 'Calling method: Start-FlySharePointVerificationJob' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-FlyConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('text/plain', 'application/json', 'text/json', 'application/*+json') if ($ReturnType) { # use the return type (MIME) provided by the user $LocalVarAccepts = @($ReturnType) } # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/projects/sharepoint/{projectId}/verifications' if (!$ProjectId) { throw "Error! The required parameter `ProjectId` missing when calling startSharePointVerificationJob." } $LocalVarUri = $LocalVarUri.replace('{projectId}', [System.Web.HTTPUtility]::UrlEncode($ProjectId)) if (!$ProjectMappingOperationModel) { throw "Error! The required parameter `ProjectMappingOperationModel` missing when calling startSharePointVerificationJob." } $LocalVarBodyParameter = ConvertTo-Json $ProjectMappingOperationModel -Depth 100 if ($Configuration["AccessToken"]) { $LocalVarHeaderParameters['Authorization'] = "Bearer " + $Configuration["AccessToken"] Write-Verbose ("Using Bearer authentication in {0}" -f $MyInvocation.MyCommand) } $LocalVarResult = Invoke-FlyApiClient -Method 'POST' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "Boolean" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } |