@flashstart/client 8.15.1 → 9.1.6

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.
@@ -332,6 +332,169 @@ export type UpdatePolicySettingsResponses = {
332
332
  };
333
333
  };
334
334
  export type UpdatePolicySettingsResponse = UpdatePolicySettingsResponses[keyof UpdatePolicySettingsResponses];
335
+ export type GetPolicyBlockData = {
336
+ body?: never;
337
+ path: {
338
+ policyId: string;
339
+ };
340
+ query?: never;
341
+ url: '/v1/policies/{policyId}/block';
342
+ };
343
+ export type GetPolicyBlockErrors = {
344
+ /**
345
+ * Missing or invalid API key or bearer credentials; missing credentials return a message, invalid credentials return a standard error
346
+ */
347
+ 401: MissingCredentialsErrorBody | FlashStartErrorBody;
348
+ /**
349
+ * Insufficient permission
350
+ */
351
+ 403: FlashStartErrorBody;
352
+ /**
353
+ * Resource not found
354
+ */
355
+ 404: FlashStartErrorBody;
356
+ /**
357
+ * Internal server error
358
+ */
359
+ 500: FlashStartErrorBody;
360
+ };
361
+ export type GetPolicyBlockError = GetPolicyBlockErrors[keyof GetPolicyBlockErrors];
362
+ export type GetPolicyBlockResponses = {
363
+ /**
364
+ * Policy block response
365
+ */
366
+ 200: {
367
+ responseType: 'NXDOMAIN';
368
+ } | {
369
+ responseType: 'STOP_PAGE';
370
+ stopPage: {
371
+ type: 'STANDARD';
372
+ } | {
373
+ type: 'CUSTOM' | 'EXTERNAL';
374
+ id: string;
375
+ name: string;
376
+ };
377
+ };
378
+ };
379
+ export type GetPolicyBlockResponse = GetPolicyBlockResponses[keyof GetPolicyBlockResponses];
380
+ export type UpdatePolicyBlockData = {
381
+ body: {
382
+ responseType: 'NXDOMAIN';
383
+ } | {
384
+ responseType: 'STOP_PAGE';
385
+ stopPageId?: string;
386
+ };
387
+ path: {
388
+ policyId: string;
389
+ };
390
+ query?: never;
391
+ url: '/v1/policies/{policyId}/block';
392
+ };
393
+ export type UpdatePolicyBlockErrors = {
394
+ /**
395
+ * Missing or invalid API key or bearer credentials; missing credentials return a message, invalid credentials return a standard error
396
+ */
397
+ 401: MissingCredentialsErrorBody | FlashStartErrorBody;
398
+ /**
399
+ * Insufficient permission
400
+ */
401
+ 403: FlashStartErrorBody;
402
+ /**
403
+ * Resource not found
404
+ */
405
+ 404: FlashStartErrorBody;
406
+ /**
407
+ * Request validation failed
408
+ */
409
+ 422: FlashStartErrorBody;
410
+ /**
411
+ * Internal server error
412
+ */
413
+ 500: FlashStartErrorBody;
414
+ };
415
+ export type UpdatePolicyBlockError = UpdatePolicyBlockErrors[keyof UpdatePolicyBlockErrors];
416
+ export type UpdatePolicyBlockResponses = {
417
+ /**
418
+ * Policy block response
419
+ */
420
+ 200: {
421
+ responseType: 'NXDOMAIN';
422
+ } | {
423
+ responseType: 'STOP_PAGE';
424
+ stopPage: {
425
+ type: 'STANDARD';
426
+ } | {
427
+ type: 'CUSTOM' | 'EXTERNAL';
428
+ id: string;
429
+ name: string;
430
+ };
431
+ };
432
+ };
433
+ export type UpdatePolicyBlockResponse = UpdatePolicyBlockResponses[keyof UpdatePolicyBlockResponses];
434
+ export type GetPolicyStopPageData = {
435
+ body?: never;
436
+ path: {
437
+ policyId: string;
438
+ };
439
+ query?: never;
440
+ url: '/v1/policies/{policyId}/stop-page';
441
+ };
442
+ export type GetPolicyStopPageErrors = {
443
+ /**
444
+ * Missing or invalid API key or bearer credentials; missing credentials return a message, invalid credentials return a standard error
445
+ */
446
+ 401: MissingCredentialsErrorBody | FlashStartErrorBody;
447
+ /**
448
+ * Insufficient permission
449
+ */
450
+ 403: FlashStartErrorBody;
451
+ /**
452
+ * Resource not found
453
+ */
454
+ 404: FlashStartErrorBody;
455
+ /**
456
+ * Internal server error
457
+ */
458
+ 500: FlashStartErrorBody;
459
+ };
460
+ export type GetPolicyStopPageError = GetPolicyStopPageErrors[keyof GetPolicyStopPageErrors];
461
+ export type GetPolicyStopPageResponses = {
462
+ /**
463
+ * Policy stop page details
464
+ */
465
+ 200: {
466
+ configured: {
467
+ responseType: 'NXDOMAIN';
468
+ } | {
469
+ responseType: 'STOP_PAGE';
470
+ stopPage: {
471
+ type: 'STANDARD';
472
+ } | {
473
+ id: string;
474
+ name: string;
475
+ type: 'CUSTOM' | 'EXTERNAL';
476
+ };
477
+ };
478
+ effective: {
479
+ responseType: 'NXDOMAIN';
480
+ } | {
481
+ responseType: 'STOP_PAGE';
482
+ stopPage: {
483
+ type: 'STANDARD';
484
+ } | {
485
+ id: string;
486
+ name: string;
487
+ type: 'CUSTOM' | 'EXTERNAL';
488
+ };
489
+ source: 'EXPLICIT' | 'LOCAL_DEFAULT' | 'ANCESTOR_DEFAULT' | 'BUILT_IN';
490
+ sourceOrganization: {
491
+ id: string;
492
+ name: string;
493
+ } | null;
494
+ };
495
+ };
496
+ };
497
+ export type GetPolicyStopPageResponse = GetPolicyStopPageResponses[keyof GetPolicyStopPageResponses];
335
498
  export type ListPolicyExceptionGroupsData = {
336
499
  body?: never;
337
500
  path: {
@@ -2789,3 +2952,741 @@ export type GetTldResponses = {
2789
2952
  };
2790
2953
  };
2791
2954
  export type GetTldResponse = GetTldResponses[keyof GetTldResponses];
2955
+ export type ListStopPagesData = {
2956
+ body?: never;
2957
+ path?: never;
2958
+ query?: {
2959
+ organizationId?: string;
2960
+ includeSharedAncestors?: 'true' | 'false';
2961
+ };
2962
+ url: '/v1/stop-pages';
2963
+ };
2964
+ export type ListStopPagesErrors = {
2965
+ /**
2966
+ * Missing or invalid API key or bearer credentials; missing credentials return a message, invalid credentials return a standard error
2967
+ */
2968
+ 401: MissingCredentialsErrorBody | FlashStartErrorBody;
2969
+ /**
2970
+ * Insufficient permission
2971
+ */
2972
+ 403: FlashStartErrorBody;
2973
+ /**
2974
+ * Resource not found
2975
+ */
2976
+ 404: FlashStartErrorBody;
2977
+ /**
2978
+ * Internal server error
2979
+ */
2980
+ 500: FlashStartErrorBody;
2981
+ };
2982
+ export type ListStopPagesError = ListStopPagesErrors[keyof ListStopPagesErrors];
2983
+ export type ListStopPagesResponses = {
2984
+ /**
2985
+ * Stop pages
2986
+ */
2987
+ 200: Array<{
2988
+ id: string;
2989
+ organizationId: string;
2990
+ name: string;
2991
+ organizationName: string | null;
2992
+ type: 'CUSTOM' | 'EXTERNAL';
2993
+ isShared: boolean;
2994
+ /**
2995
+ * True when this page is the local default of its owner organization, even when the viewer is a descendant. It is not the viewer's effective default.
2996
+ */
2997
+ isDefault: boolean;
2998
+ canManage: boolean;
2999
+ deletionBlockers: Array<'DEFAULT' | 'ASSIGNED'>;
3000
+ policyCount: number;
3001
+ }>;
3002
+ };
3003
+ export type ListStopPagesResponse = ListStopPagesResponses[keyof ListStopPagesResponses];
3004
+ export type GetStandardStopPageData = {
3005
+ body?: never;
3006
+ path?: never;
3007
+ query?: {
3008
+ organizationId?: string;
3009
+ };
3010
+ url: '/v1/stop-pages/standard';
3011
+ };
3012
+ export type GetStandardStopPageErrors = {
3013
+ /**
3014
+ * Missing or invalid API key or bearer credentials; missing credentials return a message, invalid credentials return a standard error
3015
+ */
3016
+ 401: MissingCredentialsErrorBody | FlashStartErrorBody;
3017
+ /**
3018
+ * Insufficient permission
3019
+ */
3020
+ 403: FlashStartErrorBody;
3021
+ /**
3022
+ * Resource not found
3023
+ */
3024
+ 404: FlashStartErrorBody;
3025
+ /**
3026
+ * Request validation failed
3027
+ */
3028
+ 422: FlashStartErrorBody;
3029
+ /**
3030
+ * Internal server error
3031
+ */
3032
+ 500: FlashStartErrorBody;
3033
+ };
3034
+ export type GetStandardStopPageError = GetStandardStopPageErrors[keyof GetStandardStopPageErrors];
3035
+ export type GetStandardStopPageResponses = {
3036
+ /**
3037
+ * Standard stop page
3038
+ */
3039
+ 200: {
3040
+ type: 'STANDARD';
3041
+ policyIds: Array<string>;
3042
+ };
3043
+ };
3044
+ export type GetStandardStopPageResponse = GetStandardStopPageResponses[keyof GetStandardStopPageResponses];
3045
+ export type DeleteStopPageData = {
3046
+ body?: never;
3047
+ path: {
3048
+ stopPageId: string;
3049
+ };
3050
+ query?: never;
3051
+ url: '/v1/stop-pages/{stopPageId}';
3052
+ };
3053
+ export type DeleteStopPageErrors = {
3054
+ /**
3055
+ * Missing or invalid API key or bearer credentials; missing credentials return a message, invalid credentials return a standard error
3056
+ */
3057
+ 401: MissingCredentialsErrorBody | FlashStartErrorBody;
3058
+ /**
3059
+ * Insufficient permission
3060
+ */
3061
+ 403: FlashStartErrorBody;
3062
+ /**
3063
+ * Resource not found
3064
+ */
3065
+ 404: FlashStartErrorBody;
3066
+ /**
3067
+ * Internal server error
3068
+ */
3069
+ 500: FlashStartErrorBody;
3070
+ };
3071
+ export type DeleteStopPageError = DeleteStopPageErrors[keyof DeleteStopPageErrors];
3072
+ export type DeleteStopPageResponses = {
3073
+ /**
3074
+ * Stop page
3075
+ */
3076
+ 200: {
3077
+ id: string;
3078
+ organizationId: string;
3079
+ name: string;
3080
+ organizationName: string | null;
3081
+ type: 'CUSTOM' | 'EXTERNAL';
3082
+ isShared: boolean;
3083
+ /**
3084
+ * True when this page is the local default of its owner organization, even when the viewer is a descendant. It is not the viewer's effective default.
3085
+ */
3086
+ isDefault: boolean;
3087
+ canManage: boolean;
3088
+ deletionBlockers: Array<'DEFAULT' | 'ASSIGNED'>;
3089
+ policyCount: number;
3090
+ };
3091
+ };
3092
+ export type DeleteStopPageResponse = DeleteStopPageResponses[keyof DeleteStopPageResponses];
3093
+ export type GetStopPageData = {
3094
+ body?: never;
3095
+ path: {
3096
+ stopPageId: string;
3097
+ };
3098
+ query?: never;
3099
+ url: '/v1/stop-pages/{stopPageId}';
3100
+ };
3101
+ export type GetStopPageErrors = {
3102
+ /**
3103
+ * Missing or invalid API key or bearer credentials; missing credentials return a message, invalid credentials return a standard error
3104
+ */
3105
+ 401: MissingCredentialsErrorBody | FlashStartErrorBody;
3106
+ /**
3107
+ * Insufficient permission
3108
+ */
3109
+ 403: FlashStartErrorBody;
3110
+ /**
3111
+ * Resource not found
3112
+ */
3113
+ 404: FlashStartErrorBody;
3114
+ /**
3115
+ * Internal server error
3116
+ */
3117
+ 500: FlashStartErrorBody;
3118
+ };
3119
+ export type GetStopPageError = GetStopPageErrors[keyof GetStopPageErrors];
3120
+ export type GetStopPageResponses = {
3121
+ /**
3122
+ * Stop page
3123
+ */
3124
+ 200: {
3125
+ id: string;
3126
+ organizationId: string;
3127
+ name: string;
3128
+ organizationName: string | null;
3129
+ type: 'CUSTOM' | 'EXTERNAL';
3130
+ isShared: boolean;
3131
+ /**
3132
+ * True when this page is the local default of its owner organization, even when the viewer is a descendant. It is not the viewer's effective default.
3133
+ */
3134
+ isDefault: boolean;
3135
+ canManage: boolean;
3136
+ deletionBlockers: Array<'DEFAULT' | 'ASSIGNED'>;
3137
+ policyCount: number;
3138
+ };
3139
+ };
3140
+ export type GetStopPageResponse = GetStopPageResponses[keyof GetStopPageResponses];
3141
+ export type UpdateStopPageData = {
3142
+ body: {
3143
+ name?: string;
3144
+ };
3145
+ path: {
3146
+ stopPageId: string;
3147
+ };
3148
+ query?: never;
3149
+ url: '/v1/stop-pages/{stopPageId}';
3150
+ };
3151
+ export type UpdateStopPageErrors = {
3152
+ /**
3153
+ * Missing or invalid API key or bearer credentials; missing credentials return a message, invalid credentials return a standard error
3154
+ */
3155
+ 401: MissingCredentialsErrorBody | FlashStartErrorBody;
3156
+ /**
3157
+ * Insufficient permission
3158
+ */
3159
+ 403: FlashStartErrorBody;
3160
+ /**
3161
+ * Resource not found
3162
+ */
3163
+ 404: FlashStartErrorBody;
3164
+ /**
3165
+ * Request validation failed
3166
+ */
3167
+ 422: FlashStartErrorBody;
3168
+ /**
3169
+ * Internal server error
3170
+ */
3171
+ 500: FlashStartErrorBody;
3172
+ };
3173
+ export type UpdateStopPageError = UpdateStopPageErrors[keyof UpdateStopPageErrors];
3174
+ export type UpdateStopPageResponses = {
3175
+ /**
3176
+ * Stop page
3177
+ */
3178
+ 200: {
3179
+ id: string;
3180
+ organizationId: string;
3181
+ name: string;
3182
+ organizationName: string | null;
3183
+ type: 'CUSTOM' | 'EXTERNAL';
3184
+ isShared: boolean;
3185
+ /**
3186
+ * True when this page is the local default of its owner organization, even when the viewer is a descendant. It is not the viewer's effective default.
3187
+ */
3188
+ isDefault: boolean;
3189
+ canManage: boolean;
3190
+ deletionBlockers: Array<'DEFAULT' | 'ASSIGNED'>;
3191
+ policyCount: number;
3192
+ };
3193
+ };
3194
+ export type UpdateStopPageResponse = UpdateStopPageResponses[keyof UpdateStopPageResponses];
3195
+ export type ShareStopPageData = {
3196
+ body?: never;
3197
+ path: {
3198
+ stopPageId: string;
3199
+ };
3200
+ query?: never;
3201
+ url: '/v1/stop-pages/{stopPageId}/share';
3202
+ };
3203
+ export type ShareStopPageErrors = {
3204
+ /**
3205
+ * Missing or invalid API key or bearer credentials; missing credentials return a message, invalid credentials return a standard error
3206
+ */
3207
+ 401: MissingCredentialsErrorBody | FlashStartErrorBody;
3208
+ /**
3209
+ * Insufficient permission
3210
+ */
3211
+ 403: FlashStartErrorBody;
3212
+ /**
3213
+ * Resource not found
3214
+ */
3215
+ 404: FlashStartErrorBody;
3216
+ /**
3217
+ * Internal server error
3218
+ */
3219
+ 500: FlashStartErrorBody;
3220
+ };
3221
+ export type ShareStopPageError = ShareStopPageErrors[keyof ShareStopPageErrors];
3222
+ export type ShareStopPageResponses = {
3223
+ /**
3224
+ * Stop page
3225
+ */
3226
+ 200: {
3227
+ id: string;
3228
+ organizationId: string;
3229
+ name: string;
3230
+ organizationName: string | null;
3231
+ type: 'CUSTOM' | 'EXTERNAL';
3232
+ isShared: boolean;
3233
+ /**
3234
+ * True when this page is the local default of its owner organization, even when the viewer is a descendant. It is not the viewer's effective default.
3235
+ */
3236
+ isDefault: boolean;
3237
+ canManage: boolean;
3238
+ deletionBlockers: Array<'DEFAULT' | 'ASSIGNED'>;
3239
+ policyCount: number;
3240
+ };
3241
+ };
3242
+ export type ShareStopPageResponse = ShareStopPageResponses[keyof ShareStopPageResponses];
3243
+ export type SetOrganizationStopPageDefaultData = {
3244
+ body: {
3245
+ stopPageId: string | null;
3246
+ };
3247
+ path: {
3248
+ organizationId: string;
3249
+ };
3250
+ query?: never;
3251
+ url: '/v1/organizations/{organizationId}/stop-page-default';
3252
+ };
3253
+ export type SetOrganizationStopPageDefaultErrors = {
3254
+ /**
3255
+ * Missing or invalid API key or bearer credentials; missing credentials return a message, invalid credentials return a standard error
3256
+ */
3257
+ 401: MissingCredentialsErrorBody | FlashStartErrorBody;
3258
+ /**
3259
+ * Insufficient permission
3260
+ */
3261
+ 403: FlashStartErrorBody;
3262
+ /**
3263
+ * Resource not found
3264
+ */
3265
+ 404: FlashStartErrorBody;
3266
+ /**
3267
+ * Request validation failed
3268
+ */
3269
+ 422: FlashStartErrorBody;
3270
+ /**
3271
+ * Internal server error
3272
+ */
3273
+ 500: FlashStartErrorBody;
3274
+ };
3275
+ export type SetOrganizationStopPageDefaultError = SetOrganizationStopPageDefaultErrors[keyof SetOrganizationStopPageDefaultErrors];
3276
+ export type SetOrganizationStopPageDefaultResponses = {
3277
+ /**
3278
+ * Default stop page
3279
+ */
3280
+ 200: {
3281
+ organizationId: string;
3282
+ stopPageId: string | null;
3283
+ reconciliationPending: boolean;
3284
+ };
3285
+ };
3286
+ export type SetOrganizationStopPageDefaultResponse = SetOrganizationStopPageDefaultResponses[keyof SetOrganizationStopPageDefaultResponses];
3287
+ export type CreateCustomStopPageData = {
3288
+ body: {
3289
+ name: string;
3290
+ title: {
3291
+ display: 'CUSTOM';
3292
+ value: string;
3293
+ } | {
3294
+ display: 'HIDE';
3295
+ } | {
3296
+ display: 'CUSTOMER';
3297
+ } | {
3298
+ display: 'POLICY';
3299
+ } | {
3300
+ display: 'CUSTOMER_AND_POLICY';
3301
+ };
3302
+ image: {
3303
+ display: 'CUSTOM';
3304
+ value: string;
3305
+ } | {
3306
+ display: 'DEFAULT';
3307
+ } | {
3308
+ display: 'HIDE';
3309
+ };
3310
+ message: {
3311
+ display: 'CUSTOM';
3312
+ value: string;
3313
+ } | {
3314
+ display: 'HIDE';
3315
+ };
3316
+ description: {
3317
+ display: 'CUSTOM';
3318
+ value: string;
3319
+ } | {
3320
+ display: 'HIDE';
3321
+ };
3322
+ blockedDomain: 'SHOW' | 'HIDE';
3323
+ blockReason: 'SHOW' | 'HIDE';
3324
+ unblockLink: 'SHOW' | 'HIDE';
3325
+ isShared?: boolean;
3326
+ makeDefault?: boolean;
3327
+ };
3328
+ path?: never;
3329
+ query?: {
3330
+ organizationId?: string;
3331
+ };
3332
+ url: '/v1/stop-pages/custom';
3333
+ };
3334
+ export type CreateCustomStopPageErrors = {
3335
+ /**
3336
+ * Missing or invalid API key or bearer credentials; missing credentials return a message, invalid credentials return a standard error
3337
+ */
3338
+ 401: MissingCredentialsErrorBody | FlashStartErrorBody;
3339
+ /**
3340
+ * Insufficient permission
3341
+ */
3342
+ 403: FlashStartErrorBody;
3343
+ /**
3344
+ * Resource not found
3345
+ */
3346
+ 404: FlashStartErrorBody;
3347
+ /**
3348
+ * Request validation failed
3349
+ */
3350
+ 422: FlashStartErrorBody;
3351
+ /**
3352
+ * Internal server error
3353
+ */
3354
+ 500: FlashStartErrorBody;
3355
+ };
3356
+ export type CreateCustomStopPageError = CreateCustomStopPageErrors[keyof CreateCustomStopPageErrors];
3357
+ export type CreateCustomStopPageResponses = {
3358
+ /**
3359
+ * Stop page
3360
+ */
3361
+ 201: {
3362
+ id: string;
3363
+ organizationId: string;
3364
+ name: string;
3365
+ organizationName: string | null;
3366
+ type: 'CUSTOM' | 'EXTERNAL';
3367
+ isShared: boolean;
3368
+ /**
3369
+ * True when this page is the local default of its owner organization, even when the viewer is a descendant. It is not the viewer's effective default.
3370
+ */
3371
+ isDefault: boolean;
3372
+ canManage: boolean;
3373
+ deletionBlockers: Array<'DEFAULT' | 'ASSIGNED'>;
3374
+ policyCount: number;
3375
+ };
3376
+ };
3377
+ export type CreateCustomStopPageResponse = CreateCustomStopPageResponses[keyof CreateCustomStopPageResponses];
3378
+ export type GetCustomStopPageConfigurationData = {
3379
+ body?: never;
3380
+ path: {
3381
+ stopPageId: string;
3382
+ };
3383
+ query?: never;
3384
+ url: '/v1/stop-pages/custom/{stopPageId}/configuration';
3385
+ };
3386
+ export type GetCustomStopPageConfigurationErrors = {
3387
+ /**
3388
+ * Missing or invalid API key or bearer credentials; missing credentials return a message, invalid credentials return a standard error
3389
+ */
3390
+ 401: MissingCredentialsErrorBody | FlashStartErrorBody;
3391
+ /**
3392
+ * Insufficient permission
3393
+ */
3394
+ 403: FlashStartErrorBody;
3395
+ /**
3396
+ * Resource not found
3397
+ */
3398
+ 404: FlashStartErrorBody;
3399
+ /**
3400
+ * Internal server error
3401
+ */
3402
+ 500: FlashStartErrorBody;
3403
+ };
3404
+ export type GetCustomStopPageConfigurationError = GetCustomStopPageConfigurationErrors[keyof GetCustomStopPageConfigurationErrors];
3405
+ export type GetCustomStopPageConfigurationResponses = {
3406
+ /**
3407
+ * Custom stop page configuration
3408
+ */
3409
+ 200: {
3410
+ title: {
3411
+ display: 'CUSTOM';
3412
+ value: string;
3413
+ } | {
3414
+ display: 'HIDE';
3415
+ } | {
3416
+ display: 'CUSTOMER';
3417
+ } | {
3418
+ display: 'POLICY';
3419
+ } | {
3420
+ display: 'CUSTOMER_AND_POLICY';
3421
+ };
3422
+ image: {
3423
+ display: 'CUSTOM';
3424
+ value: string;
3425
+ } | {
3426
+ display: 'DEFAULT';
3427
+ } | {
3428
+ display: 'HIDE';
3429
+ };
3430
+ message: {
3431
+ display: 'CUSTOM';
3432
+ value: string;
3433
+ } | {
3434
+ display: 'HIDE';
3435
+ };
3436
+ description: {
3437
+ display: 'CUSTOM';
3438
+ value: string;
3439
+ } | {
3440
+ display: 'HIDE';
3441
+ };
3442
+ blockedDomain: 'SHOW' | 'HIDE';
3443
+ blockReason: 'SHOW' | 'HIDE';
3444
+ unblockLink: 'SHOW' | 'HIDE';
3445
+ };
3446
+ };
3447
+ export type GetCustomStopPageConfigurationResponse = GetCustomStopPageConfigurationResponses[keyof GetCustomStopPageConfigurationResponses];
3448
+ export type UpdateCustomStopPageConfigurationData = {
3449
+ body: {
3450
+ title?: {
3451
+ display: 'CUSTOM';
3452
+ value: string;
3453
+ } | {
3454
+ display: 'HIDE';
3455
+ } | {
3456
+ display: 'CUSTOMER';
3457
+ } | {
3458
+ display: 'POLICY';
3459
+ } | {
3460
+ display: 'CUSTOMER_AND_POLICY';
3461
+ };
3462
+ image?: {
3463
+ display: 'CUSTOM';
3464
+ value: string;
3465
+ } | {
3466
+ display: 'DEFAULT';
3467
+ } | {
3468
+ display: 'HIDE';
3469
+ };
3470
+ message?: {
3471
+ display: 'CUSTOM';
3472
+ value: string;
3473
+ } | {
3474
+ display: 'HIDE';
3475
+ };
3476
+ description?: {
3477
+ display: 'CUSTOM';
3478
+ value: string;
3479
+ } | {
3480
+ display: 'HIDE';
3481
+ };
3482
+ blockedDomain?: 'SHOW' | 'HIDE';
3483
+ blockReason?: 'SHOW' | 'HIDE';
3484
+ unblockLink?: 'SHOW' | 'HIDE';
3485
+ };
3486
+ path: {
3487
+ stopPageId: string;
3488
+ };
3489
+ query?: never;
3490
+ url: '/v1/stop-pages/custom/{stopPageId}/configuration';
3491
+ };
3492
+ export type UpdateCustomStopPageConfigurationErrors = {
3493
+ /**
3494
+ * Missing or invalid API key or bearer credentials; missing credentials return a message, invalid credentials return a standard error
3495
+ */
3496
+ 401: MissingCredentialsErrorBody | FlashStartErrorBody;
3497
+ /**
3498
+ * Insufficient permission
3499
+ */
3500
+ 403: FlashStartErrorBody;
3501
+ /**
3502
+ * Resource not found
3503
+ */
3504
+ 404: FlashStartErrorBody;
3505
+ /**
3506
+ * Request validation failed
3507
+ */
3508
+ 422: FlashStartErrorBody;
3509
+ /**
3510
+ * Internal server error
3511
+ */
3512
+ 500: FlashStartErrorBody;
3513
+ };
3514
+ export type UpdateCustomStopPageConfigurationError = UpdateCustomStopPageConfigurationErrors[keyof UpdateCustomStopPageConfigurationErrors];
3515
+ export type UpdateCustomStopPageConfigurationResponses = {
3516
+ /**
3517
+ * Custom stop page configuration
3518
+ */
3519
+ 200: {
3520
+ title: {
3521
+ display: 'CUSTOM';
3522
+ value: string;
3523
+ } | {
3524
+ display: 'HIDE';
3525
+ } | {
3526
+ display: 'CUSTOMER';
3527
+ } | {
3528
+ display: 'POLICY';
3529
+ } | {
3530
+ display: 'CUSTOMER_AND_POLICY';
3531
+ };
3532
+ image: {
3533
+ display: 'CUSTOM';
3534
+ value: string;
3535
+ } | {
3536
+ display: 'DEFAULT';
3537
+ } | {
3538
+ display: 'HIDE';
3539
+ };
3540
+ message: {
3541
+ display: 'CUSTOM';
3542
+ value: string;
3543
+ } | {
3544
+ display: 'HIDE';
3545
+ };
3546
+ description: {
3547
+ display: 'CUSTOM';
3548
+ value: string;
3549
+ } | {
3550
+ display: 'HIDE';
3551
+ };
3552
+ blockedDomain: 'SHOW' | 'HIDE';
3553
+ blockReason: 'SHOW' | 'HIDE';
3554
+ unblockLink: 'SHOW' | 'HIDE';
3555
+ };
3556
+ };
3557
+ export type UpdateCustomStopPageConfigurationResponse = UpdateCustomStopPageConfigurationResponses[keyof UpdateCustomStopPageConfigurationResponses];
3558
+ export type CreateExternalStopPageData = {
3559
+ body: {
3560
+ name: string;
3561
+ externalUrl: string;
3562
+ isShared?: boolean;
3563
+ makeDefault?: boolean;
3564
+ };
3565
+ path?: never;
3566
+ query?: {
3567
+ organizationId?: string;
3568
+ };
3569
+ url: '/v1/stop-pages/external';
3570
+ };
3571
+ export type CreateExternalStopPageErrors = {
3572
+ /**
3573
+ * Missing or invalid API key or bearer credentials; missing credentials return a message, invalid credentials return a standard error
3574
+ */
3575
+ 401: MissingCredentialsErrorBody | FlashStartErrorBody;
3576
+ /**
3577
+ * Insufficient permission
3578
+ */
3579
+ 403: FlashStartErrorBody;
3580
+ /**
3581
+ * Resource not found
3582
+ */
3583
+ 404: FlashStartErrorBody;
3584
+ /**
3585
+ * Request validation failed
3586
+ */
3587
+ 422: FlashStartErrorBody;
3588
+ /**
3589
+ * Internal server error
3590
+ */
3591
+ 500: FlashStartErrorBody;
3592
+ };
3593
+ export type CreateExternalStopPageError = CreateExternalStopPageErrors[keyof CreateExternalStopPageErrors];
3594
+ export type CreateExternalStopPageResponses = {
3595
+ /**
3596
+ * Stop page
3597
+ */
3598
+ 201: {
3599
+ id: string;
3600
+ organizationId: string;
3601
+ name: string;
3602
+ organizationName: string | null;
3603
+ type: 'CUSTOM' | 'EXTERNAL';
3604
+ isShared: boolean;
3605
+ /**
3606
+ * True when this page is the local default of its owner organization, even when the viewer is a descendant. It is not the viewer's effective default.
3607
+ */
3608
+ isDefault: boolean;
3609
+ canManage: boolean;
3610
+ deletionBlockers: Array<'DEFAULT' | 'ASSIGNED'>;
3611
+ policyCount: number;
3612
+ };
3613
+ };
3614
+ export type CreateExternalStopPageResponse = CreateExternalStopPageResponses[keyof CreateExternalStopPageResponses];
3615
+ export type GetExternalStopPageConfigurationData = {
3616
+ body?: never;
3617
+ path: {
3618
+ stopPageId: string;
3619
+ };
3620
+ query?: never;
3621
+ url: '/v1/stop-pages/external/{stopPageId}/configuration';
3622
+ };
3623
+ export type GetExternalStopPageConfigurationErrors = {
3624
+ /**
3625
+ * Missing or invalid API key or bearer credentials; missing credentials return a message, invalid credentials return a standard error
3626
+ */
3627
+ 401: MissingCredentialsErrorBody | FlashStartErrorBody;
3628
+ /**
3629
+ * Insufficient permission
3630
+ */
3631
+ 403: FlashStartErrorBody;
3632
+ /**
3633
+ * Resource not found
3634
+ */
3635
+ 404: FlashStartErrorBody;
3636
+ /**
3637
+ * Internal server error
3638
+ */
3639
+ 500: FlashStartErrorBody;
3640
+ };
3641
+ export type GetExternalStopPageConfigurationError = GetExternalStopPageConfigurationErrors[keyof GetExternalStopPageConfigurationErrors];
3642
+ export type GetExternalStopPageConfigurationResponses = {
3643
+ /**
3644
+ * External stop page configuration
3645
+ */
3646
+ 200: {
3647
+ externalUrl: string;
3648
+ };
3649
+ };
3650
+ export type GetExternalStopPageConfigurationResponse = GetExternalStopPageConfigurationResponses[keyof GetExternalStopPageConfigurationResponses];
3651
+ export type UpdateExternalStopPageConfigurationData = {
3652
+ body: {
3653
+ externalUrl?: string;
3654
+ };
3655
+ path: {
3656
+ stopPageId: string;
3657
+ };
3658
+ query?: never;
3659
+ url: '/v1/stop-pages/external/{stopPageId}/configuration';
3660
+ };
3661
+ export type UpdateExternalStopPageConfigurationErrors = {
3662
+ /**
3663
+ * Missing or invalid API key or bearer credentials; missing credentials return a message, invalid credentials return a standard error
3664
+ */
3665
+ 401: MissingCredentialsErrorBody | FlashStartErrorBody;
3666
+ /**
3667
+ * Insufficient permission
3668
+ */
3669
+ 403: FlashStartErrorBody;
3670
+ /**
3671
+ * Resource not found
3672
+ */
3673
+ 404: FlashStartErrorBody;
3674
+ /**
3675
+ * Request validation failed
3676
+ */
3677
+ 422: FlashStartErrorBody;
3678
+ /**
3679
+ * Internal server error
3680
+ */
3681
+ 500: FlashStartErrorBody;
3682
+ };
3683
+ export type UpdateExternalStopPageConfigurationError = UpdateExternalStopPageConfigurationErrors[keyof UpdateExternalStopPageConfigurationErrors];
3684
+ export type UpdateExternalStopPageConfigurationResponses = {
3685
+ /**
3686
+ * External stop page configuration
3687
+ */
3688
+ 200: {
3689
+ externalUrl: string;
3690
+ };
3691
+ };
3692
+ export type UpdateExternalStopPageConfigurationResponse = UpdateExternalStopPageConfigurationResponses[keyof UpdateExternalStopPageConfigurationResponses];