@epilot/sdk 2.20.55 → 2.20.57
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/README.md +1 -0
- package/definitions/integration-toolkit.json +133 -16
- package/definitions/phone-integration-runtime.json +1 -0
- package/definitions/phone-integration.json +315 -0
- package/dist/README-EMWLD7LT.cjs +7 -0
- package/dist/README-XH3ZUZQC.js +7 -0
- package/dist/{_index-HL3HOTXB.js → _index-67F3SDWD.js} +3 -0
- package/dist/{_index-DEYTKG4Z.cjs → _index-GOK37TZ4.cjs} +4 -1
- package/dist/apis/access-token.cjs +11 -7
- package/dist/apis/access-token.js +7 -3
- package/dist/apis/address-suggestions.cjs +11 -7
- package/dist/apis/address-suggestions.js +7 -3
- package/dist/apis/address.cjs +11 -7
- package/dist/apis/address.js +7 -3
- package/dist/apis/ai-agents.cjs +11 -7
- package/dist/apis/ai-agents.js +7 -3
- package/dist/apis/app.cjs +11 -7
- package/dist/apis/app.js +7 -3
- package/dist/apis/audit-logs.cjs +11 -7
- package/dist/apis/audit-logs.js +7 -3
- package/dist/apis/automation.cjs +11 -7
- package/dist/apis/automation.js +7 -3
- package/dist/apis/billing.cjs +11 -7
- package/dist/apis/billing.js +7 -3
- package/dist/apis/blueprint-manifest.cjs +11 -7
- package/dist/apis/blueprint-manifest.js +7 -3
- package/dist/apis/calendar.cjs +11 -7
- package/dist/apis/calendar.js +7 -3
- package/dist/apis/chat.cjs +11 -7
- package/dist/apis/chat.js +7 -3
- package/dist/apis/configuration-hub.cjs +11 -7
- package/dist/apis/configuration-hub.js +7 -3
- package/dist/apis/consent.cjs +11 -7
- package/dist/apis/consent.js +7 -3
- package/dist/apis/customer-portal.cjs +11 -7
- package/dist/apis/customer-portal.js +7 -3
- package/dist/apis/dashboard.cjs +11 -7
- package/dist/apis/dashboard.js +7 -3
- package/dist/apis/data-governance.cjs +11 -7
- package/dist/apis/data-governance.js +7 -3
- package/dist/apis/deduplication.cjs +11 -7
- package/dist/apis/deduplication.js +7 -3
- package/dist/apis/design.cjs +11 -7
- package/dist/apis/design.js +7 -3
- package/dist/apis/document.cjs +11 -7
- package/dist/apis/document.js +7 -3
- package/dist/apis/email-settings.cjs +11 -7
- package/dist/apis/email-settings.js +7 -3
- package/dist/apis/email-template.cjs +11 -7
- package/dist/apis/email-template.js +7 -3
- package/dist/apis/entity-mapping.cjs +11 -7
- package/dist/apis/entity-mapping.js +7 -3
- package/dist/apis/entity.cjs +11 -7
- package/dist/apis/entity.js +7 -3
- package/dist/apis/environments.cjs +11 -7
- package/dist/apis/environments.js +7 -3
- package/dist/apis/event-catalog.cjs +11 -7
- package/dist/apis/event-catalog.js +7 -3
- package/dist/apis/external-values.cjs +11 -7
- package/dist/apis/external-values.js +7 -3
- package/dist/apis/file.cjs +11 -7
- package/dist/apis/file.js +7 -3
- package/dist/apis/iban.cjs +11 -7
- package/dist/apis/iban.js +7 -3
- package/dist/apis/identity.cjs +11 -7
- package/dist/apis/identity.js +7 -3
- package/dist/apis/integration-toolkit.cjs +11 -7
- package/dist/apis/integration-toolkit.d.cts +2 -2
- package/dist/apis/integration-toolkit.d.ts +2 -2
- package/dist/apis/integration-toolkit.js +7 -3
- package/dist/apis/journey.cjs +11 -7
- package/dist/apis/journey.js +7 -3
- package/dist/apis/kanban.cjs +11 -7
- package/dist/apis/kanban.js +7 -3
- package/dist/apis/message.cjs +11 -7
- package/dist/apis/message.js +7 -3
- package/dist/apis/metering.cjs +11 -7
- package/dist/apis/metering.js +7 -3
- package/dist/apis/notes.cjs +11 -7
- package/dist/apis/notes.js +7 -3
- package/dist/apis/notification.cjs +11 -7
- package/dist/apis/notification.js +7 -3
- package/dist/apis/organization.cjs +11 -7
- package/dist/apis/organization.js +7 -3
- package/dist/apis/partner-directory.cjs +11 -7
- package/dist/apis/partner-directory.js +7 -3
- package/dist/apis/permissions.cjs +11 -7
- package/dist/apis/permissions.js +7 -3
- package/dist/apis/phone-integration.cjs +42 -0
- package/dist/apis/phone-integration.d.cts +18 -0
- package/dist/apis/phone-integration.d.ts +18 -0
- package/dist/apis/phone-integration.js +42 -0
- package/dist/apis/pricing-tier.cjs +11 -7
- package/dist/apis/pricing-tier.js +7 -3
- package/dist/apis/pricing.cjs +11 -7
- package/dist/apis/pricing.js +7 -3
- package/dist/apis/purpose.cjs +11 -7
- package/dist/apis/purpose.js +7 -3
- package/dist/apis/query.cjs +11 -7
- package/dist/apis/query.js +7 -3
- package/dist/apis/sandbox.cjs +11 -7
- package/dist/apis/sandbox.js +7 -3
- package/dist/apis/sharing.cjs +11 -7
- package/dist/apis/sharing.js +7 -3
- package/dist/apis/snapshot.cjs +11 -7
- package/dist/apis/snapshot.js +7 -3
- package/dist/apis/submission.cjs +11 -7
- package/dist/apis/submission.js +7 -3
- package/dist/apis/target.cjs +11 -7
- package/dist/apis/target.js +7 -3
- package/dist/apis/targeting.cjs +11 -7
- package/dist/apis/targeting.js +7 -3
- package/dist/apis/template-variables.cjs +11 -7
- package/dist/apis/template-variables.js +7 -3
- package/dist/apis/user.cjs +11 -7
- package/dist/apis/user.js +7 -3
- package/dist/apis/validation-rules.cjs +11 -7
- package/dist/apis/validation-rules.js +7 -3
- package/dist/apis/webhooks.cjs +11 -7
- package/dist/apis/webhooks.js +7 -3
- package/dist/apis/workflow-definition.cjs +11 -7
- package/dist/apis/workflow-definition.js +7 -3
- package/dist/apis/workflow.cjs +11 -7
- package/dist/apis/workflow.js +7 -3
- package/dist/{chunk-KHUBKRKC.js → chunk-7G7ZIF7P.js} +5 -3
- package/dist/chunk-BY76NFAX.cjs +14 -0
- package/dist/{chunk-DPQXCUG4.cjs → chunk-IPYKWRRK.cjs} +5 -3
- package/dist/chunk-UFMZ4EV3.js +14 -0
- package/dist/index.cjs +29 -14
- package/dist/index.d.cts +33 -31
- package/dist/index.d.ts +33 -31
- package/dist/index.js +23 -8
- package/dist/integration-toolkit-3J7KVCK7.cjs +7 -0
- package/dist/integration-toolkit-CV2AU2R7.js +7 -0
- package/dist/{integration-toolkit.d-CLlaZx6b.d.cts → integration-toolkit.d-DWslwG3c.d.cts} +71 -6
- package/dist/{integration-toolkit.d-CLlaZx6b.d.ts → integration-toolkit.d-DWslwG3c.d.ts} +71 -6
- package/dist/phone-integration-JT2UAOGS.cjs +7 -0
- package/dist/phone-integration-KORLYUBG.js +7 -0
- package/dist/phone-integration-runtime-27B4SHA5.js +5 -0
- package/dist/phone-integration-runtime-DFA6NYNK.cjs +5 -0
- package/dist/phone-integration.d-ChHA2oGI.d.cts +179 -0
- package/dist/phone-integration.d-ChHA2oGI.d.ts +179 -0
- package/docs/integration-toolkit.md +41 -7
- package/docs/phone-integration.md +148 -0
- package/package.json +10 -1
- package/dist/README-B6X6BXAW.cjs +0 -7
- package/dist/README-LE2VBY2Y.js +0 -7
- package/dist/integration-toolkit-CG6SFVKC.cjs +0 -7
- package/dist/integration-toolkit-TLIEE3DY.js +0 -7
|
@@ -2990,8 +2990,23 @@ declare namespace Components {
|
|
|
2990
2990
|
* individual rows.
|
|
2991
2991
|
*
|
|
2992
2992
|
* `code` is the translation key and the other fields are its parameters — there is
|
|
2993
|
-
* deliberately no message to display. Each code appears at most once
|
|
2994
|
-
* everything it has to say aggregated
|
|
2993
|
+
* deliberately no message to display. Each code appears at most once (once per
|
|
2994
|
+
* `expected` for `VALUE_FORMAT_INVALID`), with everything it has to say aggregated
|
|
2995
|
+
* into that one entry.
|
|
2996
|
+
*
|
|
2997
|
+
* `VALUE_FORMAT_INVALID` — the mapping produces values in a format the entity schema
|
|
2998
|
+
* does not store; `expected` says which format, and `columns` names every column
|
|
2999
|
+
* (or, for a value built by an expression, the attribute) that holds one.
|
|
3000
|
+
*
|
|
3001
|
+
* `MAPPING_EXPRESSION_FAILED` (a warning) — a mapping expression failed for some rows,
|
|
3002
|
+
* including `$number()` on a value it cannot convert such as `12,50` or on a blank cell,
|
|
3003
|
+
* so importing anyway leaves those values out; `attributes` names the attribute it fills.
|
|
3004
|
+
*
|
|
3005
|
+
* `FROM_ROWS_EXPRESSION_FAILED` — an expression in a `conditional.from_rows` item failed
|
|
3006
|
+
* for some rows. Blocking, unlike a field: the import would skip every entry of that
|
|
3007
|
+
* target built in the same chunk, not one value; `attributes` names the list attribute.
|
|
3008
|
+
*
|
|
3009
|
+
* `lines` points at up to five file lines an issue was seen on, as examples.
|
|
2995
3010
|
*
|
|
2996
3011
|
* The conditional codes describe a file that cannot be written as variants:
|
|
2997
3012
|
*
|
|
@@ -3019,7 +3034,7 @@ declare namespace Components {
|
|
|
3019
3034
|
* Enum of possible issue codes.
|
|
3020
3035
|
*
|
|
3021
3036
|
*/
|
|
3022
|
-
code: "UNIQUE_ID_COLUMN_MISSING" | "MAPPED_COLUMN_MISSING" | "MALFORMED_ROW" | "INVALID_ENCODING" | "EMPTY_FILE" | "TOO_MANY_ROWS" | "BLANK_ROWS_SKIPPED" | "TIER_ROWS_NOT_GROUPED" | "TIER_BANDS_CONFLICT" | "CONDITION_VALUE_MISSING" | "VARIANT_VALUE_CONFLICT" | "ATTRIBUTE_NOT_OVERRIDABLE" | "ATTRIBUTE_NOT_IN_SCHEMA" | "IS_CONDITIONAL_NOT_CONSTANT" | "SCHEMA_NOT_CONDITIONABLE" | "SCHEMA_NOT_FOUND" | "SCHEMA_DECLARES_NO_CONDITIONS" | "GROUPING_KEY_NOT_A_COLUMN" | "GROUPING_KEY_IS_SORT_COLUMN" | "CONDITIONAL_TARGET_MODE_UNSUPPORTED";
|
|
3037
|
+
code: "UNIQUE_ID_COLUMN_MISSING" | "MAPPED_COLUMN_MISSING" | "MALFORMED_ROW" | "INVALID_ENCODING" | "EMPTY_FILE" | "TOO_MANY_ROWS" | "BLANK_ROWS_SKIPPED" | "TIER_ROWS_NOT_GROUPED" | "TIER_BANDS_CONFLICT" | "CONDITION_VALUE_MISSING" | "VARIANT_VALUE_CONFLICT" | "ATTRIBUTE_NOT_OVERRIDABLE" | "ATTRIBUTE_NOT_IN_SCHEMA" | "IS_CONDITIONAL_NOT_CONSTANT" | "SCHEMA_NOT_CONDITIONABLE" | "SCHEMA_NOT_FOUND" | "SCHEMA_DECLARES_NO_CONDITIONS" | "GROUPING_KEY_NOT_A_COLUMN" | "GROUPING_KEY_IS_SORT_COLUMN" | "CONDITIONAL_TARGET_MODE_UNSUPPORTED" | "VALUE_FORMAT_INVALID" | "MAPPING_EXPRESSION_FAILED" | "FROM_ROWS_EXPRESSION_FAILED";
|
|
3023
3038
|
severity: "warning" | "blocking";
|
|
3024
3039
|
/**
|
|
3025
3040
|
* The columns this issue is about, at most one entry per column per entity.
|
|
@@ -3035,14 +3050,33 @@ declare namespace Components {
|
|
|
3035
3050
|
*/
|
|
3036
3051
|
entity?: string;
|
|
3037
3052
|
}[];
|
|
3053
|
+
/**
|
|
3054
|
+
* The mapping fields this issue is about, where the value is not a file column as it is: an expression builds it, or the expression fails. VALUE_FORMAT_INVALID (beside `columns`, which holds the values taken from a column as they are), MAPPING_EXPRESSION_FAILED and FROM_ROWS_EXPRESSION_FAILED.
|
|
3055
|
+
*/
|
|
3056
|
+
attributes?: {
|
|
3057
|
+
/**
|
|
3058
|
+
* The attribute the mapping writes, like `unit_amount_decimal`.
|
|
3059
|
+
*/
|
|
3060
|
+
name: string;
|
|
3061
|
+
}[];
|
|
3062
|
+
/**
|
|
3063
|
+
* Up to five lines of the file this issue was seen on, as examples rather than the full list. The header is line 1. BLANK_ROWS_SKIPPED, VALUE_FORMAT_INVALID, MAPPING_EXPRESSION_FAILED, FROM_ROWS_EXPRESSION_FAILED, TIER_ROWS_NOT_GROUPED (where a variant's rows start again), TIER_BANDS_CONFLICT and VARIANT_VALUE_CONFLICT (the row at odds with the first).
|
|
3064
|
+
*/
|
|
3065
|
+
lines?: number[];
|
|
3038
3066
|
/**
|
|
3039
3067
|
* What the issue is about — an attribute, an entity type slug, or an "attribute reads column" pair — to substitute into the client's copy for the code. Independent of `columns`; a code can carry both.
|
|
3040
3068
|
*/
|
|
3041
3069
|
subject?: string;
|
|
3042
3070
|
/**
|
|
3043
|
-
* The offending
|
|
3071
|
+
* The offending row's line in the file, the header being line 1 — the number a spreadsheet or text editor shows, and the same numbering as `lines`. MALFORMED_ROW only.
|
|
3044
3072
|
*/
|
|
3045
3073
|
row?: number;
|
|
3074
|
+
/**
|
|
3075
|
+
* The format the values should have had. VALUE_FORMAT_INVALID only.
|
|
3076
|
+
* - `number` — a JSON number; the mapping produces text (wrap the column in `$number()`). - `text` — text; the mapping produces a number. - `decimal` — a plain number with a dot as text, like `12.50`. - `date` — a date like `2026-01-01`, optionally with a time and offset like
|
|
3077
|
+
* `2026-01-01T08:00:00Z`.
|
|
3078
|
+
*/
|
|
3079
|
+
expected?: "number" | "text" | "decimal" | "date";
|
|
3046
3080
|
}
|
|
3047
3081
|
export interface ErpImportJob {
|
|
3048
3082
|
/**
|
|
@@ -3158,8 +3192,23 @@ declare namespace Components {
|
|
|
3158
3192
|
* individual rows.
|
|
3159
3193
|
*
|
|
3160
3194
|
* `code` is the translation key and the other fields are its parameters — there is
|
|
3161
|
-
* deliberately no message to display. Each code appears at most once
|
|
3162
|
-
* everything it has to say aggregated
|
|
3195
|
+
* deliberately no message to display. Each code appears at most once (once per
|
|
3196
|
+
* `expected` for `VALUE_FORMAT_INVALID`), with everything it has to say aggregated
|
|
3197
|
+
* into that one entry.
|
|
3198
|
+
*
|
|
3199
|
+
* `VALUE_FORMAT_INVALID` — the mapping produces values in a format the entity schema
|
|
3200
|
+
* does not store; `expected` says which format, and `columns` names every column
|
|
3201
|
+
* (or, for a value built by an expression, the attribute) that holds one.
|
|
3202
|
+
*
|
|
3203
|
+
* `MAPPING_EXPRESSION_FAILED` (a warning) — a mapping expression failed for some rows,
|
|
3204
|
+
* including `$number()` on a value it cannot convert such as `12,50` or on a blank cell,
|
|
3205
|
+
* so importing anyway leaves those values out; `attributes` names the attribute it fills.
|
|
3206
|
+
*
|
|
3207
|
+
* `FROM_ROWS_EXPRESSION_FAILED` — an expression in a `conditional.from_rows` item failed
|
|
3208
|
+
* for some rows. Blocking, unlike a field: the import would skip every entry of that
|
|
3209
|
+
* target built in the same chunk, not one value; `attributes` names the list attribute.
|
|
3210
|
+
*
|
|
3211
|
+
* `lines` points at up to five file lines an issue was seen on, as examples.
|
|
3163
3212
|
*
|
|
3164
3213
|
* The conditional codes describe a file that cannot be written as variants:
|
|
3165
3214
|
*
|
|
@@ -8940,6 +8989,7 @@ declare namespace Paths {
|
|
|
8940
8989
|
export type $200 = Components.Responses.GetAssociatedMonitoringEventsResponse;
|
|
8941
8990
|
export type $400 = Components.Responses.BadRequest;
|
|
8942
8991
|
export type $401 = Components.Responses.Unauthorized;
|
|
8992
|
+
export type $403 = Components.Responses.Forbidden;
|
|
8943
8993
|
export type $500 = Components.Responses.InternalServerError;
|
|
8944
8994
|
}
|
|
8945
8995
|
}
|
|
@@ -9049,6 +9099,7 @@ declare namespace Paths {
|
|
|
9049
9099
|
export type $200 = Components.Responses.GetMonitoringStatsResponse;
|
|
9050
9100
|
export type $400 = Components.Responses.BadRequest;
|
|
9051
9101
|
export type $401 = Components.Responses.Unauthorized;
|
|
9102
|
+
export type $403 = Components.Responses.Forbidden;
|
|
9052
9103
|
export type $404 = Components.Responses.NotFound;
|
|
9053
9104
|
export type $500 = Components.Responses.InternalServerError;
|
|
9054
9105
|
}
|
|
@@ -9065,6 +9116,7 @@ declare namespace Paths {
|
|
|
9065
9116
|
export type $200 = Components.Responses.GetMonitoringStatsV2Response;
|
|
9066
9117
|
export type $400 = Components.Responses.BadRequest;
|
|
9067
9118
|
export type $401 = Components.Responses.Unauthorized;
|
|
9119
|
+
export type $403 = Components.Responses.Forbidden;
|
|
9068
9120
|
export type $404 = Components.Responses.NotFound;
|
|
9069
9121
|
export type $500 = Components.Responses.InternalServerError;
|
|
9070
9122
|
}
|
|
@@ -9081,6 +9133,7 @@ declare namespace Paths {
|
|
|
9081
9133
|
export type $200 = Components.Responses.GetMonitoringTimeSeriesResponse;
|
|
9082
9134
|
export type $400 = Components.Responses.BadRequest;
|
|
9083
9135
|
export type $401 = Components.Responses.Unauthorized;
|
|
9136
|
+
export type $403 = Components.Responses.Forbidden;
|
|
9084
9137
|
export type $404 = Components.Responses.NotFound;
|
|
9085
9138
|
export type $500 = Components.Responses.InternalServerError;
|
|
9086
9139
|
}
|
|
@@ -9097,6 +9150,7 @@ declare namespace Paths {
|
|
|
9097
9150
|
export type $200 = Components.Responses.GetMonitoringTimeSeriesV2Response;
|
|
9098
9151
|
export type $400 = Components.Responses.BadRequest;
|
|
9099
9152
|
export type $401 = Components.Responses.Unauthorized;
|
|
9153
|
+
export type $403 = Components.Responses.Forbidden;
|
|
9100
9154
|
export type $404 = Components.Responses.NotFound;
|
|
9101
9155
|
export type $500 = Components.Responses.InternalServerError;
|
|
9102
9156
|
}
|
|
@@ -9148,6 +9202,7 @@ declare namespace Paths {
|
|
|
9148
9202
|
namespace Responses {
|
|
9149
9203
|
export type $200 = Components.Schemas.OutboundStatusResponse;
|
|
9150
9204
|
export type $401 = Components.Responses.Unauthorized;
|
|
9205
|
+
export type $403 = Components.Responses.Forbidden;
|
|
9151
9206
|
export type $404 = Components.Responses.NotFound;
|
|
9152
9207
|
export type $500 = Components.Responses.InternalServerError;
|
|
9153
9208
|
}
|
|
@@ -9501,6 +9556,7 @@ declare namespace Paths {
|
|
|
9501
9556
|
export type $200 = Components.Responses.QueryAccessLogsResponse;
|
|
9502
9557
|
export type $400 = Components.Responses.BadRequest;
|
|
9503
9558
|
export type $401 = Components.Responses.Unauthorized;
|
|
9559
|
+
export type $403 = Components.Responses.Forbidden;
|
|
9504
9560
|
export type $404 = Components.Responses.NotFound;
|
|
9505
9561
|
export type $500 = Components.Responses.InternalServerError;
|
|
9506
9562
|
}
|
|
@@ -9533,6 +9589,7 @@ declare namespace Paths {
|
|
|
9533
9589
|
export type $200 = Components.Responses.QueryInboundMonitoringEventsResponse;
|
|
9534
9590
|
export type $400 = Components.Responses.BadRequest;
|
|
9535
9591
|
export type $401 = Components.Responses.Unauthorized;
|
|
9592
|
+
export type $403 = Components.Responses.Forbidden;
|
|
9536
9593
|
export type $404 = Components.Responses.NotFound;
|
|
9537
9594
|
export type $500 = Components.Responses.InternalServerError;
|
|
9538
9595
|
}
|
|
@@ -9549,6 +9606,7 @@ declare namespace Paths {
|
|
|
9549
9606
|
export type $200 = Components.Responses.QueryMonitoringEventsV2Response;
|
|
9550
9607
|
export type $400 = Components.Responses.BadRequest;
|
|
9551
9608
|
export type $401 = Components.Responses.Unauthorized;
|
|
9609
|
+
export type $403 = Components.Responses.Forbidden;
|
|
9552
9610
|
export type $404 = Components.Responses.NotFound;
|
|
9553
9611
|
export type $500 = Components.Responses.InternalServerError;
|
|
9554
9612
|
}
|
|
@@ -9565,6 +9623,7 @@ declare namespace Paths {
|
|
|
9565
9623
|
export type $200 = Components.Responses.QueryOutboundMonitoringEventsResponse;
|
|
9566
9624
|
export type $400 = Components.Responses.BadRequest;
|
|
9567
9625
|
export type $401 = Components.Responses.Unauthorized;
|
|
9626
|
+
export type $403 = Components.Responses.Forbidden;
|
|
9568
9627
|
export type $404 = Components.Responses.NotFound;
|
|
9569
9628
|
export type $500 = Components.Responses.InternalServerError;
|
|
9570
9629
|
}
|
|
@@ -10602,6 +10661,9 @@ interface OperationMethods {
|
|
|
10602
10661
|
* Query monitoring events from the unified erp_monitoring_v2 table.
|
|
10603
10662
|
* Returns all event types (inbound, outbound, file_proxy, etc.) in a single list.
|
|
10604
10663
|
* Replaces the separate v1 inbound-events and outbound-events endpoints.
|
|
10664
|
+
* Requires the `integration:view` grant for the integration: event
|
|
10665
|
+
* details can carry customer data (a mapped poll message's delivered
|
|
10666
|
+
* payload, for example).
|
|
10605
10667
|
*
|
|
10606
10668
|
*/
|
|
10607
10669
|
'queryMonitoringEventsV2'(
|
|
@@ -11658,6 +11720,9 @@ interface PathsDictionary {
|
|
|
11658
11720
|
* Query monitoring events from the unified erp_monitoring_v2 table.
|
|
11659
11721
|
* Returns all event types (inbound, outbound, file_proxy, etc.) in a single list.
|
|
11660
11722
|
* Replaces the separate v1 inbound-events and outbound-events endpoints.
|
|
11723
|
+
* Requires the `integration:view` grant for the integration: event
|
|
11724
|
+
* details can carry customer data (a mapped poll message's delivered
|
|
11725
|
+
* payload, for example).
|
|
11661
11726
|
*
|
|
11662
11727
|
*/
|
|
11663
11728
|
'post'(
|
|
@@ -2990,8 +2990,23 @@ declare namespace Components {
|
|
|
2990
2990
|
* individual rows.
|
|
2991
2991
|
*
|
|
2992
2992
|
* `code` is the translation key and the other fields are its parameters — there is
|
|
2993
|
-
* deliberately no message to display. Each code appears at most once
|
|
2994
|
-
* everything it has to say aggregated
|
|
2993
|
+
* deliberately no message to display. Each code appears at most once (once per
|
|
2994
|
+
* `expected` for `VALUE_FORMAT_INVALID`), with everything it has to say aggregated
|
|
2995
|
+
* into that one entry.
|
|
2996
|
+
*
|
|
2997
|
+
* `VALUE_FORMAT_INVALID` — the mapping produces values in a format the entity schema
|
|
2998
|
+
* does not store; `expected` says which format, and `columns` names every column
|
|
2999
|
+
* (or, for a value built by an expression, the attribute) that holds one.
|
|
3000
|
+
*
|
|
3001
|
+
* `MAPPING_EXPRESSION_FAILED` (a warning) — a mapping expression failed for some rows,
|
|
3002
|
+
* including `$number()` on a value it cannot convert such as `12,50` or on a blank cell,
|
|
3003
|
+
* so importing anyway leaves those values out; `attributes` names the attribute it fills.
|
|
3004
|
+
*
|
|
3005
|
+
* `FROM_ROWS_EXPRESSION_FAILED` — an expression in a `conditional.from_rows` item failed
|
|
3006
|
+
* for some rows. Blocking, unlike a field: the import would skip every entry of that
|
|
3007
|
+
* target built in the same chunk, not one value; `attributes` names the list attribute.
|
|
3008
|
+
*
|
|
3009
|
+
* `lines` points at up to five file lines an issue was seen on, as examples.
|
|
2995
3010
|
*
|
|
2996
3011
|
* The conditional codes describe a file that cannot be written as variants:
|
|
2997
3012
|
*
|
|
@@ -3019,7 +3034,7 @@ declare namespace Components {
|
|
|
3019
3034
|
* Enum of possible issue codes.
|
|
3020
3035
|
*
|
|
3021
3036
|
*/
|
|
3022
|
-
code: "UNIQUE_ID_COLUMN_MISSING" | "MAPPED_COLUMN_MISSING" | "MALFORMED_ROW" | "INVALID_ENCODING" | "EMPTY_FILE" | "TOO_MANY_ROWS" | "BLANK_ROWS_SKIPPED" | "TIER_ROWS_NOT_GROUPED" | "TIER_BANDS_CONFLICT" | "CONDITION_VALUE_MISSING" | "VARIANT_VALUE_CONFLICT" | "ATTRIBUTE_NOT_OVERRIDABLE" | "ATTRIBUTE_NOT_IN_SCHEMA" | "IS_CONDITIONAL_NOT_CONSTANT" | "SCHEMA_NOT_CONDITIONABLE" | "SCHEMA_NOT_FOUND" | "SCHEMA_DECLARES_NO_CONDITIONS" | "GROUPING_KEY_NOT_A_COLUMN" | "GROUPING_KEY_IS_SORT_COLUMN" | "CONDITIONAL_TARGET_MODE_UNSUPPORTED";
|
|
3037
|
+
code: "UNIQUE_ID_COLUMN_MISSING" | "MAPPED_COLUMN_MISSING" | "MALFORMED_ROW" | "INVALID_ENCODING" | "EMPTY_FILE" | "TOO_MANY_ROWS" | "BLANK_ROWS_SKIPPED" | "TIER_ROWS_NOT_GROUPED" | "TIER_BANDS_CONFLICT" | "CONDITION_VALUE_MISSING" | "VARIANT_VALUE_CONFLICT" | "ATTRIBUTE_NOT_OVERRIDABLE" | "ATTRIBUTE_NOT_IN_SCHEMA" | "IS_CONDITIONAL_NOT_CONSTANT" | "SCHEMA_NOT_CONDITIONABLE" | "SCHEMA_NOT_FOUND" | "SCHEMA_DECLARES_NO_CONDITIONS" | "GROUPING_KEY_NOT_A_COLUMN" | "GROUPING_KEY_IS_SORT_COLUMN" | "CONDITIONAL_TARGET_MODE_UNSUPPORTED" | "VALUE_FORMAT_INVALID" | "MAPPING_EXPRESSION_FAILED" | "FROM_ROWS_EXPRESSION_FAILED";
|
|
3023
3038
|
severity: "warning" | "blocking";
|
|
3024
3039
|
/**
|
|
3025
3040
|
* The columns this issue is about, at most one entry per column per entity.
|
|
@@ -3035,14 +3050,33 @@ declare namespace Components {
|
|
|
3035
3050
|
*/
|
|
3036
3051
|
entity?: string;
|
|
3037
3052
|
}[];
|
|
3053
|
+
/**
|
|
3054
|
+
* The mapping fields this issue is about, where the value is not a file column as it is: an expression builds it, or the expression fails. VALUE_FORMAT_INVALID (beside `columns`, which holds the values taken from a column as they are), MAPPING_EXPRESSION_FAILED and FROM_ROWS_EXPRESSION_FAILED.
|
|
3055
|
+
*/
|
|
3056
|
+
attributes?: {
|
|
3057
|
+
/**
|
|
3058
|
+
* The attribute the mapping writes, like `unit_amount_decimal`.
|
|
3059
|
+
*/
|
|
3060
|
+
name: string;
|
|
3061
|
+
}[];
|
|
3062
|
+
/**
|
|
3063
|
+
* Up to five lines of the file this issue was seen on, as examples rather than the full list. The header is line 1. BLANK_ROWS_SKIPPED, VALUE_FORMAT_INVALID, MAPPING_EXPRESSION_FAILED, FROM_ROWS_EXPRESSION_FAILED, TIER_ROWS_NOT_GROUPED (where a variant's rows start again), TIER_BANDS_CONFLICT and VARIANT_VALUE_CONFLICT (the row at odds with the first).
|
|
3064
|
+
*/
|
|
3065
|
+
lines?: number[];
|
|
3038
3066
|
/**
|
|
3039
3067
|
* What the issue is about — an attribute, an entity type slug, or an "attribute reads column" pair — to substitute into the client's copy for the code. Independent of `columns`; a code can carry both.
|
|
3040
3068
|
*/
|
|
3041
3069
|
subject?: string;
|
|
3042
3070
|
/**
|
|
3043
|
-
* The offending
|
|
3071
|
+
* The offending row's line in the file, the header being line 1 — the number a spreadsheet or text editor shows, and the same numbering as `lines`. MALFORMED_ROW only.
|
|
3044
3072
|
*/
|
|
3045
3073
|
row?: number;
|
|
3074
|
+
/**
|
|
3075
|
+
* The format the values should have had. VALUE_FORMAT_INVALID only.
|
|
3076
|
+
* - `number` — a JSON number; the mapping produces text (wrap the column in `$number()`). - `text` — text; the mapping produces a number. - `decimal` — a plain number with a dot as text, like `12.50`. - `date` — a date like `2026-01-01`, optionally with a time and offset like
|
|
3077
|
+
* `2026-01-01T08:00:00Z`.
|
|
3078
|
+
*/
|
|
3079
|
+
expected?: "number" | "text" | "decimal" | "date";
|
|
3046
3080
|
}
|
|
3047
3081
|
export interface ErpImportJob {
|
|
3048
3082
|
/**
|
|
@@ -3158,8 +3192,23 @@ declare namespace Components {
|
|
|
3158
3192
|
* individual rows.
|
|
3159
3193
|
*
|
|
3160
3194
|
* `code` is the translation key and the other fields are its parameters — there is
|
|
3161
|
-
* deliberately no message to display. Each code appears at most once
|
|
3162
|
-
* everything it has to say aggregated
|
|
3195
|
+
* deliberately no message to display. Each code appears at most once (once per
|
|
3196
|
+
* `expected` for `VALUE_FORMAT_INVALID`), with everything it has to say aggregated
|
|
3197
|
+
* into that one entry.
|
|
3198
|
+
*
|
|
3199
|
+
* `VALUE_FORMAT_INVALID` — the mapping produces values in a format the entity schema
|
|
3200
|
+
* does not store; `expected` says which format, and `columns` names every column
|
|
3201
|
+
* (or, for a value built by an expression, the attribute) that holds one.
|
|
3202
|
+
*
|
|
3203
|
+
* `MAPPING_EXPRESSION_FAILED` (a warning) — a mapping expression failed for some rows,
|
|
3204
|
+
* including `$number()` on a value it cannot convert such as `12,50` or on a blank cell,
|
|
3205
|
+
* so importing anyway leaves those values out; `attributes` names the attribute it fills.
|
|
3206
|
+
*
|
|
3207
|
+
* `FROM_ROWS_EXPRESSION_FAILED` — an expression in a `conditional.from_rows` item failed
|
|
3208
|
+
* for some rows. Blocking, unlike a field: the import would skip every entry of that
|
|
3209
|
+
* target built in the same chunk, not one value; `attributes` names the list attribute.
|
|
3210
|
+
*
|
|
3211
|
+
* `lines` points at up to five file lines an issue was seen on, as examples.
|
|
3163
3212
|
*
|
|
3164
3213
|
* The conditional codes describe a file that cannot be written as variants:
|
|
3165
3214
|
*
|
|
@@ -8940,6 +8989,7 @@ declare namespace Paths {
|
|
|
8940
8989
|
export type $200 = Components.Responses.GetAssociatedMonitoringEventsResponse;
|
|
8941
8990
|
export type $400 = Components.Responses.BadRequest;
|
|
8942
8991
|
export type $401 = Components.Responses.Unauthorized;
|
|
8992
|
+
export type $403 = Components.Responses.Forbidden;
|
|
8943
8993
|
export type $500 = Components.Responses.InternalServerError;
|
|
8944
8994
|
}
|
|
8945
8995
|
}
|
|
@@ -9049,6 +9099,7 @@ declare namespace Paths {
|
|
|
9049
9099
|
export type $200 = Components.Responses.GetMonitoringStatsResponse;
|
|
9050
9100
|
export type $400 = Components.Responses.BadRequest;
|
|
9051
9101
|
export type $401 = Components.Responses.Unauthorized;
|
|
9102
|
+
export type $403 = Components.Responses.Forbidden;
|
|
9052
9103
|
export type $404 = Components.Responses.NotFound;
|
|
9053
9104
|
export type $500 = Components.Responses.InternalServerError;
|
|
9054
9105
|
}
|
|
@@ -9065,6 +9116,7 @@ declare namespace Paths {
|
|
|
9065
9116
|
export type $200 = Components.Responses.GetMonitoringStatsV2Response;
|
|
9066
9117
|
export type $400 = Components.Responses.BadRequest;
|
|
9067
9118
|
export type $401 = Components.Responses.Unauthorized;
|
|
9119
|
+
export type $403 = Components.Responses.Forbidden;
|
|
9068
9120
|
export type $404 = Components.Responses.NotFound;
|
|
9069
9121
|
export type $500 = Components.Responses.InternalServerError;
|
|
9070
9122
|
}
|
|
@@ -9081,6 +9133,7 @@ declare namespace Paths {
|
|
|
9081
9133
|
export type $200 = Components.Responses.GetMonitoringTimeSeriesResponse;
|
|
9082
9134
|
export type $400 = Components.Responses.BadRequest;
|
|
9083
9135
|
export type $401 = Components.Responses.Unauthorized;
|
|
9136
|
+
export type $403 = Components.Responses.Forbidden;
|
|
9084
9137
|
export type $404 = Components.Responses.NotFound;
|
|
9085
9138
|
export type $500 = Components.Responses.InternalServerError;
|
|
9086
9139
|
}
|
|
@@ -9097,6 +9150,7 @@ declare namespace Paths {
|
|
|
9097
9150
|
export type $200 = Components.Responses.GetMonitoringTimeSeriesV2Response;
|
|
9098
9151
|
export type $400 = Components.Responses.BadRequest;
|
|
9099
9152
|
export type $401 = Components.Responses.Unauthorized;
|
|
9153
|
+
export type $403 = Components.Responses.Forbidden;
|
|
9100
9154
|
export type $404 = Components.Responses.NotFound;
|
|
9101
9155
|
export type $500 = Components.Responses.InternalServerError;
|
|
9102
9156
|
}
|
|
@@ -9148,6 +9202,7 @@ declare namespace Paths {
|
|
|
9148
9202
|
namespace Responses {
|
|
9149
9203
|
export type $200 = Components.Schemas.OutboundStatusResponse;
|
|
9150
9204
|
export type $401 = Components.Responses.Unauthorized;
|
|
9205
|
+
export type $403 = Components.Responses.Forbidden;
|
|
9151
9206
|
export type $404 = Components.Responses.NotFound;
|
|
9152
9207
|
export type $500 = Components.Responses.InternalServerError;
|
|
9153
9208
|
}
|
|
@@ -9501,6 +9556,7 @@ declare namespace Paths {
|
|
|
9501
9556
|
export type $200 = Components.Responses.QueryAccessLogsResponse;
|
|
9502
9557
|
export type $400 = Components.Responses.BadRequest;
|
|
9503
9558
|
export type $401 = Components.Responses.Unauthorized;
|
|
9559
|
+
export type $403 = Components.Responses.Forbidden;
|
|
9504
9560
|
export type $404 = Components.Responses.NotFound;
|
|
9505
9561
|
export type $500 = Components.Responses.InternalServerError;
|
|
9506
9562
|
}
|
|
@@ -9533,6 +9589,7 @@ declare namespace Paths {
|
|
|
9533
9589
|
export type $200 = Components.Responses.QueryInboundMonitoringEventsResponse;
|
|
9534
9590
|
export type $400 = Components.Responses.BadRequest;
|
|
9535
9591
|
export type $401 = Components.Responses.Unauthorized;
|
|
9592
|
+
export type $403 = Components.Responses.Forbidden;
|
|
9536
9593
|
export type $404 = Components.Responses.NotFound;
|
|
9537
9594
|
export type $500 = Components.Responses.InternalServerError;
|
|
9538
9595
|
}
|
|
@@ -9549,6 +9606,7 @@ declare namespace Paths {
|
|
|
9549
9606
|
export type $200 = Components.Responses.QueryMonitoringEventsV2Response;
|
|
9550
9607
|
export type $400 = Components.Responses.BadRequest;
|
|
9551
9608
|
export type $401 = Components.Responses.Unauthorized;
|
|
9609
|
+
export type $403 = Components.Responses.Forbidden;
|
|
9552
9610
|
export type $404 = Components.Responses.NotFound;
|
|
9553
9611
|
export type $500 = Components.Responses.InternalServerError;
|
|
9554
9612
|
}
|
|
@@ -9565,6 +9623,7 @@ declare namespace Paths {
|
|
|
9565
9623
|
export type $200 = Components.Responses.QueryOutboundMonitoringEventsResponse;
|
|
9566
9624
|
export type $400 = Components.Responses.BadRequest;
|
|
9567
9625
|
export type $401 = Components.Responses.Unauthorized;
|
|
9626
|
+
export type $403 = Components.Responses.Forbidden;
|
|
9568
9627
|
export type $404 = Components.Responses.NotFound;
|
|
9569
9628
|
export type $500 = Components.Responses.InternalServerError;
|
|
9570
9629
|
}
|
|
@@ -10602,6 +10661,9 @@ interface OperationMethods {
|
|
|
10602
10661
|
* Query monitoring events from the unified erp_monitoring_v2 table.
|
|
10603
10662
|
* Returns all event types (inbound, outbound, file_proxy, etc.) in a single list.
|
|
10604
10663
|
* Replaces the separate v1 inbound-events and outbound-events endpoints.
|
|
10664
|
+
* Requires the `integration:view` grant for the integration: event
|
|
10665
|
+
* details can carry customer data (a mapped poll message's delivered
|
|
10666
|
+
* payload, for example).
|
|
10605
10667
|
*
|
|
10606
10668
|
*/
|
|
10607
10669
|
'queryMonitoringEventsV2'(
|
|
@@ -11658,6 +11720,9 @@ interface PathsDictionary {
|
|
|
11658
11720
|
* Query monitoring events from the unified erp_monitoring_v2 table.
|
|
11659
11721
|
* Returns all event types (inbound, outbound, file_proxy, etc.) in a single list.
|
|
11660
11722
|
* Replaces the separate v1 inbound-events and outbound-events endpoints.
|
|
11723
|
+
* Requires the `integration:view` grant for the integration: event
|
|
11724
|
+
* details can carry customer data (a mapped poll message's delivered
|
|
11725
|
+
* payload, for example).
|
|
11661
11726
|
*
|
|
11662
11727
|
*/
|
|
11663
11728
|
'post'(
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
|
|
2
|
+
|
|
3
|
+
// src/docs/phone-integration.json
|
|
4
|
+
var phone_integration_default = '# Phone Integration API\n\n- **Base URL:** `https://phone-integration-api.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/phone-integration](https://docs.epilot.io/api/phone-integration)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.phoneIntegration.batchSearchCustomers(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/phone-integration\'\n\nconst phoneIntegrationClient = getClient()\nauthorize(phoneIntegrationClient, () => \'<token>\')\nconst { data } = await phoneIntegrationClient.batchSearchCustomers(...)\n```\n\n## Operations\n\n**phone-integration**\n- [`batchSearchCustomers`](#batchsearchcustomers)\n\n**Schemas**\n- [`CustomerBatchSearchResult`](#customerbatchsearchresult)\n- [`CustomerSearchResult`](#customersearchresult)\n- [`CustomerIdentifier`](#customeridentifier)\n- [`CustomerSummary`](#customersummary)\n- [`ErrorResponse`](#errorresponse)\n\n### `batchSearchCustomers`\n\nResolves up to 50 identifiers to epilot customers (Contacts) in one\nrequest \u2014 for example every number in an agent\'s call history.\n\n`GET /v1/customer:batchSearch`\n\n```ts\nconst { data } = await client.batchSearchCustomers({\n id: [\'...\'],\n customer_number: [\'...\'],\n external_id: [\'...\'],\n phone_number: [\'...\'],\n email: [\'...\'],\n x-trace-id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "identifier": {\n "type": "id",\n "value": "+4917012345678"\n },\n "status": "found",\n "customer": {\n "id": "dba8e5f9-8b3f-4608-b887-cd0798fce624",\n "name": "Max Mustermann",\n "customer_number": "4711"\n }\n }\n ]\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `CustomerBatchSearchResult`\n\n```ts\ntype CustomerBatchSearchResult = {\n results: Array<{\n identifier: {\n type: { ... }\n value: { ... }\n }\n status: "found" | "not_found" | "ambiguous" | "invalid" | "error"\n customer?: {\n id: { ... }\n name: { ... }\n customer_number?: { ... }\n }\n }>\n}\n```\n\n### `CustomerSearchResult`\n\n```ts\ntype CustomerSearchResult = {\n identifier: {\n type: "id" | "customer_number" | "external_id" | "phone_number" | "email"\n value: string\n }\n status: "found" | "not_found" | "ambiguous" | "invalid" | "error"\n customer?: {\n id: string\n name: string\n customer_number?: string\n }\n}\n```\n\n### `CustomerIdentifier`\n\n```ts\ntype CustomerIdentifier = {\n type: "id" | "customer_number" | "external_id" | "phone_number" | "email"\n value: string\n}\n```\n\n### `CustomerSummary`\n\nPresent when `status` is `found`\n\n```ts\ntype CustomerSummary = {\n id: string\n name: string\n customer_number?: string\n}\n```\n\n### `ErrorResponse`\n\n```ts\ntype ErrorResponse = {\n status: number\n error: string\n code?: string\n}\n```\n';
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
exports.default = phone_integration_default;
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import "./chunk-YPSWSI3M.js";
|
|
2
|
+
|
|
3
|
+
// src/docs/phone-integration.json
|
|
4
|
+
var phone_integration_default = '# Phone Integration API\n\n- **Base URL:** `https://phone-integration-api.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/phone-integration](https://docs.epilot.io/api/phone-integration)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.phoneIntegration.batchSearchCustomers(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/phone-integration\'\n\nconst phoneIntegrationClient = getClient()\nauthorize(phoneIntegrationClient, () => \'<token>\')\nconst { data } = await phoneIntegrationClient.batchSearchCustomers(...)\n```\n\n## Operations\n\n**phone-integration**\n- [`batchSearchCustomers`](#batchsearchcustomers)\n\n**Schemas**\n- [`CustomerBatchSearchResult`](#customerbatchsearchresult)\n- [`CustomerSearchResult`](#customersearchresult)\n- [`CustomerIdentifier`](#customeridentifier)\n- [`CustomerSummary`](#customersummary)\n- [`ErrorResponse`](#errorresponse)\n\n### `batchSearchCustomers`\n\nResolves up to 50 identifiers to epilot customers (Contacts) in one\nrequest \u2014 for example every number in an agent\'s call history.\n\n`GET /v1/customer:batchSearch`\n\n```ts\nconst { data } = await client.batchSearchCustomers({\n id: [\'...\'],\n customer_number: [\'...\'],\n external_id: [\'...\'],\n phone_number: [\'...\'],\n email: [\'...\'],\n x-trace-id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "identifier": {\n "type": "id",\n "value": "+4917012345678"\n },\n "status": "found",\n "customer": {\n "id": "dba8e5f9-8b3f-4608-b887-cd0798fce624",\n "name": "Max Mustermann",\n "customer_number": "4711"\n }\n }\n ]\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `CustomerBatchSearchResult`\n\n```ts\ntype CustomerBatchSearchResult = {\n results: Array<{\n identifier: {\n type: { ... }\n value: { ... }\n }\n status: "found" | "not_found" | "ambiguous" | "invalid" | "error"\n customer?: {\n id: { ... }\n name: { ... }\n customer_number?: { ... }\n }\n }>\n}\n```\n\n### `CustomerSearchResult`\n\n```ts\ntype CustomerSearchResult = {\n identifier: {\n type: "id" | "customer_number" | "external_id" | "phone_number" | "email"\n value: string\n }\n status: "found" | "not_found" | "ambiguous" | "invalid" | "error"\n customer?: {\n id: string\n name: string\n customer_number?: string\n }\n}\n```\n\n### `CustomerIdentifier`\n\n```ts\ntype CustomerIdentifier = {\n type: "id" | "customer_number" | "external_id" | "phone_number" | "email"\n value: string\n}\n```\n\n### `CustomerSummary`\n\nPresent when `status` is `found`\n\n```ts\ntype CustomerSummary = {\n id: string\n name: string\n customer_number?: string\n}\n```\n\n### `ErrorResponse`\n\n```ts\ntype ErrorResponse = {\n status: number\n error: string\n code?: string\n}\n```\n';
|
|
5
|
+
export {
|
|
6
|
+
phone_integration_default as default
|
|
7
|
+
};
|
|
@@ -0,0 +1,179 @@
|
|
|
1
|
+
import { OpenAPIClient, Parameters, AxiosRequestConfig, OperationResponse } from 'openapi-client-axios';
|
|
2
|
+
|
|
3
|
+
/* Auto-copied from phone-integration-client */
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
declare namespace Components {
|
|
7
|
+
namespace Schemas {
|
|
8
|
+
export interface CustomerBatchSearchResult {
|
|
9
|
+
/**
|
|
10
|
+
* One result per distinct identifier
|
|
11
|
+
*/
|
|
12
|
+
results: CustomerSearchResult[];
|
|
13
|
+
}
|
|
14
|
+
export interface CustomerIdentifier {
|
|
15
|
+
type: "id" | "customer_number" | "external_id" | "phone_number" | "email";
|
|
16
|
+
/**
|
|
17
|
+
* The identifier as sent
|
|
18
|
+
* example:
|
|
19
|
+
* +4917012345678
|
|
20
|
+
*/
|
|
21
|
+
value: string;
|
|
22
|
+
}
|
|
23
|
+
export interface CustomerSearchResult {
|
|
24
|
+
identifier: CustomerIdentifier;
|
|
25
|
+
/**
|
|
26
|
+
* - `found` — exactly one contact has the identifier; see `customer`
|
|
27
|
+
* - `not_found` — no contact the caller may see has it
|
|
28
|
+
* - `ambiguous` — several contacts share it; none is chosen
|
|
29
|
+
* - `invalid` — not a usable identifier (a phone number that does
|
|
30
|
+
* not parse), so nothing was searched
|
|
31
|
+
* - `error` — the search for this identifier failed; try again
|
|
32
|
+
*
|
|
33
|
+
*/
|
|
34
|
+
status: "found" | "not_found" | "ambiguous" | "invalid" | "error";
|
|
35
|
+
customer?: /* Present when `status` is `found` */ CustomerSummary;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Present when `status` is `found`
|
|
39
|
+
*/
|
|
40
|
+
export interface CustomerSummary {
|
|
41
|
+
/**
|
|
42
|
+
* epilot entity id of the customer (Contact)
|
|
43
|
+
* example:
|
|
44
|
+
* dba8e5f9-8b3f-4608-b887-cd0798fce624
|
|
45
|
+
*/
|
|
46
|
+
id: string;
|
|
47
|
+
/**
|
|
48
|
+
* The contact's title, else its first and last name; null when it has neither
|
|
49
|
+
* example:
|
|
50
|
+
* Max Mustermann
|
|
51
|
+
*/
|
|
52
|
+
name: string | null;
|
|
53
|
+
/**
|
|
54
|
+
* Omitted when the contact has none
|
|
55
|
+
* example:
|
|
56
|
+
* 4711
|
|
57
|
+
*/
|
|
58
|
+
customer_number?: string;
|
|
59
|
+
}
|
|
60
|
+
export interface ErrorResponse {
|
|
61
|
+
/**
|
|
62
|
+
* HTTP status code.
|
|
63
|
+
*/
|
|
64
|
+
status: number;
|
|
65
|
+
/**
|
|
66
|
+
* Human-readable error message.
|
|
67
|
+
*/
|
|
68
|
+
error: string;
|
|
69
|
+
/**
|
|
70
|
+
* Stable machine-readable error code, when the operation defines one.
|
|
71
|
+
*/
|
|
72
|
+
code?: string;
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
declare namespace Paths {
|
|
77
|
+
namespace BatchSearchCustomers {
|
|
78
|
+
export interface HeaderParameters {
|
|
79
|
+
"x-trace-id"?: Parameters.XTraceId;
|
|
80
|
+
}
|
|
81
|
+
namespace Parameters {
|
|
82
|
+
export type CustomerNumber = string[];
|
|
83
|
+
export type Email = string[];
|
|
84
|
+
export type ExternalId = string[];
|
|
85
|
+
export type Id = string[];
|
|
86
|
+
export type PhoneNumber = string[];
|
|
87
|
+
export type XTraceId = string;
|
|
88
|
+
}
|
|
89
|
+
export interface QueryParameters {
|
|
90
|
+
id?: Parameters.Id;
|
|
91
|
+
customer_number?: Parameters.CustomerNumber;
|
|
92
|
+
external_id?: Parameters.ExternalId;
|
|
93
|
+
phone_number?: Parameters.PhoneNumber;
|
|
94
|
+
email?: Parameters.Email;
|
|
95
|
+
}
|
|
96
|
+
namespace Responses {
|
|
97
|
+
export type $200 = Components.Schemas.CustomerBatchSearchResult;
|
|
98
|
+
export type $400 = Components.Schemas.ErrorResponse;
|
|
99
|
+
export type $401 = Components.Schemas.ErrorResponse;
|
|
100
|
+
export type $403 = Components.Schemas.ErrorResponse;
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
interface OperationMethods {
|
|
107
|
+
/**
|
|
108
|
+
* batchSearchCustomers - batchSearchCustomers
|
|
109
|
+
*
|
|
110
|
+
* Resolves up to 50 identifiers to epilot customers (Contacts) in one
|
|
111
|
+
* request — for example every number in an agent's call history.
|
|
112
|
+
*
|
|
113
|
+
* Each identifier is an exact key of a Contact: its entity `id`, its
|
|
114
|
+
* `customer_number`, its `external_id`, one of its `email` addresses or
|
|
115
|
+
* one of its `phone` numbers. Repeat a parameter to pass several values,
|
|
116
|
+
* and combine parameters freely. Phone numbers are normalized on the
|
|
117
|
+
* server, so E.164, national and formatted forms of one number match the
|
|
118
|
+
* same contact; the other identifiers match exactly, ignoring case and
|
|
119
|
+
* surrounding whitespace.
|
|
120
|
+
*
|
|
121
|
+
* Every distinct identifier gets its own result, so one unknown or
|
|
122
|
+
* ambiguous identifier never fails the others. Results are ordered by
|
|
123
|
+
* parameter (`id`, `customer_number`, `external_id`, `phone_number`,
|
|
124
|
+
* `email`), then as sent; match them by `identifier`.
|
|
125
|
+
*
|
|
126
|
+
* The search runs with the caller's token: the organization and the
|
|
127
|
+
* permissions applied are the caller's own, as for entity search.
|
|
128
|
+
*
|
|
129
|
+
*/
|
|
130
|
+
'batchSearchCustomers'(
|
|
131
|
+
parameters?: Parameters<Paths.BatchSearchCustomers.QueryParameters & Paths.BatchSearchCustomers.HeaderParameters> | null,
|
|
132
|
+
data?: any,
|
|
133
|
+
config?: AxiosRequestConfig
|
|
134
|
+
): OperationResponse<Paths.BatchSearchCustomers.Responses.$200>
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
interface PathsDictionary {
|
|
138
|
+
['/v1/customer:batchSearch']: {
|
|
139
|
+
/**
|
|
140
|
+
* batchSearchCustomers - batchSearchCustomers
|
|
141
|
+
*
|
|
142
|
+
* Resolves up to 50 identifiers to epilot customers (Contacts) in one
|
|
143
|
+
* request — for example every number in an agent's call history.
|
|
144
|
+
*
|
|
145
|
+
* Each identifier is an exact key of a Contact: its entity `id`, its
|
|
146
|
+
* `customer_number`, its `external_id`, one of its `email` addresses or
|
|
147
|
+
* one of its `phone` numbers. Repeat a parameter to pass several values,
|
|
148
|
+
* and combine parameters freely. Phone numbers are normalized on the
|
|
149
|
+
* server, so E.164, national and formatted forms of one number match the
|
|
150
|
+
* same contact; the other identifiers match exactly, ignoring case and
|
|
151
|
+
* surrounding whitespace.
|
|
152
|
+
*
|
|
153
|
+
* Every distinct identifier gets its own result, so one unknown or
|
|
154
|
+
* ambiguous identifier never fails the others. Results are ordered by
|
|
155
|
+
* parameter (`id`, `customer_number`, `external_id`, `phone_number`,
|
|
156
|
+
* `email`), then as sent; match them by `identifier`.
|
|
157
|
+
*
|
|
158
|
+
* The search runs with the caller's token: the organization and the
|
|
159
|
+
* permissions applied are the caller's own, as for entity search.
|
|
160
|
+
*
|
|
161
|
+
*/
|
|
162
|
+
'get'(
|
|
163
|
+
parameters?: Parameters<Paths.BatchSearchCustomers.QueryParameters & Paths.BatchSearchCustomers.HeaderParameters> | null,
|
|
164
|
+
data?: any,
|
|
165
|
+
config?: AxiosRequestConfig
|
|
166
|
+
): OperationResponse<Paths.BatchSearchCustomers.Responses.$200>
|
|
167
|
+
}
|
|
168
|
+
}
|
|
169
|
+
|
|
170
|
+
type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
type CustomerBatchSearchResult = Components.Schemas.CustomerBatchSearchResult;
|
|
174
|
+
type CustomerIdentifier = Components.Schemas.CustomerIdentifier;
|
|
175
|
+
type CustomerSearchResult = Components.Schemas.CustomerSearchResult;
|
|
176
|
+
type CustomerSummary = Components.Schemas.CustomerSummary;
|
|
177
|
+
type ErrorResponse = Components.Schemas.ErrorResponse;
|
|
178
|
+
|
|
179
|
+
export { type Client as C, type ErrorResponse as E, type OperationMethods as O, Paths as P, Components as a, type PathsDictionary as b, type CustomerBatchSearchResult as c, type CustomerIdentifier as d, type CustomerSearchResult as e, type CustomerSummary as f };
|