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.
@@ -9151,6 +9151,19 @@ export declare const AuthUserV2025CapabilitiesV2025: {
9151
9151
  readonly SpUiConfigHubRead: "sp:ui-config-hub-read";
9152
9152
  };
9153
9153
  export type AuthUserV2025CapabilitiesV2025 = typeof AuthUserV2025CapabilitiesV2025[keyof typeof AuthUserV2025CapabilitiesV2025];
9154
+ /**
9155
+ * Authorization scheme supported by the transmitter.
9156
+ * @export
9157
+ * @interface AuthorizationSchemeV2025
9158
+ */
9159
+ export interface AuthorizationSchemeV2025 {
9160
+ /**
9161
+ * URN describing the authorization specification. OAuth 2.0: `urn:ietf:rfc:6749`; Bearer token: `urn:ietf:rfc:6750`.
9162
+ * @type {string}
9163
+ * @memberof AuthorizationSchemeV2025
9164
+ */
9165
+ 'spec_urn'?: string;
9166
+ }
9154
9167
  /**
9155
9168
  * Backup options control what will be included in the backup.
9156
9169
  * @export
@@ -15367,6 +15380,56 @@ export interface CreateScheduledSearchRequestV2025 {
15367
15380
  */
15368
15381
  'displayQueryDetails'?: boolean;
15369
15382
  }
15383
+ /**
15384
+ * Full delivery configuration. method and endpoint_url are required.
15385
+ * @export
15386
+ * @interface CreateStreamDeliveryRequestV2025
15387
+ */
15388
+ export interface CreateStreamDeliveryRequestV2025 {
15389
+ /**
15390
+ * Delivery method (only push is supported).
15391
+ * @type {string}
15392
+ * @memberof CreateStreamDeliveryRequestV2025
15393
+ */
15394
+ 'method': string;
15395
+ /**
15396
+ * Receiver endpoint URL for push delivery.
15397
+ * @type {string}
15398
+ * @memberof CreateStreamDeliveryRequestV2025
15399
+ */
15400
+ 'endpoint_url': string;
15401
+ /**
15402
+ * Authorization header value for delivery requests.
15403
+ * @type {string}
15404
+ * @memberof CreateStreamDeliveryRequestV2025
15405
+ */
15406
+ 'authorization_header'?: string;
15407
+ }
15408
+ /**
15409
+ * Request body for POST /ssf/streams (create stream).
15410
+ * @export
15411
+ * @interface CreateStreamRequestV2025
15412
+ */
15413
+ export interface CreateStreamRequestV2025 {
15414
+ /**
15415
+ *
15416
+ * @type {CreateStreamDeliveryRequestV2025}
15417
+ * @memberof CreateStreamRequestV2025
15418
+ */
15419
+ 'delivery': CreateStreamDeliveryRequestV2025;
15420
+ /**
15421
+ * 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).
15422
+ * @type {Array<string>}
15423
+ * @memberof CreateStreamRequestV2025
15424
+ */
15425
+ 'events_requested'?: Array<string>;
15426
+ /**
15427
+ * Optional human-readable description of the stream.
15428
+ * @type {string}
15429
+ * @memberof CreateStreamRequestV2025
15430
+ */
15431
+ 'description'?: string;
15432
+ }
15370
15433
  /**
15371
15434
  *
15372
15435
  * @export
@@ -15886,6 +15949,50 @@ export declare const DeleteSource202ResponseV2025TypeV2025: {
15886
15949
  readonly TaskResult: "TASK_RESULT";
15887
15950
  };
15888
15951
  export type DeleteSource202ResponseV2025TypeV2025 = typeof DeleteSource202ResponseV2025TypeV2025[keyof typeof DeleteSource202ResponseV2025TypeV2025];
15952
+ /**
15953
+ * Delivery configuration for PATCH /ssf/streams (partial update). All fields are optional; only provided fields are updated.
15954
+ * @export
15955
+ * @interface DeliveryRequestV2025
15956
+ */
15957
+ export interface DeliveryRequestV2025 {
15958
+ /**
15959
+ * Delivery method (optional for PATCH).
15960
+ * @type {string}
15961
+ * @memberof DeliveryRequestV2025
15962
+ */
15963
+ 'method'?: string;
15964
+ /**
15965
+ * Receiver endpoint URL (optional for PATCH).
15966
+ * @type {string}
15967
+ * @memberof DeliveryRequestV2025
15968
+ */
15969
+ 'endpoint_url'?: string;
15970
+ /**
15971
+ * Optional authorization header value.
15972
+ * @type {string}
15973
+ * @memberof DeliveryRequestV2025
15974
+ */
15975
+ 'authorization_header'?: string;
15976
+ }
15977
+ /**
15978
+ * Delivery configuration returned in stream responses.
15979
+ * @export
15980
+ * @interface DeliveryResponseV2025
15981
+ */
15982
+ export interface DeliveryResponseV2025 {
15983
+ /**
15984
+ * Delivery method.
15985
+ * @type {string}
15986
+ * @memberof DeliveryResponseV2025
15987
+ */
15988
+ 'method'?: string;
15989
+ /**
15990
+ * Receiver endpoint URL.
15991
+ * @type {string}
15992
+ * @memberof DeliveryResponseV2025
15993
+ */
15994
+ 'endpoint_url'?: string;
15995
+ }
15889
15996
  /**
15890
15997
  *
15891
15998
  * @export
@@ -20959,6 +21066,11 @@ export interface GetRoleAssignments200ResponseInnerV2025 {
20959
21066
  */
20960
21067
  'accountTargets'?: Array<RoleTargetDtoV2025>;
20961
21068
  }
