@arrowsphere/api-client 3.118.0 → 3.119.0-rc-bdj.3

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 (3) hide show
  1. package/build/partner/partnerClient.d.ts +38 -0
  2. package/build/partner/partnerClient.js +54 -1
  3. package/package.json +1 -1
package/build/partner/partnerClient.d.ts CHANGED
@@ -1,5 +1,43 @@
1
1
  import { AbstractRestfulClient, Parameters } from '../abstractRestfulClient';
2
+ export declare enum UpdateUserActionEnum {
3
+ ALLOW_DIRECT_LOGIN = "allow-direct-login",
4
+ BLOCK_DIRECT_LOGIN = "block-direct-login",
5
+ DISABLE_ALIAS = "disable-alias",
6
+ LOCK = "lock",
7
+ DISABLE_MFA = "remove-mfa",
8
+ UNLOCK = "unlock",
9
+ UNLOCK_INSECURE_LOGIN = "unlock-insecure-login",
10
+ VALIDATE = "validate"
11
+ }
12
+ export declare enum PatchUserPayloadFields {
13
+ COLUMN_FIRSTNAME = "firstname",
14
+ COLUMN_LASTNAME = "lastname",
15
+ COLUMN_PHONE = "phone",
16
+ COLUMN_TITLE = "title",
17
+ COLUMN_IS_LOCKED = "isLocked",
18
+ COLUMN_ORGANIZATION_UNIT_REF = "organizationUnitRef",
19
+ COLUMN_ACTION = "action",
20
+ COLUMN_ALIAS_USERNAME = "aliasUsername"
21
+ }
22
+ export declare type PatchUserPayload = {
23
+ [PatchUserPayloadFields.COLUMN_FIRSTNAME]?: string;
24
+ [PatchUserPayloadFields.COLUMN_LASTNAME]?: string;
25
+ [PatchUserPayloadFields.COLUMN_PHONE]?: string;
26
+ [PatchUserPayloadFields.COLUMN_TITLE]?: string;
27
+ [PatchUserPayloadFields.COLUMN_ORGANIZATION_UNIT_REF]?: string;
28
+ [PatchUserPayloadFields.COLUMN_ACTION]?: string;
29
+ [PatchUserPayloadFields.COLUMN_ALIAS_USERNAME]?: string;
30
+ };
2
31
  export declare class PartnerClient extends AbstractRestfulClient {
3
32
  protected basePath: string;
4
33
  deletePartner(partnerReference: string, parameters?: Parameters): Promise<void>;
34
+ patchUser(partnerReference: string, userReference: string, payload: PatchUserPayload, parameters?: Parameters): Promise<void>;
35
+ lockUser(partnerReference: string, userReference: string, parameters?: Parameters): Promise<void>;
36
+ unlockUser(partnerReference: string, userReference: string, parameters?: Parameters): Promise<void>;
37
+ allowDirectLoginUser(partnerReference: string, userReference: string, parameters?: Parameters): Promise<void>;
38
+ blockDirectLoginUser(partnerReference: string, userReference: string, parameters?: Parameters): Promise<void>;
39
+ disableMfaUser(partnerReference: string, userReference: string, parameters?: Parameters): Promise<void>;
40
+ disableAliasUser(partnerReference: string, userReference: string, aliasUsername: string, parameters?: Parameters): Promise<void>;
41
+ unlockInsecureLoginUser(partnerReference: string, userReference: string, parameters?: Parameters): Promise<void>;
42
+ validateUser(partnerReference: string, userReference: string, parameters?: Parameters): Promise<void>;
5
43
  }
package/build/partner/partnerClient.js CHANGED
@@ -1,7 +1,29 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.PartnerClient = void 0;
3
+ exports.PartnerClient = exports.PatchUserPayloadFields = exports.UpdateUserActionEnum = void 0;
4
4
  const abstractRestfulClient_1 = require("../abstractRestfulClient");
