Skip to content

Commit

Permalink
Adding more examples for #13
Browse files Browse the repository at this point in the history
  • Loading branch information
gitfvb committed Jul 1, 2024
1 parent fe60828 commit 7b1cd32
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions AptecoPSFramework/plugins/InxmailPro/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,10 @@ import-settings ".\inx.yaml"
# EXAMPLES
#-----------------------------------------------
# Get first page of lists
# Get first page of lists (100 by default)
get-list -type STANDARD | Out-GridView
# Get all lists
# Get all STANDARD lists
get-list -type STANDARD -All | Out-GridView
# All approved mailings of type regular mailing
Expand All @@ -79,7 +79,23 @@ Get-Mailing -Type REGULAR_MAILING -All -CreatedAfter "1.5.2022" | Out-GridView
# Show the current api usage and when the calls will refresh
# The numbers get automatically refreshed when other calls are executed
Get-ApiUsage -verbose -ForceRefresh# Structure/Hierarchy of data
Get-ApiUsage -verbose -ForceRefresh
# Create a new list
Add-List -Name "A new list" -Description "This is a new lists description" -SenderAddress "[email protected]"
# Get details of a list by id
Get-list -Id 301
# Remove a list with a specific id
Remove-List -Id 301
# Get all STANDARD lists, open a table to choose some of them, and delete the selected ones after pressing "OK"
Get-List -All -Type STANDARD | Out-GridView -PassThru | Remove-List
```

# Structure/Hierarchy of data

- Recipients (global list and attributes)
|- Lists (recipients list dependent and lists data)
Expand Down

0 comments on commit 7b1cd32

Please sign in to comment.