21069
+ /**
21070
+ * @type GetStream200ResponseV2025
21071
+ * @export
21072
+ */
21073
+ export type GetStream200ResponseV2025 = Array<StreamConfigResponseV2025> | StreamConfigResponseV2025;
20962
21074
  /**
20963
21075
  *
20964
21076
  * @export
@@ -24182,6 +24294,62 @@ export interface JITConfigurationV2025 {
24182
24294
  [key: string]: string;
24183
24295
  };
24184
24296
  }
24297
+ /**
24298
+ * JSON Web Key Set containing the transmitter\'s public keys for verifying signed delivery requests.
24299
+ * @export
24300
+ * @interface JWKSV2025
24301
+ */
24302
+ export interface JWKSV2025 {
24303
+ /**
24304
+ * Array of JSON Web Keys.
24305
+ * @type {Array<JWKV2025>}
24306
+ * @memberof JWKSV2025
24307
+ */
24308
+ 'keys': Array<JWKV2025>;
24309
+ }
24310
+ /**
24311
+ * A single JSON Web Key used for verifying signed delivery requests.
24312
+ * @export
24313
+ * @interface JWKV2025
24314
+ */
24315
+ export interface JWKV2025 {
24316
+ /**
24317
+ * Algorithm intended for use with the key (e.g. RS256).
24318
+ * @type {string}
24319
+ * @memberof JWKV2025
24320
+ */
24321
+ 'alg'?: string;
24322
+ /**
24323
+ * RSA public exponent (Base64url encoded).
24324
+ * @type {string}
24325
+ * @memberof JWKV2025
24326
+ */
24327
+ 'e'?: string;
24328
+ /**
24329
+ * Key ID - unique identifier for the key.
24330
+ * @type {string}
24331
+ * @memberof JWKV2025
24332
+ */
24333
+ 'kid'?: string;
24334
+ /**
24335
+ * Key type (e.g. RSA).
24336
+ * @type {string}
24337
+ * @memberof JWKV2025
24338
+ */
24339
+ 'kty'?: string;
24340
+ /**
24341
+ * RSA modulus (Base64url encoded).
24342
+ * @type {string}
24343
+ * @memberof JWKV2025
24344
+ */
24345
+ 'n'?: string;
24346
+ /**
24347
+ * Intended use of the key (e.g. sig for signature verification).
24348
+ * @type {string}
24349
+ * @memberof JWKV2025
24350
+ */
24351
+ 'use'?: string;
24352
+ }
24185
24353
  /**
24186
24354
  * 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)
24187
24355
  * @export
@@ -34893,6 +35061,62 @@ export interface ReplaceAllV2025 {
34893
35061
  [key: string]: any;
34894
35062
  };
34895
35063
  }
35064
+ /**
35065
+ *
35066
+ * @export
35067
+ * @interface ReplaceStreamConfigurationRequestDeliveryV2025
35068
+ */
35069
+ export interface ReplaceStreamConfigurationRequestDeliveryV2025 {
35070
+ /**
35071
+ * Delivery method (only push is supported).
35072
+ * @type {string}
35073
+ * @memberof ReplaceStreamConfigurationRequestDeliveryV2025
35074
+ */
35075
+ 'method': string;
35076
+ /**
35077
+ * Receiver endpoint URL for push delivery.
35078
+ * @type {string}
35079
+ * @memberof ReplaceStreamConfigurationRequestDeliveryV2025
35080
+ */
35081
+ 'endpoint_url': string;
35082
+ /**
35083
+ * Authorization header value for delivery requests.
35084
+ * @type {string}
35085
+ * @memberof ReplaceStreamConfigurationRequestDeliveryV2025
35086
+ */
35087
+ 'authorization_header'?: string;
35088
+ }
35089
+ /**
35090
+ * Request body for PUT /ssf/streams (full replace).
35091
+ * @export
35092
+ * @interface ReplaceStreamConfigurationRequestV2025
35093
+ */
35094
+ export interface ReplaceStreamConfigurationRequestV2025 {
35095
+ /**
35096
+ * ID of the stream to replace.
35097
+ * @type {string}
35098
+ * @memberof ReplaceStreamConfigurationRequestV2025
35099
+ */
35100
+ 'stream_id': string;
35101
+ /**
35102
+ *
35103
+ * @type {ReplaceStreamConfigurationRequestDeliveryV2025}
35104
+ * @memberof ReplaceStreamConfigurationRequestV2025
35105
+ */
35106
+ 'delivery': ReplaceStreamConfigurationRequestDeliveryV2025;
35107
+ /**
35108
+ * Event types the receiver wants. Use CAEP event-type URIs.
35109
+ * @type {Array<string>}
35110
+ * @memberof ReplaceStreamConfigurationRequestV2025
35111
+ */
35112
+ 'events_requested'?: Array<string>;
35113
+ /**
35114
+ * Optional human-readable description of the stream.
35115
+ * @type {string}
35116
+ * @memberof ReplaceStreamConfigurationRequestV2025
35117
+ */
35118
+ 'description'?: string;
35119
+ }
34896
35120
  /**
34897
35121
  *
34898
35122
  * @export
@@ -46033,6 +46257,104 @@ export declare const StatusResponseV2025StatusV2025: {
46033
46257
  readonly Failure: "FAILURE";
46034
46258
  };
46035
46259
  export type StatusResponseV2025StatusV2025 = typeof StatusResponseV2025StatusV2025[keyof typeof StatusResponseV2025StatusV2025];
46260
+ /**
46261
+ * Full stream configuration returned by create/get/update/replace.
46262
+ * @export
46263
+ * @interface StreamConfigResponseV2025
46264
+ */
46265
+ export interface StreamConfigResponseV2025 {
46266
+ /**
46267
+ * Unique stream identifier.
46268
+ * @type {string}
46269
+ * @memberof StreamConfigResponseV2025
46270
+ */
46271
+ 'stream_id'?: string;
46272
+ /**
46273
+ * Issuer (transmitter) URL.
46274
+ * @type {string}
46275
+ * @memberof StreamConfigResponseV2025
46276
+ */
46277
+ 'iss'?: string;
46278
+ /**
46279
+ * Audience for the stream.
46280
+ * @type {string}
46281
+ * @memberof StreamConfigResponseV2025
46282
+ */
46283
+ 'aud'?: string;
46284
+ /**
46285
+ *
46286
+ * @type {DeliveryResponseV2025}
46287
+ * @memberof StreamConfigResponseV2025
46288
+ */
46289
+ 'delivery'?: DeliveryResponseV2025;
46290
+ /**
46291
+ * 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).
46292
+ * @type {Array<string>}
46293
+ * @memberof StreamConfigResponseV2025
46294
+ */
46295
+ 'events_supported'?: Array<string>;
46296
+ /**
46297
+ * 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).
46298
+ * @type {Array<string>}
46299
+ * @memberof StreamConfigResponseV2025
46300
+ */
46301
+ 'events_requested'?: Array<string>;
46302
+ /**
46303
+ * Event types currently being delivered (intersection of supported and requested).
46304
+ * @type {Array<string>}
46305
+ * @memberof StreamConfigResponseV2025
46306
+ */
46307
+ 'events_delivered'?: Array<string>;
46308
+ /**
46309
+ * Optional stream description.
46310
+ * @type {string}
46311
+ * @memberof StreamConfigResponseV2025
46312
+ */
46313
+ 'description'?: string;
46314
+ /**
46315
+ * Inactivity timeout in seconds (optional).
46316
+ * @type {number}
46317
+ * @memberof StreamConfigResponseV2025
46318
+ */
46319
+ 'inactivity_timeout'?: number;
46320
+ /**
46321
+ * Minimum verification interval in seconds (optional).
46322
+ * @type {number}
46323
+ * @memberof StreamConfigResponseV2025
46324
+ */
46325
+ 'min_verification_interval'?: number;
46326
+ }
46327
+ /**
46328
+ * Stream status returned by GET/POST /ssf/streams/status.
46329
+ * @export
46330
+ * @interface StreamStatusResponseV2025
46331
+ */
46332
+ export interface StreamStatusResponseV2025 {
46333
+ /**
46334
+ * Stream identifier.
46335
+ * @type {string}
46336
+ * @memberof StreamStatusResponseV2025
46337
+ */
46338
+ 'stream_id'?: string;
46339
+ /**
46340
+ * Operational status of the stream (enabled, paused, or disabled).
46341
+ * @type {string}
46342
+ * @memberof StreamStatusResponseV2025
46343
+ */
46344
+ 'status'?: StreamStatusResponseV2025StatusV2025;
46345
+ /**
46346
+ * Optional reason for the current status (e.g. set when status is updated).
46347
+ * @type {string}
46348
+ * @memberof StreamStatusResponseV2025
46349
+ */
46350
+ 'reason'?: string;
46351
+ }
46352
+ export declare const StreamStatusResponseV2025StatusV2025: {
46353
+ readonly Enabled: "enabled";
46354
+ readonly Paused: "paused";
46355
+ readonly Disabled: "disabled";
46356
+ };
46357
+ export type StreamStatusResponseV2025StatusV2025 = typeof StreamStatusResponseV2025StatusV2025[keyof typeof StreamStatusResponseV2025StatusV2025];
46036
46358
  /**
46037
46359
  *
46038
46360
  * @export
@@ -48113,6 +48435,61 @@ export interface TranslationMessageV2025 {
48113
48435
  */
