ReferralRockPS - a PowerShell module for the Referral Rock API

This PowerShell module is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• SDK version: 0.1.2
• Generator version: 7.11.0
• Build package: org.openapitools.codegen.languages.PowerShellClientCodegen

Frameworks supported

• PowerShell 6.2 or later

Dependencies

Installation

To install from the source, run the following command to build and install the PowerShell module locally:

Build.ps1
Import-Module -Name '.\src\ReferralRockPS' -Verbose

To avoid function name collision, one can use -Prefix, e.g. Import-Module -Name '.\src\ReferralRockPS' -Prefix prefix

To uninstall the module, simply run:

Remove-Module -FullyQualifiedName @{ModuleName = "ReferralRockPS"; ModuleVersion = "0.1.2"}

Tests

To install and run Pester, please execute the following commands in the terminal:

Install-module -name Pester -force

Invoke-Pester

For troubleshooting, please run $DebugPreference = 'Continue' to turn on debugging and disable it with $DebugPreference = 'SilentlyContinue' when done with the troubleshooting.

Documentation for API Endpoints

All URIs are relative to https://api.referralrock.com

Class	Method	HTTP request	Description
ReferralRockDefaultApi	Invoke-ReferralRockApiEmailGetunsubscribedGet	GET /api/email/getunsubscribed	Get Unsubscribed
ReferralRockDefaultApi	Invoke-ReferralRockApiEmailRemoveunsubscribePost	POST /api/email/removeunsubscribe	Remove Unsubscribe
ReferralRockDefaultApi	Invoke-ReferralRockApiEmailUnsubscribePost	POST /api/email/unsubscribe	Unsubscribe
ReferralRockDefaultApi	Invoke-ReferralRockApiEventPost	POST /api/event	Integration Log
ReferralRockDefaultApi	Invoke-ReferralRockApiHooksDelete	DELETE /api/hooks	Hooks
ReferralRockDefaultApi	Invoke-ReferralRockApiHooksHistoryEventNameGet	GET /api/Hooks/History/{eventName}	Hooks History
ReferralRockDefaultApi	Invoke-ReferralRockApiHooksPost	POST /api/hooks	Hooks
ReferralRockDefaultApi	Invoke-ReferralRockApiInvitefeedPost	POST /api/invitefeed	Invite Feed
ReferralRockDefaultApi	Invoke-ReferralRockApiInvitefeedsPost	POST /api/invitefeeds	Invite Feeds
ReferralRockDefaultApi	Invoke-ReferralRockApiMemberaccessPost	POST /api/memberaccess	Member Access
ReferralRockDefaultApi	Invoke-ReferralRockApiMemberaccessurlsPost	POST /api/memberaccessurls	Member Access URLs by externalId
ReferralRockDefaultApi	Invoke-ReferralRockApiMembersGet	GET /api/members	Members
ReferralRockDefaultApi	Invoke-ReferralRockApiMembersPost	POST /api/members	Members
ReferralRockDefaultApi	Invoke-ReferralRockApiMembersRemovePost	POST /api/members/remove	Remove Members
ReferralRockDefaultApi	Invoke-ReferralRockApiMembersUpdatePost	POST /api/members/Update	Update Members
ReferralRockDefaultApi	Invoke-ReferralRockApiPayoutsAddPost	POST /api/payouts/add	Create Payout
ReferralRockDefaultApi	Invoke-ReferralRockApiPayoutsPayoutIdGet	GET /api/payouts/{payoutId}	Payout
ReferralRockDefaultApi	Invoke-ReferralRockApiPayoutsPendingGet	GET /api/payouts/pending	Payouts Pending
ReferralRockDefaultApi	Invoke-ReferralRockApiPayoutsTransactionsGet	GET /api/payouts/transactions	Payout Transactions
ReferralRockDefaultApi	Invoke-ReferralRockApiPayoutsTransactionsPost	POST /api/payouts/transactions	Issue Payout Transactions
ReferralRockDefaultApi	Invoke-ReferralRockApiProgramCreatePost	POST /api/program/create	Create Program
ReferralRockDefaultApi	Invoke-ReferralRockApiProgramGetsingleGet	GET /api/program/getsingle	Program Single
ReferralRockDefaultApi	Invoke-ReferralRockApiProgramsGet	GET /api/programs	Programs
ReferralRockDefaultApi	Invoke-ReferralRockApiReferralRemovePost	POST /api/referral/remove	Remove Referral
ReferralRockDefaultApi	Invoke-ReferralRockApiReferralSingleGet	GET /api/referral/single	Referral Single
ReferralRockDefaultApi	Invoke-ReferralRockApiReferralUpdatePost	POST /api/referral/Update	Update Referral
ReferralRockDefaultApi	Invoke-ReferralRockApiReferralsGet	GET /api/referrals	Referrals
ReferralRockDefaultApi	Invoke-ReferralRockApiReferralsPost	POST /api/referrals	Referrals
ReferralRockDefaultApi	Invoke-ReferralRockApiReferralsStatusPost	POST /api/referrals/status	Referrals - Update Status
ReferralRockDefaultApi	Invoke-ReferralRockApiRewardrulesGet	GET /api/rewardrules	Rewards Rules
ReferralRockDefaultApi	Invoke-ReferralRockApiRewardsGet	GET /api/rewards	Rewards
ReferralRockDefaultApi	Invoke-ReferralRockApiRewardsIssuePost	POST /api/rewards/issue	Issue Reward
ReferralRockDefaultApi	Invoke-ReferralRockApiRewardsPost	POST /api/rewards	Rewards
ReferralRockDefaultApi	Invoke-ReferralRockApiRewardsRemovePost	POST /api/rewards/remove	Remove Reward
ReferralRockDefaultApi	Invoke-ReferralRockApiRewardsUpdatePost	POST /api/rewards/update	Update Rewards

Documentation for Models

Documentation for Authorization

Basic authorization header is required. Authorization header is "Basic (Base64 encoded [Public Api Key]:[Private Api key]"