@or-sdk/invitations 1.4.1-beta.4012.0 → 1.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,14 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [1.4.1](https://gitlab.internal.onereach.io/onereach/platform/or-sdk-next/compare/@or-sdk/invitations@1.4.0...@or-sdk/invitations@1.4.1) (2026-02-25)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @or-sdk/invitations
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
6
14
|
## [1.4.0](https://gitlab.internal.onereach.io/onereach/platform/or-sdk-next/compare/@or-sdk/invitations@1.3.6...@or-sdk/invitations@1.4.0) (2026-02-24)
|
|
7
15
|
|
|
8
16
|
|
|
@@ -1,10 +1,45 @@
|
|
|
1
1
|
import { InvitationsConfig, InvitationCreatePayload, InvitationResponse, ApproveInvitationPayload, ListInvitationsParams } from './types';
|
|
2
|
+
/**
|
|
3
|
+
* OneReach Invitations service client
|
|
4
|
+
* ## Installation:
|
|
5
|
+
* ```
|
|
6
|
+
* $ npm i @or-sdk/invitations
|
|
7
|
+
* ```
|
|
8
|
+
*/
|
|
2
9
|
export declare class Invitations {
|
|
3
10
|
private readonly users;
|
|
11
|
+
/**
|
|
12
|
+
* ```typescript
|
|
13
|
+
* import { Invitations } from '@or-sdk/invitations'
|
|
14
|
+
* const invitations = new Invitations({token: 'my-account-token-string', discoveryUrl: 'http://example.tables/endpoint'});
|
|
15
|
+
* ```
|
|
16
|
+
*/
|
|
4
17
|
constructor(params: InvitationsConfig);
|
|
18
|
+
/**
|
|
19
|
+
* Creates a new invitation.
|
|
20
|
+
* @param payload - The invitation creation payload.
|
|
21
|
+
* @returns A promise that resolves to the created InvitationResponse.
|
|
22
|
+
*/
|
|
5
23
|
createInvitation(payload: InvitationCreatePayload): Promise<InvitationResponse>;
|
|
24
|
+
/**
|
|
25
|
+
* Lists all invitations.
|
|
26
|
+
* @param params - Optional parameters for listing invitations including pagination and sorting.
|
|
27
|
+
* @returns A promise that resolves to an array of InvitationResponse objects.
|
|
28
|
+
*/
|
|
6
29
|
listInvitations(params?: ListInvitationsParams): Promise<InvitationResponse[]>;
|
|
30
|
+
/**
|
|
31
|
+
* Approves an invitation.
|
|
32
|
+
* @param invitationId - The ID of the invitation to approve.
|
|
33
|
+
* @param payload - The payload containing any additional data required to approve the invitation.
|
|
34
|
+
* @returns A promise that resolves to the updated InvitationResponse.
|
|
35
|
+
*/
|
|
7
36
|
approveInvitation(invitationId: string, payload: ApproveInvitationPayload): Promise<InvitationResponse>;
|
|
37
|
+
/**
|
|
38
|
+
* Deletes an invitation.
|
|
39
|
+
* @param invitationId - The ID of the invitation to delete.
|
|
40
|
+
* @param notifyEmail - should user receive email.
|
|
41
|
+
* @returns A promise that resolves when the invitation has been deleted.
|
|
42
|
+
*/
|
|
8
43
|
deleteInvitation(invitationId: string, notifyEmail?: boolean): Promise<void>;
|
|
9
44
|
}
|
|
10
45
|
//# sourceMappingURL=Invitations.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Invitations.d.ts","sourceRoot":"","sources":["../../src/Invitations.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,iBAAiB,EACjB,uBAAuB,EACvB,kBAAkB,EAClB,wBAAwB,EACxB,qBAAqB,EACtB,MAAM,SAAS,CAAC;
|
|
1
|
+
{"version":3,"file":"Invitations.d.ts","sourceRoot":"","sources":["../../src/Invitations.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,iBAAiB,EACjB,uBAAuB,EACvB,kBAAkB,EAClB,wBAAwB,EACxB,qBAAqB,EACtB,MAAM,SAAS,CAAC;AAEjB;;;;;;GAMG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAQ;IAC9B;;;;;OAKG;gBACS,MAAM,EAAE,iBAAiB;IAIrC;;;;OAIG;IACU,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAS5F;;;;OAIG;IACU,eAAe,CAAC,MAAM,GAAS,qBAAqB,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;IAgBjG;;;;;OAKG;IACU,iBAAiB,CAC5B,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,kBAAkB,CAAC;IAQ9B;;;;;OAKG;IACU,gBAAgB,CAAC,YAAY,EAAE,MAAM,EAAE,WAAW,UAAO;CAOvE"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@or-sdk/invitations",
|
|
3
|
-
"version": "1.4.1
|
|
3
|
+
"version": "1.4.1",
|
|
4
4
|
"license": "Apache-2.0",
|
|
5
5
|
"main": "dist/cjs/index.js",
|
|
6
6
|
"module": "dist/esm/index.js",
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
"dev": "pnpm build:watch:esm"
|
|
19
19
|
},
|
|
20
20
|
"dependencies": {
|
|
21
|
-
"@or-sdk/users": "^3.7.1
|
|
21
|
+
"@or-sdk/users": "^3.7.1"
|
|
22
22
|
},
|
|
23
23
|
"devDependencies": {
|
|
24
24
|
"concurrently": "9.0.1",
|
|
@@ -26,5 +26,6 @@
|
|
|
26
26
|
},
|
|
27
27
|
"publishConfig": {
|
|
28
28
|
"access": "public"
|
|
29
|
-
}
|
|
29
|
+
},
|
|
30
|
+
"gitHead": "7d3b49250a670964dfe9e8e50e95417761c5473f"
|
|
30
31
|
}
|