48114
48436
  'values'?: Array<string>;
48115
48437
  }
48438
+ /**
48439
+ * SSF transmitter discovery metadata per the SSF specification.
48440
+ * @export
48441
+ * @interface TransmitterMetadataV2025
48442
+ */
48443
+ export interface TransmitterMetadataV2025 {
48444
+ /**
48445
+ * Version of the SSF specification supported.
48446
+ * @type {string}
48447
+ * @memberof TransmitterMetadataV2025
48448
+ */
48449
+ 'spec_version'?: string;
48450
+ /**
48451
+ * Base URL of the transmitter (issuer).
48452
+ * @type {string}
48453
+ * @memberof TransmitterMetadataV2025
48454
+ */
48455
+ 'issuer'?: string;
48456
+ /**
48457
+ * URL of the transmitter\'s JSON Web Key Set.
48458
+ * @type {string}
48459
+ * @memberof TransmitterMetadataV2025
48460
+ */
48461
+ 'jwks_uri'?: string;
48462
+ /**
48463
+ * Supported delivery methods (e.g. push URN).
48464
+ * @type {Array<string>}
48465
+ * @memberof TransmitterMetadataV2025
48466
+ */
48467
+ 'delivery_methods_supported'?: Array<string>;
48468
+ /**
48469
+ * Endpoint for stream configuration (create, read, update, replace, delete).
48470
+ * @type {string}
48471
+ * @memberof TransmitterMetadataV2025
48472
+ */
48473
+ 'configuration_endpoint'?: string;
48474
+ /**
48475
+ * Endpoint for reading and updating stream status.
48476
+ * @type {string}
48477
+ * @memberof TransmitterMetadataV2025
48478
+ */
48479
+ 'status_endpoint'?: string;
48480
+ /**
48481
+ * Endpoint for receiver verification.
48482
+ * @type {string}
48483
+ * @memberof TransmitterMetadataV2025
48484
+ */
48485
+ 'verification_endpoint'?: string;
48486
+ /**
48487
+ * Supported authorization schemes (e.g. OAuth2, Bearer).
48488
+ * @type {Array<AuthorizationSchemeV2025>}
48489
+ * @memberof TransmitterMetadataV2025
48490
+ */
48491
+ 'authorization_schemes'?: Array<AuthorizationSchemeV2025>;
48492
+ }
48116
48493
  /**
48117
48494
  * @type TriggerExampleInputV2025
48118
48495
  * An example of the JSON payload that will be sent by the trigger to the subscribed service.
@@ -48464,6 +48841,141 @@ export interface UpdateScheduleRequestV2025 {
48464
48841
  */
48465
48842
  'applicationId'?: number | null;
48466
48843
  }
