https://github.com/joelst/referralrock-powershell

Small Referral Rock API PowerShell module
https://github.com/joelst/referralrock-powershell
client powershell powershell-module referral-rock web-api
Last synced: 7 months ago
JSON representation
Small Referral Rock API PowerShell module
Host: GitHub
URL: https://github.com/joelst/referralrock-powershell
Owner: joelst
Created: 2025-02-04T23:45:55.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2025-02-05T02:39:55.000Z (about 1 year ago)
Last Synced: 2025-06-25T08:04:57.718Z (9 months ago)
Topics: client, powershell, powershell-module, referral-rock, web-api
Language: PowerShell
Homepage:
Size: 30.3 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
Awesome Lists containing this project

README

          # ReferralRockPS - a PowerShell module for the Referral Rock API

This PowerShell module is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) 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:

```powershell

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:

```powershell

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

```

## Tests

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

```powershell

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**](docs/ReferralRockDefaultApi.md#Invoke-ReferralRockApiEmailGetunsubscribedGet) | **GET** /api/email/getunsubscribed | Get Unsubscribed

*ReferralRockDefaultApi* | [**Invoke-ReferralRockApiEmailRemoveunsubscribePost**](docs/ReferralRockDefaultApi.md#Invoke-ReferralRockApiEmailRemoveunsubscribePost) | **POST** /api/email/removeunsubscribe | Remove Unsubscribe

*ReferralRockDefaultApi* | [**Invoke-ReferralRockApiEmailUnsubscribePost**](docs/ReferralRockDefaultApi.md#Invoke-ReferralRockApiEmailUnsubscribePost) | **POST** /api/email/unsubscribe | Unsubscribe

*ReferralRockDefaultApi* | [**Invoke-ReferralRockApiEventPost**](docs/ReferralRockDefaultApi.md#Invoke-ReferralRockApiEventPost) | **POST** /api/event | Integration Log

*ReferralRockDefaultApi* | [**Invoke-ReferralRockApiHooksDelete**](docs/ReferralRockDefaultApi.md#Invoke-ReferralRockApiHooksDelete) | **DELETE** /api/hooks | Hooks

*ReferralRockDefaultApi* | [**Invoke-ReferralRockApiHooksHistoryEventNameGet**](docs/ReferralRockDefaultApi.md#Invoke-ReferralRockApiHooksHistoryEventNameGet) | **GET** /api/Hooks/History/{eventName} | Hooks History

*ReferralRockDefaultApi* | [**Invoke-ReferralRockApiHooksPost**](docs/ReferralRockDefaultApi.md#Invoke-ReferralRockApiHooksPost) | **POST** /api/hooks | Hooks

*ReferralRockDefaultApi* | [**Invoke-ReferralRockApiInvitefeedPost**](docs/ReferralRockDefaultApi.md#Invoke-ReferralRockApiInvitefeedPost) | **POST** /api/invitefeed | Invite Feed

*ReferralRockDefaultApi* | [**Invoke-ReferralRockApiInvitefeedsPost**](docs/ReferralRockDefaultApi.md#Invoke-ReferralRockApiInvitefeedsPost) | **POST** /api/invitefeeds | Invite Feeds

*ReferralRockDefaultApi* | [**Invoke-ReferralRockApiMemberaccessPost**](docs/ReferralRockDefaultApi.md#Invoke-ReferralRockApiMemberaccessPost) | **POST** /api/memberaccess | Member Access

*ReferralRockDefaultApi* | [**Invoke-ReferralRockApiMemberaccessurlsPost**](docs/ReferralRockDefaultApi.md#Invoke-ReferralRockApiMemberaccessurlsPost) | **POST** /api/memberaccessurls | Member Access URLs by externalId

*ReferralRockDefaultApi* | [**Invoke-ReferralRockApiMembersGet**](docs/ReferralRockDefaultApi.md#Invoke-ReferralRockApiMembersGet) | **GET** /api/members | Members

*ReferralRockDefaultApi* | [**Invoke-ReferralRockApiMembersPost**](docs/ReferralRockDefaultApi.md#Invoke-ReferralRockApiMembersPost) | **POST** /api/members | Members

*ReferralRockDefaultApi* | [**Invoke-ReferralRockApiMembersRemovePost**](docs/ReferralRockDefaultApi.md#Invoke-ReferralRockApiMembersRemovePost) | **POST** /api/members/remove | Remove Members

*ReferralRockDefaultApi* | [**Invoke-ReferralRockApiMembersUpdatePost**](docs/ReferralRockDefaultApi.md#Invoke-ReferralRockApiMembersUpdatePost) | **POST** /api/members/Update | Update Members

*ReferralRockDefaultApi* | [**Invoke-ReferralRockApiPayoutsAddPost**](docs/ReferralRockDefaultApi.md#Invoke-ReferralRockApiPayoutsAddPost) | **POST** /api/payouts/add | Create Payout

*ReferralRockDefaultApi* | [**Invoke-ReferralRockApiPayoutsPayoutIdGet**](docs/ReferralRockDefaultApi.md#Invoke-ReferralRockApiPayoutsPayoutIdGet) | **GET** /api/payouts/{payoutId} | Payout

*ReferralRockDefaultApi* | [**Invoke-ReferralRockApiPayoutsPendingGet**](docs/ReferralRockDefaultApi.md#Invoke-ReferralRockApiPayoutsPendingGet) | **GET** /api/payouts/pending | Payouts Pending

*ReferralRockDefaultApi* | [**Invoke-ReferralRockApiPayoutsTransactionsGet**](docs/ReferralRockDefaultApi.md#Invoke-ReferralRockApiPayoutsTransactionsGet) | **GET** /api/payouts/transactions | Payout Transactions

*ReferralRockDefaultApi* | [**Invoke-ReferralRockApiPayoutsTransactionsPost**](docs/ReferralRockDefaultApi.md#Invoke-ReferralRockApiPayoutsTransactionsPost) | **POST** /api/payouts/transactions | Issue Payout Transactions

*ReferralRockDefaultApi* | [**Invoke-ReferralRockApiProgramCreatePost**](docs/ReferralRockDefaultApi.md#Invoke-ReferralRockApiProgramCreatePost) | **POST** /api/program/create | Create Program

*ReferralRockDefaultApi* | [**Invoke-ReferralRockApiProgramGetsingleGet**](docs/ReferralRockDefaultApi.md#Invoke-ReferralRockApiProgramGetsingleGet) | **GET** /api/program/getsingle | Program Single

*ReferralRockDefaultApi* | [**Invoke-ReferralRockApiProgramsGet**](docs/ReferralRockDefaultApi.md#Invoke-ReferralRockApiProgramsGet) | **GET** /api/programs | Programs

*ReferralRockDefaultApi* | [**Invoke-ReferralRockApiReferralRemovePost**](docs/ReferralRockDefaultApi.md#Invoke-ReferralRockApiReferralRemovePost) | **POST** /api/referral/remove | Remove Referral

*ReferralRockDefaultApi* | [**Invoke-ReferralRockApiReferralSingleGet**](docs/ReferralRockDefaultApi.md#Invoke-ReferralRockApiReferralSingleGet) | **GET** /api/referral/single | Referral Single

*ReferralRockDefaultApi* | [**Invoke-ReferralRockApiReferralUpdatePost**](docs/ReferralRockDefaultApi.md#Invoke-ReferralRockApiReferralUpdatePost) | **POST** /api/referral/Update | Update Referral

*ReferralRockDefaultApi* | [**Invoke-ReferralRockApiReferralsGet**](docs/ReferralRockDefaultApi.md#Invoke-ReferralRockApiReferralsGet) | **GET** /api/referrals | Referrals

*ReferralRockDefaultApi* | [**Invoke-ReferralRockApiReferralsPost**](docs/ReferralRockDefaultApi.md#Invoke-ReferralRockApiReferralsPost) | **POST** /api/referrals | Referrals

*ReferralRockDefaultApi* | [**Invoke-ReferralRockApiReferralsStatusPost**](docs/ReferralRockDefaultApi.md#Invoke-ReferralRockApiReferralsStatusPost) | **POST** /api/referrals/status | Referrals - Update Status

*ReferralRockDefaultApi* | [**Invoke-ReferralRockApiRewardrulesGet**](docs/ReferralRockDefaultApi.md#Invoke-ReferralRockApiRewardrulesGet) | **GET** /api/rewardrules | Rewards Rules

*ReferralRockDefaultApi* | [**Invoke-ReferralRockApiRewardsGet**](docs/ReferralRockDefaultApi.md#Invoke-ReferralRockApiRewardsGet) | **GET** /api/rewards | Rewards

*ReferralRockDefaultApi* | [**Invoke-ReferralRockApiRewardsIssuePost**](docs/ReferralRockDefaultApi.md#Invoke-ReferralRockApiRewardsIssuePost) | **POST** /api/rewards/issue | Issue Reward

*ReferralRockDefaultApi* | [**Invoke-ReferralRockApiRewardsPost**](docs/ReferralRockDefaultApi.md#Invoke-ReferralRockApiRewardsPost) | **POST** /api/rewards | Rewards

*ReferralRockDefaultApi* | [**Invoke-ReferralRockApiRewardsRemovePost**](docs/ReferralRockDefaultApi.md#Invoke-ReferralRockApiRewardsRemovePost) | **POST** /api/rewards/remove | Remove Reward

*ReferralRockDefaultApi* | [**Invoke-ReferralRockApiRewardsUpdatePost**](docs/ReferralRockDefaultApi.md#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]"`
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/joelst/referralrock-powershell

Awesome Lists containing this project

README
