@epilot/customer-portal-client 0.17.2 → 0.17.3-rc.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.
Files changed (4) hide show
  1. package/dist/definition.js +1 -1
  2. package/dist/openapi.d.ts +107 -88
  3. package/package.json +1 -1
  4. package/src/openapi.json +99 -90
package/src/openapi.json CHANGED
@@ -5000,6 +5000,13 @@
5000
5000
  }
5001
5001
  }
5002
5002
  },
5003
+ "extensions": {
5004
+ "type": "array",
5005
+ "description": "Configured Portal extensions",
5006
+ "items": {
5007
+ "$ref": "#/components/schemas/ExtensionConfig"
5008
+ }
5009
+ },
5003
5010
  "default_user_to_notify": {
5004
5011
  "type": "object",
5005
5012
  "description": "Default 360 user to notify upon an internal notification",
@@ -5343,13 +5350,6 @@
5343
5350
  },
5344
5351
  "allowed_file_extensions": {
5345
5352
  "$ref": "#/components/schemas/AllowedFileExtensions"
5346
- },
5347
- "extensions": {
5348
- "type": "array",
5349
- "description": "Configured Portal extensions",
5350
- "items": {
5351
- "$ref": "#/components/schemas/ExtensionConfig"
5352
- }
5353
5353
  }
5354
5354
  }
5355
5355
  },
@@ -7345,68 +7345,85 @@
7345
7345
  ],
7346
7346
  "description": "Name of the extension."
7347
7347
  },
7348
+ "description": {
7349
+ "type": "object",
7350
+ "properties": {
7351
+ "en": {
7352
+ "type": "string",
7353
+ "description": "Name of the extension in English."
7354
+ }
7355
+ },
7356
+ "additionalProperties": {
7357
+ "type": "string",
7358
+ "description": "Name of the extension in some other language denoted by ISO 3166-1 alpha-2 code."
7359
+ },
7360
+ "required": [
7361
+ "en"
7362
+ ],
7363
+ "description": "Name of the extension."
7364
+ },
7348
7365
  "version": {
7349
7366
  "type": "string",
7350
7367
  "description": "Version of the extension."
7351
7368
  },
7352
- "variables": {
7369
+ "options": {
7353
7370
  "type": "array",
7354
- "description": "Variables available to the extension configurable by the portal administrator.",
7371
+ "description": "Options available to the extension configurable by the portal administrator.",
7355
7372
  "items": {
7356
7373
  "type": "object",
7357
7374
  "properties": {
7358
7375
  "id": {
7359
7376
  "type": "string",
7360
- "description": "Identifier of the variable. Should not change between updates."
7377
+ "description": "Identifier of the option. Should not change between updates."
7361
7378
  },
7362
7379
  "name": {
7363
7380
  "type": "object",
7364
7381
  "properties": {
7365
7382
  "en": {
7366
7383
  "type": "string",
7367
- "description": "Name of the variable in English."
7384
+ "description": "Name of the option in English."
7368
7385
  }
7369
7386
  },
7370
7387
  "additionalProperties": {
7371
7388
  "type": "string",
7372
- "description": "Name of the variable in some other language denoted by ISO 3166-1 alpha-2 code."
7389
+ "description": "Name of the option in some other language denoted by ISO 3166-1 alpha-2 code."
7373
7390
  },
7374
7391
  "required": [
7375
7392
  "en"
7376
7393
  ],
7377
- "description": "Name of the variable."
7394
+ "description": "Name of the option."
7378
7395
  },
7379
7396
  "type": {
7380
7397
  "type": "string",
7381
7398
  "enum": [
7382
7399
  "secret"
7383
7400
  ],
7384
- "description": "Type of the variable."
7401
+ "description": "Type of the option."
7385
7402
  },
7386
7403
  "description": {
7387
7404
  "type": "object",
7388
7405
  "properties": {
7389
7406
  "en": {
7390
7407
  "type": "string",
7391
- "description": "Description of the variable in English."
7408
+ "description": "Description of the option in English."
7392
7409
  }
7393
7410
  },
7394
7411
  "additionalProperties": {
7395
7412
  "type": "string",
7396
- "description": "Description of the variable in some other language denoted by ISO 3166-1 alpha-2 code."
7413
+ "description": "Description of the option in some other language denoted by ISO 3166-1 alpha-2 code."
7397
7414
  },
7398
7415
  "required": [
7399
7416
  "en"
7400
7417
  ],
7401
- "description": "Description of the variable."
7418
+ "description": "Description of the option."
7402
7419
  },
7403
7420
  "default": {
7404
7421
  "type": "string",
7405
- "description": "Default value of the variable."
7422
+ "description": "Default value of the option."
7406
7423
  },
7407
7424
  "required": {
7408
7425
  "type": "boolean",
7409
- "description": "Indicate whether the variable is required.",
7426
+ "description": "Indicate whether the option is required.",
7410
7427
  "default": false
7411
7428
  }
7412
7429
  },
@@ -7417,20 +7434,13 @@
7417
7434
  ]
7418
7435
  }
7419
7436
  },
