-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
905bb53
commit 065f2cb
Showing
110 changed files
with
5,791 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# Specify files that shouldn't be modified by Fern |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
name: ci | ||
|
||
on: [push] | ||
|
||
jobs: | ||
compile: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout repo | ||
uses: actions/checkout@v3 | ||
|
||
- name: Set up node | ||
uses: actions/setup-node@v3 | ||
|
||
- name: Compile | ||
run: yarn && yarn build | ||
|
||
test: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout repo | ||
uses: actions/checkout@v3 | ||
|
||
- name: Set up node | ||
uses: actions/setup-node@v3 | ||
|
||
- name: Compile | ||
run: yarn && yarn test | ||
|
||
publish: | ||
needs: [ compile, test ] | ||
if: github.event_name == 'push' && contains(github.ref, 'refs/tags/') | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout repo | ||
uses: actions/checkout@v3 | ||
|
||
- name: Set up node | ||
uses: actions/setup-node@v3 | ||
|
||
- name: Install dependencies | ||
run: yarn install | ||
|
||
- name: Build | ||
run: yarn build |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
node_modules | ||
.DS_Store | ||
/dist |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
node_modules | ||
src | ||
tests | ||
.gitignore | ||
.github | ||
.fernignore | ||
.prettierrc.yml | ||
tsconfig.json | ||
yarn.lock |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
tabWidth: 4 | ||
printWidth: 120 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
/** @type {import('jest').Config} */ | ||
module.exports = { | ||
preset: "ts-jest", | ||
testEnvironment: "node", | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
{ | ||
"name": "", | ||
"version": "0.0.1", | ||
"private": false, | ||
"repository": "https://github.com/fern-demo/ssoready-typescript", | ||
"main": "./index.js", | ||
"types": "./index.d.ts", | ||
"scripts": { | ||
"format": "prettier . --write --ignore-unknown", | ||
"build": "tsc", | ||
"prepack": "cp -rv dist/. .", | ||
"test": "jest" | ||
}, | ||
"dependencies": { | ||
"url-join": "4.0.1", | ||
"form-data": "4.0.0", | ||
"formdata-node": "^6.0.3", | ||
"node-fetch": "2.7.0", | ||
"qs": "6.11.2", | ||
"js-base64": "3.7.2" | ||
}, | ||
"devDependencies": { | ||
"@types/url-join": "4.0.1", | ||
"@types/qs": "6.9.8", | ||
"@types/node-fetch": "2.6.9", | ||
"jest": "29.7.0", | ||
"@types/jest": "29.5.5", | ||
"ts-jest": "29.1.1", | ||
"jest-environment-jsdom": "29.7.0", | ||
"@types/node": "17.0.33", | ||
"prettier": "2.7.1", | ||
"typescript": "4.6.4" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,172 @@ | ||
## Saml | ||
|
||
<details><summary> <code>ssoReady.saml.<a href="./src/api/resources/saml/client/Client.ts">redeemAccessCode</a>({ ...params }) -> SSOReady.RedeemSamlAccessCodeResponse</code> </summary> | ||
|
||
<dl> | ||
|
||
<dd> | ||
|
||
#### 📝 Description | ||
|
||
<dl> | ||
|
||
<dd> | ||
|
||
<dl> | ||
|
||
<dd> | ||
|
||
Exchange a SAML access code for details about a SAML login. | ||
|
||
</dd> | ||
|
||
</dl> | ||
|
||
</dd> | ||
|
||
</dl> | ||
|
||
#### 🔌 Usage | ||
|
||
<dl> | ||
|
||
<dd> | ||
|
||
<dl> | ||
|
||
<dd> | ||
|
||
```ts | ||
await ssoReady.saml.redeemAccessCode({ | ||
samlAccessCode: "saml_access_code_94d90b43a2027a9084bfc792", | ||
}); | ||
``` | ||
|
||
</dd> | ||
|
||
</dl> | ||
|
||
</dd> | ||
|
||
</dl> | ||
|
||
#### ⚙️ Parameters | ||
|
||
<dl> | ||
|
||
<dd> | ||
|
||
<dl> | ||
|
||
<dd> | ||
|
||
**request: `SSOReady.RedeemSamlAccessCodeRequest`** | ||
|
||
</dd> | ||
|
||
</dl> | ||
|
||
<dl> | ||
|
||
<dd> | ||
|
||
**requestOptions: `Saml.RequestOptions`** | ||
|
||
</dd> | ||
|
||
</dl> | ||
|
||
</dd> | ||
|
||
</dl> | ||
|
||
</dd> | ||
|
||
</dl> | ||
</details> | ||
|
||
<details><summary> <code>ssoReady.saml.<a href="./src/api/resources/saml/client/Client.ts">getRedirectUrl</a>({ ...params }) -> SSOReady.GetSamlRedirectUrlResponse</code> </summary> | ||
|
||
<dl> | ||
|
||
<dd> | ||
|
||
#### 📝 Description | ||
|
||
<dl> | ||
|
||
<dd> | ||
|
||
<dl> | ||
|
||
<dd> | ||
|
||
Get a URL to initiate a SAML login. | ||
|
||
</dd> | ||
|
||
</dl> | ||
|
||
</dd> | ||
|
||
</dl> | ||
|
||
#### 🔌 Usage | ||
|
||
<dl> | ||
|
||
<dd> | ||
|
||
<dl> | ||
|
||
<dd> | ||
|
||
```ts | ||
await ssoReady.saml.getRedirectUrl({ | ||
samlConnectionId: "saml_conn_ac3bzzoqhaa88ozk29hhv12l", | ||
organizationId: "org_7cu5hsy9vrbi5d2k1qvbh19lj", | ||
}); | ||
``` | ||
|
||
</dd> | ||
|
||
</dl> | ||
|
||
</dd> | ||
|
||
</dl> | ||
|
||
#### ⚙️ Parameters | ||
|
||
<dl> | ||
|
||
<dd> | ||
|
||
<dl> | ||
|
||
<dd> | ||
|
||
**request: `SSOReady.GetSamlRedirectUrlRequest`** | ||
|
||
</dd> | ||
|
||
</dl> | ||
|
||
<dl> | ||
|
||
<dd> | ||
|
||
**requestOptions: `Saml.RequestOptions`** | ||
|
||
</dd> | ||
|
||
</dl> | ||
|
||
</dd> | ||
|
||
</dl> | ||
|
||
</dd> | ||
|
||
</dl> | ||
</details> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
/** | ||
* This file was auto-generated by Fern from our API Definition. | ||
*/ | ||
|
||
import * as environments from "./environments"; | ||
import * as core from "./core"; | ||
import { Saml } from "./api/resources/saml/client/Client"; | ||
|
||
export declare namespace SSOReadyClient { | ||
interface Options { | ||
environment?: core.Supplier<environments.SSOReadyEnvironment | string>; | ||
apiKey?: core.Supplier<core.BearerToken | undefined>; | ||
fetcher?: core.FetchFunction; | ||
} | ||
|
||
interface RequestOptions { | ||
timeoutInSeconds?: number; | ||
maxRetries?: number; | ||
} | ||
} | ||
|
||
export class SSOReadyClient { | ||
constructor(protected readonly _options: SSOReadyClient.Options = {}) {} | ||
|
||
protected _saml: Saml | undefined; | ||
|
||
public get saml(): Saml { | ||
return (this._saml ??= new Saml(this._options)); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
export * from "./types"; | ||
export * from "./resources"; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
export * as saml from "./saml"; | ||
export * from "./saml/client/requests"; |
Oops, something went wrong.