@uptime.app/contracts 2.0.37 → 2.0.38

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.
Files changed (10) hide show
  1. package/dist/cjs/user/get-user.d.ts +19 -0
  2. package/dist/cjs/user/get-user.d.ts.map +1 -1
  3. package/dist/cjs/user/get-user.js +19 -0
  4. package/dist/cjs/user/get-user.js.map +1 -1
  5. package/dist/esm/user/get-user.d.ts +19 -0
  6. package/dist/esm/user/get-user.d.ts.map +1 -1
  7. package/dist/esm/user/get-user.js +19 -0
  8. package/dist/esm/user/get-user.js.map +1 -1
  9. package/package.json +2 -2
  10. package/src/user/get-user.ts +19 -0
package/dist/cjs/user/get-user.d.ts CHANGED
@@ -25,9 +25,28 @@ export interface UserResponse {
25
25
  identityProviderId?: string;
26
26
  }
27
27
  export declare enum UserStatus {
28
+ /**
29
+ * User has not yet been created.
30
+ * Requires the frontend to post data to create the user
31
+ * */
28
32
  NEEDS_CREATING = "NEEDS_CREATING",
33
+ /**
34
+ * User is being created.
35
+ * Frontend has sent the required data and the backend is asynchronously processing.
36
+ * Poll and wait for ACTIVE
37
+ * */
29
38
  CREATION_IN_PROGRESS = "CREATION_IN_PROGRESS",
39
+ /**
40
+ * User has been created and should be part of an organisation but the membership has not been processed yet.
41
+ * Poll and wait for ACTIVE
42
+ * */
30
43
  PENDING_ORGANISATION_MEMBERSHIP = "PENDING_ORGANISATION_MEMBERSHIP",
44
+ /**
45
+ * User has been created and should have been issued entitlements but they have not been issued yet.
46
+ * Poll and wait for ACTIVE
47
+ * */
48
+ PENDING_ENTITLEMENTS = "PENDING_ENTITLEMENTS",
49
+ /** All user data is up to date */
31
50
  ACTIVE = "ACTIVE"
32
51
  }
