Skip to content

RGSALettersApi.md

Latest commit

 

History

History
686 lines (459 loc) · 20.6 KB

RGSALettersApi.md

File metadata and controls

686 lines (459 loc) · 20.6 KB
Raw

RealGreenSaPS.RealGreenSaPS\Api.RGSALettersApi

All URIs are relative to https://saapi.realgreen.com

Method HTTP request Description
Invoke-RGSALettersAnybranchAnybranchGet GET /Letters/Anybranch/{anybranch}
Invoke-RGSALettersAvailableAvailableGet GET /Letters/Available/{available}
Invoke-RGSALettersCancelGet GET /Letters/Cancel
Invoke-RGSALettersCollectionGet GET /Letters/Collection
Invoke-RGSALettersConfirmationGet GET /Letters/Confirmation
Invoke-RGSALettersContractGet GET /Letters/Contract
Invoke-RGSALettersGet GET /Letters
Invoke-RGSALettersIdGet GET /Letters/{id}
Invoke-RGSALettersInfoUpsellGet GET /Letters/InfoUpsell
Invoke-RGSALettersLetterTypeLettertypeGet GET /Letters/LetterType/{lettertype}
Invoke-RGSALettersPendingPendingGet GET /Letters/Pending/{pending}
Invoke-RGSALettersPostcardGet GET /Letters/Postcard
Invoke-RGSALettersPrepayGet GET /Letters/Prepay
Invoke-RGSALettersReferralGet GET /Letters/Referral
Invoke-RGSALettersTypeLetterTypeGet GET /Letters/Type/{letterType} Get Letters by their type (Confirmation, Prepay, InfoUpsell, Cancel, Collection, Postcard, Referral)
Invoke-RGSALettersUseLetterheadUseltrheadGet GET /Letters/UseLetterhead/{useltrhead}

Invoke-RGSALettersAnybranchAnybranchGet

void Invoke-RGSALettersAnybranchAnybranchGet
        [-Anybranch]
        [-ApiKey]

Example

$Anybranch = $true # Boolean | 
$ApiKey = "MyApiKey" # String | API Key

try {
    $Result = Invoke-RGSALettersAnybranchAnybranchGet -Anybranch $Anybranch -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSALettersAnybranchAnybranchGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Anybranch Boolean
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-RGSALettersAvailableAvailableGet

void Invoke-RGSALettersAvailableAvailableGet
        [-Available]
        [-ApiKey]

Example

$Available = $true # Boolean | 
$ApiKey = "MyApiKey" # String | API Key

try {
    $Result = Invoke-RGSALettersAvailableAvailableGet -Available $Available -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSALettersAvailableAvailableGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Available Boolean
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-RGSALettersCancelGet

void Invoke-RGSALettersCancelGet
        [-ApiKey]

Example

$ApiKey = "MyApiKey" # String | API Key

try {
    $Result = Invoke-RGSALettersCancelGet -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSALettersCancelGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-RGSALettersCollectionGet

void Invoke-RGSALettersCollectionGet
        [-ApiKey]

Example

$ApiKey = "MyApiKey" # String | API Key

try {
    $Result = Invoke-RGSALettersCollectionGet -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSALettersCollectionGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-RGSALettersConfirmationGet

void Invoke-RGSALettersConfirmationGet
        [-ApiKey]

Example

$ApiKey = "MyApiKey" # String | API Key

try {
    $Result = Invoke-RGSALettersConfirmationGet -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSALettersConfirmationGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-RGSALettersContractGet

void Invoke-RGSALettersContractGet
        [-ApiKey]

Example

$ApiKey = "MyApiKey" # String | API Key

try {
    $Result = Invoke-RGSALettersContractGet -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSALettersContractGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-RGSALettersGet

void Invoke-RGSALettersGet
        [-ApiKey]

Example

$ApiKey = "MyApiKey" # String | API Key

try {
    $Result = Invoke-RGSALettersGet -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSALettersGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-RGSALettersIdGet

void Invoke-RGSALettersIdGet
        [-Id]
        [-ApiKey]

Example

$Id = 56 # Int32 | 
$ApiKey = "MyApiKey" # String | API Key

try {
    $Result = Invoke-RGSALettersIdGet -Id $Id -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSALettersIdGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Id Int32
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-RGSALettersInfoUpsellGet

void Invoke-RGSALettersInfoUpsellGet
        [-ApiKey]

Example

$ApiKey = "MyApiKey" # String | API Key

try {
    $Result = Invoke-RGSALettersInfoUpsellGet -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSALettersInfoUpsellGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-RGSALettersLetterTypeLettertypeGet

void Invoke-RGSALettersLetterTypeLettertypeGet
        [-Lettertype]
        [-ApiKey]

Example

$Lettertype = 1.2 # Double | 
$ApiKey = "MyApiKey" # String | API Key

try {
    $Result = Invoke-RGSALettersLetterTypeLettertypeGet -Lettertype $Lettertype -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSALettersLetterTypeLettertypeGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Lettertype Double
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-RGSALettersPendingPendingGet

void Invoke-RGSALettersPendingPendingGet
        [-Pending]
        [-ApiKey]

Example

$Pending = $true # Boolean | 
$ApiKey = "MyApiKey" # String | API Key

try {
    $Result = Invoke-RGSALettersPendingPendingGet -Pending $Pending -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSALettersPendingPendingGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Pending Boolean
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-RGSALettersPostcardGet

void Invoke-RGSALettersPostcardGet
        [-ApiKey]

Example

$ApiKey = "MyApiKey" # String | API Key

try {
    $Result = Invoke-RGSALettersPostcardGet -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSALettersPostcardGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-RGSALettersPrepayGet

void Invoke-RGSALettersPrepayGet
        [-ApiKey]

Example

$ApiKey = "MyApiKey" # String | API Key

try {
    $Result = Invoke-RGSALettersPrepayGet -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSALettersPrepayGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-RGSALettersReferralGet

void Invoke-RGSALettersReferralGet
        [-ApiKey]

Example

$ApiKey = "MyApiKey" # String | API Key

try {
    $Result = Invoke-RGSALettersReferralGet -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSALettersReferralGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-RGSALettersTypeLetterTypeGet

void Invoke-RGSALettersTypeLetterTypeGet
        [-LetterType]
        [-ApiKey]

Get Letters by their type (Confirmation, Prepay, InfoUpsell, Cancel, Collection, Postcard, Referral)

Example

$LetterType = "MyLetterType" # String | 
$ApiKey = "MyApiKey" # String | API Key

# Get Letters by their type (Confirmation, Prepay, InfoUpsell, Cancel, Collection, Postcard, Referral)
try {
    $Result = Invoke-RGSALettersTypeLetterTypeGet -LetterType $LetterType -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSALettersTypeLetterTypeGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
LetterType String
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-RGSALettersUseLetterheadUseltrheadGet

void Invoke-RGSALettersUseLetterheadUseltrheadGet
        [-Useltrhead]
        [-ApiKey]

Example

$Useltrhead = $true # Boolean | 
$ApiKey = "MyApiKey" # String | API Key

try {
    $Result = Invoke-RGSALettersUseLetterheadUseltrheadGet -Useltrhead $Useltrhead -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSALettersUseLetterheadUseltrheadGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Useltrhead Boolean
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]