7420
- "widgets": {
7437
+ "links": {
7421
7438
  "type": "array",
7422
- "description": "Widgets that can be used by portal administrator.",
7439
+ "description": "External links added to the portal.",
7423
7440
  "items": {
7424
7441
  "allOf": [
7425
7442
  {
7426
- "$ref": "#/components/schemas/ExtensionWidget"
7427
- },
7428
- {
7429
- "anyOf": [
7430
- {
7431
- "$ref": "#/components/schemas/ExtensionWidgetSeamlessLink"
7432
- }
7433
- ]
7443
+ "$ref": "#/components/schemas/ExtensionSeamlessLink"
7434
7444
  }
7435
7445
  ]
7436
7446
  }
@@ -7460,67 +7470,18 @@
7460
7470
  "description"
7461
7471
  ]
7462
7472
  },
7463
- "ExtensionWidget": {
7464
- "type": "object",
7465
- "properties": {
7466
- "id": {
7467
- "type": "string",
7468
- "description": "Identifier of the widget. Should not change between updates."
7469
- },
7470
- "name": {
7471
- "type": "object",
7472
- "properties": {
7473
- "en": {
7474
- "type": "string",
7475
- "description": "Name of the widget in English."
7476
- }
7477
- },
7478
- "additionalProperties": {
7479
- "type": "string",
7480
- "description": "Name of the widget in some other language denoted by ISO 3166-1 alpha-2 code."
7481
- },
7482
- "required": [
7483
- "en"
7484
- ],
7485
- "description": "Name of the widget."
7486
- },
7487
- "description": {
7488
- "type": "object",
7489
- "properties": {
7490
- "en": {
7491
- "type": "string",
7492
- "description": "Description of the widget in English."
7493
- }
7494
- },
7495
- "additionalProperties": {
7496
- "type": "string",
7497
- "description": "Description of the widget in some other language denoted by ISO 3166-1 alpha-2 code."
7498
- },
7499
- "required": [
7500
- "en"
7501
- ],
7502
- "description": "Description of the widget."
7503
- }
7504
- }
7505
- },
7506
- "ExtensionWidgetSeamlessLink": {
7473
+ "ExtensionSeamlessLink": {
7507
7474
  "type": "object",
7508
7475
  "properties": {
7509
7476
  "type": {
7510
7477
  "type": "string",
7511
7478
  "enum": [
7512
- "seamlessLink"
7479
+ "seamless"
7513
7480
  ]
7514
7481
  },
7515
7482
  "authentication": {
7516
7483
  "type": "object",
7517
7484
  "properties": {
7518
- "type": {
7519
- "type": "string",
7520
- "enum": [
7521
- "token"
7522
- ]
7523
- },
7524
7485
  "method": {
7525
7486
  "type": "string",
7526
7487
  "description": "HTTP method to use for authentication",
@@ -7528,11 +7489,11 @@
7528
7489
  },
7529
7490
  "url": {
7530
7491
  "type": "string",
7531
- "description": "URL to use for authentication"
7492
+ "description": "URL to use for authentication. Supports variable interpolation."
7532
7493
  },
7533
7494
  "params": {
7534
7495
  "type": "object",
7535
- "description": "Parameters to append to the URL.",
7496
+ "description": "Parameters to append to the URL. Supports variable interpolation.",
7536
7497
  "additionalProperties": {
7537
7498
  "type": "string"
7538
7499
  },
@@ -7540,7 +7501,7 @@
7540
7501
  },
7541
7502
  "headers": {
7542
7503
  "type": "object",
7543
- "description": "Headers to use for authentication",
7504
+ "description": "Headers to use for authentication. Supports variable interpolation.",
7544
7505
  "additionalProperties": {
7545
7506
  "type": "string"
7546
7507
  },
@@ -7548,24 +7509,27 @@
7548
7509
  },
7549
7510
  "body": {
7550
7511
  "type": "object",
7551
- "description": "JSON body to use for authentication",
7512
+ "description": "JSON body to use for authentication. Supports variable interpolation.",
7552
7513
  "additionalProperties": {
7553
7514
  "type": "string"
7554
7515
  },
7555
7516
  "default": {}
7556
7517
  }
7557
- }
7518
+ },
7519
+ "required": [
7520
+ "url"
7521
+ ]
7558
7522
  },
7559
7523
  "redirect": {
7560
7524
  "type": "object",
7561
7525
  "properties": {
7562
7526
  "url": {
7563
7527
  "type": "string",
7564
- "description": "URL to redirect to."
7528
+ "description": "URL to redirect to. Supports variable interpolation."
7565
7529
  },
7566
7530
  "params": {
7567
7531
  "type": "object",
7568
- "description": "Parameters to append to the URL.",
7532
+ "description": "Parameters to append to the URL. Supports variable interpolation.",
7569
7533
  "additionalProperties": {
7570
7534
  "type": "string"
7571
7535
  },
@@ -7573,7 +7537,11 @@
7573
7537
  }
7574
7538
  }
7575
7539
  }
7576
- }
7540
+ },
7541
+ "required": [
7542
+ "type",
7543
+ "redirect"
7544
+ ]
7577
7545
  },
