@or-sdk/idw-public 1.6.2-beta.4098.0 → 1.6.2

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 (6) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/dist/types/IdwPublic.d.ts +98 -0
  3. package/dist/types/IdwPublic.d.ts.map +1 -1
  4. package/dist/types/schemas/IDWPublicConstructorParams.d.ts +15 -0
  5. package/dist/types/schemas/IDWPublicConstructorParams.d.ts.map +1 -1
  6. package/package.json +4 -3
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.6.2](https://gitlab.internal.onereach.io/onereach/platform/or-sdk-next/compare/@or-sdk/idw-public@1.6.1...@or-sdk/idw-public@1.6.2) (2026-04-22)
7
+
8
+ **Note:** Version bump only for package @or-sdk/idw-public
9
+
10
+
11
+
12
+
13
+
6
14
  ## [1.6.1](https://gitlab.internal.onereach.io/onereach/platform/or-sdk-next/compare/@or-sdk/idw-public@1.6.0...@or-sdk/idw-public@1.6.1) (2026-02-25)
7
15
 
8
16
  **Note:** Version bump only for package @or-sdk/idw-public
package/dist/types/IdwPublic.d.ts CHANGED
@@ -4,10 +4,108 @@ export declare class IdwPublic {
4
4
  private readonly idwProviderNameSpace;
5
5
  private readonly validate;
6
6
  constructor(params: IDWPublicConfig);
7
+ /**
8
+ * Get extended public info about IDW with statistic
9
+ *
10
+ * ```typescript
11
+ * const client = new IdwPublic({
12
+ * serviceDiscoveryUrl: 'https://service-discovery-url',
13
+ * });
14
+ * const idwInfo = await client.getIdwInfoWithStatistic({ idwSlug: 'idw-slug' });
15
+ * ```
16
+ *
17
+ * To prevent validation of params and response use `validate` option:
18
+ *
19
+ * ```typescript
20
+ * const client = new IdwPublic({
21
+ * serviceDiscoveryUrl: 'https://service-discovery-url',
22
+ * validate: false,
23
+ * });
24
+ * const idwInfo = await client.getIdwInfoWithStatistic({ idwSlug: 'idw-slug' });
25
+ * ```
26
+ */
7
27
  getIdwInfoWithStatistic(params: IdwPublicParams): Promise<IdwPublicInfoWithStatistic>;
28
+ /**
29
+ * Get list of active channels
30
+ *
31
+ * ```typescript
32
+ * const client = new IdwPublic({
33
+ * serviceDiscoveryUrl: 'https://service-discovery-url',
34
+ * });
35
+ * const activeChannels = await client.getActiveChannels({ idwSlug: 'idw-slug' });
36
+ * ```
37
+ *
38
+ * To prevent validation of params and response use `validate` option:
39
+ *
40
+ * ```typescript
41
+ * const client = new IdwPublic({
42
+ * serviceDiscoveryUrl: 'https://service-discovery-url',
43
+ * validate: false,
44
+ * });
45
+ * const activeChannels = await client.getActiveChannels({ idwSlug: 'idw-slug' });
46
+ * ```
47
+ */
8
48
  getActiveChannels(params: IdwPublicParams): Promise<IdwPublicChannelList>;
49
+ /**
50
+ * Get complete list of channels
51
+ *
52
+ * ```typescript
53
+ * const client = new IdwPublic({
54
+ * serviceDiscoveryUrl: 'https://service-discovery-url',
55
+ * });
56
+ * const allChannels = await client.getAllChannels({ idwSlug: 'idw-slug' });
57
+ * ```
58
+ *
59
+ * To prevent validation of params and response use `validate` option:
60
+ *
61
+ * ```typescript
62
+ * const client = new IdwPublic({
63
+ * serviceDiscoveryUrl: 'https://service-discovery-url',
64
+ * validate: false,
65
+ * });
66
+ * const allChannels = await client.getAllChannels({ idwSlug: 'idw-slug' });
67
+ * ```
68
+ */
9
69
  getAllChannels(params: IdwPublicParams): Promise<IdwPublicChannelList>;
70
+ /**
71
+ * Get complete list of skills
72
+ *
73
+ * ```typescript
74
+ * const client = new IdwPublic({
75
+ * serviceDiscoveryUrl: 'https://service-discovery-url',
76
+ * });
77
+ * const allSkills = await client.getSkills({ idwSlug: 'idw-slug' });
78
+ * ```
79
+ *
80
+ * To prevent validation of params and response use `validate` option:
81
+ * ```typescript
82
+ * const client = new IdwPublic({
83
+ * serviceDiscoveryUrl: 'https://service-discovery-url',
84
+ * validate: false,
85
+ * });
86
+ * const allSkills = await client.getSkills({ idwSlug: 'idw-slug' });
87
+ * ```
88
+ */
10
89
  getSkills(params: IdwPublicParams): Promise<IdwPublicSkillList>;
90
+ /**
91
+ * Get IDW vCard
92
+ *
93
+ * ```typescript
94
+ * const client = new IdwPublic({
95
+ * serviceDiscoveryUrl: 'https://service-discovery-url',
96
+ * });
97
+ * const vCard = await client.getIdwVcf({ idwSlug: 'idw-slug' });
98
+ * ```
99
+ *
100
+ * To prevent validation of params and response use `validate` option:
101
+ * ```typescript
102
+ * const client = new IdwPublic({
103
+ * serviceDiscoveryUrl: 'https://service-discovery-url',
104
+ * validate: false,
105
+ * });
106
+ * const vCard = await client.getIdwVcf({ idwSlug: 'idw-slug' });
107
+ * ```
108
+ */
11
109
  getIdwVcf(params: IdwPublicParams): Promise<string>;
12
110
  private requestWithValidation;
13
111
  private buildRoute;
package/dist/types/IdwPublic.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"IdwPublic.d.ts","sourceRoot":"","sources":["../../src/IdwPublic.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,eAAe,EACf,eAAe,EACf,0BAA0B,EAC1B,oBAAoB,EACpB,kBAAkB,EACnB,MAAM,WAAW,CAAC;AAKnB,qBAAa,SAAS;IACpB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAY;IACrC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAS;IAC9C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAU;gBAEvB,MAAM,EAAE,eAAe;IAkCtB,uBAAuB,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAgCrF,iBAAiB,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAgCzE,cAAc,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,oBAAoB,CAAC;IA+BtE,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,kBAAkB,CAAC;IA+B/D,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC;YAelD,qBAAqB;IAenC,OAAO,CAAC,UAAU;CAGnB"}
1
+ {"version":3,"file":"IdwPublic.d.ts","sourceRoot":"","sources":["../../src/IdwPublic.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,eAAe,EACf,eAAe,EACf,0BAA0B,EAC1B,oBAAoB,EACpB,kBAAkB,EACnB,MAAM,WAAW,CAAC;AAKnB,qBAAa,SAAS;IACpB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAY;IACrC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAS;IAC9C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAU;gBAEvB,MAAM,EAAE,eAAe;IAcnC;;;;;;;;;;;;;;;;;;;OAmBG;IACU,uBAAuB,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAYlG;;;;;;;;;;;;;;;;;;;OAmBG;IACU,iBAAiB,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAYtF;;;;;;;;;;;;;;;;;;;OAmBG;IACU,cAAc,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAYnF;;;;;;;;;;;;;;;;;;OAkBG;IACU,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAY5E;;;;;;;;;;;;;;;;;;OAkBG;IACU,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC;YAelD,qBAAqB;IAenC,OAAO,CAAC,UAAU;CAGnB"}
package/dist/types/schemas/IDWPublicConstructorParams.d.ts CHANGED
@@ -1,9 +1,24 @@
1
1
  import { z } from 'zod';
2
2
  export declare const IDWPublicConfig: z.ZodIntersection<z.ZodObject<{
3
+ /**
4
+ * Event Manager url
5
+ */
3
6
  emUrl: z.ZodOptional<z.ZodString>;
7
+ /**
8
+ * Service Discovery url
9
+ */
4
10
  serviceDiscoveryUrl: z.ZodOptional<z.ZodString>;
11
+ /**
12
+ * Provides OneReach account ID
13
+ */
5
14
  providerAccountId: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodLiteral<"provider">]>>;
15
+ /**
16
+ * Provider NameSpace
17
+ */
6
18
  idwProviderNameSpace: z.ZodOptional<z.ZodString>;
19
+ /**
20
+ * Validate params and responses
21
+ */
7
22
  validate: z.ZodOptional<z.ZodBoolean>;
8
23
  }, "strip", z.ZodTypeAny, {
9
24
  emUrl?: string | undefined;
package/dist/types/schemas/IDWPublicConstructorParams.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"IDWPublicConstructorParams.d.ts","sourceRoot":"","sources":["../../../src/schemas/IDWPublicConstructorParams.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAwCqE,CAAC;AAClG,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC"}
1
+ {"version":3,"file":"IDWPublicConstructorParams.d.ts","sourceRoot":"","sources":["../../../src/schemas/IDWPublicConstructorParams.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,eAAe;IAExB;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAgB0F,CAAC;AAClG,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@or-sdk/idw-public",
3
- "version": "1.6.2-beta.4098.0",
3
+ "version": "1.6.2",
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/providers": "^0.3.2-beta.4098.0",
21
+ "@or-sdk/providers": "^0.3.2",
22
22
  "zod": "^3.22.4"
23
23
  },
24
24
  "devDependencies": {
@@ -27,5 +27,6 @@
27
27
  },
28
28
  "publishConfig": {
29
29
  "access": "public"
30
- }
30
+ },
31
+ "gitHead": "86de10f6cf0ed69410c43aacc6ea678d3d5fa717"
31
32
  }