Rename "Add" to "New" functions (#63)

* Fix .gitignore so I can actually commit new files * Rename "Edit" functions to "New" to match Microsofts guidance on allowed verbs * Update DOCs with new names * Fix gitignore to not have unnecessary parts from copy/pasted gitignore templates
AeriesSoftware · Aug 14, 2023 · 1d3510a · 1d3510a
1 parent 08ffa63
commit 1d3510a
Show file tree

Hide file tree

Showing 13 changed files with 2,314 additions and 2,297 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,42 +2,22 @@ test.*
 temp/*
 *.csv
 
+# VS code related
+
 .vscode/*
 !.vscode/settings.json
 !.vscode/tasks.json
 !.vscode/launch.json
 !.vscode/extensions.json
+!.vscode/*.code-snippets
 
 # Local History for Visual Studio Code
 .history/
 
+# Built Visual Studio Code Extensions
+*.vsix
+
 # VS related
-Skip to content
-Search or jump to…
-Pull requests
-Issues
-Marketplace
-Explore
-
-@AeriesSoftware 
-github
-/
-gitignore
-Public
-Code
-Pull requests
-214
-Actions
-Security
-Insights
-gitignore/VisualStudio.gitignore
-@n0099
-n0099 [VisualStudio.gitignore] remove a trailing space
-Latest commit 491040e on Jan 26
- History
- 165 contributors
-@shiftkey@arcresu@aroben@bbodenmiller@HassanHashemi@haacked@niik@AArnott@sayedihashimi@saschanaz@bdougie@OsirisTerje
-398 lines (319 sloc)  6.7 KB
 
 ## Ignore Visual Studio temporary files, build results, and
 ## files generated by popular Visual Studio add-ons.
@@ -436,16 +416,4 @@ FodyWeavers.xsd
 *.msp
 
 # JetBrains Rider
-*.sln.iml
-© 2022 GitHub, Inc.
-Terms
-Privacy
-Security
-Status
-Docs
-Contact GitHub
-Pricing
-API
-Training
-Blog
-About
+*.sln.iml
diff --git a/AeriesApi/AeriesApi.psd1 b/AeriesApi/AeriesApi.psd1
@@ -72,16 +72,6 @@ ScriptsToProcess = @(
 
 # Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
 FunctionsToExport = @(
-    'Add-AeriesActivity',
-    'Add-AeriesAlternateCourseRequest',
-    'Add-AeriesAuthorization',
-    'Add-AeriesContact',
-    'Add-AeriesCourseRequest',
-    'Add-AeriesGradebookAssignment',
-    'Add-AeriesSchedulingSection',
-    'Add-AeriesStaff',
-    'Add-AeriesStaffAssignment',
-    'Add-AeriesStudent',
     'Edit-AeriesActivity',
     'Edit-AeriesAddress',
     'Edit-AeriesAlternateCourseRequest',
@@ -154,6 +144,16 @@ FunctionsToExport = @(
     'Initialize-AeriesApi',
     'Initialize-AeriesPreEnrollActive',
     'Initialize-AeriesPreEnrollInactive',
+    'New-AeriesActivity',
+    'New-AeriesAlternateCourseRequest',
+    'New-AeriesAuthorization',
+    'New-AeriesContact',
+    'New-AeriesCourseRequest',
+    'New-AeriesGradebookAssignment',
+    'New-AeriesSchedulingSection',
+    'New-AeriesStaff',
+    'New-AeriesStaffAssignment',
+    'New-AeriesStudent',
     'Remove-AeriesActivity',
     'Remove-AeriesAlternateCourseRequest',
     'Remove-AeriesAuthorization',

diff --git a/AeriesApi/Public/Add-AeriesActivity.ps1 → AeriesApi/Public/New-AeriesActivity.ps1 b/AeriesApi/Public/Add-AeriesActivity.ps1 → AeriesApi/Public/New-AeriesActivity.ps1
@@ -1,16 +1,17 @@
-function Add-AeriesActivity
+function New-AeriesActivity
 {
     <#
         .SYNOPSIS
         Add an Activity/Award to Aeries
 
         .DESCRIPTION
-        The Add-AeriesActivity cmdlet is used to create an Activity/Award in Aeries for a given StudentID at the SchoolCode
+        The New-AeriesActivity cmdlet is used to create an Activity/Award in Aeries for a given StudentID at the SchoolCode
 
         .EXAMPLE
-        Add-AeriesActivity -SchoolCode 994 -StudentID 99400001 -TypeCode "1" -DateEntered "2021-10-26" -Comment "This was added via PowerShell!"
+        New-AeriesActivity -SchoolCode 994 -StudentID 99400001 -TypeCode "1" -DateEntered "2021-10-26" -Comment "This was added via PowerShell!"
         This will create an Activity in Aeries for StudentID 99400001 at SchoolCode 994
     #>
+    [Alias("Add-AeriesActivity")]
 
     [CmdletBinding()]
     param (

diff --git a/...blic/Add-AeriesAlternateCourseRequest.ps1 → ...blic/New-AeriesAlternateCourseRequest.ps1 b/...blic/Add-AeriesAlternateCourseRequest.ps1 → ...blic/New-AeriesAlternateCourseRequest.ps1
@@ -1,17 +1,19 @@
-function Add-AeriesAlternateCourseRequest
+function New-AeriesAlternateCourseRequest
 {
     <#
         .SYNOPSIS
         Add an Alternate Course Request to Aeries
 
         .DESCRIPTION
-        The Add-AeriesAlternateCourseRequest cmdlet is used to add an Alternate Course Request in Aeries for a given StudentID and SchoolCode 
+        The New-AeriesAlternateCourseRequest cmdlet is used to add an Alternate Course Request in Aeries for a given StudentID and SchoolCode 
 
         .EXAMPLE
-        Add-AeriesAlternateCourseRequest -SchoolCode 994 -StudentID 99400001 -CourseNumber "123456"
+        New-AeriesAlternateCourseRequest -SchoolCode 994 -StudentID 99400001 -CourseNumber "123456"
         This will create an Alternate Course Request in Aeries for StudentID 99400001 at SchoolCode 994 with Course Number 123456
     #>
 
+    [Alias("Add-AeriesAlternateCourseRequest")]
+
     [CmdletBinding()]
     param (
         [ValidateRange(1, [Int16]::MaxValue)]

diff --git a/AeriesApi/Public/Add-AeriesAuthorization.ps1 → AeriesApi/Public/New-AeriesAuthorization.ps1 b/AeriesApi/Public/Add-AeriesAuthorization.ps1 → AeriesApi/Public/New-AeriesAuthorization.ps1
@@ -1,17 +1,19 @@
-function Add-AeriesAuthorization
+function New-AeriesAuthorization
 {
     <#
         .SYNOPSIS
         Add a new Authorization in Aeries
 
         .DESCRIPTION
-        The Add-AeriesAuthorization cmdlet is used to add an Authorization in Aeries
+        The New-AeriesAuthorization cmdlet is used to add an Authorization in Aeries
 
         .EXAMPLE
-        Add-AeriesAuthorization -SchoolCode 994 -StudentID 99400001 -Comment "This was added with PowerShell"
+        New-AeriesAuthorization -SchoolCode 994 -StudentID 99400001 -Comment "This was added with PowerShell"
         This will add an Authorization to Aeries
     #>
 
+    [Alias("Add-AeriesAuthorization")]
+
     [CmdletBinding()]
     param (
         [ValidateRange(1, [Int16]::MaxValue)]

diff --git a/AeriesApi/Public/Add-AeriesContact.ps1 → AeriesApi/Public/New-AeriesContact.ps1 b/AeriesApi/Public/Add-AeriesContact.ps1 → AeriesApi/Public/New-AeriesContact.ps1
@@ -1,17 +1,19 @@
-function Add-AeriesContact
+function New-AeriesContact
 {
     <#
         .SYNOPSIS
         Add a Contact to Aeries
 
         .DESCRIPTION
-        The Add-AeriesContact cmdlet is used to create a Contact in Aeries for a given StudentID
+        The New-AeriesContact cmdlet is used to create a Contact in Aeries for a given StudentID
 
         .EXAMPLE
-        Add-AeriesContact -StudentID 99400001 -FirstName "Aeries" -LastName "Software"
+        New-AeriesContact -StudentID 99400001 -FirstName "Aeries" -LastName "Software"
         This will create a Contact in Aeries for StudentID 99400001
     #>
 
+    [Alias("Add-AeriesContact")]
+
     [CmdletBinding()]
     param (
         [ValidateRange(1, [Int]::MaxValue)]

diff --git a/AeriesApi/Public/Add-AeriesCourseRequest.ps1 → AeriesApi/Public/New-AeriesCourseRequest.ps1 b/AeriesApi/Public/Add-AeriesCourseRequest.ps1 → AeriesApi/Public/New-AeriesCourseRequest.ps1
@@ -1,17 +1,19 @@
-function Add-AeriesCourseRequest
+function New-AeriesCourseRequest
 {
     <#
         .SYNOPSIS
         Add a Course Request to Aeries
 
         .DESCRIPTION
-        The Add-AeriesCourseRequest cmdlet is used to add a Course Request in Aeries for a given StudentID and SchoolCode 
+        The New-AeriesCourseRequest cmdlet is used to add a Course Request in Aeries for a given StudentID and SchoolCode 
 
         .EXAMPLE
-        Add-AeriesCourseRequest -SchoolCode 994 -StudentID 99400001 -CourseNumber "123456"
+        New-AeriesCourseRequest -SchoolCode 994 -StudentID 99400001 -CourseNumber "123456"
         This will create a Course Request in Aeries for StudentID 99400001 at SchoolCode 994 with Course Number 123456
     #>
 
+    [Alias("Add-AeriesCourseRequest")]
+
     [CmdletBinding()]
     param (
         [ValidateRange(1, [Int16]::MaxValue)]

diff --git a/.../Public/Add-AeriesGradebookAssignment.ps1 → .../Public/New-AeriesGradebookAssignment.ps1 b/.../Public/Add-AeriesGradebookAssignment.ps1 → .../Public/New-AeriesGradebookAssignment.ps1
@@ -1,17 +1,19 @@
-function Add-AeriesGradebookAssignment
+function New-AeriesGradebookAssignment
 {
     <#
         .SYNOPSIS
         Add a new Gradbook Assignment in Aeries
 
         .DESCRIPTION
-        The Add-AeriesGradebookAssignment cmdlet is used to add a Gradebook Assignment in Aeries
+        The New-AeriesGradebookAssignment cmdlet is used to add a Gradebook Assignment in Aeries
 
         .EXAMPLE
-        Add-AeriesGradebookAssignment -GradebookNumber 123456 -Description "Assignment created from PowerShell"
+        New-AeriesGradebookAssignment -GradebookNumber 123456 -Description "Assignment created from PowerShell"
         This will add a Gradebook Assignment to Aeries
     #>
 
+    [Alias("Add-AeriesGradebookAssignment")]
+
     [CmdletBinding()]
     param (
         [ValidateRange(1, [Int]::MaxValue)]

diff --git a/...pi/Public/Add-AeriesSchedulingSection.ps1 → ...pi/Public/New-AeriesSchedulingSection.ps1 b/...pi/Public/Add-AeriesSchedulingSection.ps1 → ...pi/Public/New-AeriesSchedulingSection.ps1
@@ -1,17 +1,19 @@
-function Add-AeriesSchedulingSection
+function New-AeriesSchedulingSection
 {
     <#
         .SYNOPSIS
         Add a Scheduling Section to Aeries
 
         .DESCRIPTION
-        The Add-AeriesSchedulingSection cmdlet is used to create a Scheduling Section in Aeries for the given SchoolCode
+        The New-AeriesSchedulingSection cmdlet is used to create a Scheduling Section in Aeries for the given SchoolCode
 
         .EXAMPLE
-        Add-AeriesSchedulingSection -SchoolCode 884
+        New-AeriesSchedulingSection -SchoolCode 884 -Semester "F"
         This will create a Schedule Section in Aeries for SchoolCode 884
     #>
 
+    [Alias("Add-AeriesSchedulingSection")]
+
     [CmdletBinding()]
     param (
         [ValidateRange(1, [Int16]::MaxValue)]

diff --git a/AeriesApi/Public/Add-AeriesStaff.ps1 → AeriesApi/Public/New-AeriesStaff.ps1 b/AeriesApi/Public/Add-AeriesStaff.ps1 → AeriesApi/Public/New-AeriesStaff.ps1
@@ -1,18 +1,20 @@
-function Add-AeriesStaff
+function New-AeriesStaff
 {
     <#
         .SYNOPSIS
         Add a new Staff in Aeries
 
         .DESCRIPTION
-        The Add-AeriesStaff cmdlet is used to add a Staff in Aeries
+        The New-AeriesStaff cmdlet is used to add a Staff in Aeries
         No fields are technically required other than StaffID depending on if "auto-generate new staff IDs" is enabled
 
         .EXAMPLE
-        Add-AeriesStaff -StaffID 1 -FirstName "Aeries" -LastName "Software"
+        New-AeriesStaff -StaffID 1 -FirstName "Aeries" -LastName "Software"
         This will add a Staff to Aeries
     #>
 
+    [Alias("Add-AeriesStaff")]
+
     [CmdletBinding()]
     param (
         [ValidateRange(1, [Int]::MaxValue)]

diff --git a/...sApi/Public/Add-AeriesStaffAssignment.ps1 → ...sApi/Public/New-AeriesStaffAssignment.ps1 b/...sApi/Public/Add-AeriesStaffAssignment.ps1 → ...sApi/Public/New-AeriesStaffAssignment.ps1
@@ -1,17 +1,19 @@
-function Add-AeriesStaffAssignment
+function New-AeriesStaffAssignment
 {
     <#
         .SYNOPSIS
         Add a Staff Assignment in Aeries
 
         .DESCRIPTION
-        The Add-AeriesStaffAssignment cmdlet is used to create a Staff Assignment in Aeries
+        The New-AeriesStaffAssignment cmdlet is used to create a Staff Assignment in Aeries
 
         .EXAMPLE
-        Add-AeriesStaffAssignment -StaffID 1 -AssignmentType "classified"
+        New-AeriesStaffAssignment -StaffID 1 -AssignmentType "classified"
         This will create a Staff Assignment for Staff ID 1 with an Assignment Type of "classified" in Aeries
     #>
 
+    [Alias("Add-AeriesStaffAssignment")]
+
     [CmdletBinding()]
     param (
         [ValidateRange(1, [Int]::MaxValue)]

diff --git a/AeriesApi/Public/Add-AeriesStudent.ps1 → AeriesApi/Public/New-AeriesStudent.ps1 b/AeriesApi/Public/Add-AeriesStudent.ps1 → AeriesApi/Public/New-AeriesStudent.ps1
@@ -1,18 +1,20 @@
-function Add-AeriesStudent
+function New-AeriesStudent
 {
     <#
         .SYNOPSIS
         Add a new Student in Aeries
 
         .DESCRIPTION
-        The Add-AeriesStudent cmdlet is used to add a Student for a specific School in Aeries
+        The New-AeriesStudent cmdlet is used to add a Student for a specific School in Aeries
         No fields are technically required other than SchoolCode, but the more you provide the more accurate it will be immediately
 
         .EXAMPLE
-        Add-AeriesStudent -SchoolCode 994 -FirstName "Aeries" -LastName "Software"
+        New-AeriesStudent -SchoolCode 994 -FirstName "Aeries" -LastName "Software"
         This will add a student to the specific School Code in Aeries
     #>
 
+    [Alias("Add-AeriesStudent")]
+
     [CmdletBinding()]
     param (
         [ValidateRange(1, [Int16]::MaxValue)]