48844
+ /**
48845
+ * Stream configuration response including updatedAt (for PATCH/PUT). Same JSON shape as GET single stream plus updatedAt.
48846
+ * @export
48847
+ * @interface UpdateStreamConfigResponseV2025
48848
+ */
48849
+ export interface UpdateStreamConfigResponseV2025 {
48850
+ /**
48851
+ * Unique stream identifier.
48852
+ * @type {string}
48853
+ * @memberof UpdateStreamConfigResponseV2025
48854
+ */
48855
+ 'stream_id'?: string;
48856
+ /**
48857
+ * Issuer (transmitter) URL.
48858
+ * @type {string}
48859
+ * @memberof UpdateStreamConfigResponseV2025
48860
+ */
48861
+ 'iss'?: string;
48862
+ /**
48863
+ * Audience for the stream.
48864
+ * @type {string}
48865
+ * @memberof UpdateStreamConfigResponseV2025
48866
+ */
48867
+ 'aud'?: string;
48868
+ /**
48869
+ *
48870
+ * @type {DeliveryResponseV2025}
48871
+ * @memberof UpdateStreamConfigResponseV2025
48872
+ */
48873
+ 'delivery'?: DeliveryResponseV2025;
48874
+ /**
48875
+ * 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).
48876
+ * @type {Array<string>}
48877
+ * @memberof UpdateStreamConfigResponseV2025
48878
+ */
48879
+ 'events_supported'?: Array<string>;
48880
+ /**
48881
+ * 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).
48882
+ * @type {Array<string>}
48883
+ * @memberof UpdateStreamConfigResponseV2025
48884
+ */
48885
+ 'events_requested'?: Array<string>;
48886
+ /**
48887
+ * Event types currently being delivered (intersection of supported and requested).
48888
+ * @type {Array<string>}
48889
+ * @memberof UpdateStreamConfigResponseV2025
48890
+ */
48891
+ 'events_delivered'?: Array<string>;
48892
+ /**
48893
+ * Optional stream description.
48894
+ * @type {string}
48895
+ * @memberof UpdateStreamConfigResponseV2025
48896
+ */
48897
+ 'description'?: string;
48898
+ /**
48899
+ * Inactivity timeout in seconds (optional).
48900
+ * @type {number}
48901
+ * @memberof UpdateStreamConfigResponseV2025
48902
+ */
48903
+ 'inactivity_timeout'?: number;
48904
+ /**
48905
+ * Minimum verification interval in seconds (optional).
48906
+ * @type {number}
48907
+ * @memberof UpdateStreamConfigResponseV2025
48908
+ */
48909
+ 'min_verification_interval'?: number;
48910
+ /**
48911
+ * Timestamp of the last configuration update.
48912
+ * @type {string}
48913
+ * @memberof UpdateStreamConfigResponseV2025
48914
+ */
48915
+ 'updatedAt'?: string;
48916
+ }
48917
+ /**
48918
+ * Request body for PATCH /ssf/streams (partial update).
48919
+ * @export
48920
+ * @interface UpdateStreamConfigurationRequestV2025
48921
+ */
48922
+ export interface UpdateStreamConfigurationRequestV2025 {
48923
+ /**
48924
+ * ID of the stream to update.
48925
+ * @type {string}
48926
+ * @memberof UpdateStreamConfigurationRequestV2025
48927
+ */
48928
+ 'stream_id': string;
48929
+ /**
48930
+ *
48931
+ * @type {DeliveryRequestV2025}
48932
+ * @memberof UpdateStreamConfigurationRequestV2025
48933
+ */
48934
+ 'delivery'?: DeliveryRequestV2025;
48935
+ /**
48936
+ * Event types the receiver wants. Use CAEP event-type URIs.
48937
+ * @type {Array<string>}
48938
+ * @memberof UpdateStreamConfigurationRequestV2025
48939
+ */
48940
+ 'events_requested'?: Array<string>;
48941
+ /**
48942
+ * Optional human-readable description of the stream.
48943
+ * @type {string}
48944
+ * @memberof UpdateStreamConfigurationRequestV2025
48945
+ */
48946
+ 'description'?: string;
48947
+ }
48948
+ /**
48949
+ * Request body for POST /ssf/streams/status.
48950
+ * @export
48951
+ * @interface UpdateStreamStatusRequestV2025
48952
+ */
48953
+ export interface UpdateStreamStatusRequestV2025 {
48954
+ /**
48955
+ * ID of the stream whose status to update.
48956
+ * @type {string}
48957
+ * @memberof UpdateStreamStatusRequestV2025
48958
+ */
48959
+ 'stream_id': string;
48960
+ /**
48961
+ * Desired stream status.
48962
+ * @type {string}
48963
+ * @memberof UpdateStreamStatusRequestV2025
48964
+ */
48965
+ 'status': UpdateStreamStatusRequestV2025StatusV2025;
48966
+ /**
48967
+ * Optional reason for the status change.
48968
+ * @type {string}
48969
+ * @memberof UpdateStreamStatusRequestV2025
48970
+ */
48971
+ 'reason'?: string;
48972
+ }
48973
+ export declare const UpdateStreamStatusRequestV2025StatusV2025: {
48974
+ readonly Enabled: "enabled";
48975
+ readonly Paused: "paused";
48976
+ readonly Disabled: "disabled";
48977
+ };
48978
+ export type UpdateStreamStatusRequestV2025StatusV2025 = typeof UpdateStreamStatusRequestV2025StatusV2025[keyof typeof UpdateStreamStatusRequestV2025StatusV2025];
48467
48979
  /**
48468
48980
  *
48469
48981
  * @export
@@ -49151,6 +49663,25 @@ export interface ValueV2025 {
49151
49663
  */
49152
49664
  'value'?: string;
49153
49665
  }
49666
+ /**
49667
+ * Request body for POST /ssf/streams/verify (receiver verification).
49668
+ * @export
49669
+ * @interface VerificationRequestV2025
49670
+ */
49671
+ export interface VerificationRequestV2025 {
49672
+ /**
49673
+ * Stream ID for verification.
49674
+ * @type {string}
49675
+ * @memberof VerificationRequestV2025
49676
+ */
49677
+ 'stream_id': string;
49678
+ /**
49679
+ * Optional state value for verification challenge.
49680
+ * @type {string}
49681
+ * @memberof VerificationRequestV2025
49682
+ */
49683
+ 'state'?: string;
49684
+ }
49154
49685
  /**
49155
49686
  * The types of objects supported for SOD violations
49156
49687
  * @export
@@ -91028,6 +91559,458 @@ export declare class ServiceDeskIntegrationV2025Api extends BaseAPI {
91028
91559
  */
91029
91560
  updateStatusCheckDetails(requestParameters: ServiceDeskIntegrationV2025ApiUpdateStatusCheckDetailsRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedCheckConfigDetailsV2025, any>>;
91030
91561
  }
