@or-sdk/contacts 4.7.2 → 4.7.3-beta.4119.0

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.
@@ -1,4 +1,7 @@
1
1
  import { ApiErrorOptions, ApiError as BaseApiError } from '@or-sdk/base';
2
+ /**
3
+ * Common parent for all api errors
4
+ */
2
5
  export declare class ApiError extends BaseApiError {
3
6
  readonly statusCode: number;
4
7
  readonly stack?: string | undefined;
@@ -1 +1 @@
1
- {"version":3,"file":"apiError.d.ts","sourceRoot":"","sources":["../../src/apiError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,QAAQ,IAAI,YAAY,EAAE,MAAM,cAAc,CAAC;AAKzE,qBAAa,QAAS,SAAQ,YAAY;aAEtB,UAAU,EAAE,MAAM;aAElB,KAAK,CAAC,EAAE,MAAM;aACd,cAAc,CAAC,EAAE,MAAM;gBAHvB,UAAU,EAAE,MAAM,EAClC,OAAO,EAAE,MAAM,EACC,KAAK,CAAC,EAAE,MAAM,YAAA,EACd,cAAc,CAAC,EAAE,MAAM,YAAA,EACvC,OAAO,CAAC,EAAE,eAAe;CAO5B;AAED,qBAAa,wBAAyB,SAAQ,YAAY;aAGtC,aAAa,EAAE,MAAM;aACrB,aAAa,CAAC,EAAE,MAAM,EAAE;IACjC,iBAAiB,CAAC,EAAE,MAAM,EAAE;gBAHnC,OAAO,EAAE,MAAM,EACC,aAAa,EAAE,MAAM,EACrB,aAAa,CAAC,EAAE,MAAM,EAAE,YAAA,EACjC,iBAAiB,CAAC,EAAE,MAAM,EAAE,YAAA,EACnC,OAAO,CAAC,EAAE,eAAe;CAI5B"}
1
+ {"version":3,"file":"apiError.d.ts","sourceRoot":"","sources":["../../src/apiError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,QAAQ,IAAI,YAAY,EAAE,MAAM,cAAc,CAAC;AAEzE;;GAEG;AACH,qBAAa,QAAS,SAAQ,YAAY;aAEtB,UAAU,EAAE,MAAM;aAElB,KAAK,CAAC,EAAE,MAAM;aACd,cAAc,CAAC,EAAE,MAAM;gBAHvB,UAAU,EAAE,MAAM,EAClC,OAAO,EAAE,MAAM,EACC,KAAK,CAAC,EAAE,MAAM,YAAA,EACd,cAAc,CAAC,EAAE,MAAM,YAAA,EACvC,OAAO,CAAC,EAAE,eAAe;CAO5B;AAED,qBAAa,wBAAyB,SAAQ,YAAY;aAGtC,aAAa,EAAE,MAAM;aACrB,aAAa,CAAC,EAAE,MAAM,EAAE;IACjC,iBAAiB,CAAC,EAAE,MAAM,EAAE;gBAHnC,OAAO,EAAE,MAAM,EACC,aAAa,EAAE,MAAM,EACrB,aAAa,CAAC,EAAE,MAAM,EAAE,YAAA,EACjC,iBAAiB,CAAC,EAAE,MAAM,EAAE,YAAA,EACnC,OAAO,CAAC,EAAE,eAAe;CAI5B"}
@@ -5,12 +5,33 @@ type OptionalBy<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
5
5
  export { OrderDirection, PaginationOptions, OrderOptions } from '@or-sdk/base';
6
6
  type DbVersionsMismatchCallback = (targetVersion: string, originVersion: string) => void;
7
7
  export type ContactsConfig = {
8
+ /**
9
+ * token
10
+ */
8
11
  token: Token;
12
+ /**
13
+ * function which return token
14
+ */
9
15
  discoveryUrl?: string;
16
+ /**
17
+ * Url of OneReach Contacts api
18
+ */
10
19
  contactsApiUrl?: string;
11
20
  accountId?: string;
21
+ /**
22
+ * If true, keep alive agents will be used.
23
+ * Use this setting if long-time running scripts supposed to
24
+ * make many requests, for example for bulk operations.
25
+ */
12
26
  withKeepAliveAgents?: boolean;
27
+ /**
28
+ * If true, the API error details like request url, params and body,
29
+ * will be outputted to console
30
+ */
13
31
  withApiErrorLog?: boolean;
32
+ /**
33
+ * Function to be called at detecting db versions mismatch
34
+ */
14
35
  dbVersionMismatchCallback?: DbVersionsMismatchCallback;
15
36
  };
16
37
  export interface ContactBookParams extends AdaptedListParams<ContactBookParamsDto> {
@@ -52,7 +73,18 @@ export type BulkLogger = {
52
73
  log: (message?: unknown, ...optionalParams: unknown[]) => void;
53
74
  };
54
75
  export type BulkOptions = {
76
+ /**
77
+ * Sets the limit in bytes for the JSON body size to be processed by a single bulk batch.
78
+ * Can be used for decreasing DB server load.
79
+ * Default is 4000000 bytes, or approximately 4mb.
80
+ *
81
+ * @see REQUEST_PAYLOAD_MAX_BYTES in packages/contacts/src/constants.ts
82
+ */
55
83
  batchSize?: number;
84
+ /**
85
+ * Sets the amount of parallel batches. Default is 4.
86
+ * Use it to tune workload to the DB server and to the machine executing bulk
87
+ */
56
88
  parallelBatchesAmount?: number;
57
89
  batchesToProcess?: number;
58
90
  polingDuration?: number;
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,cAAc,EACd,oBAAoB,EACpB,oBAAoB,EACpB,oBAAoB,EACpB,2BAA2B,EAC3B,aAAa,EACb,WAAW,EACX,oBAAoB,EACrB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACtE,cAAc,8BAA8B,CAAC;AAE7C,KAAK,UAAU,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAGzE,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAE/E,KAAK,0BAA0B,GAAG,CAAC,aAAa,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,KAAK,IAAI,CAAC;AAEzF,MAAM,MAAM,cAAc,GAAG;IAI3B,KAAK,EAAE,KAAK,CAAC;IAKb,YAAY,CAAC,EAAE,MAAM,CAAC;IAKtB,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,SAAS,CAAC,EAAE,MAAM,CAAC;IAOnB,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAM9B,eAAe,CAAC,EAAE,OAAO,CAAC;IAK1B,yBAAyB,CAAC,EAAE,0BAA0B,CAAC;CACxD,CAAC;AAEF,MAAM,WAAW,iBAAkB,SAAQ,iBAAiB,CAAC,oBAAoB,CAAC;IAChF,aAAa,CAAC,EAAE,OAAO,GAAG,YAAY,GAAG,YAAY,CAAC;CACvD;AAED,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,aAAa,GAAG,WAAW,IACjE,IAAI,CAAC,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC,GAAG,OAAO,CAAC,iBAAiB,GAAG,YAAY,CAAC,CAAC;AAEjF,MAAM,MAAM,0BAA0B,GAAE;IACtC,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,EAAE,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC,2BAA2B,EAAE,KAAK,CAAC,GAAG;IAAE,GAAG,CAAC,EAAE,OAAO,CAAC;CAAC,CAAC;AAEpG,MAAM,MAAM,yBAAyB,GAAG;IACtC,MAAM,EAAE,kBAAkB,CAAC;IAC3B,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG,oBAAoB,GAAG;IAAC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CAAC,CAAC;AAErF,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,oBAAoB,EAAE,SAAS,GAAG,cAAc,GAAG,UAAU,CAAC,GAC9F;IAAE,QAAQ,EAAE,UAAU,CAAC,cAAc,EAAE,YAAY,CAAC,EAAE,CAAC;CAAE,CAAC;AAE5D,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,oBAAoB,EAAE,SAAS,GAAG,cAAc,CAAC,CAAC;AAEzF,MAAM,MAAM,yBAAyB,GAAG,mBAAmB,GAAG;IAAE,QAAQ,EAAE,MAAM,CAAC;CAAE,CAAC;AAEpF,MAAM,MAAM,iBAAiB,GAAG;IAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAAC,CAAC;AAEnG,MAAM,MAAM,UAAU,GAAG;IACvB,GAAG,EAAE,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,cAAc,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;CAChE,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IAQxB,SAAS,CAAC,EAAE,MAAM,CAAC;IAKnB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,6BAA6B,CAAC,EAAE,MAAM,CAAC;IACvC,MAAM,CAAC,EAAE,UAAU,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,MAAM,CAAC;IACzB,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,UAAU,GAAG,SAAS,CAAC;IAC7B,OAAO,EAAE,YAAY,GAAG,oBAAoB,CAAC;CAC9C,CAAC"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,cAAc,EACd,oBAAoB,EACpB,oBAAoB,EACpB,oBAAoB,EACpB,2BAA2B,EAC3B,aAAa,EACb,WAAW,EACX,oBAAoB,EACrB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACtE,cAAc,8BAA8B,CAAC;AAE7C,KAAK,UAAU,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAGzE,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAE/E,KAAK,0BAA0B,GAAG,CAAC,aAAa,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,KAAK,IAAI,CAAC;AAEzF,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IAEb;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,yBAAyB,CAAC,EAAE,0BAA0B,CAAC;CACxD,CAAC;AAEF,MAAM,WAAW,iBAAkB,SAAQ,iBAAiB,CAAC,oBAAoB,CAAC;IAChF,aAAa,CAAC,EAAE,OAAO,GAAG,YAAY,GAAG,YAAY,CAAC;CACvD;AAED,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,aAAa,GAAG,WAAW,IACjE,IAAI,CAAC,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC,GAAG,OAAO,CAAC,iBAAiB,GAAG,YAAY,CAAC,CAAC;AAEjF,MAAM,MAAM,0BAA0B,GAAE;IACtC,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,EAAE,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC,2BAA2B,EAAE,KAAK,CAAC,GAAG;IAAE,GAAG,CAAC,EAAE,OAAO,CAAC;CAAC,CAAC;AAEpG,MAAM,MAAM,yBAAyB,GAAG;IACtC,MAAM,EAAE,kBAAkB,CAAC;IAC3B,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG,oBAAoB,GAAG;IAAC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CAAC,CAAC;AAErF,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,oBAAoB,EAAE,SAAS,GAAG,cAAc,GAAG,UAAU,CAAC,GAC9F;IAAE,QAAQ,EAAE,UAAU,CAAC,cAAc,EAAE,YAAY,CAAC,EAAE,CAAC;CAAE,CAAC;AAE5D,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,oBAAoB,EAAE,SAAS,GAAG,cAAc,CAAC,CAAC;AAEzF,MAAM,MAAM,yBAAyB,GAAG,mBAAmB,GAAG;IAAE,QAAQ,EAAE,MAAM,CAAC;CAAE,CAAC;AAEpF,MAAM,MAAM,iBAAiB,GAAG;IAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAAC,CAAC;AAEnG,MAAM,MAAM,UAAU,GAAG;IACvB,GAAG,EAAE,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,cAAc,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;CAChE,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,6BAA6B,CAAC,EAAE,MAAM,CAAC;IACvC,MAAM,CAAC,EAAE,UAAU,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,MAAM,CAAC;IACzB,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,UAAU,GAAG,SAAS,CAAC;IAC7B,OAAO,EAAE,YAAY,GAAG,oBAAoB,CAAC;CAC9C,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@or-sdk/contacts",
3
- "version": "4.7.2",
3
+ "version": "4.7.3-beta.4119.0",
4
4
  "license": "Apache-2.0",
5
5
  "main": "dist/cjs/index.js",
6
6
  "module": "dist/esm/index.js",
@@ -22,7 +22,7 @@
22
22
  },
23
23
  "dependencies": {
24
24
  "@onereach/types-contacts-api": "5.40.14",
25
- "@or-sdk/base": "^0.44.1",
25
+ "@or-sdk/base": "^0.44.2-beta.4119.0",
26
26
  "agentkeepalive": "^4.5.0",
27
27
  "uuid": "^8.3.2"
28
28
  },
@@ -33,6 +33,5 @@
33
33
  },
34
34
  "publishConfig": {
35
35
  "access": "public"
36
- },
37
- "gitHead": "86de10f6cf0ed69410c43aacc6ea678d3d5fa717"
36
+ }
38
37
  }