33
52
  export interface UserResponseMembership {
package/dist/cjs/user/get-user.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"get-user.d.ts","sourceRoot":"","sources":["../../../src/user/get-user.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAC;AAC/D,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAEjD,MAAM,WAAW,4BAA4B;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,YAAY;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,OAAO,CAAC;IACrB,MAAM,EAAE,UAAU,CAAC;IACnB,YAAY,EAAE,WAAW,EAAE,CAAC;IAC5B,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,WAAW,EAAE,sBAAsB,EAAE,CAAC;IACtC,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,YAAY,EAAE,OAAO,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yEAAyE;IACzE,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,oBAAY,UAAU;IAClB,cAAc,mBAAmB;IACjC,oBAAoB,yBAAyB;IAC7C,+BAA+B,oCAAoC;IACnE,MAAM,WAAW;CACpB;AAED,MAAM,WAAW,sBAAsB;IACnC,cAAc,EAAE,MAAM,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAClB"}
1
+ {"version":3,"file":"get-user.d.ts","sourceRoot":"","sources":["../../../src/user/get-user.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAC;AAC/D,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAEjD,MAAM,WAAW,4BAA4B;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,YAAY;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,OAAO,CAAC;IACrB,MAAM,EAAE,UAAU,CAAC;IACnB,YAAY,EAAE,WAAW,EAAE,CAAC;IAC5B,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,WAAW,EAAE,sBAAsB,EAAE,CAAC;IACtC,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,YAAY,EAAE,OAAO,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yEAAyE;IACzE,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,oBAAY,UAAU;IAClB;;;SAGK;IACL,cAAc,mBAAmB;IACjC;;;;SAIK;IACL,oBAAoB,yBAAyB;IAC7C;;;SAGK;IACL,+BAA+B,oCAAoC;IACnE;;;SAGK;IACL,oBAAoB,yBAAyB;IAC7C,kCAAkC;IAClC,MAAM,WAAW;CACpB;AAED,MAAM,WAAW,sBAAsB;IACnC,cAAc,EAAE,MAAM,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAClB"}
package/dist/cjs/user/get-user.js CHANGED
@@ -3,9 +3,28 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.UserStatus = void 0;
4
4
  var UserStatus;
5
5
  (function (UserStatus) {
6
+ /**
7
+ * User has not yet been created.
8
+ * Requires the frontend to post data to create the user
9
+ * */
6
10
  UserStatus["NEEDS_CREATING"] = "NEEDS_CREATING";
11
+ /**
12
+ * User is being created.
13
+ * Frontend has sent the required data and the backend is asynchronously processing.
14
+ * Poll and wait for ACTIVE
15
+ * */
7
16
  UserStatus["CREATION_IN_PROGRESS"] = "CREATION_IN_PROGRESS";
17
+ /**
18
+ * User has been created and should be part of an organisation but the membership has not been processed yet.
19
+ * Poll and wait for ACTIVE
20
+ * */
8
21
  UserStatus["PENDING_ORGANISATION_MEMBERSHIP"] = "PENDING_ORGANISATION_MEMBERSHIP";
22
+ /**
23
+ * User has been created and should have been issued entitlements but they have not been issued yet.
24
+ * Poll and wait for ACTIVE
25
+ * */
26
+ UserStatus["PENDING_ENTITLEMENTS"] = "PENDING_ENTITLEMENTS";
27
+ /** All user data is up to date */
9
28
  UserStatus["ACTIVE"] = "ACTIVE";
10
29
  })(UserStatus || (exports.UserStatus = UserStatus = {}));
11
30
  //# sourceMappingURL=get-user.js.map
package/dist/cjs/user/get-user.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"get-user.js","sourceRoot":"","sources":["../../../src/user/get-user.ts"],"names":[],"mappings":";;;AA6BA,IAAY,UAKX;AALD,WAAY,UAAU;IAClB,+CAAiC,CAAA;IACjC,2DAA6C,CAAA;IAC7C,iFAAmE,CAAA;IACnE,+BAAiB,CAAA;AACrB,CAAC,EALW,UAAU,0BAAV,UAAU,QAKrB"}
1
+ {"version":3,"file":"get-user.js","sourceRoot":"","sources":["../../../src/user/get-user.ts"],"names":[],"mappings":";;;AA6BA,IAAY,UAwBX;AAxBD,WAAY,UAAU;IAClB;;;SAGK;IACL,+CAAiC,CAAA;IACjC;;;;SAIK;IACL,2DAA6C,CAAA;IAC7C;;;SAGK;IACL,iFAAmE,CAAA;IACnE;;;SAGK;IACL,2DAA6C,CAAA;IAC7C,kCAAkC;IAClC,+BAAiB,CAAA;AACrB,CAAC,EAxBW,UAAU,0BAAV,UAAU,QAwBrB"}
package/dist/esm/user/get-user.d.ts CHANGED
@@ -25,9 +25,28 @@ export interface UserResponse {
25
25
  identityProviderId?: string;
26
26
  }
27
27
  export declare enum UserStatus {
28
+ /**
29
+ * User has not yet been created.
30
+ * Requires the frontend to post data to create the user
31
+ * */
28
32
  NEEDS_CREATING = "NEEDS_CREATING",
33
+ /**
34
+ * User is being created.
35
+ * Frontend has sent the required data and the backend is asynchronously processing.
36
+ * Poll and wait for ACTIVE
37
+ * */
29
38
  CREATION_IN_PROGRESS = "CREATION_IN_PROGRESS",
39
+ /**
40
+ * User has been created and should be part of an organisation but the membership has not been processed yet.
41
+ * Poll and wait for ACTIVE
42
+ * */
30
43
  PENDING_ORGANISATION_MEMBERSHIP = "PENDING_ORGANISATION_MEMBERSHIP",
44
+ /**
45
+ * User has been created and should have been issued entitlements but they have not been issued yet.
46
+ * Poll and wait for ACTIVE
47
+ * */
48
+ PENDING_ENTITLEMENTS = "PENDING_ENTITLEMENTS",
49
+ /** All user data is up to date */
31
50
  ACTIVE = "ACTIVE"
32
51
  }
33
52
  export interface UserResponseMembership {
package/dist/esm/user/get-user.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"get-user.d.ts","sourceRoot":"","sources":["../../../src/user/get-user.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAC;AAC/D,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAEjD,MAAM,WAAW,4BAA4B;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,YAAY;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,OAAO,CAAC;IACrB,MAAM,EAAE,UAAU,CAAC;IACnB,YAAY,EAAE,WAAW,EAAE,CAAC;IAC5B,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,WAAW,EAAE,sBAAsB,EAAE,CAAC;IACtC,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,YAAY,EAAE,OAAO,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yEAAyE;IACzE,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,oBAAY,UAAU;IAClB,cAAc,mBAAmB;IACjC,oBAAoB,yBAAyB;IAC7C,+BAA+B,oCAAoC;IACnE,MAAM,WAAW;CACpB;AAED,MAAM,WAAW,sBAAsB;IACnC,cAAc,EAAE,MAAM,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAClB"}
1
+ {"version":3,"file":"get-user.d.ts","sourceRoot":"","sources":["../../../src/user/get-user.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAC;AAC/D,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAEjD,MAAM,WAAW,4BAA4B;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,YAAY;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,OAAO,CAAC;IACrB,MAAM,EAAE,UAAU,CAAC;IACnB,YAAY,EAAE,WAAW,EAAE,CAAC;IAC5B,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,WAAW,EAAE,sBAAsB,EAAE,CAAC;IACtC,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,YAAY,EAAE,OAAO,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yEAAyE;IACzE,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,oBAAY,UAAU;IAClB;;;SAGK;IACL,cAAc,mBAAmB;IACjC;;;;SAIK;IACL,oBAAoB,yBAAyB;IAC7C;;;SAGK;IACL,+BAA+B,oCAAoC;IACnE;;;SAGK;IACL,oBAAoB,yBAAyB;IAC7C,kCAAkC;IAClC,MAAM,WAAW;CACpB;AAED,MAAM,WAAW,sBAAsB;IACnC,cAAc,EAAE,MAAM,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAClB"}
package/dist/esm/user/get-user.js CHANGED
@@ -1,8 +1,27 @@
1
1
  export var UserStatus;
2
2
  (function (UserStatus) {
3
+ /**
4
+ * User has not yet been created.
5
+ * Requires the frontend to post data to create the user
6
+ * */
3
7
  UserStatus["NEEDS_CREATING"] = "NEEDS_CREATING";
8
+ /**
9
+ * User is being created.
10
+ * Frontend has sent the required data and the backend is asynchronously processing.
11
+ * Poll and wait for ACTIVE
12
+ * */
4
13
  UserStatus["CREATION_IN_PROGRESS"] = "CREATION_IN_PROGRESS";
14
+ /**
15
+ * User has been created and should be part of an organisation but the membership has not been processed yet.
16
+ * Poll and wait for ACTIVE
17
+ * */
5
18
  UserStatus["PENDING_ORGANISATION_MEMBERSHIP"] = "PENDING_ORGANISATION_MEMBERSHIP";
19
+ /**
20
+ * User has been created and should have been issued entitlements but they have not been issued yet.
21
+ * Poll and wait for ACTIVE
22
+ * */
23
+ UserStatus["PENDING_ENTITLEMENTS"] = "PENDING_ENTITLEMENTS";
24
+ /** All user data is up to date */
6
25
  UserStatus["ACTIVE"] = "ACTIVE";
7
26
  })(UserStatus || (UserStatus = {}));
8
27
  //# sourceMappingURL=get-user.js.map
package/dist/esm/user/get-user.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"get-user.js","sourceRoot":"","sources":["../../../src/user/get-user.ts"],"names":[],"mappings":"AA6BA,MAAM,CAAN,IAAY,UAKX;AALD,WAAY,UAAU;IAClB,+CAAiC,CAAA;IACjC,2DAA6C,CAAA;IAC7C,iFAAmE,CAAA;IACnE,+BAAiB,CAAA;AACrB,CAAC,EALW,UAAU,KAAV,UAAU,QAKrB"}
1
+ {"version":3,"file":"get-user.js","sourceRoot":"","sources":["../../../src/user/get-user.ts"],"names":[],"mappings":"AA6BA,MAAM,CAAN,IAAY,UAwBX;AAxBD,WAAY,UAAU;IAClB;;;SAGK;IACL,+CAAiC,CAAA;IACjC;;;;SAIK;IACL,2DAA6C,CAAA;IAC7C;;;SAGK;IACL,iFAAmE,CAAA;IACnE;;;SAGK;IACL,2DAA6C,CAAA;IAC7C,kCAAkC;IAClC,+BAAiB,CAAA;AACrB,CAAC,EAxBW,UAAU,KAAV,UAAU,QAwBrB"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uptime.app/contracts",
3
- "version": "2.0.37",
3
+ "version": "2.0.38",
4
4
  "license": "MIT",
5
5
  "types": "./dist/esm/index.d.ts",
6
6
  "main": "./dist/cjs/index.js",
@@ -14,5 +14,5 @@
14
14
  "devDependencies": {
15
15
  "typescript": "^5.4.3"
16
16
  },
17
- "gitHead": "4f00b19debd06f8b1330d7471807d66b2635565f"
17
+ "gitHead": "13c92b2a9f4c835356a0500faaa5a3664194dcf4"
18
18
  }
package/src/user/get-user.ts CHANGED
@@ -28,9 +28,28 @@ export interface UserResponse {
28
28
  }
29
29
 
30
30
  export enum UserStatus {
31
+ /**
32
+ * User has not yet been created.
33
+ * Requires the frontend to post data to create the user
34
+ * */
31
35
  NEEDS_CREATING = 'NEEDS_CREATING',
36
+ /**
37
+ * User is being created.
38
+ * Frontend has sent the required data and the backend is asynchronously processing.
39
+ * Poll and wait for ACTIVE
40
+ * */
32
41
  CREATION_IN_PROGRESS = 'CREATION_IN_PROGRESS',
42
+ /**
43
+ * User has been created and should be part of an organisation but the membership has not been processed yet.
44
+ * Poll and wait for ACTIVE
45
+ * */
33
46
  PENDING_ORGANISATION_MEMBERSHIP = 'PENDING_ORGANISATION_MEMBERSHIP',
47
+ /**
48
+ * User has been created and should have been issued entitlements but they have not been issued yet.
49
+ * Poll and wait for ACTIVE
50
+ * */
51
+ PENDING_ENTITLEMENTS = 'PENDING_ENTITLEMENTS',
52
+ /** All user data is up to date */
34
53
  ACTIVE = 'ACTIVE',
35
54
  }
36
55