7578
7546
  "ExtensionHook": {
7579
7547
  "type": "object",
@@ -7585,7 +7553,7 @@
7585
7553
  }
7586
7554
  },
7587
7555
  "ExtensionHookRegistrationIdentifiersCheck": {
7588
- "description": "Hook that replaces the built-in registration identifiers check. This hook makes the specified call whenever a user is trying to register to find the corresponding contact. The expected response to the call is:\n - 200 with body `{ \"contactId\": \"uuid\" }` if exactly one contact is found\n - 404 if no contact is found or more than contact is found\n",
7556
+ "description": "Hook that replaces the built-in registration identifiers check. This hook makes a POST call whenever a user is trying to register to find the corresponding contact. The expected response to the call is:\n - 200 with body `{ \"contactId\": \"uuid\" }` if exactly one contact is found\n - 404 if no contact is found or more than contact is found\n",
7589
7557
  "type": "object",
7590
7558
  "properties": {
7591
7559
  "type": {
@@ -7594,6 +7562,47 @@
7594
7562
  "registrationIdentifiersCheck"
7595
7563
  ]
7596
7564
  },
7565
+ "authentication": {
7566
+ "type": "object",
7567
+ "properties": {
7568
+ "method": {
7569
+ "type": "string",
7570
+ "description": "HTTP method to use for authentication",
7571
+ "default": "GET"
7572
+ },
7573
+ "url": {
7574
+ "type": "string",
7575
+ "description": "URL to use for authentication. Supports variable interpolation."
7576
+ },
7577
+ "params": {
7578
+ "type": "object",
7579
+ "description": "Parameters to append to the URL. Supports variable interpolation.",
7580
+ "additionalProperties": {
7581
+ "type": "string"
7582
+ },
7583
+ "default": {}
7584
+ },
7585
+ "headers": {
7586
+ "type": "object",
7587
+ "description": "Headers to use for authentication. Supports variable interpolation.",
7588
+ "additionalProperties": {
7589
+ "type": "string"
7590
+ },
7591
+ "default": {}
7592
+ },
7593
+ "body": {
7594
+ "type": "object",
7595
+ "description": "JSON body to use for authentication. Supports variable interpolation.",
7596
+ "additionalProperties": {
7597
+ "type": "string"
7598
+ },
7599
+ "default": {}
7600
+ }
7601
+ },
7602
+ "required": [
7603
+ "url"
7604
+ ]
7605
+ },
7597
7606
  "call": {
7598
7607
  "type": "object",
7599
7608
  "properties": {
@@ -7603,7 +7612,7 @@
7603
7612
  },
7604
7613
  "params": {
7605
7614
  "type": "object",
7606
- "description": "Parameters to append to the URL.",
7615
+ "description": "Parameters to append to the URL. Supports variable interpolation.",
7607
7616
  "additionalProperties": {
7608
7617
  "type": "string"
7609
7618
  },