sailpoint-api-client 1.7.19 → 1.7.21
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/beta/README.md +2 -2
- package/beta/common.ts +2 -2
- package/beta/package.json +1 -1
- package/dist/beta/common.js +1 -1
- package/dist/v2024/common.js +1 -1
- package/dist/v2025/api.d.ts +983 -0
- package/dist/v2025/api.js +1294 -263
- package/dist/v2025/api.js.map +1 -1
- package/dist/v2025/common.js +1 -1
- package/dist/v2026/common.js +1 -1
- package/dist/v3/common.js +1 -1
- package/package.json +1 -1
- package/v2024/README.md +2 -2
- package/v2024/common.ts +2 -2
- package/v2024/package.json +1 -1
- package/v2025/README.md +2 -2
- package/v2025/api.ts +1462 -0
- package/v2025/common.ts +2 -2
- package/v2025/package.json +1 -1
- package/v2026/README.md +2 -2
- package/v2026/common.ts +2 -2
- package/v2026/package.json +1 -1
- package/v3/README.md +2 -2
- package/v3/common.ts +2 -2
- package/v3/package.json +1 -1
package/v2025/api.ts
CHANGED
|
@@ -9444,6 +9444,19 @@ export const AuthUserV2025CapabilitiesV2025 = {
|
|
|
9444
9444
|
|
|
9445
9445
|
export type AuthUserV2025CapabilitiesV2025 = typeof AuthUserV2025CapabilitiesV2025[keyof typeof AuthUserV2025CapabilitiesV2025];
|
|
9446
9446
|
|
|
9447
|
+
/**
|
|
9448
|
+
* Authorization scheme supported by the transmitter.
|
|
9449
|
+
* @export
|
|
9450
|
+
* @interface AuthorizationSchemeV2025
|
|
9451
|
+
*/
|
|
9452
|
+
export interface AuthorizationSchemeV2025 {
|
|
9453
|
+
/**
|
|
9454
|
+
* URN describing the authorization specification. OAuth 2.0: `urn:ietf:rfc:6749`; Bearer token: `urn:ietf:rfc:6750`.
|
|
9455
|
+
* @type {string}
|
|
9456
|
+
* @memberof AuthorizationSchemeV2025
|
|
9457
|
+
*/
|
|
9458
|
+
'spec_urn'?: string;
|
|
9459
|
+
}
|
|
9447
9460
|
/**
|
|
9448
9461
|
* Backup options control what will be included in the backup.
|
|
9449
9462
|
* @export
|
|
@@ -15863,6 +15876,56 @@ export interface CreateScheduledSearchRequestV2025 {
|
|
|
15863
15876
|
*/
|
|
15864
15877
|
'displayQueryDetails'?: boolean;
|
|
15865
15878
|
}
|
|
15879
|
+
/**
|
|
15880
|
+
* Full delivery configuration. method and endpoint_url are required.
|
|
15881
|
+
* @export
|
|
15882
|
+
* @interface CreateStreamDeliveryRequestV2025
|
|
15883
|
+
*/
|
|
15884
|
+
export interface CreateStreamDeliveryRequestV2025 {
|
|
15885
|
+
/**
|
|
15886
|
+
* Delivery method (only push is supported).
|
|
15887
|
+
* @type {string}
|
|
15888
|
+
* @memberof CreateStreamDeliveryRequestV2025
|
|
15889
|
+
*/
|
|
15890
|
+
'method': string;
|
|
15891
|
+
/**
|
|
15892
|
+
* Receiver endpoint URL for push delivery.
|
|
15893
|
+
* @type {string}
|
|
15894
|
+
* @memberof CreateStreamDeliveryRequestV2025
|
|
15895
|
+
*/
|
|
15896
|
+
'endpoint_url': string;
|
|
15897
|
+
/**
|
|
15898
|
+
* Authorization header value for delivery requests.
|
|
15899
|
+
* @type {string}
|
|
15900
|
+
* @memberof CreateStreamDeliveryRequestV2025
|
|
15901
|
+
*/
|
|
15902
|
+
'authorization_header'?: string;
|
|
15903
|
+
}
|
|
15904
|
+
/**
|
|
15905
|
+
* Request body for POST /ssf/streams (create stream).
|
|
15906
|
+
* @export
|
|
15907
|
+
* @interface CreateStreamRequestV2025
|
|
15908
|
+
*/
|
|
15909
|
+
export interface CreateStreamRequestV2025 {
|
|
15910
|
+
/**
|
|
15911
|
+
*
|
|
15912
|
+
* @type {CreateStreamDeliveryRequestV2025}
|
|
15913
|
+
* @memberof CreateStreamRequestV2025
|
|
15914
|
+
*/
|
|
15915
|
+
'delivery': CreateStreamDeliveryRequestV2025;
|
|
15916
|
+
/**
|
|
15917
|
+
* Optional list of event types the receiver wants. Use CAEP event-type URIs in the form: `https://schemas.openid.net/secevent/caep/event-type/{event-type}` (e.g. session revoke).
|
|
15918
|
+
* @type {Array<string>}
|
|
15919
|
+
* @memberof CreateStreamRequestV2025
|
|
15920
|
+
*/
|
|
15921
|
+
'events_requested'?: Array<string>;
|
|
15922
|
+
/**
|
|
15923
|
+
* Optional human-readable description of the stream.
|
|
15924
|
+
* @type {string}
|
|
15925
|
+
* @memberof CreateStreamRequestV2025
|
|
15926
|
+
*/
|
|
15927
|
+
'description'?: string;
|
|
15928
|
+
}
|
|
15866
15929
|
/**
|
|
15867
15930
|
*
|
|
15868
15931
|
* @export
|
|
@@ -16393,6 +16456,50 @@ export const DeleteSource202ResponseV2025TypeV2025 = {
|
|
|
16393
16456
|
|
|
16394
16457
|
export type DeleteSource202ResponseV2025TypeV2025 = typeof DeleteSource202ResponseV2025TypeV2025[keyof typeof DeleteSource202ResponseV2025TypeV2025];
|
|
16395
16458
|
|
|
16459
|
+
/**
|
|
16460
|
+
* Delivery configuration for PATCH /ssf/streams (partial update). All fields are optional; only provided fields are updated.
|
|
16461
|
+
* @export
|
|
16462
|
+
* @interface DeliveryRequestV2025
|
|
16463
|
+
*/
|
|
16464
|
+
export interface DeliveryRequestV2025 {
|
|
16465
|
+
/**
|
|
16466
|
+
* Delivery method (optional for PATCH).
|
|
16467
|
+
* @type {string}
|
|
16468
|
+
* @memberof DeliveryRequestV2025
|
|
16469
|
+
*/
|
|
16470
|
+
'method'?: string;
|
|
16471
|
+
/**
|
|
16472
|
+
* Receiver endpoint URL (optional for PATCH).
|
|
16473
|
+
* @type {string}
|
|
16474
|
+
* @memberof DeliveryRequestV2025
|
|
16475
|
+
*/
|
|
16476
|
+
'endpoint_url'?: string;
|
|
16477
|
+
/**
|
|
16478
|
+
* Optional authorization header value.
|
|
16479
|
+
* @type {string}
|
|
16480
|
+
* @memberof DeliveryRequestV2025
|
|
16481
|
+
*/
|
|
16482
|
+
'authorization_header'?: string;
|
|
16483
|
+
}
|
|
16484
|
+
/**
|
|
16485
|
+
* Delivery configuration returned in stream responses.
|
|
16486
|
+
* @export
|
|
16487
|
+
* @interface DeliveryResponseV2025
|
|
16488
|
+
*/
|
|
16489
|
+
export interface DeliveryResponseV2025 {
|
|
16490
|
+
/**
|
|
16491
|
+
* Delivery method.
|
|
16492
|
+
* @type {string}
|
|
16493
|
+
* @memberof DeliveryResponseV2025
|
|
16494
|
+
*/
|
|
16495
|
+
'method'?: string;
|
|
16496
|
+
/**
|
|
16497
|
+
* Receiver endpoint URL.
|
|
16498
|
+
* @type {string}
|
|
16499
|
+
* @memberof DeliveryResponseV2025
|
|
16500
|
+
*/
|
|
16501
|
+
'endpoint_url'?: string;
|
|
16502
|
+
}
|
|
16396
16503
|
/**
|
|
16397
16504
|
*
|
|
16398
16505
|
* @export
|
|
@@ -21613,6 +21720,12 @@ export interface GetRoleAssignments200ResponseInnerV2025 {
|
|
|
21613
21720
|
*/
|
|
21614
21721
|
'accountTargets'?: Array<RoleTargetDtoV2025>;
|
|
21615
21722
|
}
|
|
21723
|
+
/**
|
|
21724
|
+
* @type GetStream200ResponseV2025
|
|
21725
|
+
* @export
|
|
21726
|
+
*/
|
|
21727
|
+
export type GetStream200ResponseV2025 = Array<StreamConfigResponseV2025> | StreamConfigResponseV2025;
|
|
21728
|
+
|
|
21616
21729
|
/**
|
|
21617
21730
|
*
|
|
21618
21731
|
* @export
|
|
@@ -24881,6 +24994,62 @@ export interface JITConfigurationV2025 {
|
|
|
24881
24994
|
*/
|
|
24882
24995
|
'sourceAttributeMappings'?: { [key: string]: string; };
|
|
24883
24996
|
}
|
|
24997
|
+
/**
|
|
24998
|
+
* JSON Web Key Set containing the transmitter\'s public keys for verifying signed delivery requests.
|
|
24999
|
+
* @export
|
|
25000
|
+
* @interface JWKSV2025
|
|
25001
|
+
*/
|
|
25002
|
+
export interface JWKSV2025 {
|
|
25003
|
+
/**
|
|
25004
|
+
* Array of JSON Web Keys.
|
|
25005
|
+
* @type {Array<JWKV2025>}
|
|
25006
|
+
* @memberof JWKSV2025
|
|
25007
|
+
*/
|
|
25008
|
+
'keys': Array<JWKV2025>;
|
|
25009
|
+
}
|
|
25010
|
+
/**
|
|
25011
|
+
* A single JSON Web Key used for verifying signed delivery requests.
|
|
25012
|
+
* @export
|
|
25013
|
+
* @interface JWKV2025
|
|
25014
|
+
*/
|
|
25015
|
+
export interface JWKV2025 {
|
|
25016
|
+
/**
|
|
25017
|
+
* Algorithm intended for use with the key (e.g. RS256).
|
|
25018
|
+
* @type {string}
|
|
25019
|
+
* @memberof JWKV2025
|
|
25020
|
+
*/
|
|
25021
|
+
'alg'?: string;
|
|
25022
|
+
/**
|
|
25023
|
+
* RSA public exponent (Base64url encoded).
|
|
25024
|
+
* @type {string}
|
|
25025
|
+
* @memberof JWKV2025
|
|
25026
|
+
*/
|
|
25027
|
+
'e'?: string;
|
|
25028
|
+
/**
|
|
25029
|
+
* Key ID - unique identifier for the key.
|
|
25030
|
+
* @type {string}
|
|
25031
|
+
* @memberof JWKV2025
|
|
25032
|
+
*/
|
|
25033
|
+
'kid'?: string;
|
|
25034
|
+
/**
|
|
25035
|
+
* Key type (e.g. RSA).
|
|
25036
|
+
* @type {string}
|
|
25037
|
+
* @memberof JWKV2025
|
|
25038
|
+
*/
|
|
25039
|
+
'kty'?: string;
|
|
25040
|
+
/**
|
|
25041
|
+
* RSA modulus (Base64url encoded).
|
|
25042
|
+
* @type {string}
|
|
25043
|
+
* @memberof JWKV2025
|
|
25044
|
+
*/
|
|
25045
|
+
'n'?: string;
|
|
25046
|
+
/**
|
|
25047
|
+
* Intended use of the key (e.g. sig for signature verification).
|
|
25048
|
+
* @type {string}
|
|
25049
|
+
* @memberof JWKV2025
|
|
25050
|
+
*/
|
|
25051
|
+
'use'?: string;
|
|
25052
|
+
}
|
|
24884
25053
|
/**
|
|
24885
25054
|
* A JSONPatch Operation for Role Mining endpoints, supporting only remove and replace operations as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)
|
|
24886
25055
|
* @export
|
|
@@ -35890,6 +36059,62 @@ export interface ReplaceAllV2025 {
|
|
|
35890
36059
|
*/
|
|
35891
36060
|
'input'?: { [key: string]: any; };
|
|
35892
36061
|
}
|
|
36062
|
+
/**
|
|
36063
|
+
*
|
|
36064
|
+
* @export
|
|
36065
|
+
* @interface ReplaceStreamConfigurationRequestDeliveryV2025
|
|
36066
|
+
*/
|
|
36067
|
+
export interface ReplaceStreamConfigurationRequestDeliveryV2025 {
|
|
36068
|
+
/**
|
|
36069
|
+
* Delivery method (only push is supported).
|
|
36070
|
+
* @type {string}
|
|
36071
|
+
* @memberof ReplaceStreamConfigurationRequestDeliveryV2025
|
|
36072
|
+
*/
|
|
36073
|
+
'method': string;
|
|
36074
|
+
/**
|
|
36075
|
+
* Receiver endpoint URL for push delivery.
|
|
36076
|
+
* @type {string}
|
|
36077
|
+
* @memberof ReplaceStreamConfigurationRequestDeliveryV2025
|
|
36078
|
+
*/
|
|
36079
|
+
'endpoint_url': string;
|
|
36080
|
+
/**
|
|
36081
|
+
* Authorization header value for delivery requests.
|
|
36082
|
+
* @type {string}
|
|
36083
|
+
* @memberof ReplaceStreamConfigurationRequestDeliveryV2025
|
|
36084
|
+
*/
|
|
36085
|
+
'authorization_header'?: string;
|
|
36086
|
+
}
|
|
36087
|
+
/**
|
|
36088
|
+
* Request body for PUT /ssf/streams (full replace).
|
|
36089
|
+
* @export
|
|
36090
|
+
* @interface ReplaceStreamConfigurationRequestV2025
|
|
36091
|
+
*/
|
|
36092
|
+
export interface ReplaceStreamConfigurationRequestV2025 {
|
|
36093
|
+
/**
|
|
36094
|
+
* ID of the stream to replace.
|
|
36095
|
+
* @type {string}
|
|
36096
|
+
* @memberof ReplaceStreamConfigurationRequestV2025
|
|
36097
|
+
*/
|
|
36098
|
+
'stream_id': string;
|
|
36099
|
+
/**
|
|
36100
|
+
*
|
|
36101
|
+
* @type {ReplaceStreamConfigurationRequestDeliveryV2025}
|
|
36102
|
+
* @memberof ReplaceStreamConfigurationRequestV2025
|
|
36103
|
+
*/
|
|
36104
|
+
'delivery': ReplaceStreamConfigurationRequestDeliveryV2025;
|
|
36105
|
+
/**
|
|
36106
|
+
* Event types the receiver wants. Use CAEP event-type URIs.
|
|
36107
|
+
* @type {Array<string>}
|
|
36108
|
+
* @memberof ReplaceStreamConfigurationRequestV2025
|
|
36109
|
+
*/
|
|
36110
|
+
'events_requested'?: Array<string>;
|
|
36111
|
+
/**
|
|
36112
|
+
* Optional human-readable description of the stream.
|
|
36113
|
+
* @type {string}
|
|
36114
|
+
* @memberof ReplaceStreamConfigurationRequestV2025
|
|
36115
|
+
*/
|
|
36116
|
+
'description'?: string;
|
|
36117
|
+
}
|
|
35893
36118
|
/**
|
|
35894
36119
|
*
|
|
35895
36120
|
* @export
|
|
@@ -47355,6 +47580,107 @@ export const StatusResponseV2025StatusV2025 = {
|
|
|
47355
47580
|
|
|
47356
47581
|
export type StatusResponseV2025StatusV2025 = typeof StatusResponseV2025StatusV2025[keyof typeof StatusResponseV2025StatusV2025];
|
|
47357
47582
|
|
|
47583
|
+
/**
|
|
47584
|
+
* Full stream configuration returned by create/get/update/replace.
|
|
47585
|
+
* @export
|
|
47586
|
+
* @interface StreamConfigResponseV2025
|
|
47587
|
+
*/
|
|
47588
|
+
export interface StreamConfigResponseV2025 {
|
|
47589
|
+
/**
|
|
47590
|
+
* Unique stream identifier.
|
|
47591
|
+
* @type {string}
|
|
47592
|
+
* @memberof StreamConfigResponseV2025
|
|
47593
|
+
*/
|
|
47594
|
+
'stream_id'?: string;
|
|
47595
|
+
/**
|
|
47596
|
+
* Issuer (transmitter) URL.
|
|
47597
|
+
* @type {string}
|
|
47598
|
+
* @memberof StreamConfigResponseV2025
|
|
47599
|
+
*/
|
|
47600
|
+
'iss'?: string;
|
|
47601
|
+
/**
|
|
47602
|
+
* Audience for the stream.
|
|
47603
|
+
* @type {string}
|
|
47604
|
+
* @memberof StreamConfigResponseV2025
|
|
47605
|
+
*/
|
|
47606
|
+
'aud'?: string;
|
|
47607
|
+
/**
|
|
47608
|
+
*
|
|
47609
|
+
* @type {DeliveryResponseV2025}
|
|
47610
|
+
* @memberof StreamConfigResponseV2025
|
|
47611
|
+
*/
|
|
47612
|
+
'delivery'?: DeliveryResponseV2025;
|
|
47613
|
+
/**
|
|
47614
|
+
* Event types supported by the transmitter. Use CAEP event-type URIs in the form: `https://schemas.openid.net/secevent/caep/event-type/{event-type}` (e.g. session-revoked).
|
|
47615
|
+
* @type {Array<string>}
|
|
47616
|
+
* @memberof StreamConfigResponseV2025
|
|
47617
|
+
*/
|
|
47618
|
+
'events_supported'?: Array<string>;
|
|
47619
|
+
/**
|
|
47620
|
+
* Event types requested by the receiver. Use CAEP event-type URIs in the form: `https://schemas.openid.net/secevent/caep/event-type/{event-type}` (e.g. session revoke).
|
|
47621
|
+
* @type {Array<string>}
|
|
47622
|
+
* @memberof StreamConfigResponseV2025
|
|
47623
|
+
*/
|
|
47624
|
+
'events_requested'?: Array<string>;
|
|
47625
|
+
/**
|
|
47626
|
+
* Event types currently being delivered (intersection of supported and requested).
|
|
47627
|
+
* @type {Array<string>}
|
|
47628
|
+
* @memberof StreamConfigResponseV2025
|
|
47629
|
+
*/
|
|
47630
|
+
'events_delivered'?: Array<string>;
|
|
47631
|
+
/**
|
|
47632
|
+
* Optional stream description.
|
|
47633
|
+
* @type {string}
|
|
47634
|
+
* @memberof StreamConfigResponseV2025
|
|
47635
|
+
*/
|
|
47636
|
+
'description'?: string;
|
|
47637
|
+
/**
|
|
47638
|
+
* Inactivity timeout in seconds (optional).
|
|
47639
|
+
* @type {number}
|
|
47640
|
+
* @memberof StreamConfigResponseV2025
|
|
47641
|
+
*/
|
|
47642
|
+
'inactivity_timeout'?: number;
|
|
47643
|
+
/**
|
|
47644
|
+
* Minimum verification interval in seconds (optional).
|
|
47645
|
+
* @type {number}
|
|
47646
|
+
* @memberof StreamConfigResponseV2025
|
|
47647
|
+
*/
|
|
47648
|
+
'min_verification_interval'?: number;
|
|
47649
|
+
}
|
|
47650
|
+
/**
|
|
47651
|
+
* Stream status returned by GET/POST /ssf/streams/status.
|
|
47652
|
+
* @export
|
|
47653
|
+
* @interface StreamStatusResponseV2025
|
|
47654
|
+
*/
|
|
47655
|
+
export interface StreamStatusResponseV2025 {
|
|
47656
|
+
/**
|
|
47657
|
+
* Stream identifier.
|
|
47658
|
+
* @type {string}
|
|
47659
|
+
* @memberof StreamStatusResponseV2025
|
|
47660
|
+
*/
|
|
47661
|
+
'stream_id'?: string;
|
|
47662
|
+
/**
|
|
47663
|
+
* Operational status of the stream (enabled, paused, or disabled).
|
|
47664
|
+
* @type {string}
|
|
47665
|
+
* @memberof StreamStatusResponseV2025
|
|
47666
|
+
*/
|
|
47667
|
+
'status'?: StreamStatusResponseV2025StatusV2025;
|
|
47668
|
+
/**
|
|
47669
|
+
* Optional reason for the current status (e.g. set when status is updated).
|
|
47670
|
+
* @type {string}
|
|
47671
|
+
* @memberof StreamStatusResponseV2025
|
|
47672
|
+
*/
|
|
47673
|
+
'reason'?: string;
|
|
47674
|
+
}
|
|
47675
|
+
|
|
47676
|
+
export const StreamStatusResponseV2025StatusV2025 = {
|
|
47677
|
+
Enabled: 'enabled',
|
|
47678
|
+
Paused: 'paused',
|
|
47679
|
+
Disabled: 'disabled'
|
|
47680
|
+
} as const;
|
|
47681
|
+
|
|
47682
|
+
export type StreamStatusResponseV2025StatusV2025 = typeof StreamStatusResponseV2025StatusV2025[keyof typeof StreamStatusResponseV2025StatusV2025];
|
|
47683
|
+
|
|
47358
47684
|
/**
|
|
47359
47685
|
*
|
|
47360
47686
|
* @export
|
|
@@ -49489,6 +49815,61 @@ export interface TranslationMessageV2025 {
|
|
|
49489
49815
|
*/
|
|
49490
49816
|
'values'?: Array<string>;
|
|
49491
49817
|
}
|
|
49818
|
+
/**
|
|
49819
|
+
* SSF transmitter discovery metadata per the SSF specification.
|
|
49820
|
+
* @export
|
|
49821
|
+
* @interface TransmitterMetadataV2025
|
|
49822
|
+
*/
|
|
49823
|
+
export interface TransmitterMetadataV2025 {
|
|
49824
|
+
/**
|
|
49825
|
+
* Version of the SSF specification supported.
|
|
49826
|
+
* @type {string}
|
|
49827
|
+
* @memberof TransmitterMetadataV2025
|
|
49828
|
+
*/
|
|
49829
|
+
'spec_version'?: string;
|
|
49830
|
+
/**
|
|
49831
|
+
* Base URL of the transmitter (issuer).
|
|
49832
|
+
* @type {string}
|
|
49833
|
+
* @memberof TransmitterMetadataV2025
|
|
49834
|
+
*/
|
|
49835
|
+
'issuer'?: string;
|
|
49836
|
+
/**
|
|
49837
|
+
* URL of the transmitter\'s JSON Web Key Set.
|
|
49838
|
+
* @type {string}
|
|
49839
|
+
* @memberof TransmitterMetadataV2025
|
|
49840
|
+
*/
|
|
49841
|
+
'jwks_uri'?: string;
|
|
49842
|
+
/**
|
|
49843
|
+
* Supported delivery methods (e.g. push URN).
|
|
49844
|
+
* @type {Array<string>}
|
|
49845
|
+
* @memberof TransmitterMetadataV2025
|
|
49846
|
+
*/
|
|
49847
|
+
'delivery_methods_supported'?: Array<string>;
|
|
49848
|
+
/**
|
|
49849
|
+
* Endpoint for stream configuration (create, read, update, replace, delete).
|
|
49850
|
+
* @type {string}
|
|
49851
|
+
* @memberof TransmitterMetadataV2025
|
|
49852
|
+
*/
|
|
49853
|
+
'configuration_endpoint'?: string;
|
|
49854
|
+
/**
|
|
49855
|
+
* Endpoint for reading and updating stream status.
|
|
49856
|
+
* @type {string}
|
|
49857
|
+
* @memberof TransmitterMetadataV2025
|
|
49858
|
+
*/
|
|
49859
|
+
'status_endpoint'?: string;
|
|
49860
|
+
/**
|
|
49861
|
+
* Endpoint for receiver verification.
|
|
49862
|
+
* @type {string}
|
|
49863
|
+
* @memberof TransmitterMetadataV2025
|
|
49864
|
+
*/
|
|
49865
|
+
'verification_endpoint'?: string;
|
|
49866
|
+
/**
|
|
49867
|
+
* Supported authorization schemes (e.g. OAuth2, Bearer).
|
|
49868
|
+
* @type {Array<AuthorizationSchemeV2025>}
|
|
49869
|
+
* @memberof TransmitterMetadataV2025
|
|
49870
|
+
*/
|
|
49871
|
+
'authorization_schemes'?: Array<AuthorizationSchemeV2025>;
|
|
49872
|
+
}
|
|
49492
49873
|
/**
|
|
49493
49874
|
* @type TriggerExampleInputV2025
|
|
49494
49875
|
* An example of the JSON payload that will be sent by the trigger to the subscribed service.
|
|
@@ -49858,6 +50239,144 @@ export interface UpdateScheduleRequestV2025 {
|
|
|
49858
50239
|
*/
|
|
49859
50240
|
'applicationId'?: number | null;
|
|
49860
50241
|
}
|
|
50242
|
+
/**
|
|
50243
|
+
* Stream configuration response including updatedAt (for PATCH/PUT). Same JSON shape as GET single stream plus updatedAt.
|
|
50244
|
+
* @export
|
|
50245
|
+
* @interface UpdateStreamConfigResponseV2025
|
|
50246
|
+
*/
|
|
50247
|
+
export interface UpdateStreamConfigResponseV2025 {
|
|
50248
|
+
/**
|
|
50249
|
+
* Unique stream identifier.
|
|
50250
|
+
* @type {string}
|
|
50251
|
+
* @memberof UpdateStreamConfigResponseV2025
|
|
50252
|
+
*/
|
|
50253
|
+
'stream_id'?: string;
|
|
50254
|
+
/**
|
|
50255
|
+
* Issuer (transmitter) URL.
|
|
50256
|
+
* @type {string}
|
|
50257
|
+
* @memberof UpdateStreamConfigResponseV2025
|
|
50258
|
+
*/
|
|
50259
|
+
'iss'?: string;
|
|
50260
|
+
/**
|
|
50261
|
+
* Audience for the stream.
|
|
50262
|
+
* @type {string}
|
|
50263
|
+
* @memberof UpdateStreamConfigResponseV2025
|
|
50264
|
+
*/
|
|
50265
|
+
'aud'?: string;
|
|
50266
|
+
/**
|
|
50267
|
+
*
|
|
50268
|
+
* @type {DeliveryResponseV2025}
|
|
50269
|
+
* @memberof UpdateStreamConfigResponseV2025
|
|
50270
|
+
*/
|
|
50271
|
+
'delivery'?: DeliveryResponseV2025;
|
|
50272
|
+
/**
|
|
50273
|
+
* Event types supported by the transmitter. Use CAEP event-type URIs in the form: `https://schemas.openid.net/secevent/caep/event-type/{event-type}` (e.g. session-revoked).
|
|
50274
|
+
* @type {Array<string>}
|
|
50275
|
+
* @memberof UpdateStreamConfigResponseV2025
|
|
50276
|
+
*/
|
|
50277
|
+
'events_supported'?: Array<string>;
|
|
50278
|
+
/**
|
|
50279
|
+
* Event types requested by the receiver. Use CAEP event-type URIs in the form: `https://schemas.openid.net/secevent/caep/event-type/{event-type}` (e.g. session revoke).
|
|
50280
|
+
* @type {Array<string>}
|
|
50281
|
+
* @memberof UpdateStreamConfigResponseV2025
|
|
50282
|
+
*/
|
|
50283
|
+
'events_requested'?: Array<string>;
|
|
50284
|
+
/**
|
|
50285
|
+
* Event types currently being delivered (intersection of supported and requested).
|
|
50286
|
+
* @type {Array<string>}
|
|
50287
|
+
* @memberof UpdateStreamConfigResponseV2025
|
|
50288
|
+
*/
|
|
50289
|
+
'events_delivered'?: Array<string>;
|
|
50290
|
+
/**
|
|
50291
|
+
* Optional stream description.
|
|
50292
|
+
* @type {string}
|
|
50293
|
+
* @memberof UpdateStreamConfigResponseV2025
|
|
50294
|
+
*/
|
|
50295
|
+
'description'?: string;
|
|
50296
|
+
/**
|
|
50297
|
+
* Inactivity timeout in seconds (optional).
|
|
50298
|
+
* @type {number}
|
|
50299
|
+
* @memberof UpdateStreamConfigResponseV2025
|
|
50300
|
+
*/
|
|
50301
|
+
'inactivity_timeout'?: number;
|
|
50302
|
+
/**
|
|
50303
|
+
* Minimum verification interval in seconds (optional).
|
|
50304
|
+
* @type {number}
|
|
50305
|
+
* @memberof UpdateStreamConfigResponseV2025
|
|
50306
|
+
*/
|
|
50307
|
+
'min_verification_interval'?: number;
|
|
50308
|
+
/**
|
|
50309
|
+
* Timestamp of the last configuration update.
|
|
50310
|
+
* @type {string}
|
|
50311
|
+
* @memberof UpdateStreamConfigResponseV2025
|
|
50312
|
+
*/
|
|
50313
|
+
'updatedAt'?: string;
|
|
50314
|
+
}
|
|
50315
|
+
/**
|
|
50316
|
+
* Request body for PATCH /ssf/streams (partial update).
|
|
50317
|
+
* @export
|
|
50318
|
+
* @interface UpdateStreamConfigurationRequestV2025
|
|
50319
|
+
*/
|
|
50320
|
+
export interface UpdateStreamConfigurationRequestV2025 {
|
|
50321
|
+
/**
|
|
50322
|
+
* ID of the stream to update.
|
|
50323
|
+
* @type {string}
|
|
50324
|
+
* @memberof UpdateStreamConfigurationRequestV2025
|
|
50325
|
+
*/
|
|
50326
|
+
'stream_id': string;
|
|
50327
|
+
/**
|
|
50328
|
+
*
|
|
50329
|
+
* @type {DeliveryRequestV2025}
|
|
50330
|
+
* @memberof UpdateStreamConfigurationRequestV2025
|
|
50331
|
+
*/
|
|
50332
|
+
'delivery'?: DeliveryRequestV2025;
|
|
50333
|
+
/**
|
|
50334
|
+
* Event types the receiver wants. Use CAEP event-type URIs.
|
|
50335
|
+
* @type {Array<string>}
|
|
50336
|
+
* @memberof UpdateStreamConfigurationRequestV2025
|
|
50337
|
+
*/
|
|
50338
|
+
'events_requested'?: Array<string>;
|
|
50339
|
+
/**
|
|
50340
|
+
* Optional human-readable description of the stream.
|
|
50341
|
+
* @type {string}
|
|
50342
|
+
* @memberof UpdateStreamConfigurationRequestV2025
|
|
50343
|
+
*/
|
|
50344
|
+
'description'?: string;
|
|
50345
|
+
}
|
|
50346
|
+
/**
|
|
50347
|
+
* Request body for POST /ssf/streams/status.
|
|
50348
|
+
* @export
|
|
50349
|
+
* @interface UpdateStreamStatusRequestV2025
|
|
50350
|
+
*/
|
|
50351
|
+
export interface UpdateStreamStatusRequestV2025 {
|
|
50352
|
+
/**
|
|
50353
|
+
* ID of the stream whose status to update.
|
|
50354
|
+
* @type {string}
|
|
50355
|
+
* @memberof UpdateStreamStatusRequestV2025
|
|
50356
|
+
*/
|
|
50357
|
+
'stream_id': string;
|
|
50358
|
+
/**
|
|
50359
|
+
* Desired stream status.
|
|
50360
|
+
* @type {string}
|
|
50361
|
+
* @memberof UpdateStreamStatusRequestV2025
|
|
50362
|
+
*/
|
|
50363
|
+
'status': UpdateStreamStatusRequestV2025StatusV2025;
|
|
50364
|
+
/**
|
|
50365
|
+
* Optional reason for the status change.
|
|
50366
|
+
* @type {string}
|
|
50367
|
+
* @memberof UpdateStreamStatusRequestV2025
|
|
50368
|
+
*/
|
|
50369
|
+
'reason'?: string;
|
|
50370
|
+
}
|
|
50371
|
+
|
|
50372
|
+
export const UpdateStreamStatusRequestV2025StatusV2025 = {
|
|
50373
|
+
Enabled: 'enabled',
|
|
50374
|
+
Paused: 'paused',
|
|
50375
|
+
Disabled: 'disabled'
|
|
50376
|
+
} as const;
|
|
50377
|
+
|
|
50378
|
+
export type UpdateStreamStatusRequestV2025StatusV2025 = typeof UpdateStreamStatusRequestV2025StatusV2025[keyof typeof UpdateStreamStatusRequestV2025StatusV2025];
|
|
50379
|
+
|
|
49861
50380
|
/**
|
|
49862
50381
|
*
|
|
49863
50382
|
* @export
|
|
@@ -50561,6 +51080,25 @@ export interface ValueV2025 {
|
|
|
50561
51080
|
*/
|
|
50562
51081
|
'value'?: string;
|
|
50563
51082
|
}
|
|
51083
|
+
/**
|
|
51084
|
+
* Request body for POST /ssf/streams/verify (receiver verification).
|
|
51085
|
+
* @export
|
|
51086
|
+
* @interface VerificationRequestV2025
|
|
51087
|
+
*/
|
|
51088
|
+
export interface VerificationRequestV2025 {
|
|
51089
|
+
/**
|
|
51090
|
+
* Stream ID for verification.
|
|
51091
|
+
* @type {string}
|
|
51092
|
+
* @memberof VerificationRequestV2025
|
|
51093
|
+
*/
|
|
51094
|
+
'stream_id': string;
|
|
51095
|
+
/**
|
|
51096
|
+
* Optional state value for verification challenge.
|
|
51097
|
+
* @type {string}
|
|
51098
|
+
* @memberof VerificationRequestV2025
|
|
51099
|
+
*/
|
|
51100
|
+
'state'?: string;
|
|
51101
|
+
}
|
|
50564
51102
|
/**
|
|
50565
51103
|
* The types of objects supported for SOD violations
|
|
50566
51104
|
* @export
|
|
@@ -130229,6 +130767,930 @@ export class ServiceDeskIntegrationV2025Api extends BaseAPI {
|
|
|
130229
130767
|
|
|
130230
130768
|
|
|
130231
130769
|
|
|
130770
|
+
/**
|
|
130771
|
+
* SharedSignalsFrameworkSSFV2025Api - axios parameter creator
|
|
130772
|
+
* @export
|
|
130773
|
+
*/
|
|
130774
|
+
export const SharedSignalsFrameworkSSFV2025ApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
130775
|
+
return {
|
|
130776
|
+
/**
|
|
130777
|
+
* An SSF stream is associated with the client ID of the OAuth 2.0 access token used to create the stream. One SSF stream is allowed for each client ID. You can create a maximum of 10 SSF stream configurations for one org.
|
|
130778
|
+
* @summary Create stream
|
|
130779
|
+
* @param {CreateStreamRequestV2025} createStreamRequestV2025
|
|
130780
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
130781
|
+
* @throws {RequiredError}
|
|
130782
|
+
*/
|
|
130783
|
+
createStream: async (createStreamRequestV2025: CreateStreamRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
130784
|
+
// verify required parameter 'createStreamRequestV2025' is not null or undefined
|
|
130785
|
+
assertParamExists('createStream', 'createStreamRequestV2025', createStreamRequestV2025)
|
|
130786
|
+
const localVarPath = `/ssf/streams`;
|
|
130787
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
130788
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
130789
|
+
let baseOptions;
|
|
130790
|
+
if (configuration) {
|
|
130791
|
+
baseOptions = configuration.baseOptions;
|
|
130792
|
+
}
|
|
130793
|
+
|
|
130794
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions};
|
|
130795
|
+
const localVarHeaderParameter = {} as any;
|
|
130796
|
+
const localVarQueryParameter = {} as any;
|
|
130797
|
+
|
|
130798
|
+
// authentication userAuth required
|
|
130799
|
+
// oauth required
|
|
130800
|
+
await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
|
|
130801
|
+
|
|
130802
|
+
// authentication userAuth required
|
|
130803
|
+
// oauth required
|
|
130804
|
+
await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
|
|
130805
|
+
|
|
130806
|
+
|
|
130807
|
+
|
|
130808
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
130809
|
+
|
|
130810
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
130811
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
130812
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
130813
|
+
localVarRequestOptions.data = serializeDataIfNeeded(createStreamRequestV2025, localVarRequestOptions, configuration)
|
|
130814
|
+
|
|
130815
|
+
return {
|
|
130816
|
+
url: toPathString(localVarUrlObj),
|
|
130817
|
+
axiosOptions: localVarRequestOptions,
|
|
130818
|
+
};
|
|
130819
|
+
},
|
|
130820
|
+
/**
|
|
130821
|
+
* Deletes a stream by its ID. There is no request body; the stream is identified by the required query parameter `stream_id`. On success the response has no body (204 No Content). The associated stream with the client ID (through the request OAuth 2.0 access token) is deleted.
|
|
130822
|
+
* @summary Delete stream
|
|
130823
|
+
* @param {string} streamId ID of the stream to delete. Required; omitted or empty returns 400.
|
|
130824
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
130825
|
+
* @throws {RequiredError}
|
|
130826
|
+
*/
|
|
130827
|
+
deleteStream: async (streamId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
130828
|
+
// verify required parameter 'streamId' is not null or undefined
|
|
130829
|
+
assertParamExists('deleteStream', 'streamId', streamId)
|
|
130830
|
+
const localVarPath = `/ssf/streams`;
|
|
130831
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
130832
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
130833
|
+
let baseOptions;
|
|
130834
|
+
if (configuration) {
|
|
130835
|
+
baseOptions = configuration.baseOptions;
|
|
130836
|
+
}
|
|
130837
|
+
|
|
130838
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions};
|
|
130839
|
+
const localVarHeaderParameter = {} as any;
|
|
130840
|
+
const localVarQueryParameter = {} as any;
|
|
130841
|
+
|
|
130842
|
+
// authentication userAuth required
|
|
130843
|
+
// oauth required
|
|
130844
|
+
await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
|
|
130845
|
+
|
|
130846
|
+
// authentication userAuth required
|
|
130847
|
+
// oauth required
|
|
130848
|
+
await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
|
|
130849
|
+
|
|
130850
|
+
if (streamId !== undefined) {
|
|
130851
|
+
localVarQueryParameter['stream_id'] = streamId;
|
|
130852
|
+
}
|
|
130853
|
+
|
|
130854
|
+
|
|
130855
|
+
|
|
130856
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
130857
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
130858
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
130859
|
+
|
|
130860
|
+
return {
|
|
130861
|
+
url: toPathString(localVarUrlObj),
|
|
130862
|
+
axiosOptions: localVarRequestOptions,
|
|
130863
|
+
};
|
|
130864
|
+
},
|
|
130865
|
+
/**
|
|
130866
|
+
* Returns the transmitter\'s JSON Web Key Set (JWKS) for verifying signed delivery requests.
|
|
130867
|
+
* @summary Get JWKS
|
|
130868
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
130869
|
+
* @throws {RequiredError}
|
|
130870
|
+
*/
|
|
130871
|
+
getJWKSData: async (axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
130872
|
+
const localVarPath = `/ssf/jwks`;
|
|
130873
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
130874
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
130875
|
+
let baseOptions;
|
|
130876
|
+
if (configuration) {
|
|
130877
|
+
baseOptions = configuration.baseOptions;
|
|
130878
|
+
}
|
|
130879
|
+
|
|
130880
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions};
|
|
130881
|
+
const localVarHeaderParameter = {} as any;
|
|
130882
|
+
const localVarQueryParameter = {} as any;
|
|
130883
|
+
|
|
130884
|
+
// authentication userAuth required
|
|
130885
|
+
// oauth required
|
|
130886
|
+
await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration)
|
|
130887
|
+
|
|
130888
|
+
// authentication userAuth required
|
|
130889
|
+
// oauth required
|
|
130890
|
+
await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration)
|
|
130891
|
+
|
|
130892
|
+
|
|
130893
|
+
|
|
130894
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
130895
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
130896
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
130897
|
+
|
|
130898
|
+
return {
|
|
130899
|
+
url: toPathString(localVarUrlObj),
|
|
130900
|
+
axiosOptions: localVarRequestOptions,
|
|
130901
|
+
};
|
|
130902
|
+
},
|
|
130903
|
+
/**
|
|
130904
|
+
* Returns the SSF transmitter discovery metadata (well-known configuration).
|
|
130905
|
+
* @summary Get SSF configuration
|
|
130906
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
130907
|
+
* @throws {RequiredError}
|
|
130908
|
+
*/
|
|
130909
|
+
getSSFConfiguration: async (axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
130910
|
+
const localVarPath = `/.well-known/ssf-configuration`;
|
|
130911
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
130912
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
130913
|
+
let baseOptions;
|
|
130914
|
+
if (configuration) {
|
|
130915
|
+
baseOptions = configuration.baseOptions;
|
|
130916
|
+
}
|
|
130917
|
+
|
|
130918
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions};
|
|
130919
|
+
const localVarHeaderParameter = {} as any;
|
|
130920
|
+
const localVarQueryParameter = {} as any;
|
|
130921
|
+
|
|
130922
|
+
// authentication userAuth required
|
|
130923
|
+
// oauth required
|
|
130924
|
+
await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration)
|
|
130925
|
+
|
|
130926
|
+
// authentication userAuth required
|
|
130927
|
+
// oauth required
|
|
130928
|
+
await setOAuthToObject(localVarHeaderParameter, "userAuth", ["sp:scopes:all"], configuration)
|
|
130929
|
+
|
|
130930
|
+
|
|
130931
|
+
|
|
130932
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
130933
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
130934
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
130935
|
+
|
|
130936
|
+
return {
|
|
130937
|
+
url: toPathString(localVarUrlObj),
|
|
130938
|
+
axiosOptions: localVarRequestOptions,
|
|
130939
|
+
};
|
|
130940
|
+
},
|
|
130941
|
+
/**
|
|
130942
|
+
* Retrieves either a list of all SSF stream configurations or the individual configuration if specified by ID. As stream configurations are tied to a client ID, you can only view the stream associated with the client ID of the request OAuth 2.0 access token. Query parameter `aud` (co filter) can be used to filter by audience.
|
|
130943
|
+
* @summary Get stream(s)
|
|
130944
|
+
* @param {string} [streamId] If provided, returns that stream; otherwise returns list of all streams.
|
|
130945
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
130946
|
+
* @throws {RequiredError}
|
|
130947
|
+
*/
|
|
130948
|
+
getStream: async (streamId?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
130949
|
+
const localVarPath = `/ssf/streams`;
|
|
130950
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
130951
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
130952
|
+
let baseOptions;
|
|
130953
|
+
if (configuration) {
|
|
130954
|
+
baseOptions = configuration.baseOptions;
|
|
130955
|
+
}
|
|
130956
|
+
|
|
130957
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions};
|
|
130958
|
+
const localVarHeaderParameter = {} as any;
|
|
130959
|
+
const localVarQueryParameter = {} as any;
|
|
130960
|
+
|
|
130961
|
+
// authentication userAuth required
|
|
130962
|
+
// oauth required
|
|
130963
|
+
await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
|
|
130964
|
+
|
|
130965
|
+
// authentication userAuth required
|
|
130966
|
+
// oauth required
|
|
130967
|
+
await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
|
|
130968
|
+
|
|
130969
|
+
if (streamId !== undefined) {
|
|
130970
|
+
localVarQueryParameter['stream_id'] = streamId;
|
|
130971
|
+
}
|
|
130972
|
+
|
|
130973
|
+
|
|
130974
|
+
|
|
130975
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
130976
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
130977
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
130978
|
+
|
|
130979
|
+
return {
|
|
130980
|
+
url: toPathString(localVarUrlObj),
|
|
130981
|
+
axiosOptions: localVarRequestOptions,
|
|
130982
|
+
};
|
|
130983
|
+
},
|
|
130984
|
+
/**
|
|
130985
|
+
* Returns the status (enabled, paused, disabled) and optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token. The stream_id query parameter is required.
|
|
130986
|
+
* @summary Get stream status
|
|
130987
|
+
* @param {string} streamId ID of the stream whose status to retrieve.
|
|
130988
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
130989
|
+
* @throws {RequiredError}
|
|
130990
|
+
*/
|
|
130991
|
+
getStreamStatus: async (streamId: string, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
130992
|
+
// verify required parameter 'streamId' is not null or undefined
|
|
130993
|
+
assertParamExists('getStreamStatus', 'streamId', streamId)
|
|
130994
|
+
const localVarPath = `/ssf/streams/status`;
|
|
130995
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
130996
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
130997
|
+
let baseOptions;
|
|
130998
|
+
if (configuration) {
|
|
130999
|
+
baseOptions = configuration.baseOptions;
|
|
131000
|
+
}
|
|
131001
|
+
|
|
131002
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions};
|
|
131003
|
+
const localVarHeaderParameter = {} as any;
|
|
131004
|
+
const localVarQueryParameter = {} as any;
|
|
131005
|
+
|
|
131006
|
+
// authentication userAuth required
|
|
131007
|
+
// oauth required
|
|
131008
|
+
await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
|
|
131009
|
+
|
|
131010
|
+
// authentication userAuth required
|
|
131011
|
+
// oauth required
|
|
131012
|
+
await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
|
|
131013
|
+
|
|
131014
|
+
if (streamId !== undefined) {
|
|
131015
|
+
localVarQueryParameter['stream_id'] = streamId;
|
|
131016
|
+
}
|
|
131017
|
+
|
|
131018
|
+
|
|
131019
|
+
|
|
131020
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
131021
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
131022
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
131023
|
+
|
|
131024
|
+
return {
|
|
131025
|
+
url: toPathString(localVarUrlObj),
|
|
131026
|
+
axiosOptions: localVarRequestOptions,
|
|
131027
|
+
};
|
|
131028
|
+
},
|
|
131029
|
+
/**
|
|
131030
|
+
* Verifies an SSF stream by publishing a verification event requested by a security events provider.
|
|
131031
|
+
* @summary Verify stream
|
|
131032
|
+
* @param {VerificationRequestV2025} verificationRequestV2025
|
|
131033
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
131034
|
+
* @throws {RequiredError}
|
|
131035
|
+
*/
|
|
131036
|
+
sendStreamVerification: async (verificationRequestV2025: VerificationRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
131037
|
+
// verify required parameter 'verificationRequestV2025' is not null or undefined
|
|
131038
|
+
assertParamExists('sendStreamVerification', 'verificationRequestV2025', verificationRequestV2025)
|
|
131039
|
+
const localVarPath = `/ssf/streams/verify`;
|
|
131040
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
131041
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
131042
|
+
let baseOptions;
|
|
131043
|
+
if (configuration) {
|
|
131044
|
+
baseOptions = configuration.baseOptions;
|
|
131045
|
+
}
|
|
131046
|
+
|
|
131047
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions};
|
|
131048
|
+
const localVarHeaderParameter = {} as any;
|
|
131049
|
+
const localVarQueryParameter = {} as any;
|
|
131050
|
+
|
|
131051
|
+
// authentication userAuth required
|
|
131052
|
+
// oauth required
|
|
131053
|
+
await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
|
|
131054
|
+
|
|
131055
|
+
// authentication userAuth required
|
|
131056
|
+
// oauth required
|
|
131057
|
+
await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
|
|
131058
|
+
|
|
131059
|
+
|
|
131060
|
+
|
|
131061
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
131062
|
+
|
|
131063
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
131064
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
131065
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
131066
|
+
localVarRequestOptions.data = serializeDataIfNeeded(verificationRequestV2025, localVarRequestOptions, configuration)
|
|
131067
|
+
|
|
131068
|
+
return {
|
|
131069
|
+
url: toPathString(localVarUrlObj),
|
|
131070
|
+
axiosOptions: localVarRequestOptions,
|
|
131071
|
+
};
|
|
131072
|
+
},
|
|
131073
|
+
/**
|
|
131074
|
+
* Replaces a stream\'s configuration (PUT). stream_id and delivery are required; full receiver-supplied properties. The associated stream with the client ID (through the request OAuth 2.0 access token) is replaced.
|
|
131075
|
+
* @summary Replace stream configuration
|
|
131076
|
+
* @param {ReplaceStreamConfigurationRequestV2025} replaceStreamConfigurationRequestV2025
|
|
131077
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
131078
|
+
* @throws {RequiredError}
|
|
131079
|
+
*/
|
|
131080
|
+
setStreamConfiguration: async (replaceStreamConfigurationRequestV2025: ReplaceStreamConfigurationRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
131081
|
+
// verify required parameter 'replaceStreamConfigurationRequestV2025' is not null or undefined
|
|
131082
|
+
assertParamExists('setStreamConfiguration', 'replaceStreamConfigurationRequestV2025', replaceStreamConfigurationRequestV2025)
|
|
131083
|
+
const localVarPath = `/ssf/streams`;
|
|
131084
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
131085
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
131086
|
+
let baseOptions;
|
|
131087
|
+
if (configuration) {
|
|
131088
|
+
baseOptions = configuration.baseOptions;
|
|
131089
|
+
}
|
|
131090
|
+
|
|
131091
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...axiosOptions};
|
|
131092
|
+
const localVarHeaderParameter = {} as any;
|
|
131093
|
+
const localVarQueryParameter = {} as any;
|
|
131094
|
+
|
|
131095
|
+
// authentication userAuth required
|
|
131096
|
+
// oauth required
|
|
131097
|
+
await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
|
|
131098
|
+
|
|
131099
|
+
// authentication userAuth required
|
|
131100
|
+
// oauth required
|
|
131101
|
+
await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
|
|
131102
|
+
|
|
131103
|
+
|
|
131104
|
+
|
|
131105
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
131106
|
+
|
|
131107
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
131108
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
131109
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
131110
|
+
localVarRequestOptions.data = serializeDataIfNeeded(replaceStreamConfigurationRequestV2025, localVarRequestOptions, configuration)
|
|
131111
|
+
|
|
131112
|
+
return {
|
|
131113
|
+
url: toPathString(localVarUrlObj),
|
|
131114
|
+
axiosOptions: localVarRequestOptions,
|
|
131115
|
+
};
|
|
131116
|
+
},
|
|
131117
|
+
/**
|
|
131118
|
+
* Partially updates a stream\'s configuration (PATCH). Only provided fields are updated. The associated stream with the client ID (through the request OAuth 2.0 access token) is updated.
|
|
131119
|
+
* @summary Update stream configuration
|
|
131120
|
+
* @param {UpdateStreamConfigurationRequestV2025} updateStreamConfigurationRequestV2025
|
|
131121
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
131122
|
+
* @throws {RequiredError}
|
|
131123
|
+
*/
|
|
131124
|
+
updateStreamConfiguration: async (updateStreamConfigurationRequestV2025: UpdateStreamConfigurationRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
131125
|
+
// verify required parameter 'updateStreamConfigurationRequestV2025' is not null or undefined
|
|
131126
|
+
assertParamExists('updateStreamConfiguration', 'updateStreamConfigurationRequestV2025', updateStreamConfigurationRequestV2025)
|
|
131127
|
+
const localVarPath = `/ssf/streams`;
|
|
131128
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
131129
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
131130
|
+
let baseOptions;
|
|
131131
|
+
if (configuration) {
|
|
131132
|
+
baseOptions = configuration.baseOptions;
|
|
131133
|
+
}
|
|
131134
|
+
|
|
131135
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...axiosOptions};
|
|
131136
|
+
const localVarHeaderParameter = {} as any;
|
|
131137
|
+
const localVarQueryParameter = {} as any;
|
|
131138
|
+
|
|
131139
|
+
// authentication userAuth required
|
|
131140
|
+
// oauth required
|
|
131141
|
+
await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
|
|
131142
|
+
|
|
131143
|
+
// authentication userAuth required
|
|
131144
|
+
// oauth required
|
|
131145
|
+
await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
|
|
131146
|
+
|
|
131147
|
+
|
|
131148
|
+
|
|
131149
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
131150
|
+
|
|
131151
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
131152
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
131153
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
131154
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateStreamConfigurationRequestV2025, localVarRequestOptions, configuration)
|
|
131155
|
+
|
|
131156
|
+
return {
|
|
131157
|
+
url: toPathString(localVarUrlObj),
|
|
131158
|
+
axiosOptions: localVarRequestOptions,
|
|
131159
|
+
};
|
|
131160
|
+
},
|
|
131161
|
+
/**
|
|
131162
|
+
* Updates the operational status (enabled, paused, disabled) with an optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token.
|
|
131163
|
+
* @summary Update stream status
|
|
131164
|
+
* @param {UpdateStreamStatusRequestV2025} updateStreamStatusRequestV2025
|
|
131165
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
131166
|
+
* @throws {RequiredError}
|
|
131167
|
+
*/
|
|
131168
|
+
updateStreamStatus: async (updateStreamStatusRequestV2025: UpdateStreamStatusRequestV2025, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
131169
|
+
// verify required parameter 'updateStreamStatusRequestV2025' is not null or undefined
|
|
131170
|
+
assertParamExists('updateStreamStatus', 'updateStreamStatusRequestV2025', updateStreamStatusRequestV2025)
|
|
131171
|
+
const localVarPath = `/ssf/streams/status`;
|
|
131172
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
131173
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
131174
|
+
let baseOptions;
|
|
131175
|
+
if (configuration) {
|
|
131176
|
+
baseOptions = configuration.baseOptions;
|
|
131177
|
+
}
|
|
131178
|
+
|
|
131179
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions};
|
|
131180
|
+
const localVarHeaderParameter = {} as any;
|
|
131181
|
+
const localVarQueryParameter = {} as any;
|
|
131182
|
+
|
|
131183
|
+
// authentication userAuth required
|
|
131184
|
+
// oauth required
|
|
131185
|
+
await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
|
|
131186
|
+
|
|
131187
|
+
// authentication userAuth required
|
|
131188
|
+
// oauth required
|
|
131189
|
+
await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
|
|
131190
|
+
|
|
131191
|
+
|
|
131192
|
+
|
|
131193
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
131194
|
+
|
|
131195
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
131196
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
131197
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
|
|
131198
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateStreamStatusRequestV2025, localVarRequestOptions, configuration)
|
|
131199
|
+
|
|
131200
|
+
return {
|
|
131201
|
+
url: toPathString(localVarUrlObj),
|
|
131202
|
+
axiosOptions: localVarRequestOptions,
|
|
131203
|
+
};
|
|
131204
|
+
},
|
|
131205
|
+
}
|
|
131206
|
+
};
|
|
131207
|
+
|
|
131208
|
+
/**
|
|
131209
|
+
* SharedSignalsFrameworkSSFV2025Api - functional programming interface
|
|
131210
|
+
* @export
|
|
131211
|
+
*/
|
|
131212
|
+
export const SharedSignalsFrameworkSSFV2025ApiFp = function(configuration?: Configuration) {
|
|
131213
|
+
const localVarAxiosParamCreator = SharedSignalsFrameworkSSFV2025ApiAxiosParamCreator(configuration)
|
|
131214
|
+
return {
|
|
131215
|
+
/**
|
|
131216
|
+
* An SSF stream is associated with the client ID of the OAuth 2.0 access token used to create the stream. One SSF stream is allowed for each client ID. You can create a maximum of 10 SSF stream configurations for one org.
|
|
131217
|
+
* @summary Create stream
|
|
131218
|
+
* @param {CreateStreamRequestV2025} createStreamRequestV2025
|
|
131219
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
131220
|
+
* @throws {RequiredError}
|
|
131221
|
+
*/
|
|
131222
|
+
async createStream(createStreamRequestV2025: CreateStreamRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StreamConfigResponseV2025>> {
|
|
131223
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createStream(createStreamRequestV2025, axiosOptions);
|
|
131224
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
131225
|
+
const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV2025Api.createStream']?.[localVarOperationServerIndex]?.url;
|
|
131226
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
131227
|
+
},
|
|
131228
|
+
/**
|
|
131229
|
+
* Deletes a stream by its ID. There is no request body; the stream is identified by the required query parameter `stream_id`. On success the response has no body (204 No Content). The associated stream with the client ID (through the request OAuth 2.0 access token) is deleted.
|
|
131230
|
+
* @summary Delete stream
|
|
131231
|
+
* @param {string} streamId ID of the stream to delete. Required; omitted or empty returns 400.
|
|
131232
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
131233
|
+
* @throws {RequiredError}
|
|
131234
|
+
*/
|
|
131235
|
+
async deleteStream(streamId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
131236
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteStream(streamId, axiosOptions);
|
|
131237
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
131238
|
+
const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV2025Api.deleteStream']?.[localVarOperationServerIndex]?.url;
|
|
131239
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
131240
|
+
},
|
|
131241
|
+
/**
|
|
131242
|
+
* Returns the transmitter\'s JSON Web Key Set (JWKS) for verifying signed delivery requests.
|
|
131243
|
+
* @summary Get JWKS
|
|
131244
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
131245
|
+
* @throws {RequiredError}
|
|
131246
|
+
*/
|
|
131247
|
+
async getJWKSData(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JWKSV2025>> {
|
|
131248
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getJWKSData(axiosOptions);
|
|
131249
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
131250
|
+
const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV2025Api.getJWKSData']?.[localVarOperationServerIndex]?.url;
|
|
131251
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
131252
|
+
},
|
|
131253
|
+
/**
|
|
131254
|
+
* Returns the SSF transmitter discovery metadata (well-known configuration).
|
|
131255
|
+
* @summary Get SSF configuration
|
|
131256
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
131257
|
+
* @throws {RequiredError}
|
|
131258
|
+
*/
|
|
131259
|
+
async getSSFConfiguration(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransmitterMetadataV2025>> {
|
|
131260
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getSSFConfiguration(axiosOptions);
|
|
131261
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
131262
|
+
const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV2025Api.getSSFConfiguration']?.[localVarOperationServerIndex]?.url;
|
|
131263
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
131264
|
+
},
|
|
131265
|
+
/**
|
|
131266
|
+
* Retrieves either a list of all SSF stream configurations or the individual configuration if specified by ID. As stream configurations are tied to a client ID, you can only view the stream associated with the client ID of the request OAuth 2.0 access token. Query parameter `aud` (co filter) can be used to filter by audience.
|
|
131267
|
+
* @summary Get stream(s)
|
|
131268
|
+
* @param {string} [streamId] If provided, returns that stream; otherwise returns list of all streams.
|
|
131269
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
131270
|
+
* @throws {RequiredError}
|
|
131271
|
+
*/
|
|
131272
|
+
async getStream(streamId?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStream200ResponseV2025>> {
|
|
131273
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getStream(streamId, axiosOptions);
|
|
131274
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
131275
|
+
const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV2025Api.getStream']?.[localVarOperationServerIndex]?.url;
|
|
131276
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
131277
|
+
},
|
|
131278
|
+
/**
|
|
131279
|
+
* Returns the status (enabled, paused, disabled) and optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token. The stream_id query parameter is required.
|
|
131280
|
+
* @summary Get stream status
|
|
131281
|
+
* @param {string} streamId ID of the stream whose status to retrieve.
|
|
131282
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
131283
|
+
* @throws {RequiredError}
|
|
131284
|
+
*/
|
|
131285
|
+
async getStreamStatus(streamId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StreamStatusResponseV2025>> {
|
|
131286
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getStreamStatus(streamId, axiosOptions);
|
|
131287
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
131288
|
+
const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV2025Api.getStreamStatus']?.[localVarOperationServerIndex]?.url;
|
|
131289
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
131290
|
+
},
|
|
131291
|
+
/**
|
|
131292
|
+
* Verifies an SSF stream by publishing a verification event requested by a security events provider.
|
|
131293
|
+
* @summary Verify stream
|
|
131294
|
+
* @param {VerificationRequestV2025} verificationRequestV2025
|
|
131295
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
131296
|
+
* @throws {RequiredError}
|
|
131297
|
+
*/
|
|
131298
|
+
async sendStreamVerification(verificationRequestV2025: VerificationRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
131299
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.sendStreamVerification(verificationRequestV2025, axiosOptions);
|
|
131300
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
131301
|
+
const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV2025Api.sendStreamVerification']?.[localVarOperationServerIndex]?.url;
|
|
131302
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
131303
|
+
},
|
|
131304
|
+
/**
|
|
131305
|
+
* Replaces a stream\'s configuration (PUT). stream_id and delivery are required; full receiver-supplied properties. The associated stream with the client ID (through the request OAuth 2.0 access token) is replaced.
|
|
131306
|
+
* @summary Replace stream configuration
|
|
131307
|
+
* @param {ReplaceStreamConfigurationRequestV2025} replaceStreamConfigurationRequestV2025
|
|
131308
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
131309
|
+
* @throws {RequiredError}
|
|
131310
|
+
*/
|
|
131311
|
+
async setStreamConfiguration(replaceStreamConfigurationRequestV2025: ReplaceStreamConfigurationRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateStreamConfigResponseV2025>> {
|
|
131312
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.setStreamConfiguration(replaceStreamConfigurationRequestV2025, axiosOptions);
|
|
131313
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
131314
|
+
const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV2025Api.setStreamConfiguration']?.[localVarOperationServerIndex]?.url;
|
|
131315
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
131316
|
+
},
|
|
131317
|
+
/**
|
|
131318
|
+
* Partially updates a stream\'s configuration (PATCH). Only provided fields are updated. The associated stream with the client ID (through the request OAuth 2.0 access token) is updated.
|
|
131319
|
+
* @summary Update stream configuration
|
|
131320
|
+
* @param {UpdateStreamConfigurationRequestV2025} updateStreamConfigurationRequestV2025
|
|
131321
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
131322
|
+
* @throws {RequiredError}
|
|
131323
|
+
*/
|
|
131324
|
+
async updateStreamConfiguration(updateStreamConfigurationRequestV2025: UpdateStreamConfigurationRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateStreamConfigResponseV2025>> {
|
|
131325
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateStreamConfiguration(updateStreamConfigurationRequestV2025, axiosOptions);
|
|
131326
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
131327
|
+
const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV2025Api.updateStreamConfiguration']?.[localVarOperationServerIndex]?.url;
|
|
131328
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
131329
|
+
},
|
|
131330
|
+
/**
|
|
131331
|
+
* Updates the operational status (enabled, paused, disabled) with an optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token.
|
|
131332
|
+
* @summary Update stream status
|
|
131333
|
+
* @param {UpdateStreamStatusRequestV2025} updateStreamStatusRequestV2025
|
|
131334
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
131335
|
+
* @throws {RequiredError}
|
|
131336
|
+
*/
|
|
131337
|
+
async updateStreamStatus(updateStreamStatusRequestV2025: UpdateStreamStatusRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StreamStatusResponseV2025>> {
|
|
131338
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateStreamStatus(updateStreamStatusRequestV2025, axiosOptions);
|
|
131339
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
131340
|
+
const localVarOperationServerBasePath = operationServerMap['SharedSignalsFrameworkSSFV2025Api.updateStreamStatus']?.[localVarOperationServerIndex]?.url;
|
|
131341
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
131342
|
+
},
|
|
131343
|
+
}
|
|
131344
|
+
};
|
|
131345
|
+
|
|
131346
|
+
/**
|
|
131347
|
+
* SharedSignalsFrameworkSSFV2025Api - factory interface
|
|
131348
|
+
* @export
|
|
131349
|
+
*/
|
|
131350
|
+
export const SharedSignalsFrameworkSSFV2025ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
131351
|
+
const localVarFp = SharedSignalsFrameworkSSFV2025ApiFp(configuration)
|
|
131352
|
+
return {
|
|
131353
|
+
/**
|
|
131354
|
+
* An SSF stream is associated with the client ID of the OAuth 2.0 access token used to create the stream. One SSF stream is allowed for each client ID. You can create a maximum of 10 SSF stream configurations for one org.
|
|
131355
|
+
* @summary Create stream
|
|
131356
|
+
* @param {SharedSignalsFrameworkSSFV2025ApiCreateStreamRequest} requestParameters Request parameters.
|
|
131357
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
131358
|
+
* @throws {RequiredError}
|
|
131359
|
+
*/
|
|
131360
|
+
createStream(requestParameters: SharedSignalsFrameworkSSFV2025ApiCreateStreamRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<StreamConfigResponseV2025> {
|
|
131361
|
+
return localVarFp.createStream(requestParameters.createStreamRequestV2025, axiosOptions).then((request) => request(axios, basePath));
|
|
131362
|
+
},
|
|
131363
|
+
/**
|
|
131364
|
+
* Deletes a stream by its ID. There is no request body; the stream is identified by the required query parameter `stream_id`. On success the response has no body (204 No Content). The associated stream with the client ID (through the request OAuth 2.0 access token) is deleted.
|
|
131365
|
+
* @summary Delete stream
|
|
131366
|
+
* @param {SharedSignalsFrameworkSSFV2025ApiDeleteStreamRequest} requestParameters Request parameters.
|
|
131367
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
131368
|
+
* @throws {RequiredError}
|
|
131369
|
+
*/
|
|
131370
|
+
deleteStream(requestParameters: SharedSignalsFrameworkSSFV2025ApiDeleteStreamRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
131371
|
+
return localVarFp.deleteStream(requestParameters.streamId, axiosOptions).then((request) => request(axios, basePath));
|
|
131372
|
+
},
|
|
131373
|
+
/**
|
|
131374
|
+
* Returns the transmitter\'s JSON Web Key Set (JWKS) for verifying signed delivery requests.
|
|
131375
|
+
* @summary Get JWKS
|
|
131376
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
131377
|
+
* @throws {RequiredError}
|
|
131378
|
+
*/
|
|
131379
|
+
getJWKSData(axiosOptions?: RawAxiosRequestConfig): AxiosPromise<JWKSV2025> {
|
|
131380
|
+
return localVarFp.getJWKSData(axiosOptions).then((request) => request(axios, basePath));
|
|
131381
|
+
},
|
|
131382
|
+
/**
|
|
131383
|
+
* Returns the SSF transmitter discovery metadata (well-known configuration).
|
|
131384
|
+
* @summary Get SSF configuration
|
|
131385
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
131386
|
+
* @throws {RequiredError}
|
|
131387
|
+
*/
|
|
131388
|
+
getSSFConfiguration(axiosOptions?: RawAxiosRequestConfig): AxiosPromise<TransmitterMetadataV2025> {
|
|
131389
|
+
return localVarFp.getSSFConfiguration(axiosOptions).then((request) => request(axios, basePath));
|
|
131390
|
+
},
|
|
131391
|
+
/**
|
|
131392
|
+
* Retrieves either a list of all SSF stream configurations or the individual configuration if specified by ID. As stream configurations are tied to a client ID, you can only view the stream associated with the client ID of the request OAuth 2.0 access token. Query parameter `aud` (co filter) can be used to filter by audience.
|
|
131393
|
+
* @summary Get stream(s)
|
|
131394
|
+
* @param {SharedSignalsFrameworkSSFV2025ApiGetStreamRequest} requestParameters Request parameters.
|
|
131395
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
131396
|
+
* @throws {RequiredError}
|
|
131397
|
+
*/
|
|
131398
|
+
getStream(requestParameters: SharedSignalsFrameworkSSFV2025ApiGetStreamRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<GetStream200ResponseV2025> {
|
|
131399
|
+
return localVarFp.getStream(requestParameters.streamId, axiosOptions).then((request) => request(axios, basePath));
|
|
131400
|
+
},
|
|
131401
|
+
/**
|
|
131402
|
+
* Returns the status (enabled, paused, disabled) and optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token. The stream_id query parameter is required.
|
|
131403
|
+
* @summary Get stream status
|
|
131404
|
+
* @param {SharedSignalsFrameworkSSFV2025ApiGetStreamStatusRequest} requestParameters Request parameters.
|
|
131405
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
131406
|
+
* @throws {RequiredError}
|
|
131407
|
+
*/
|
|
131408
|
+
getStreamStatus(requestParameters: SharedSignalsFrameworkSSFV2025ApiGetStreamStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<StreamStatusResponseV2025> {
|
|
131409
|
+
return localVarFp.getStreamStatus(requestParameters.streamId, axiosOptions).then((request) => request(axios, basePath));
|
|
131410
|
+
},
|
|
131411
|
+
/**
|
|
131412
|
+
* Verifies an SSF stream by publishing a verification event requested by a security events provider.
|
|
131413
|
+
* @summary Verify stream
|
|
131414
|
+
* @param {SharedSignalsFrameworkSSFV2025ApiSendStreamVerificationRequest} requestParameters Request parameters.
|
|
131415
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
131416
|
+
* @throws {RequiredError}
|
|
131417
|
+
*/
|
|
131418
|
+
sendStreamVerification(requestParameters: SharedSignalsFrameworkSSFV2025ApiSendStreamVerificationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
131419
|
+
return localVarFp.sendStreamVerification(requestParameters.verificationRequestV2025, axiosOptions).then((request) => request(axios, basePath));
|
|
131420
|
+
},
|
|
131421
|
+
/**
|
|
131422
|
+
* Replaces a stream\'s configuration (PUT). stream_id and delivery are required; full receiver-supplied properties. The associated stream with the client ID (through the request OAuth 2.0 access token) is replaced.
|
|
131423
|
+
* @summary Replace stream configuration
|
|
131424
|
+
* @param {SharedSignalsFrameworkSSFV2025ApiSetStreamConfigurationRequest} requestParameters Request parameters.
|
|
131425
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
131426
|
+
* @throws {RequiredError}
|
|
131427
|
+
*/
|
|
131428
|
+
setStreamConfiguration(requestParameters: SharedSignalsFrameworkSSFV2025ApiSetStreamConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<UpdateStreamConfigResponseV2025> {
|
|
131429
|
+
return localVarFp.setStreamConfiguration(requestParameters.replaceStreamConfigurationRequestV2025, axiosOptions).then((request) => request(axios, basePath));
|
|
131430
|
+
},
|
|
131431
|
+
/**
|
|
131432
|
+
* Partially updates a stream\'s configuration (PATCH). Only provided fields are updated. The associated stream with the client ID (through the request OAuth 2.0 access token) is updated.
|
|
131433
|
+
* @summary Update stream configuration
|
|
131434
|
+
* @param {SharedSignalsFrameworkSSFV2025ApiUpdateStreamConfigurationRequest} requestParameters Request parameters.
|
|
131435
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
131436
|
+
* @throws {RequiredError}
|
|
131437
|
+
*/
|
|
131438
|
+
updateStreamConfiguration(requestParameters: SharedSignalsFrameworkSSFV2025ApiUpdateStreamConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<UpdateStreamConfigResponseV2025> {
|
|
131439
|
+
return localVarFp.updateStreamConfiguration(requestParameters.updateStreamConfigurationRequestV2025, axiosOptions).then((request) => request(axios, basePath));
|
|
131440
|
+
},
|
|
131441
|
+
/**
|
|
131442
|
+
* Updates the operational status (enabled, paused, disabled) with an optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token.
|
|
131443
|
+
* @summary Update stream status
|
|
131444
|
+
* @param {SharedSignalsFrameworkSSFV2025ApiUpdateStreamStatusRequest} requestParameters Request parameters.
|
|
131445
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
131446
|
+
* @throws {RequiredError}
|
|
131447
|
+
*/
|
|
131448
|
+
updateStreamStatus(requestParameters: SharedSignalsFrameworkSSFV2025ApiUpdateStreamStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<StreamStatusResponseV2025> {
|
|
131449
|
+
return localVarFp.updateStreamStatus(requestParameters.updateStreamStatusRequestV2025, axiosOptions).then((request) => request(axios, basePath));
|
|
131450
|
+
},
|
|
131451
|
+
};
|
|
131452
|
+
};
|
|
131453
|
+
|
|
131454
|
+
/**
|
|
131455
|
+
* Request parameters for createStream operation in SharedSignalsFrameworkSSFV2025Api.
|
|
131456
|
+
* @export
|
|
131457
|
+
* @interface SharedSignalsFrameworkSSFV2025ApiCreateStreamRequest
|
|
131458
|
+
*/
|
|
131459
|
+
export interface SharedSignalsFrameworkSSFV2025ApiCreateStreamRequest {
|
|
131460
|
+
/**
|
|
131461
|
+
*
|
|
131462
|
+
* @type {CreateStreamRequestV2025}
|
|
131463
|
+
* @memberof SharedSignalsFrameworkSSFV2025ApiCreateStream
|
|
131464
|
+
*/
|
|
131465
|
+
readonly createStreamRequestV2025: CreateStreamRequestV2025
|
|
131466
|
+
}
|
|
131467
|
+
|
|
131468
|
+
/**
|
|
131469
|
+
* Request parameters for deleteStream operation in SharedSignalsFrameworkSSFV2025Api.
|
|
131470
|
+
* @export
|
|
131471
|
+
* @interface SharedSignalsFrameworkSSFV2025ApiDeleteStreamRequest
|
|
131472
|
+
*/
|
|
131473
|
+
export interface SharedSignalsFrameworkSSFV2025ApiDeleteStreamRequest {
|
|
131474
|
+
/**
|
|
131475
|
+
* ID of the stream to delete. Required; omitted or empty returns 400.
|
|
131476
|
+
* @type {string}
|
|
131477
|
+
* @memberof SharedSignalsFrameworkSSFV2025ApiDeleteStream
|
|
131478
|
+
*/
|
|
131479
|
+
readonly streamId: string
|
|
131480
|
+
}
|
|
131481
|
+
|
|
131482
|
+
/**
|
|
131483
|
+
* Request parameters for getStream operation in SharedSignalsFrameworkSSFV2025Api.
|
|
131484
|
+
* @export
|
|
131485
|
+
* @interface SharedSignalsFrameworkSSFV2025ApiGetStreamRequest
|
|
131486
|
+
*/
|
|
131487
|
+
export interface SharedSignalsFrameworkSSFV2025ApiGetStreamRequest {
|
|
131488
|
+
/**
|
|
131489
|
+
* If provided, returns that stream; otherwise returns list of all streams.
|
|
131490
|
+
* @type {string}
|
|
131491
|
+
* @memberof SharedSignalsFrameworkSSFV2025ApiGetStream
|
|
131492
|
+
*/
|
|
131493
|
+
readonly streamId?: string
|
|
131494
|
+
}
|
|
131495
|
+
|
|
131496
|
+
/**
|
|
131497
|
+
* Request parameters for getStreamStatus operation in SharedSignalsFrameworkSSFV2025Api.
|
|
131498
|
+
* @export
|
|
131499
|
+
* @interface SharedSignalsFrameworkSSFV2025ApiGetStreamStatusRequest
|
|
131500
|
+
*/
|
|
131501
|
+
export interface SharedSignalsFrameworkSSFV2025ApiGetStreamStatusRequest {
|
|
131502
|
+
/**
|
|
131503
|
+
* ID of the stream whose status to retrieve.
|
|
131504
|
+
* @type {string}
|
|
131505
|
+
* @memberof SharedSignalsFrameworkSSFV2025ApiGetStreamStatus
|
|
131506
|
+
*/
|
|
131507
|
+
readonly streamId: string
|
|
131508
|
+
}
|
|
131509
|
+
|
|
131510
|
+
/**
|
|
131511
|
+
* Request parameters for sendStreamVerification operation in SharedSignalsFrameworkSSFV2025Api.
|
|
131512
|
+
* @export
|
|
131513
|
+
* @interface SharedSignalsFrameworkSSFV2025ApiSendStreamVerificationRequest
|
|
131514
|
+
*/
|
|
131515
|
+
export interface SharedSignalsFrameworkSSFV2025ApiSendStreamVerificationRequest {
|
|
131516
|
+
/**
|
|
131517
|
+
*
|
|
131518
|
+
* @type {VerificationRequestV2025}
|
|
131519
|
+
* @memberof SharedSignalsFrameworkSSFV2025ApiSendStreamVerification
|
|
131520
|
+
*/
|
|
131521
|
+
readonly verificationRequestV2025: VerificationRequestV2025
|
|
131522
|
+
}
|
|
131523
|
+
|
|
131524
|
+
/**
|
|
131525
|
+
* Request parameters for setStreamConfiguration operation in SharedSignalsFrameworkSSFV2025Api.
|
|
131526
|
+
* @export
|
|
131527
|
+
* @interface SharedSignalsFrameworkSSFV2025ApiSetStreamConfigurationRequest
|
|
131528
|
+
*/
|
|
131529
|
+
export interface SharedSignalsFrameworkSSFV2025ApiSetStreamConfigurationRequest {
|
|
131530
|
+
/**
|
|
131531
|
+
*
|
|
131532
|
+
* @type {ReplaceStreamConfigurationRequestV2025}
|
|
131533
|
+
* @memberof SharedSignalsFrameworkSSFV2025ApiSetStreamConfiguration
|
|
131534
|
+
*/
|
|
131535
|
+
readonly replaceStreamConfigurationRequestV2025: ReplaceStreamConfigurationRequestV2025
|
|
131536
|
+
}
|
|
131537
|
+
|
|
131538
|
+
/**
|
|
131539
|
+
* Request parameters for updateStreamConfiguration operation in SharedSignalsFrameworkSSFV2025Api.
|
|
131540
|
+
* @export
|
|
131541
|
+
* @interface SharedSignalsFrameworkSSFV2025ApiUpdateStreamConfigurationRequest
|
|
131542
|
+
*/
|
|
131543
|
+
export interface SharedSignalsFrameworkSSFV2025ApiUpdateStreamConfigurationRequest {
|
|
131544
|
+
/**
|
|
131545
|
+
*
|
|
131546
|
+
* @type {UpdateStreamConfigurationRequestV2025}
|
|
131547
|
+
* @memberof SharedSignalsFrameworkSSFV2025ApiUpdateStreamConfiguration
|
|
131548
|
+
*/
|
|
131549
|
+
readonly updateStreamConfigurationRequestV2025: UpdateStreamConfigurationRequestV2025
|
|
131550
|
+
}
|
|
131551
|
+
|
|
131552
|
+
/**
|
|
131553
|
+
* Request parameters for updateStreamStatus operation in SharedSignalsFrameworkSSFV2025Api.
|
|
131554
|
+
* @export
|
|
131555
|
+
* @interface SharedSignalsFrameworkSSFV2025ApiUpdateStreamStatusRequest
|
|
131556
|
+
*/
|
|
131557
|
+
export interface SharedSignalsFrameworkSSFV2025ApiUpdateStreamStatusRequest {
|
|
131558
|
+
/**
|
|
131559
|
+
*
|
|
131560
|
+
* @type {UpdateStreamStatusRequestV2025}
|
|
131561
|
+
* @memberof SharedSignalsFrameworkSSFV2025ApiUpdateStreamStatus
|
|
131562
|
+
*/
|
|
131563
|
+
readonly updateStreamStatusRequestV2025: UpdateStreamStatusRequestV2025
|
|
131564
|
+
}
|
|
131565
|
+
|
|
131566
|
+
/**
|
|
131567
|
+
* SharedSignalsFrameworkSSFV2025Api - object-oriented interface
|
|
131568
|
+
* @export
|
|
131569
|
+
* @class SharedSignalsFrameworkSSFV2025Api
|
|
131570
|
+
* @extends {BaseAPI}
|
|
131571
|
+
*/
|
|
131572
|
+
export class SharedSignalsFrameworkSSFV2025Api extends BaseAPI {
|
|
131573
|
+
/**
|
|
131574
|
+
* An SSF stream is associated with the client ID of the OAuth 2.0 access token used to create the stream. One SSF stream is allowed for each client ID. You can create a maximum of 10 SSF stream configurations for one org.
|
|
131575
|
+
* @summary Create stream
|
|
131576
|
+
* @param {SharedSignalsFrameworkSSFV2025ApiCreateStreamRequest} requestParameters Request parameters.
|
|
131577
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
131578
|
+
* @throws {RequiredError}
|
|
131579
|
+
* @memberof SharedSignalsFrameworkSSFV2025Api
|
|
131580
|
+
*/
|
|
131581
|
+
public createStream(requestParameters: SharedSignalsFrameworkSSFV2025ApiCreateStreamRequest, axiosOptions?: RawAxiosRequestConfig) {
|
|
131582
|
+
return SharedSignalsFrameworkSSFV2025ApiFp(this.configuration).createStream(requestParameters.createStreamRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
131583
|
+
}
|
|
131584
|
+
|
|
131585
|
+
/**
|
|
131586
|
+
* Deletes a stream by its ID. There is no request body; the stream is identified by the required query parameter `stream_id`. On success the response has no body (204 No Content). The associated stream with the client ID (through the request OAuth 2.0 access token) is deleted.
|
|
131587
|
+
* @summary Delete stream
|
|
131588
|
+
* @param {SharedSignalsFrameworkSSFV2025ApiDeleteStreamRequest} requestParameters Request parameters.
|
|
131589
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
131590
|
+
* @throws {RequiredError}
|
|
131591
|
+
* @memberof SharedSignalsFrameworkSSFV2025Api
|
|
131592
|
+
*/
|
|
131593
|
+
public deleteStream(requestParameters: SharedSignalsFrameworkSSFV2025ApiDeleteStreamRequest, axiosOptions?: RawAxiosRequestConfig) {
|
|
131594
|
+
return SharedSignalsFrameworkSSFV2025ApiFp(this.configuration).deleteStream(requestParameters.streamId, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
131595
|
+
}
|
|
131596
|
+
|
|
131597
|
+
/**
|
|
131598
|
+
* Returns the transmitter\'s JSON Web Key Set (JWKS) for verifying signed delivery requests.
|
|
131599
|
+
* @summary Get JWKS
|
|
131600
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
131601
|
+
* @throws {RequiredError}
|
|
131602
|
+
* @memberof SharedSignalsFrameworkSSFV2025Api
|
|
131603
|
+
*/
|
|
131604
|
+
public getJWKSData(axiosOptions?: RawAxiosRequestConfig) {
|
|
131605
|
+
return SharedSignalsFrameworkSSFV2025ApiFp(this.configuration).getJWKSData(axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
131606
|
+
}
|
|
131607
|
+
|
|
131608
|
+
/**
|
|
131609
|
+
* Returns the SSF transmitter discovery metadata (well-known configuration).
|
|
131610
|
+
* @summary Get SSF configuration
|
|
131611
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
131612
|
+
* @throws {RequiredError}
|
|
131613
|
+
* @memberof SharedSignalsFrameworkSSFV2025Api
|
|
131614
|
+
*/
|
|
131615
|
+
public getSSFConfiguration(axiosOptions?: RawAxiosRequestConfig) {
|
|
131616
|
+
return SharedSignalsFrameworkSSFV2025ApiFp(this.configuration).getSSFConfiguration(axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
131617
|
+
}
|
|
131618
|
+
|
|
131619
|
+
/**
|
|
131620
|
+
* Retrieves either a list of all SSF stream configurations or the individual configuration if specified by ID. As stream configurations are tied to a client ID, you can only view the stream associated with the client ID of the request OAuth 2.0 access token. Query parameter `aud` (co filter) can be used to filter by audience.
|
|
131621
|
+
* @summary Get stream(s)
|
|
131622
|
+
* @param {SharedSignalsFrameworkSSFV2025ApiGetStreamRequest} requestParameters Request parameters.
|
|
131623
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
131624
|
+
* @throws {RequiredError}
|
|
131625
|
+
* @memberof SharedSignalsFrameworkSSFV2025Api
|
|
131626
|
+
*/
|
|
131627
|
+
public getStream(requestParameters: SharedSignalsFrameworkSSFV2025ApiGetStreamRequest = {}, axiosOptions?: RawAxiosRequestConfig) {
|
|
131628
|
+
return SharedSignalsFrameworkSSFV2025ApiFp(this.configuration).getStream(requestParameters.streamId, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
131629
|
+
}
|
|
131630
|
+
|
|
131631
|
+
/**
|
|
131632
|
+
* Returns the status (enabled, paused, disabled) and optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token. The stream_id query parameter is required.
|
|
131633
|
+
* @summary Get stream status
|
|
131634
|
+
* @param {SharedSignalsFrameworkSSFV2025ApiGetStreamStatusRequest} requestParameters Request parameters.
|
|
131635
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
131636
|
+
* @throws {RequiredError}
|
|
131637
|
+
* @memberof SharedSignalsFrameworkSSFV2025Api
|
|
131638
|
+
*/
|
|
131639
|
+
public getStreamStatus(requestParameters: SharedSignalsFrameworkSSFV2025ApiGetStreamStatusRequest, axiosOptions?: RawAxiosRequestConfig) {
|
|
131640
|
+
return SharedSignalsFrameworkSSFV2025ApiFp(this.configuration).getStreamStatus(requestParameters.streamId, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
131641
|
+
}
|
|
131642
|
+
|
|
131643
|
+
/**
|
|
131644
|
+
* Verifies an SSF stream by publishing a verification event requested by a security events provider.
|
|
131645
|
+
* @summary Verify stream
|
|
131646
|
+
* @param {SharedSignalsFrameworkSSFV2025ApiSendStreamVerificationRequest} requestParameters Request parameters.
|
|
131647
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
131648
|
+
* @throws {RequiredError}
|
|
131649
|
+
* @memberof SharedSignalsFrameworkSSFV2025Api
|
|
131650
|
+
*/
|
|
131651
|
+
public sendStreamVerification(requestParameters: SharedSignalsFrameworkSSFV2025ApiSendStreamVerificationRequest, axiosOptions?: RawAxiosRequestConfig) {
|
|
131652
|
+
return SharedSignalsFrameworkSSFV2025ApiFp(this.configuration).sendStreamVerification(requestParameters.verificationRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
131653
|
+
}
|
|
131654
|
+
|
|
131655
|
+
/**
|
|
131656
|
+
* Replaces a stream\'s configuration (PUT). stream_id and delivery are required; full receiver-supplied properties. The associated stream with the client ID (through the request OAuth 2.0 access token) is replaced.
|
|
131657
|
+
* @summary Replace stream configuration
|
|
131658
|
+
* @param {SharedSignalsFrameworkSSFV2025ApiSetStreamConfigurationRequest} requestParameters Request parameters.
|
|
131659
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
131660
|
+
* @throws {RequiredError}
|
|
131661
|
+
* @memberof SharedSignalsFrameworkSSFV2025Api
|
|
131662
|
+
*/
|
|
131663
|
+
public setStreamConfiguration(requestParameters: SharedSignalsFrameworkSSFV2025ApiSetStreamConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) {
|
|
131664
|
+
return SharedSignalsFrameworkSSFV2025ApiFp(this.configuration).setStreamConfiguration(requestParameters.replaceStreamConfigurationRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
131665
|
+
}
|
|
131666
|
+
|
|
131667
|
+
/**
|
|
131668
|
+
* Partially updates a stream\'s configuration (PATCH). Only provided fields are updated. The associated stream with the client ID (through the request OAuth 2.0 access token) is updated.
|
|
131669
|
+
* @summary Update stream configuration
|
|
131670
|
+
* @param {SharedSignalsFrameworkSSFV2025ApiUpdateStreamConfigurationRequest} requestParameters Request parameters.
|
|
131671
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
131672
|
+
* @throws {RequiredError}
|
|
131673
|
+
* @memberof SharedSignalsFrameworkSSFV2025Api
|
|
131674
|
+
*/
|
|
131675
|
+
public updateStreamConfiguration(requestParameters: SharedSignalsFrameworkSSFV2025ApiUpdateStreamConfigurationRequest, axiosOptions?: RawAxiosRequestConfig) {
|
|
131676
|
+
return SharedSignalsFrameworkSSFV2025ApiFp(this.configuration).updateStreamConfiguration(requestParameters.updateStreamConfigurationRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
131677
|
+
}
|
|
131678
|
+
|
|
131679
|
+
/**
|
|
131680
|
+
* Updates the operational status (enabled, paused, disabled) with an optional reason for the stream associated with the client ID of the request\'s OAuth 2.0 access token.
|
|
131681
|
+
* @summary Update stream status
|
|
131682
|
+
* @param {SharedSignalsFrameworkSSFV2025ApiUpdateStreamStatusRequest} requestParameters Request parameters.
|
|
131683
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
131684
|
+
* @throws {RequiredError}
|
|
131685
|
+
* @memberof SharedSignalsFrameworkSSFV2025Api
|
|
131686
|
+
*/
|
|
131687
|
+
public updateStreamStatus(requestParameters: SharedSignalsFrameworkSSFV2025ApiUpdateStreamStatusRequest, axiosOptions?: RawAxiosRequestConfig) {
|
|
131688
|
+
return SharedSignalsFrameworkSSFV2025ApiFp(this.configuration).updateStreamStatus(requestParameters.updateStreamStatusRequestV2025, axiosOptions).then((request) => request(this.axios, this.basePath));
|
|
131689
|
+
}
|
|
131690
|
+
}
|
|
131691
|
+
|
|
131692
|
+
|
|
131693
|
+
|
|
130232
131694
|
/**
|
|
130233
131695
|
* SourceUsagesV2025Api - axios parameter creator
|
|
130234
131696
|
* @export
|