91562
+ /**
91563
+ * SharedSignalsFrameworkSSFV2025Api - axios parameter creator
91564
+ * @export
91565
+ */
91566
+ export declare const SharedSignalsFrameworkSSFV2025ApiAxiosParamCreator: (configuration?: Configuration) => {
91567
+ /**
91568
+ * 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.
91569
+ * @summary Create stream
91570
+ * @param {CreateStreamRequestV2025} createStreamRequestV2025
91571
+ * @param {*} [axiosOptions] Override http request option.
91572
+ * @throws {RequiredError}
91573
+ */
91574
+ createStream: (createStreamRequestV2025: CreateStreamRequestV2025, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
91575
+ /**
91576
+ * 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.
91577
+ * @summary Delete stream
91578
+ * @param {string} streamId ID of the stream to delete. Required; omitted or empty returns 400.
91579
+ * @param {*} [axiosOptions] Override http request option.
91580
+ * @throws {RequiredError}
91581
+ */
91582
+ deleteStream: (streamId: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
91583
+ /**
91584
+ * Returns the transmitter\'s JSON Web Key Set (JWKS) for verifying signed delivery requests.
91585
+ * @summary Get JWKS
91586
+ * @param {*} [axiosOptions] Override http request option.
91587
+ * @throws {RequiredError}
91588
+ */
91589
+ getJWKSData: (axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
91590
+ /**
91591
+ * Returns the SSF transmitter discovery metadata (well-known configuration).
91592
+ * @summary Get SSF configuration
91593
+ * @param {*} [axiosOptions] Override http request option.
91594
+ * @throws {RequiredError}
91595
+ */
91596
+ getSSFConfiguration: (axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
91597
+ /**
91598
+ * 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.
91599
+ * @summary Get stream(s)
91600
+ * @param {string} [streamId] If provided, returns that stream; otherwise returns list of all streams.
91601
+ * @param {*} [axiosOptions] Override http request option.
91602
+ * @throws {RequiredError}
91603
+ */
91604
+ getStream: (streamId?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
91605
+ /**
91606
+ * 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.
91607
+ * @summary Get stream status
91608
+ * @param {string} streamId ID of the stream whose status to retrieve.
91609
+ * @param {*} [axiosOptions] Override http request option.
91610
+ * @throws {RequiredError}
91611
+ */
91612
+ getStreamStatus: (streamId: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
91613
+ /**
91614
+ * Verifies an SSF stream by publishing a verification event requested by a security events provider.
91615
+ * @summary Verify stream
91616
+ * @param {VerificationRequestV2025} verificationRequestV2025
91617
+ * @param {*} [axiosOptions] Override http request option.
91618
+ * @throws {RequiredError}
91619
+ */
91620
+ sendStreamVerification: (verificationRequestV2025: VerificationRequestV2025, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
91621
+ /**
91622
+ * 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.
91623
+ * @summary Replace stream configuration
91624
+ * @param {ReplaceStreamConfigurationRequestV2025} replaceStreamConfigurationRequestV2025
91625
+ * @param {*} [axiosOptions] Override http request option.
91626
+ * @throws {RequiredError}
91627
+ */
91628
+ setStreamConfiguration: (replaceStreamConfigurationRequestV2025: ReplaceStreamConfigurationRequestV2025, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
91629
+ /**
91630
+ * 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.
91631
+ * @summary Update stream configuration
91632
+ * @param {UpdateStreamConfigurationRequestV2025} updateStreamConfigurationRequestV2025
91633
+ * @param {*} [axiosOptions] Override http request option.
91634
+ * @throws {RequiredError}
91635
+ */
91636
+ updateStreamConfiguration: (updateStreamConfigurationRequestV2025: UpdateStreamConfigurationRequestV2025, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
91637
+ /**
91638
+ * 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.
91639
+ * @summary Update stream status
91640
+ * @param {UpdateStreamStatusRequestV2025} updateStreamStatusRequestV2025
91641
+ * @param {*} [axiosOptions] Override http request option.
91642
+ * @throws {RequiredError}
91643
+ */
91644
+ updateStreamStatus: (updateStreamStatusRequestV2025: UpdateStreamStatusRequestV2025, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
91645
+ };
91646
+ /**
91647
+ * SharedSignalsFrameworkSSFV2025Api - functional programming interface
91648
+ * @export
91649
+ */
91650
+ export declare const SharedSignalsFrameworkSSFV2025ApiFp: (configuration?: Configuration) => {
91651
+ /**
91652
+ * 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.
91653
+ * @summary Create stream
91654
+ * @param {CreateStreamRequestV2025} createStreamRequestV2025
91655
+ * @param {*} [axiosOptions] Override http request option.
91656
+ * @throws {RequiredError}
91657
+ */
91658
+ createStream(createStreamRequestV2025: CreateStreamRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StreamConfigResponseV2025>>;
91659
+ /**
91660
+ * 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.
91661
+ * @summary Delete stream
91662
+ * @param {string} streamId ID of the stream to delete. Required; omitted or empty returns 400.
91663
+ * @param {*} [axiosOptions] Override http request option.
91664
+ * @throws {RequiredError}
91665
+ */
91666
+ deleteStream(streamId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
91667
+ /**
91668
+ * Returns the transmitter\'s JSON Web Key Set (JWKS) for verifying signed delivery requests.
91669
+ * @summary Get JWKS
91670
+ * @param {*} [axiosOptions] Override http request option.
91671
+ * @throws {RequiredError}
91672
+ */
91673
+ getJWKSData(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JWKSV2025>>;
91674
+ /**
91675
+ * Returns the SSF transmitter discovery metadata (well-known configuration).
91676
+ * @summary Get SSF configuration
91677
+ * @param {*} [axiosOptions] Override http request option.
91678
+ * @throws {RequiredError}
91679
+ */
91680
+ getSSFConfiguration(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransmitterMetadataV2025>>;
91681
+ /**
91682
+ * 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.
91683
+ * @summary Get stream(s)
91684
+ * @param {string} [streamId] If provided, returns that stream; otherwise returns list of all streams.
91685
+ * @param {*} [axiosOptions] Override http request option.
91686
+ * @throws {RequiredError}
91687
+ */
91688
+ getStream(streamId?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStream200ResponseV2025>>;
91689
+ /**
91690
+ * 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.
91691
+ * @summary Get stream status
91692
+ * @param {string} streamId ID of the stream whose status to retrieve.
91693
+ * @param {*} [axiosOptions] Override http request option.
91694
+ * @throws {RequiredError}
91695
+ */
91696
+ getStreamStatus(streamId: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StreamStatusResponseV2025>>;
91697
+ /**
91698
+ * Verifies an SSF stream by publishing a verification event requested by a security events provider.
91699
+ * @summary Verify stream
91700
+ * @param {VerificationRequestV2025} verificationRequestV2025
91701
+ * @param {*} [axiosOptions] Override http request option.
91702
+ * @throws {RequiredError}
91703
+ */
91704
+ sendStreamVerification(verificationRequestV2025: VerificationRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
91705
+ /**
91706
+ * 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.
91707
+ * @summary Replace stream configuration
91708
+ * @param {ReplaceStreamConfigurationRequestV2025} replaceStreamConfigurationRequestV2025
91709
+ * @param {*} [axiosOptions] Override http request option.
91710
+ * @throws {RequiredError}
91711
+ */
91712
+ setStreamConfiguration(replaceStreamConfigurationRequestV2025: ReplaceStreamConfigurationRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateStreamConfigResponseV2025>>;
91713
+ /**
91714
+ * 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.
91715
+ * @summary Update stream configuration
91716
+ * @param {UpdateStreamConfigurationRequestV2025} updateStreamConfigurationRequestV2025
91717
+ * @param {*} [axiosOptions] Override http request option.
91718
+ * @throws {RequiredError}
91719
+ */
91720
+ updateStreamConfiguration(updateStreamConfigurationRequestV2025: UpdateStreamConfigurationRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateStreamConfigResponseV2025>>;
91721
+ /**
91722
+ * 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.
91723
+ * @summary Update stream status
91724
+ * @param {UpdateStreamStatusRequestV2025} updateStreamStatusRequestV2025
91725
+ * @param {*} [axiosOptions] Override http request option.
91726
+ * @throws {RequiredError}
91727
+ */
91728
+ updateStreamStatus(updateStreamStatusRequestV2025: UpdateStreamStatusRequestV2025, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StreamStatusResponseV2025>>;
91729
+ };
91730
+ /**
91731
+ * SharedSignalsFrameworkSSFV2025Api - factory interface
91732
+ * @export
91733
+ */
91734
+ export declare const SharedSignalsFrameworkSSFV2025ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
91735
+ /**
91736
+ * 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.
91737
+ * @summary Create stream
91738
+ * @param {SharedSignalsFrameworkSSFV2025ApiCreateStreamRequest} requestParameters Request parameters.
91739
+ * @param {*} [axiosOptions] Override http request option.
91740
+ * @throws {RequiredError}
91741
+ */
91742
+ createStream(requestParameters: SharedSignalsFrameworkSSFV2025ApiCreateStreamRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<StreamConfigResponseV2025>;
91743
+ /**
91744
+ * 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.
91745
+ * @summary Delete stream
91746
+ * @param {SharedSignalsFrameworkSSFV2025ApiDeleteStreamRequest} requestParameters Request parameters.
91747
+ * @param {*} [axiosOptions] Override http request option.
91748
+ * @throws {RequiredError}
91749
+ */
91750
+ deleteStream(requestParameters: SharedSignalsFrameworkSSFV2025ApiDeleteStreamRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void>;
91751
+ /**
91752
+ * Returns the transmitter\'s JSON Web Key Set (JWKS) for verifying signed delivery requests.
91753
+ * @summary Get JWKS
91754
+ * @param {*} [axiosOptions] Override http request option.
91755
+ * @throws {RequiredError}
91756
+ */
91757
+ getJWKSData(axiosOptions?: RawAxiosRequestConfig): AxiosPromise<JWKSV2025>;
91758
+ /**
91759
+ * Returns the SSF transmitter discovery metadata (well-known configuration).
91760
+ * @summary Get SSF configuration
91761
+ * @param {*} [axiosOptions] Override http request option.
91762
+ * @throws {RequiredError}
91763
+ */
91764
+ getSSFConfiguration(axiosOptions?: RawAxiosRequestConfig): AxiosPromise<TransmitterMetadataV2025>;
91765
+ /**
91766
+ * 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.
91767
+ * @summary Get stream(s)
91768
+ * @param {SharedSignalsFrameworkSSFV2025ApiGetStreamRequest} requestParameters Request parameters.
91769
+ * @param {*} [axiosOptions] Override http request option.
91770
+ * @throws {RequiredError}
91771
+ */
91772
+ getStream(requestParameters?: SharedSignalsFrameworkSSFV2025ApiGetStreamRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<GetStream200ResponseV2025>;
91773
+ /**
91774
+ * 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.
91775
+ * @summary Get stream status
91776
+ * @param {SharedSignalsFrameworkSSFV2025ApiGetStreamStatusRequest} requestParameters Request parameters.
91777
+ * @param {*} [axiosOptions] Override http request option.
91778
+ * @throws {RequiredError}
91779
+ */
91780
+ getStreamStatus(requestParameters: SharedSignalsFrameworkSSFV2025ApiGetStreamStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<StreamStatusResponseV2025>;
91781
+ /**
91782
+ * Verifies an SSF stream by publishing a verification event requested by a security events provider.
91783
+ * @summary Verify stream
91784
+ * @param {SharedSignalsFrameworkSSFV2025ApiSendStreamVerificationRequest} requestParameters Request parameters.
91785
+ * @param {*} [axiosOptions] Override http request option.
91786
+ * @throws {RequiredError}
91787
+ */
91788
+ sendStreamVerification(requestParameters: SharedSignalsFrameworkSSFV2025ApiSendStreamVerificationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void>;
91789
+ /**
91790
+ * 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.
91791
+ * @summary Replace stream configuration
91792
+ * @param {SharedSignalsFrameworkSSFV2025ApiSetStreamConfigurationRequest} requestParameters Request parameters.
91793
+ * @param {*} [axiosOptions] Override http request option.
91794
+ * @throws {RequiredError}
91795
+ */
91796
+ setStreamConfiguration(requestParameters: SharedSignalsFrameworkSSFV2025ApiSetStreamConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<UpdateStreamConfigResponseV2025>;
91797
+ /**
91798
+ * 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.
91799
+ * @summary Update stream configuration
91800
+ * @param {SharedSignalsFrameworkSSFV2025ApiUpdateStreamConfigurationRequest} requestParameters Request parameters.
91801
+ * @param {*} [axiosOptions] Override http request option.
91802
+ * @throws {RequiredError}
91803
+ */
91804
+ updateStreamConfiguration(requestParameters: SharedSignalsFrameworkSSFV2025ApiUpdateStreamConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<UpdateStreamConfigResponseV2025>;
91805
+ /**
91806
+ * 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.
91807
+ * @summary Update stream status
91808
+ * @param {SharedSignalsFrameworkSSFV2025ApiUpdateStreamStatusRequest} requestParameters Request parameters.
91809
+ * @param {*} [axiosOptions] Override http request option.
91810
+ * @throws {RequiredError}
91811
+ */
91812
+ updateStreamStatus(requestParameters: SharedSignalsFrameworkSSFV2025ApiUpdateStreamStatusRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<StreamStatusResponseV2025>;
91813
+ };
91814
+ /**
91815
+ * Request parameters for createStream operation in SharedSignalsFrameworkSSFV2025Api.
91816
+ * @export
91817
+ * @interface SharedSignalsFrameworkSSFV2025ApiCreateStreamRequest
91818
+ */
91819
+ export interface SharedSignalsFrameworkSSFV2025ApiCreateStreamRequest {
91820
+ /**
91821
+ *
91822
+ * @type {CreateStreamRequestV2025}
91823
+ * @memberof SharedSignalsFrameworkSSFV2025ApiCreateStream
91824
+ */
91825
+ readonly createStreamRequestV2025: CreateStreamRequestV2025;
91826
+ }
91827
+ /**
91828
+ * Request parameters for deleteStream operation in SharedSignalsFrameworkSSFV2025Api.
91829
+ * @export
91830
+ * @interface SharedSignalsFrameworkSSFV2025ApiDeleteStreamRequest
91831
+ */
91832
+ export interface SharedSignalsFrameworkSSFV2025ApiDeleteStreamRequest {
91833
+ /**
91834
+ * ID of the stream to delete. Required; omitted or empty returns 400.
91835
+ * @type {string}
91836
+ * @memberof SharedSignalsFrameworkSSFV2025ApiDeleteStream
91837
+ */
91838
+ readonly streamId: string;
91839
+ }
91840
+ /**
91841
+ * Request parameters for getStream operation in SharedSignalsFrameworkSSFV2025Api.
91842
+ * @export
91843
+ * @interface SharedSignalsFrameworkSSFV2025ApiGetStreamRequest
91844
+ */
91845
+ export interface SharedSignalsFrameworkSSFV2025ApiGetStreamRequest {
91846
+ /**
91847
+ * If provided, returns that stream; otherwise returns list of all streams.
91848
+ * @type {string}
91849
+ * @memberof SharedSignalsFrameworkSSFV2025ApiGetStream
91850
+ */
91851
+ readonly streamId?: string;
91852
+ }
91853
+ /**
91854
+ * Request parameters for getStreamStatus operation in SharedSignalsFrameworkSSFV2025Api.
91855
+ * @export
91856
+ * @interface SharedSignalsFrameworkSSFV2025ApiGetStreamStatusRequest
91857
+ */
91858
+ export interface SharedSignalsFrameworkSSFV2025ApiGetStreamStatusRequest {
91859
+ /**
91860
+ * ID of the stream whose status to retrieve.
91861
+ * @type {string}
91862
+ * @memberof SharedSignalsFrameworkSSFV2025ApiGetStreamStatus
91863
+ */
91864
+ readonly streamId: string;
91865
+ }
91866
+ /**
91867
+ * Request parameters for sendStreamVerification operation in SharedSignalsFrameworkSSFV2025Api.
91868
+ * @export
91869
+ * @interface SharedSignalsFrameworkSSFV2025ApiSendStreamVerificationRequest
91870
+ */
91871
+ export interface SharedSignalsFrameworkSSFV2025ApiSendStreamVerificationRequest {
91872
+ /**
91873
+ *
91874
+ * @type {VerificationRequestV2025}
91875
+ * @memberof SharedSignalsFrameworkSSFV2025ApiSendStreamVerification
91876
+ */
91877
+ readonly verificationRequestV2025: VerificationRequestV2025;
91878
+ }
91879
+ /**
91880
+ * Request parameters for setStreamConfiguration operation in SharedSignalsFrameworkSSFV2025Api.
91881
+ * @export
91882
+ * @interface SharedSignalsFrameworkSSFV2025ApiSetStreamConfigurationRequest
91883
+ */
91884
+ export interface SharedSignalsFrameworkSSFV2025ApiSetStreamConfigurationRequest {
91885
+ /**
91886
+ *
91887
+ * @type {ReplaceStreamConfigurationRequestV2025}
91888
+ * @memberof SharedSignalsFrameworkSSFV2025ApiSetStreamConfiguration
91889
+ */
91890
+ readonly replaceStreamConfigurationRequestV2025: ReplaceStreamConfigurationRequestV2025;
91891
+ }
91892
+ /**
91893
+ * Request parameters for updateStreamConfiguration operation in SharedSignalsFrameworkSSFV2025Api.
91894
+ * @export
91895
+ * @interface SharedSignalsFrameworkSSFV2025ApiUpdateStreamConfigurationRequest
91896
+ */
91897
+ export interface SharedSignalsFrameworkSSFV2025ApiUpdateStreamConfigurationRequest {
91898
+ /**
91899
+ *
91900
+ * @type {UpdateStreamConfigurationRequestV2025}
91901
+ * @memberof SharedSignalsFrameworkSSFV2025ApiUpdateStreamConfiguration
91902
+ */
91903
+ readonly updateStreamConfigurationRequestV2025: UpdateStreamConfigurationRequestV2025;
91904
+ }
91905
+ /**
91906
+ * Request parameters for updateStreamStatus operation in SharedSignalsFrameworkSSFV2025Api.
91907
+ * @export
91908
+ * @interface SharedSignalsFrameworkSSFV2025ApiUpdateStreamStatusRequest
91909
+ */
91910
+ export interface SharedSignalsFrameworkSSFV2025ApiUpdateStreamStatusRequest {
91911
+ /**
91912
+ *
91913
+ * @type {UpdateStreamStatusRequestV2025}
91914
+ * @memberof SharedSignalsFrameworkSSFV2025ApiUpdateStreamStatus
91915
+ */
91916
+ readonly updateStreamStatusRequestV2025: UpdateStreamStatusRequestV2025;
91917
+ }
91918
+ /**
91919
+ * SharedSignalsFrameworkSSFV2025Api - object-oriented interface
91920
+ * @export
91921
+ * @class SharedSignalsFrameworkSSFV2025Api
91922
+ * @extends {BaseAPI}
91923
+ */
91924
+ export declare class SharedSignalsFrameworkSSFV2025Api extends BaseAPI {
91925
+ /**
91926
+ * 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.
91927
+ * @summary Create stream
91928
+ * @param {SharedSignalsFrameworkSSFV2025ApiCreateStreamRequest} requestParameters Request parameters.
91929
+ * @param {*} [axiosOptions] Override http request option.
91930
+ * @throws {RequiredError}
91931
+ * @memberof SharedSignalsFrameworkSSFV2025Api
91932
+ */
91933
+ createStream(requestParameters: SharedSignalsFrameworkSSFV2025ApiCreateStreamRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<StreamConfigResponseV2025, any>>;
91934
+ /**
91935
+ * 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.
91936
+ * @summary Delete stream
91937
+ * @param {SharedSignalsFrameworkSSFV2025ApiDeleteStreamRequest} requestParameters Request parameters.
91938
+ * @param {*} [axiosOptions] Override http request option.
91939
+ * @throws {RequiredError}
91940
+ * @memberof SharedSignalsFrameworkSSFV2025Api
91941
+ */
91942
+ deleteStream(requestParameters: SharedSignalsFrameworkSSFV2025ApiDeleteStreamRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
91943
+ /**
91944
+ * Returns the transmitter\'s JSON Web Key Set (JWKS) for verifying signed delivery requests.
91945
+ * @summary Get JWKS
91946
+ * @param {*} [axiosOptions] Override http request option.
91947
+ * @throws {RequiredError}
91948
+ * @memberof SharedSignalsFrameworkSSFV2025Api
91949
+ */
91950
+ getJWKSData(axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<JWKSV2025, any>>;
91951
+ /**
91952
+ * Returns the SSF transmitter discovery metadata (well-known configuration).
91953
+ * @summary Get SSF configuration
91954
+ * @param {*} [axiosOptions] Override http request option.
91955
+ * @throws {RequiredError}
91956
+ * @memberof SharedSignalsFrameworkSSFV2025Api
91957
+ */
91958
+ getSSFConfiguration(axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransmitterMetadataV2025, any>>;
91959
+ /**
91960
+ * 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.
91961
+ * @summary Get stream(s)
91962
+ * @param {SharedSignalsFrameworkSSFV2025ApiGetStreamRequest} requestParameters Request parameters.
91963
+ * @param {*} [axiosOptions] Override http request option.
91964
+ * @throws {RequiredError}
91965
+ * @memberof SharedSignalsFrameworkSSFV2025Api
91966
+ */
91967
+ getStream(requestParameters?: SharedSignalsFrameworkSSFV2025ApiGetStreamRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStream200ResponseV2025, any>>;
91968
+ /**
91969
+ * 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.
91970
+ * @summary Get stream status
91971
+ * @param {SharedSignalsFrameworkSSFV2025ApiGetStreamStatusRequest} requestParameters Request parameters.
91972
+ * @param {*} [axiosOptions] Override http request option.
91973
+ * @throws {RequiredError}
91974
+ * @memberof SharedSignalsFrameworkSSFV2025Api
91975
+ */
91976
+ getStreamStatus(requestParameters: SharedSignalsFrameworkSSFV2025ApiGetStreamStatusRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<StreamStatusResponseV2025, any>>;
91977
+ /**
91978
+ * Verifies an SSF stream by publishing a verification event requested by a security events provider.
91979
+ * @summary Verify stream
91980
+ * @param {SharedSignalsFrameworkSSFV2025ApiSendStreamVerificationRequest} requestParameters Request parameters.
91981
+ * @param {*} [axiosOptions] Override http request option.
91982
+ * @throws {RequiredError}
91983
+ * @memberof SharedSignalsFrameworkSSFV2025Api
91984
+ */
91985
+ sendStreamVerification(requestParameters: SharedSignalsFrameworkSSFV2025ApiSendStreamVerificationRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
91986
+ /**
91987
+ * 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.
91988
+ * @summary Replace stream configuration
91989
+ * @param {SharedSignalsFrameworkSSFV2025ApiSetStreamConfigurationRequest} requestParameters Request parameters.
91990
+ * @param {*} [axiosOptions] Override http request option.
91991
+ * @throws {RequiredError}
91992
+ * @memberof SharedSignalsFrameworkSSFV2025Api
91993
+ */
91994
+ setStreamConfiguration(requestParameters: SharedSignalsFrameworkSSFV2025ApiSetStreamConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateStreamConfigResponseV2025, any>>;
91995
+ /**
91996
+ * 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.
91997
+ * @summary Update stream configuration
91998
+ * @param {SharedSignalsFrameworkSSFV2025ApiUpdateStreamConfigurationRequest} requestParameters Request parameters.
91999
+ * @param {*} [axiosOptions] Override http request option.
92000
+ * @throws {RequiredError}
92001
+ * @memberof SharedSignalsFrameworkSSFV2025Api
92002
+ */
92003
+ updateStreamConfiguration(requestParameters: SharedSignalsFrameworkSSFV2025ApiUpdateStreamConfigurationRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateStreamConfigResponseV2025, any>>;
92004
+ /**
92005
+ * 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.
92006
+ * @summary Update stream status
92007
+ * @param {SharedSignalsFrameworkSSFV2025ApiUpdateStreamStatusRequest} requestParameters Request parameters.
92008
+ * @param {*} [axiosOptions] Override http request option.
92009
+ * @throws {RequiredError}
92010
+ * @memberof SharedSignalsFrameworkSSFV2025Api
92011
+ */
92012
+ updateStreamStatus(requestParameters: SharedSignalsFrameworkSSFV2025ApiUpdateStreamStatusRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<StreamStatusResponseV2025, any>>;
92013
+ }
91031
92014
  /**
91032
92015
  * SourceUsagesV2025Api - axios parameter creator
91033
92016
  * @export