5
+ var UpdateUserActionEnum;
6
+ (function (UpdateUserActionEnum) {
7
+ UpdateUserActionEnum["ALLOW_DIRECT_LOGIN"] = "allow-direct-login";
8
+ UpdateUserActionEnum["BLOCK_DIRECT_LOGIN"] = "block-direct-login";
9
+ UpdateUserActionEnum["DISABLE_ALIAS"] = "disable-alias";
10
+ UpdateUserActionEnum["LOCK"] = "lock";
11
+ UpdateUserActionEnum["DISABLE_MFA"] = "remove-mfa";
12
+ UpdateUserActionEnum["UNLOCK"] = "unlock";
13
+ UpdateUserActionEnum["UNLOCK_INSECURE_LOGIN"] = "unlock-insecure-login";
14
+ UpdateUserActionEnum["VALIDATE"] = "validate";
15
+ })(UpdateUserActionEnum = exports.UpdateUserActionEnum || (exports.UpdateUserActionEnum = {}));
16
+ var PatchUserPayloadFields;
17
+ (function (PatchUserPayloadFields) {
18
+ PatchUserPayloadFields["COLUMN_FIRSTNAME"] = "firstname";
19
+ PatchUserPayloadFields["COLUMN_LASTNAME"] = "lastname";
20
+ PatchUserPayloadFields["COLUMN_PHONE"] = "phone";
21
+ PatchUserPayloadFields["COLUMN_TITLE"] = "title";
22
+ PatchUserPayloadFields["COLUMN_IS_LOCKED"] = "isLocked";
23
+ PatchUserPayloadFields["COLUMN_ORGANIZATION_UNIT_REF"] = "organizationUnitRef";
24
+ PatchUserPayloadFields["COLUMN_ACTION"] = "action";
25
+ PatchUserPayloadFields["COLUMN_ALIAS_USERNAME"] = "aliasUsername";
26
+ })(PatchUserPayloadFields = exports.PatchUserPayloadFields || (exports.PatchUserPayloadFields = {}));
5
27
  class PartnerClient extends abstractRestfulClient_1.AbstractRestfulClient {
6
28
  constructor() {
7
29
  super(...arguments);
@@ -11,6 +33,37 @@ class PartnerClient extends abstractRestfulClient_1.AbstractRestfulClient {
11
33
  this.path = `/${partnerReference}`;
12
34
  return this.delete(parameters);
13
35
  }
36
+ async patchUser(partnerReference, userReference, payload, parameters = {}) {
37
+ this.path = `/${partnerReference}/users/${userReference}`;
38
+ return await this.patch(payload, parameters);
39
+ }
40
+ async lockUser(partnerReference, userReference, parameters = {}) {
41
+ return await this.patchUser(partnerReference, userReference, { action: UpdateUserActionEnum.LOCK }, parameters);
42
+ }
43
+ async unlockUser(partnerReference, userReference, parameters = {}) {
44
+ return await this.patchUser(partnerReference, userReference, { action: UpdateUserActionEnum.UNLOCK }, parameters);
45
+ }
46
+ async allowDirectLoginUser(partnerReference, userReference, parameters = {}) {
47
+ return await this.patchUser(partnerReference, userReference, { action: UpdateUserActionEnum.ALLOW_DIRECT_LOGIN }, parameters);
48
+ }
49
+ async blockDirectLoginUser(partnerReference, userReference, parameters = {}) {
50
+ return await this.patchUser(partnerReference, userReference, { action: UpdateUserActionEnum.BLOCK_DIRECT_LOGIN }, parameters);
51
+ }
52
+ async disableMfaUser(partnerReference, userReference, parameters = {}) {
53
+ return await this.patchUser(partnerReference, userReference, { action: UpdateUserActionEnum.DISABLE_MFA }, parameters);
54
+ }
55
+ async disableAliasUser(partnerReference, userReference, aliasUsername, parameters = {}) {
56
+ return await this.patchUser(partnerReference, userReference, {
57
+ action: UpdateUserActionEnum.DISABLE_ALIAS,
58
+ aliasUsername,
59
+ }, parameters);
60
+ }
61
+ async unlockInsecureLoginUser(partnerReference, userReference, parameters = {}) {
62
+ return await this.patchUser(partnerReference, userReference, { action: UpdateUserActionEnum.UNLOCK_INSECURE_LOGIN }, parameters);
63
+ }
64
+ async validateUser(partnerReference, userReference, parameters = {}) {
65
+ return await this.patchUser(partnerReference, userReference, { action: UpdateUserActionEnum.VALIDATE }, parameters);
66
+ }
14
67
  }
15
68
  exports.PartnerClient = PartnerClient;
16
69
  //# sourceMappingURL=partnerClient.js.map
package/package.json CHANGED
@@ -4,7 +4,7 @@
4
4
  "type": "git",
5
5
  "url": "https://github.com/ArrowSphere/nodejs-api-client.git"
6
6
  },
7
- "version": "3.118.0",
7
+ "version": "3.119.0-rc-bdj.3",
8
8
  "description": "Node.js client for ArrowSphere's public API",
9
9
  "main": "build/index.js",
10
10
  "types": "build/index.d.ts",