@musallam/ffs-photoshop-client 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,3792 @@
1
+ import { n as Options$2, t as ky } from "./index-B2PznWi7.cjs";
2
+
3
+ //#region packages/photoshop/src/flat/core/auth.gen.d.ts
4
+ type AuthToken = string | undefined;
5
+ interface Auth {
6
+ /**
7
+ * Which part of the request do we use to send the auth?
8
+ *
9
+ * @default 'header'
10
+ */
11
+ in?: 'header' | 'query' | 'cookie';
12
+ /**
13
+ * Header or query parameter name.
14
+ *
15
+ * @default 'Authorization'
16
+ */
17
+ name?: string;
18
+ scheme?: 'basic' | 'bearer';
19
+ type: 'apiKey' | 'http';
20
+ }
21
+ //#endregion
22
+ //#region packages/photoshop/src/flat/core/pathSerializer.gen.d.ts
23
+ interface SerializerOptions<T> {
24
+ /**
25
+ * @default true
26
+ */
27
+ explode: boolean;
28
+ style: T;
29
+ }
30
+ type ArrayStyle = 'form' | 'spaceDelimited' | 'pipeDelimited';
31
+ type ObjectStyle = 'form' | 'deepObject';
32
+ //#endregion
33
+ //#region packages/photoshop/src/flat/core/bodySerializer.gen.d.ts
34
+ type QuerySerializer = (query: Record<string, unknown>) => string;
35
+ type BodySerializer = (body: unknown) => unknown;
36
+ type QuerySerializerOptionsObject = {
37
+ allowReserved?: boolean;
38
+ array?: Partial<SerializerOptions<ArrayStyle>>;
39
+ object?: Partial<SerializerOptions<ObjectStyle>>;
40
+ };
41
+ type QuerySerializerOptions = QuerySerializerOptionsObject & {
42
+ /**
43
+ * Per-parameter serialization overrides. When provided, these settings
44
+ * override the global array/object settings for specific parameter names.
45
+ */
46
+ parameters?: Record<string, QuerySerializerOptionsObject>;
47
+ };
48
+ //#endregion
49
+ //#region packages/photoshop/src/flat/core/types.gen.d.ts
50
+ type HttpMethod = 'connect' | 'delete' | 'get' | 'head' | 'options' | 'patch' | 'post' | 'put' | 'trace';
51
+ type Client$1<RequestFn = never, Config = unknown, MethodFn = never, BuildUrlFn = never, SseFn = never> = {
52
+ /**
53
+ * Returns the final request URL.
54
+ */
55
+ buildUrl: BuildUrlFn;
56
+ getConfig: () => Config;
57
+ request: RequestFn;
58
+ setConfig: (config: Config) => Config;
59
+ } & { [K in HttpMethod]: MethodFn } & ([SseFn] extends [never] ? {
60
+ sse?: never;
61
+ } : {
62
+ sse: { [K in HttpMethod]: SseFn };
63
+ });
64
+ interface Config$1 {
65
+ /**
66
+ * Auth token or a function returning auth token. The resolved value will be
67
+ * added to the request payload as defined by its `security` array.
68
+ */
69
+ auth?: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken;
70
+ /**
71
+ * A function for serializing request body parameter. By default,
72
+ * {@link JSON.stringify()} will be used.
73
+ */
74
+ bodySerializer?: BodySerializer | null;
75
+ /**
76
+ * An object containing any HTTP headers that you want to pre-populate your
77
+ * `Headers` object with.
78
+ *
79
+ * {@link https://developer.mozilla.org/docs/Web/API/Headers/Headers#init See more}
80
+ */
81
+ headers?: RequestInit['headers'] | Record<string, string | number | boolean | (string | number | boolean)[] | null | undefined | unknown>;
82
+ /**
83
+ * The request method.
84
+ *
85
+ * {@link https://developer.mozilla.org/docs/Web/API/fetch#method See more}
86
+ */
87
+ method?: Uppercase<HttpMethod>;
88
+ /**
89
+ * A function for serializing request query parameters. By default, arrays
90
+ * will be exploded in form style, objects will be exploded in deepObject
91
+ * style, and reserved characters are percent-encoded.
92
+ *
93
+ * This method will have no effect if the native `paramsSerializer()` Axios
94
+ * API function is used.
95
+ *
96
+ * {@link https://swagger.io/docs/specification/serialization/#query View examples}
97
+ */
98
+ querySerializer?: QuerySerializer | QuerySerializerOptions;
99
+ /**
100
+ * A function validating request data. This is useful if you want to ensure
101
+ * the request conforms to the desired shape, so it can be safely sent to
102
+ * the server.
103
+ */
104
+ requestValidator?: (data: unknown) => Promise<unknown>;
105
+ /**
106
+ * A function transforming response data before it's returned. This is useful
107
+ * for post-processing data, e.g. converting ISO strings into Date objects.
108
+ */
109
+ responseTransformer?: (data: unknown) => Promise<unknown>;
110
+ /**
111
+ * A function validating response data. This is useful if you want to ensure
112
+ * the response conforms to the desired shape, so it can be safely passed to
113
+ * the transformers and returned to the user.
114
+ */
115
+ responseValidator?: (data: unknown) => Promise<unknown>;
116
+ }
117
+ //#endregion
118
+ //#region packages/photoshop/src/flat/core/serverSentEvents.gen.d.ts
119
+ type ServerSentEventsOptions<TData = unknown> = Omit<RequestInit, 'method'> & Pick<Config$1, 'method' | 'responseTransformer' | 'responseValidator'> & {
120
+ /**
121
+ * Fetch API implementation. You can use this option to provide a custom
122
+ * fetch instance.
123
+ *
124
+ * @default globalThis.fetch
125
+ */
126
+ fetch?: typeof fetch;
127
+ /**
128
+ * Implementing clients can call request interceptors inside this hook.
129
+ */
130
+ onRequest?: (url: string, init: RequestInit) => Promise<Request>;
131
+ /**
132
+ * Callback invoked when a network or parsing error occurs during streaming.
133
+ *
134
+ * This option applies only if the endpoint returns a stream of events.
135
+ *
136
+ * @param error The error that occurred.
137
+ */
138
+ onSseError?: (error: unknown) => void;
139
+ /**
140
+ * Callback invoked when an event is streamed from the server.
141
+ *
142
+ * This option applies only if the endpoint returns a stream of events.
143
+ *
144
+ * @param event Event streamed from the server.
145
+ * @returns Nothing (void).
146
+ */
147
+ onSseEvent?: (event: StreamEvent<TData>) => void;
148
+ serializedBody?: RequestInit['body'];
149
+ /**
150
+ * Default retry delay in milliseconds.
151
+ *
152
+ * This option applies only if the endpoint returns a stream of events.
153
+ *
154
+ * @default 3000
155
+ */
156
+ sseDefaultRetryDelay?: number;
157
+ /**
158
+ * Maximum number of retry attempts before giving up.
159
+ */
160
+ sseMaxRetryAttempts?: number;
161
+ /**
162
+ * Maximum retry delay in milliseconds.
163
+ *
164
+ * Applies only when exponential backoff is used.
165
+ *
166
+ * This option applies only if the endpoint returns a stream of events.
167
+ *
168
+ * @default 30000
169
+ */
170
+ sseMaxRetryDelay?: number;
171
+ /**
172
+ * Optional sleep function for retry backoff.
173
+ *
174
+ * Defaults to using `setTimeout`.
175
+ */
176
+ sseSleepFn?: (ms: number) => Promise<void>;
177
+ url: string;
178
+ };
179
+ interface StreamEvent<TData = unknown> {
180
+ data: TData;
181
+ event?: string;
182
+ id?: string;
183
+ retry?: number;
184
+ }
185
+ type ServerSentEventsResult<TData = unknown, TReturn = void, TNext = unknown> = {
186
+ stream: AsyncGenerator<TData extends Record<string, unknown> ? TData[keyof TData] : TData, TReturn, TNext>;
187
+ };
188
+ //#endregion
189
+ //#region packages/photoshop/src/flat/client/utils.gen.d.ts
190
+ type ErrInterceptor<Err, Res, Req, Options> = (error: Err, response: Res, request: Req, options: Options) => Err | Promise<Err>;
191
+ type ReqInterceptor<Req, Options> = (request: Req, options: Options) => Req | Promise<Req>;
192
+ type ResInterceptor<Res, Req, Options> = (response: Res, request: Req, options: Options) => Res | Promise<Res>;
193
+ declare class Interceptors<Interceptor> {
194
+ fns: Array<Interceptor | null>;
195
+ clear(): void;
196
+ eject(id: number | Interceptor): void;
197
+ exists(id: number | Interceptor): boolean;
198
+ getInterceptorIndex(id: number | Interceptor): number;
199
+ update(id: number | Interceptor, fn: Interceptor): number | Interceptor | false;
200
+ use(fn: Interceptor): number;
201
+ }
202
+ interface Middleware<Req, Res, Err, Options> {
203
+ error: Interceptors<ErrInterceptor<Err, Res, Req, Options>>;
204
+ request: Interceptors<ReqInterceptor<Req, Options>>;
205
+ response: Interceptors<ResInterceptor<Res, Req, Options>>;
206
+ }
207
+ //#endregion
208
+ //#region packages/photoshop/src/flat/client/types.gen.d.ts
209
+ type ResponseStyle = 'data' | 'fields';
210
+ interface RetryOptions {
211
+ /**
212
+ * Maximum number of retry attempts
213
+ *
214
+ * @default 2
215
+ */
216
+ limit?: number;
217
+ /**
218
+ * HTTP methods to retry
219
+ *
220
+ * @default ['get', 'put', 'head', 'delete', 'options', 'trace']
221
+ */
222
+ methods?: Array<'get' | 'post' | 'put' | 'delete' | 'patch' | 'head' | 'options' | 'trace'>;
223
+ /**
224
+ * HTTP status codes to retry
225
+ *
226
+ * @default [408, 413, 429, 500, 502, 503, 504]
227
+ */
228
+ statusCodes?: number[];
229
+ }
230
+ interface Config<T extends ClientOptions$1 = ClientOptions$1> extends Omit<Options$2, 'body' | 'headers' | 'method' | 'prefixUrl' | 'retry' | 'throwHttpErrors'>, Config$1 {
231
+ /**
232
+ * Base URL for all requests made by this client.
233
+ */
234
+ baseUrl?: T['baseUrl'];
235
+ /**
236
+ * Ky instance to use. You can use this option to provide a custom
237
+ * ky instance.
238
+ */
239
+ ky?: typeof ky;
240
+ /**
241
+ * Additional ky-specific options that will be passed directly to ky.
242
+ * This allows you to use any ky option not explicitly exposed in the config.
243
+ */
244
+ kyOptions?: Omit<Options$2, 'method' | 'prefixUrl'>;
245
+ /**
246
+ * Return the response data parsed in a specified format. By default, `auto`
247
+ * will infer the appropriate method from the `Content-Type` response header.
248
+ * You can override this behavior with any of the {@link Body} methods.
249
+ * Select `stream` if you don't want to parse response data at all.
250
+ *
251
+ * @default 'auto'
252
+ */
253
+ parseAs?: 'arrayBuffer' | 'auto' | 'blob' | 'formData' | 'json' | 'stream' | 'text';
254
+ /**
255
+ * Should we return only data or multiple fields (data, error, response, etc.)?
256
+ *
257
+ * @default 'fields'
258
+ */
259
+ responseStyle?: ResponseStyle;
260
+ /**
261
+ * Retry configuration
262
+ */
263
+ retry?: RetryOptions;
264
+ /**
265
+ * Throw an error instead of returning it in the response?
266
+ *
267
+ * @default false
268
+ */
269
+ throwOnError?: T['throwOnError'];
270
+ /**
271
+ * Request timeout in milliseconds
272
+ *
273
+ * @default 10000
274
+ */
275
+ timeout?: number;
276
+ }
277
+ interface RequestOptions<TData = unknown, TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends Config<{
278
+ responseStyle: TResponseStyle;
279
+ throwOnError: ThrowOnError;
280
+ }>, Pick<ServerSentEventsOptions<TData>, 'onRequest' | 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> {
281
+ /**
282
+ * Any body that you want to add to your request.
283
+ *
284
+ * {@link https://developer.mozilla.org/docs/Web/API/fetch#body}
285
+ */
286
+ body?: unknown;
287
+ path?: Record<string, unknown>;
288
+ query?: Record<string, unknown>;
289
+ /**
290
+ * Security mechanism(s) to use for the request.
291
+ */
292
+ security?: ReadonlyArray<Auth>;
293
+ url: Url;
294
+ }
295
+ interface ResolvedRequestOptions<TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends RequestOptions<unknown, TResponseStyle, ThrowOnError, Url> {
296
+ serializedBody?: string;
297
+ }
298
+ type RequestResult<TData = unknown, TError = unknown, ThrowOnError extends boolean = boolean, TResponseStyle extends ResponseStyle = 'fields'> = ThrowOnError extends true ? Promise<TResponseStyle extends 'data' ? TData extends Record<string, unknown> ? TData[keyof TData] : TData : {
299
+ data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
300
+ request: Request;
301
+ response: Response;
302
+ }> : Promise<TResponseStyle extends 'data' ? (TData extends Record<string, unknown> ? TData[keyof TData] : TData) | undefined : ({
303
+ data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
304
+ error: undefined;
305
+ } | {
306
+ data: undefined;
307
+ error: TError extends Record<string, unknown> ? TError[keyof TError] : TError;
308
+ }) & {
309
+ request: Request;
310
+ response: Response;
311
+ }>;
312
+ interface ClientOptions$1 {
313
+ baseUrl?: string;
314
+ responseStyle?: ResponseStyle;
315
+ throwOnError?: boolean;
316
+ }
317
+ type MethodFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
318
+ type SseFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData, TError>>;
319
+ type RequestFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'> & Pick<Required<RequestOptions<TData, TResponseStyle, ThrowOnError>>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
320
+ type BuildUrlFn = <TData extends {
321
+ body?: unknown;
322
+ path?: Record<string, unknown>;
323
+ query?: Record<string, unknown>;
324
+ url: string;
325
+ }>(options: TData & Options$1<TData>) => string;
326
+ type Client = Client$1<RequestFn, Config, MethodFn, BuildUrlFn, SseFn> & {
327
+ interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>;
328
+ };
329
+ interface TDataShape {
330
+ body?: unknown;
331
+ headers?: unknown;
332
+ path?: unknown;
333
+ query?: unknown;
334
+ url: string;
335
+ }
336
+ type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
337
+ type Options$1<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown, TResponseStyle extends ResponseStyle = 'fields'> = OmitKeys<RequestOptions<TResponse, TResponseStyle, ThrowOnError>, 'body' | 'path' | 'query' | 'url'> & ([TData] extends [never] ? unknown : Omit<TData, 'url'>);
338
+ //#endregion
339
+ //#region packages/photoshop/src/flat/types.gen.d.ts
340
+ type ClientOptions = {
341
+ baseUrl: 'https://image.adobe.io' | (string & {});
342
+ };
343
+ /**
344
+ * JobError
345
+ *
346
+ * Any errors reported in the requested output.
347
+ */
348
+ type JobError = {
349
+ /**
350
+ * The error type.
351
+ */
352
+ type?: string;
353
+ /**
354
+ * The error code.
355
+ */
356
+ code?: string;
357
+ /**
358
+ * The error description.
359
+ */
360
+ title?: string;
361
+ /**
362
+ * The internal error code.
363
+ */
364
+ error_code?: string;
365
+ /**
366
+ * The details of the error returned.
367
+ */
368
+ details?: Array<ErrorDetails>;
369
+ };
370
+ /**
371
+ * InputValidationError
372
+ *
373
+ * Any errors reported in the requested output.
374
+ */
375
+ type InputValidationError = {
376
+ /**
377
+ * The error type.
378
+ */
379
+ type?: string;
380
+ /**
381
+ * The error code.
382
+ */
383
+ code?: string;
384
+ /**
385
+ * The error description.
386
+ */
387
+ title?: string;
388
+ /**
389
+ * The details of the error returned.
390
+ */
391
+ details?: Array<InputValidationErrorDetail>;
392
+ };
393
+ /**
394
+ * TrialLimitExceededError
395
+ *
396
+ * Any errors reported in the requested output.
397
+ */
398
+ type TrialLimitExceededError = {
399
+ /**
400
+ * The error type.
401
+ */
402
+ type?: string;
403
+ /**
404
+ * The error code.
405
+ */
406
+ code?: string;
407
+ /**
408
+ * The error description.
409
+ */
410
+ title?: string;
411
+ /**
412
+ * The details of the error returned.
413
+ */
414
+ details?: string;
415
+ };
416
+ /**
417
+ * InputValidationErrorDetail
418
+ *
419
+ * Details of the input validation error returned.
420
+ */
421
+ type InputValidationErrorDetail = {
422
+ /**
423
+ * The name of the input parameter.
424
+ */
425
+ allowedValues?: string;
426
+ /**
427
+ * The reason for the error.
428
+ */
429
+ reason?: string;
430
+ };
431
+ /**
432
+ * StorageDetails
433
+ *
434
+ * A file located on Adobe's cloud or a supported external service.
435
+ */
436
+ type StorageDetails = {
437
+ /**
438
+ * A pre-signed GET URL.
439
+ */
440
+ href: string;
441
+ storage: StorageType;
442
+ };
443
+ /**
444
+ * SenseiColor
445
+ *
446
+ * Color space for output image
447
+ */
448
+ type SenseiColor = {
449
+ space?: ColorSpaceType;
450
+ };
451
+ /**
452
+ * ColorSpaceType
453
+ *
454
+ * Color space for output image
455
+ */
456
+ type ColorSpaceType = 'rgb' | 'rgba';
457
+ /**
458
+ * SenseiOutputDetails
459
+ *
460
+ * A PNG file.
461
+ */
462
+ type SenseiOutputDetails = {
463
+ /**
464
+ * A pre-signed POST URL to the output file.
465
+ */
466
+ href: string;
467
+ storage: StorageType;
468
+ mask?: MaskFormat;
469
+ color?: SenseiColor;
470
+ /**
471
+ * If the file already exists, indicates if the output file should be overwritten. Will eventually support eTags. Only applies to CC Storage.
472
+ */
473
+ overwrite?: boolean;
474
+ };
475
+ /**
476
+ * SenseiJobApiResponse
477
+ */
478
+ type SenseiJobApiResponse = {
479
+ /**
480
+ * The job ID requested.
481
+ */
482
+ jobId?: string;
483
+ /**
484
+ * Created timestamp of the job (YYYY-DD-MMThh:mm:ss.mmmmmZ).
485
+ */
486
+ created?: string;
487
+ /**
488
+ * Modified timestamp of the job (YYYY-DD-MMThh:mm:ss.mmmmmZ).
489
+ */
490
+ modified?: string;
491
+ status?: JobStatus;
492
+ output?: SenseiOutputDetails;
493
+ errors?: JobError;
494
+ _links?: JobStatusLink;
495
+ };
496
+ /**
497
+ * JobStatusLink
498
+ */
499
+ type JobStatusLink = {
500
+ self?: SelfLink;
501
+ };
502
+ /**
503
+ * RemoveBackgroundRequest
504
+ */
505
+ type RemoveBackgroundRequest = {
506
+ input: StorageDetails;
507
+ output: SenseiOutputDetails;
508
+ };
509
+ /**
510
+ * CreateMaskRequest
511
+ */
512
+ type CreateMaskRequest = {
513
+ input: StorageDetails;
514
+ output: SenseiOutputDetails;
515
+ };
516
+ /**
517
+ * JobStatusLinkResponse
518
+ */
519
+ type JobStatusLinkResponse = {
520
+ _links?: JobStatusLink;
521
+ };
522
+ /**
523
+ * IccProfileDetails
524
+ */
525
+ type IccProfileDetails = {
526
+ imageMode?: ImageModeType;
527
+ input?: StorageDetails;
528
+ profileName?: ColorProfileType;
529
+ };
530
+ /**
531
+ * SmartObjectOutputDetails
532
+ *
533
+ * An output object.
534
+ */
535
+ type SmartObjectOutputDetails = {
536
+ /**
537
+ * A pre-signed POST URL to the output file.
538
+ */
539
+ href: string;
540
+ storage: StorageType;
541
+ type: ImageFormatType;
542
+ /**
543
+ * If the file already exists, indicates if the output file should be overwritten. Will eventually support eTags. Only applies to CC Storage.
544
+ */
545
+ overwrite?: boolean;
546
+ /**
547
+ * The width, in pixels, of the renditions. A width of 0 generates a full size rendition. Height is generated automatically using the aspect ratio. Only supported for image rendition.
548
+ */
549
+ width?: number;
550
+ /**
551
+ * The quality of the renditions for JPEG. The range is 1 to 7, 7 being the highest quality.
552
+ */
553
+ quality?: number;
554
+ compression?: CompressionType;
555
+ };
556
+ /**
557
+ * ActionOutputDetails
558
+ *
559
+ * An output object.
560
+ */
561
+ type ActionOutputDetails = {
562
+ /**
563
+ * A pre-signed POST URL to the output file.
564
+ */
565
+ href: string;
566
+ storage: StorageType;
567
+ type: ImageFormatType;
568
+ /**
569
+ * If the file already exists, indicates if the output file should be overwritten. Will eventually support eTags. Only applies to CC Storage.
570
+ */
571
+ overwrite?: boolean;
572
+ /**
573
+ * The quality of the renditions for JPEG. The range is 1 to 7, 7 being the highest quality.
574
+ */
575
+ quality?: number;
576
+ compression?: CompressionType;
577
+ };
578
+ /**
579
+ * PsOutputDetails
580
+ *
581
+ * An output object.
582
+ */
583
+ type PsOutputDetails = {
584
+ /**
585
+ * A pre-signed POST URL to the output file.
586
+ */
587
+ href: string;
588
+ storage: StorageType;
589
+ type: ImageFormatType;
590
+ /**
591
+ * If the file already exists, indicates if the output file should be overwritten. Will eventually support eTags. Only applies to CC Storage.
592
+ */
593
+ overwrite?: boolean;
594
+ /**
595
+ * The width, in pixels, of the renditions. A width of 0 generates a full size rendition. Height is generated automatically using the aspect ratio. Only supported for image rendition.
596
+ */
597
+ width?: number;
598
+ /**
599
+ * The size, in pixels, of the renditions. When width is 0, maxWidth can be provided to get the rendition size. maxWidth when less than document width gets precedence over width. Height is not necessary as the rendition generate will automatically maintain the aspect ratio.
600
+ */
601
+ maxWidth?: number;
602
+ /**
603
+ * The quality of the renditions for JPEG. The range is 1 to 7, 7 being the highest quality.
604
+ */
605
+ quality?: number;
606
+ compression?: CompressionType;
607
+ trimToCanvas?: TrimToCanvasType;
608
+ /**
609
+ * An array of layer objects.
610
+ * By including this array you are signaling that you'd like a rendition created from these layer id's or layer names. Excluding it will generate a document-level rendition.
611
+ */
612
+ layers?: Array<LayerReference>;
613
+ iccProfile?: IccProfileDetails;
614
+ };
615
+ /**
616
+ * RenditionLinkDetails
617
+ *
618
+ * A rendition object.
619
+ */
620
+ type RenditionLinkDetails = {
621
+ /**
622
+ * The rendition location.
623
+ */
624
+ href?: string;
625
+ storage?: StorageType;
626
+ /**
627
+ * The requested rendition width in pixels.
628
+ */
629
+ width?: number;
630
+ type?: ImageFormatType;
631
+ };
632
+ /**
633
+ * ManifestJobApiResponse
634
+ */
635
+ type ManifestJobApiResponse = {
636
+ /**
637
+ * The job ID requested.
638
+ */
639
+ jobId?: string;
640
+ /**
641
+ * The outputs requested.
642
+ */
643
+ outputs?: Array<ManifestJobStatusOutputDetails>;
644
+ _links?: JobStatusLink;
645
+ };
646
+ /**
647
+ * PsJobApiResponse
648
+ */
649
+ type PsJobApiResponse = {
650
+ /**
651
+ * The job ID requested.
652
+ */
653
+ jobId?: string;
654
+ /**
655
+ * API output details.
656
+ */
657
+ outputs?: Array<JobOutputDetails>;
658
+ _links?: JobStatusLink;
659
+ };
660
+ /**
661
+ * Photoshop Job response.
662
+ */
663
+ type PsJobResponse = ManifestJobApiResponse | PsJobApiResponse;
664
+ /**
665
+ * DocumentManifestRequest
666
+ */
667
+ type DocumentManifestRequest = {
668
+ /**
669
+ * An array of input objects. Each input object represents a file to be processed.
670
+ */
671
+ inputs: Array<StorageDetails>;
672
+ options?: DocumentManifestOptions & unknown;
673
+ };
674
+ /**
675
+ * LayerPosition
676
+ */
677
+ type LayerPosition = {
678
+ insertAbove?: LayerReference;
679
+ insertBelow?: LayerReference;
680
+ insertInto?: LayerReference;
681
+ insertTop?: boolean;
682
+ insertBottom?: boolean;
683
+ };
684
+ /**
685
+ * DeleteDetails
686
+ *
687
+ * Indicates you want to delete the layer, identified by the `id` or `name`. Note the object is currently empty but leaves room for further enhancements.
688
+ */
689
+ type DeleteDetails = {
690
+ /**
691
+ * Indicates that child layers are included when deleting a group layer.
692
+ */
693
+ includeChildren?: boolean;
694
+ /**
695
+ * The layer ID.
696
+ */
697
+ id?: number;
698
+ /**
699
+ * The layer name. You can identify a layer by id or name. That makes either id or name a required field.
700
+ */
701
+ name?: string;
702
+ };
703
+ /**
704
+ * LayerReference
705
+ *
706
+ * A layer reference object.
707
+ */
708
+ type LayerReference = {
709
+ /**
710
+ * The id of the layer. Use either `id` OR `name`.
711
+ */
712
+ id?: number;
713
+ /**
714
+ * The name of the layer. Use either `id` OR `name`.
715
+ */
716
+ name?: string;
717
+ };
718
+ /**
719
+ * CreateDocumentRequest
720
+ */
721
+ type CreateDocumentRequest = {
722
+ /**
723
+ * An array of output objects. Each output object represents a file to be created.
724
+ */
725
+ outputs: Array<PsOutputDetails>;
726
+ options: DocumentCreateOptions;
727
+ };
728
+ /**
729
+ * ModifyDocumentRequest
730
+ */
731
+ type ModifyDocumentRequest = {
732
+ /**
733
+ * An array of input objects. Each input object represents a file to be processed.
734
+ */
735
+ inputs: Array<StorageDetails>;
736
+ /**
737
+ * An array of output objects. Each output object represents a file to be created.
738
+ */
739
+ outputs: Array<PsOutputDetails>;
740
+ options: DocumentOperationOptions;
741
+ };
742
+ /**
743
+ * CreateRenditionRequest
744
+ */
745
+ type CreateRenditionRequest = {
746
+ /**
747
+ * An array of input objects. Only one input object is currently supported.
748
+ */
749
+ inputs: Array<StorageDetails>;
750
+ /**
751
+ * An array of output objects.
752
+ */
753
+ outputs: Array<PsOutputDetails>;
754
+ };
755
+ /**
756
+ * ReplaceSmartObjectRequest
757
+ */
758
+ type ReplaceSmartObjectRequest = {
759
+ /**
760
+ * An array of input objects. Only one input object is currently supported.
761
+ */
762
+ inputs: Array<StorageDetails>;
763
+ /**
764
+ * An array of output objects.
765
+ */
766
+ outputs: Array<SmartObjectOutputDetails>;
767
+ options: SmartObjectOptions;
768
+ };
769
+ /**
770
+ * PlayPhotoshopActionsRequest
771
+ */
772
+ type PlayPhotoshopActionsRequest = {
773
+ /**
774
+ * An array of input objects. Only one input object is currently supported.
775
+ */
776
+ inputs: Array<StorageDetails>;
777
+ /**
778
+ * An array of output objects.
779
+ */
780
+ outputs: Array<ActionOutputDetails>;
781
+ options: ActionOptions;
782
+ };
783
+ /**
784
+ * PlayPhotoshopActionsJsonRequest
785
+ */
786
+ type PlayPhotoshopActionsJsonRequest = {
787
+ /**
788
+ * An array of input objects. Only one input object is currently supported.
789
+ */
790
+ inputs: Array<StorageDetails>;
791
+ /**
792
+ * An array of output objects.
793
+ */
794
+ outputs: Array<ActionOutputDetails>;
795
+ options: ActionJsonOptions;
796
+ };
797
+ /**
798
+ * ConvertToActionsJsonRequest
799
+ */
800
+ type ConvertToActionsJsonRequest = {
801
+ /**
802
+ * An array of input action sets in ATN format. Only one input object is currently supported.
803
+ */
804
+ inputs: Array<StorageDetails>;
805
+ options?: ActionJsonCreateOptions;
806
+ };
807
+ /**
808
+ * ApplyAutoCropRequest
809
+ */
810
+ type ApplyAutoCropRequest = {
811
+ /**
812
+ * An array of input objects. Only one input object is currently supported.
813
+ */
814
+ inputs: Array<StorageDetails>;
815
+ /**
816
+ * An array of output objects
817
+ */
818
+ outputs: Array<ActionOutputDetails>;
819
+ options: CropOptions;
820
+ };
821
+ /**
822
+ * ApplyDepthBlurRequest
823
+ */
824
+ type ApplyDepthBlurRequest = {
825
+ /**
826
+ * An array of input objects. We currently only support one input object
827
+ */
828
+ inputs: Array<StorageDetails>;
829
+ /**
830
+ * An array of output objects
831
+ */
832
+ outputs: Array<ActionOutputDetails>;
833
+ options?: DepthBlurDetails;
834
+ };
835
+ /**
836
+ * EditTextLayerRequest
837
+ */
838
+ type EditTextLayerRequest = {
839
+ /**
840
+ * An array of input objects. We currently only support one input object
841
+ */
842
+ inputs: Array<StorageDetails>;
843
+ /**
844
+ * An array of output objects
845
+ */
846
+ outputs: Array<ActionOutputDetails>;
847
+ options: TextOptions;
848
+ };
849
+ /**
850
+ * CreateArtboardRequest
851
+ */
852
+ type CreateArtboardRequest = {
853
+ options: ArtboardDetails;
854
+ /**
855
+ * An array of output objects
856
+ */
857
+ outputs: Array<PsOutputDetails>;
858
+ };
859
+ /**
860
+ * DocumentDetails
861
+ */
862
+ type DocumentDetails = {
863
+ /**
864
+ * In pixels
865
+ */
866
+ height: number;
867
+ /**
868
+ * In pixels
869
+ */
870
+ width: number;
871
+ /**
872
+ * In pixels per inch
873
+ */
874
+ resolution: number;
875
+ fill: FillType;
876
+ mode: ChannelModeType;
877
+ depth?: DepthType;
878
+ };
879
+ /**
880
+ * ManifestJobDocumentDetails
881
+ */
882
+ type ManifestJobDocumentDetails = {
883
+ /**
884
+ * The name of the document
885
+ */
886
+ name?: string;
887
+ /**
888
+ * In pixels
889
+ */
890
+ height?: number;
891
+ /**
892
+ * In pixels
893
+ */
894
+ width?: number;
895
+ /**
896
+ * The version of Photoshop used to create the document
897
+ */
898
+ photoshopBuild?: string;
899
+ imageMode?: ImageModeType;
900
+ bitDepth?: ChannelModeType;
901
+ /**
902
+ * The name of the ICC profile used for the document
903
+ */
904
+ iccProfileName?: string;
905
+ };
906
+ /**
907
+ * ChildrenLayerDetails
908
+ */
909
+ type ChildrenLayerDetails = {
910
+ /**
911
+ * The layer ID. An ID of -1 is valid and indicates a PSD that only contains a background image and no layers.
912
+ */
913
+ id?: number;
914
+ /**
915
+ * The layer index.
916
+ */
917
+ index?: number;
918
+ /**
919
+ * If thumbnails were requested, a pre-signed GET URL to the thumbnail
920
+ */
921
+ thumbnail?: string;
922
+ type?: LayerType;
923
+ /**
924
+ * The layer name.
925
+ */
926
+ name?: string;
927
+ /**
928
+ * Whether the layer is locked
929
+ */
930
+ locked?: boolean;
931
+ /**
932
+ * Whether the layer is visible
933
+ */
934
+ visible?: boolean;
935
+ adjustments?: AdjustmentDetails;
936
+ bounds?: Bounds;
937
+ blendOptions?: BlendDetails;
938
+ mask?: LayerMaskDetails;
939
+ smartObject?: SmartObjectDetails;
940
+ fill?: FillDetails;
941
+ text?: TextLayerDetails;
942
+ };
943
+ /**
944
+ * LayerDetails
945
+ */
946
+ type LayerDetails = {
947
+ /**
948
+ * The layer ID. An ID of -1 is valid and indicates a PSD that only contains a background image and no layers.
949
+ */
950
+ id?: number;
951
+ /**
952
+ * The layer index.
953
+ */
954
+ index?: number;
955
+ /**
956
+ * If thumbnails were requested, this is a pre-signed GET URL to the thumbnail.
957
+ */
958
+ thumbnail?: string;
959
+ /**
960
+ * An array of nested layer objects. Only layerSections (group layers) can include children.
961
+ */
962
+ children?: Array<ChildrenLayerDetails>;
963
+ type?: LayerType;
964
+ /**
965
+ * The layer name.
966
+ */
967
+ name?: string;
968
+ /**
969
+ * Whether the layer is locked.
970
+ */
971
+ locked?: boolean;
972
+ /**
973
+ * Whether the layer is visible.
974
+ */
975
+ visible?: boolean;
976
+ adjustments?: ManifestJobAdjustmentDetails;
977
+ bounds?: Bounds;
978
+ blendOptions?: BlendDetails;
979
+ mask?: LayerMaskDetails;
980
+ smartObject?: SmartObjectDetails;
981
+ fill?: FillDetails;
982
+ text?: TextLayerDetails;
983
+ };
984
+ /**
985
+ * Action
986
+ *
987
+ * An object describing the input Photoshop Actions to play.
988
+ */
989
+ type Action = {
990
+ storage?: StorageType & unknown;
991
+ /**
992
+ * Presigned GET URL
993
+ */
994
+ href?: string;
995
+ /**
996
+ * If you only want to execute a particular action, you may specify which action to play from the ActionSet
997
+ */
998
+ actionName?: string;
999
+ };
1000
+ /**
1001
+ * ActionDetails
1002
+ *
1003
+ * Details of Actions from the ActionSet.
1004
+ */
1005
+ type ActionDetails = {
1006
+ /**
1007
+ * If you only want to execute a particular action, you may specify whcih action to convert from the ActionSet
1008
+ */
1009
+ actionName?: string;
1010
+ };
1011
+ /**
1012
+ * AdjustmentDetails
1013
+ *
1014
+ * Adjustment layer information.
1015
+ */
1016
+ type AdjustmentDetails = {
1017
+ brightnessContrast?: BrightnessContrast;
1018
+ exposure?: ExposureDetails;
1019
+ hueSaturation?: HueSaturation;
1020
+ colorBalance?: ColorBalance;
1021
+ };
1022
+ /**
1023
+ * ManifestJobAdjustmentDetails
1024
+ *
1025
+ * Adjustment layer information.
1026
+ */
1027
+ type ManifestJobAdjustmentDetails = {
1028
+ brightness_contrast?: BrightnessContrast;
1029
+ exposure?: ExposureDetails;
1030
+ hue_saturation?: HueSaturation;
1031
+ color_balance?: ColorBalance;
1032
+ };
1033
+ /**
1034
+ * BrightnessContrast
1035
+ *
1036
+ * Brightness and contrast settings.
1037
+ */
1038
+ type BrightnessContrast = {
1039
+ /**
1040
+ * The adjustment layer's brightness.
1041
+ */
1042
+ brightness?: number;
1043
+ /**
1044
+ * The adjustment layer's contrast.
1045
+ */
1046
+ contrast?: number;
1047
+ };
1048
+ /**
1049
+ * ExposureDetails
1050
+ *
1051
+ * Exposure settings.
1052
+ */
1053
+ type ExposureDetails = {
1054
+ /**
1055
+ * The layer's exposure.
1056
+ */
1057
+ exposure?: number;
1058
+ /**
1059
+ * The layer's offset.
1060
+ */
1061
+ offset?: number;
1062
+ /**
1063
+ * The layer's gamma correction.
1064
+ */
1065
+ gammaCorrection?: number;
1066
+ };
1067
+ /**
1068
+ * HueSaturation
1069
+ */
1070
+ type HueSaturation = {
1071
+ /**
1072
+ * Whether to colorize.
1073
+ */
1074
+ colorize?: boolean;
1075
+ /**
1076
+ * An array of hashes representing the 'master' channel (the remaining five channels of 'magentas', 'yellows', 'greens', etc. are not yet supported).
1077
+ */
1078
+ channels?: Array<ChannelDetails>;
1079
+ };
1080
+ /**
1081
+ * ColorBalance
1082
+ *
1083
+ * Color balance settings.
1084
+ */
1085
+ type ColorBalance = {
1086
+ /**
1087
+ * Whether to preserve luminosity.
1088
+ */
1089
+ preserveLuminosity?: boolean;
1090
+ /**
1091
+ * Shadow levels.
1092
+ */
1093
+ shadowLevels?: Array<number>;
1094
+ /**
1095
+ * Midtone levels.
1096
+ */
1097
+ midtoneLevels?: Array<number>;
1098
+ /**
1099
+ * Highlight levels.
1100
+ */
1101
+ highlightLevels?: Array<number>;
1102
+ };
1103
+ /**
1104
+ * Bounds
1105
+ *
1106
+ * The bounds of the layer.
1107
+ */
1108
+ type Bounds = {
1109
+ /**
1110
+ * The top position in pixels.
1111
+ */
1112
+ top?: number;
1113
+ /**
1114
+ * The left position in pixels.
1115
+ */
1116
+ left?: number;
1117
+ /**
1118
+ * The width in pixels.
1119
+ */
1120
+ width?: number;
1121
+ /**
1122
+ * The height in pixels.
1123
+ */
1124
+ height?: number;
1125
+ };
1126
+ /**
1127
+ * CharacterStyleDetails
1128
+ *
1129
+ * Character style settings.
1130
+ */
1131
+ type CharacterStyleDetails = {
1132
+ /**
1133
+ * The font size, in pixels.
1134
+ */
1135
+ size?: number;
1136
+ /**
1137
+ * The font's PostScript name to be used to set the font for this layer.
1138
+ */
1139
+ fontPostScriptName?: string;
1140
+ color?: ColorDetails;
1141
+ /**
1142
+ * The font's leading value, where leading is the distance between each line of text.
1143
+ */
1144
+ leading?: number;
1145
+ /**
1146
+ * The font's tracking value, where tracking is the horizontal spacing between a range of characters.
1147
+ */
1148
+ tracking?: number;
1149
+ baseline?: BaselineType;
1150
+ fontCaps?: FontCaps;
1151
+ autoKern?: AutoKernType;
1152
+ /**
1153
+ * Toggle strikethrough for selected text.
1154
+ */
1155
+ strikethrough?: boolean;
1156
+ /**
1157
+ * Toggle bold for selected text.
1158
+ */
1159
+ syntheticBold?: boolean;
1160
+ /**
1161
+ * Toggle italic for selected text.
1162
+ */
1163
+ syntheticItalic?: boolean;
1164
+ /**
1165
+ * Toggle underlining of text.
1166
+ */
1167
+ underline?: boolean;
1168
+ /**
1169
+ * Toggle text ligature, which are special characters in a font that combine two (or more).
1170
+ */
1171
+ ligature?: boolean;
1172
+ /**
1173
+ * Toggle automatic formatting of fractions: numbers separated by a slash (such as 1/2).
1174
+ */
1175
+ fractions?: boolean;
1176
+ /**
1177
+ * Toggle stylistic alternates, which formats stylized characters that create a purely aesthetic effect.
1178
+ */
1179
+ stylisticAlternates?: boolean;
1180
+ /**
1181
+ * The amount of vertical scaling to apply to the font.
1182
+ */
1183
+ verticalScale?: number;
1184
+ /**
1185
+ * The amount of horizontal scaling to apply to the font.
1186
+ */
1187
+ horizontalScale?: number;
1188
+ };
1189
+ /**
1190
+ * ParagraphStyleDetails
1191
+ *
1192
+ * Paragraph style settings.
1193
+ */
1194
+ type ParagraphStyleDetails = {
1195
+ alignment?: ParagraphStyleAlignmentType;
1196
+ /**
1197
+ * The amount of indent to add to the left margin.
1198
+ */
1199
+ startIndent?: number;
1200
+ /**
1201
+ * The amount of indent to add to the right margin.
1202
+ */
1203
+ endIndent?: number;
1204
+ /**
1205
+ * Toggle hyphenate for paragraph text.
1206
+ */
1207
+ hyphenate?: boolean;
1208
+ /**
1209
+ * The amount of indent to add to the first line of the paragraph.
1210
+ */
1211
+ firstLineIndent?: number;
1212
+ /**
1213
+ * The amount of space to add before the paragraph.
1214
+ */
1215
+ spaceBefore?: number;
1216
+ /**
1217
+ * The amount of space to add after the paragraph.
1218
+ */
1219
+ spaceAfter?: number;
1220
+ };
1221
+ /**
1222
+ * LayerMaskDetails
1223
+ *
1224
+ * An object describing the input mask replaced or added to the layer.
1225
+ */
1226
+ type LayerMaskDetails = {
1227
+ /**
1228
+ * Indicates if this is a clipped layer.
1229
+ */
1230
+ clip?: boolean;
1231
+ /**
1232
+ * Indicates whether a mask is enabled on that layer.
1233
+ */
1234
+ enabled?: boolean;
1235
+ /**
1236
+ * Indicates whether a mask is linked to the layer.
1237
+ */
1238
+ linked?: boolean;
1239
+ offset?: Offset;
1240
+ };
1241
+ /**
1242
+ * Offset
1243
+ *
1244
+ * Offset details.
1245
+ */
1246
+ type Offset = {
1247
+ /**
1248
+ * Offset to indicate horizontal move of the mask.
1249
+ */
1250
+ x?: number;
1251
+ /**
1252
+ * Offset to indicate vertical move of the mask.
1253
+ */
1254
+ y?: number;
1255
+ };
1256
+ /**
1257
+ * SmartObjectDetails
1258
+ *
1259
+ * Smart object details.
1260
+ */
1261
+ type SmartObjectDetails = {
1262
+ /**
1263
+ * Desired image format for the smart object.
1264
+ */
1265
+ type?: string;
1266
+ /**
1267
+ * Indicates if the smart object is linked. Currently we support embedded smart object only, which means "linked = false".
1268
+ */
1269
+ linked?: boolean;
1270
+ /**
1271
+ * Name of the embedded or linked smart object. Currently we support embedded smart object only.
1272
+ */
1273
+ name?: string;
1274
+ /**
1275
+ * Only for a linked smart object. Indicates the relative path for the linked smart object.
1276
+ */
1277
+ path?: string;
1278
+ /**
1279
+ * Only for an embedded smart object. Indicates the instance ID of the embedded smart object. This ID is unique and the value is derived from the RAW data of the document. `instanceId` may show a value as unknown, if the embedded smart object is generated using a non-Adobe application.
1280
+ */
1281
+ instanceId?: string;
1282
+ };
1283
+ /**
1284
+ * FillDetails
1285
+ */
1286
+ type FillDetails = {
1287
+ solidColor?: SolidColor;
1288
+ };
1289
+ /**
1290
+ * SolidColor
1291
+ */
1292
+ type SolidColor = {
1293
+ rgb: RgbColor;
1294
+ };
1295
+ /**
1296
+ * RgbColor
1297
+ *
1298
+ * An object describing the RGB color format in 8 bits.
1299
+ */
1300
+ type RgbColor = {
1301
+ red?: number;
1302
+ green?: number;
1303
+ blue?: number;
1304
+ };
1305
+ /**
1306
+ * FontColorRgb
1307
+ *
1308
+ * An object describing the RGB color format in 16 bits.
1309
+ */
1310
+ type FontColorRgb = {
1311
+ red?: number;
1312
+ green?: number;
1313
+ blue?: number;
1314
+ };
1315
+ /**
1316
+ * FontColorCmyk
1317
+ *
1318
+ * The font color settings for CMYK mode in 16-bit representation.
1319
+ */
1320
+ type FontColorCmyk = {
1321
+ cyan?: number;
1322
+ magenta?: number;
1323
+ yellowColor?: number;
1324
+ black?: number;
1325
+ };
1326
+ /**
1327
+ * FontColorGray
1328
+ *
1329
+ * The font color settings for gray mode in 16-bit representation.
1330
+ */
1331
+ type FontColorGray = {
1332
+ gray?: number;
1333
+ };
1334
+ /**
1335
+ * FontColorLab
1336
+ *
1337
+ * The font color settings for Lab mode in 16-bit representation.
1338
+ */
1339
+ type FontColorLab = {
1340
+ luminance?: number;
1341
+ a?: number;
1342
+ b?: number;
1343
+ };
1344
+ /**
1345
+ * TextLayerDetails
1346
+ *
1347
+ * Text settings.
1348
+ */
1349
+ type TextLayerDetails = {
1350
+ /**
1351
+ * The text string.
1352
+ */
1353
+ content?: string;
1354
+ /**
1355
+ * Character style settings. If the same supported attributes apply to all characters in the layer, then this will be an array of one item. Otherwise, each `characterStyle` object will have a 'from' and 'to' value indicating the range of characters that style applies to.
1356
+ */
1357
+ characterStyles?: Array<TextLayerCharacterStyleDetails>;
1358
+ /**
1359
+ * Paragraph style settings. If the same supported attributes apply to all characters in the layer then this will be an array of one item, otherwise each paragraph style object will have a 'from' and 'to' value indicating the range of characters that the style applies to.
1360
+ */
1361
+ paragraphStyles?: Array<TextLayerParagraphStyleDetails>;
1362
+ };
1363
+ /**
1364
+ * TextLayerCharacterStyleDetails
1365
+ */
1366
+ type TextLayerCharacterStyleDetails = {
1367
+ /**
1368
+ * The beginning of the range of characters that this character style applies to. Based on initial index of 0. For example a style applied to only the first two characters would be from=0 and to=1.
1369
+ */
1370
+ from?: number;
1371
+ /**
1372
+ * The ending of the range of characters that this character style applies to. Based on initial index of 0. For example a style applied to only the first two characters would be from=0 and to=1.
1373
+ */
1374
+ to?: number;
1375
+ /**
1376
+ * The font size in points.
1377
+ */
1378
+ fontSize?: number;
1379
+ /**
1380
+ * The font's PostScript name from the [list of supported fonts](../../getting_started/technical_usage_notes/index.md#photoshop-api-supported-fonts).
1381
+ */
1382
+ fontName?: string;
1383
+ orientation?: OrientationType;
1384
+ fontColor?: FontColorDetails;
1385
+ };
1386
+ /**
1387
+ * TextLayerParagraphStyleDetails
1388
+ *
1389
+ * If the same supported attributes apply to all characters in the layer then this will be an array of one item, otherwise each paragraph style object will have a 'from' and 'to' value indicating the range of characters that the style applies to.
1390
+ */
1391
+ type TextLayerParagraphStyleDetails = {
1392
+ /**
1393
+ * The beginning of the range of characters that this paragraph style applies to. Based on initial index of 0. For example a style applied to only the first two characters would be from=0 and to=1.
1394
+ */
1395
+ from?: number;
1396
+ /**
1397
+ * The ending of the range of characters that this paragraph style applies to. Based on initial index of 0. For example a style applied to only the first two characters would be from=0 and to=1.
1398
+ */
1399
+ to?: number;
1400
+ alignment?: AlignmentType;
1401
+ };
1402
+ /**
1403
+ * BlendDetails
1404
+ *
1405
+ * Blend options of a layer, including opacity and blend mode.
1406
+ */
1407
+ type BlendDetails = {
1408
+ /**
1409
+ * Indicates the opacity value of a layer.
1410
+ */
1411
+ opacity?: number;
1412
+ blendMode?: BlendModeType;
1413
+ };
1414
+ /**
1415
+ * AlignmentType
1416
+ *
1417
+ * The paragraph alignment.
1418
+ */
1419
+ type AlignmentType = 'left' | 'center' | 'right' | 'justify' | 'justifyLeft' | 'justifyCenter' | 'justifyRight';
1420
+ /**
1421
+ * ParagraphStyleAlignmentType
1422
+ *
1423
+ * The paragraph alignment.
1424
+ */
1425
+ type ParagraphStyleAlignmentType = 'left' | 'center' | 'right' | 'justify' | 'justifyLeft' | 'justifyCenter' | 'justifyRight' | 'justifyAll';
1426
+ /**
1427
+ * AntiAliasType
1428
+ *
1429
+ * The text's aliasing type which determines the smoothness of the jagged edges of the text.
1430
+ */
1431
+ type AntiAliasType = 'antiAliasNone' | 'antiAliasSharp' | 'antiAliasCrisp' | 'antiAliasStrong' | 'antiAliasSmooth' | 'antiAliasPlatformLCD' | 'antiAliasPlatformGray';
1432
+ /**
1433
+ * AutoKernType
1434
+ *
1435
+ * The text's kerning setting. Optical: set based on the shape of the font. Metrics: uses kern pairs included in fonts.
1436
+ */
1437
+ type AutoKernType = 'opticalKern' | 'metricsKern';
1438
+ /**
1439
+ * BasedOnType
1440
+ *
1441
+ * Based on type.
1442
+ */
1443
+ type BasedOnType = 'transparentPixels';
1444
+ /**
1445
+ * BaselineType
1446
+ *
1447
+ * Indicates if the text is raised or lowered in relation to a font's baseline.
1448
+ */
1449
+ type BaselineType = 'subScript' | 'superScript';
1450
+ /**
1451
+ * BlendModeType
1452
+ *
1453
+ * Blend mode of layer.
1454
+ */
1455
+ type BlendModeType = 'normal' | 'dissolve' | 'darken' | 'multiply' | 'colorBurn' | 'linearBurn' | 'darkerColor' | 'lighten' | 'screen' | 'colorDodge' | 'linearDodge' | 'lighterColor' | 'overlay' | 'softLight' | 'hardLight' | 'vividLight' | 'linearLight' | 'pinLight' | 'hardMix' | 'difference' | 'exclusion' | 'subtract' | 'divide' | 'hue' | 'saturation' | 'color' | 'luminosity';
1456
+ /**
1457
+ * CanvasSize
1458
+ */
1459
+ type CanvasSize = {
1460
+ bounds: Bounds;
1461
+ };
1462
+ /**
1463
+ * ChannelDetails
1464
+ */
1465
+ type ChannelDetails = {
1466
+ channel?: ChannelType;
1467
+ hue?: number;
1468
+ saturation?: number;
1469
+ lightness?: number;
1470
+ };
1471
+ /**
1472
+ * ChannelType
1473
+ *
1474
+ * The channel type.
1475
+ */
1476
+ type ChannelType = 'master';
1477
+ /**
1478
+ * ColorDetails
1479
+ *
1480
+ * Font color in RGB format.
1481
+ */
1482
+ type ColorDetails = {
1483
+ /**
1484
+ * The color red value.
1485
+ */
1486
+ red: number;
1487
+ /**
1488
+ * The color green value.
1489
+ */
1490
+ green: number;
1491
+ /**
1492
+ * The color blue value.
1493
+ */
1494
+ blue: number;
1495
+ };
1496
+ /**
1497
+ * CompressionType
1498
+ *
1499
+ * Desired PNG compression level.
1500
+ */
1501
+ type CompressionType = 'small' | 'medium' | 'large';
1502
+ /**
1503
+ * DepthType
1504
+ *
1505
+ * Bit depth. This is either 8, 16 or 32 bit.
1506
+ */
1507
+ type DepthType = 8 | 16 | 32;
1508
+ /**
1509
+ * OperationDocument
1510
+ */
1511
+ type OperationDocument = {
1512
+ canvasSize?: CanvasSize;
1513
+ imageSize?: ImageSize;
1514
+ trim?: Trim;
1515
+ };
1516
+ /**
1517
+ * EastAsianFeatures
1518
+ *
1519
+ * Text features specifically for East Asian languages.
1520
+ */
1521
+ type EastAsianFeatures = {
1522
+ textStyle?: TextStyleType & unknown;
1523
+ };
1524
+ /**
1525
+ * ErrorDetails
1526
+ *
1527
+ * Error details.
1528
+ */
1529
+ type ErrorDetails = {
1530
+ /**
1531
+ * The parameter name.
1532
+ */
1533
+ name?: string;
1534
+ /**
1535
+ * The error.
1536
+ */
1537
+ reason?: string;
1538
+ };
1539
+ /**
1540
+ * FillType
1541
+ *
1542
+ * Type of fill for the background layer.
1543
+ */
1544
+ type FillType = 'white' | 'backgroundColor' | 'transparent';
1545
+ /**
1546
+ * FocalSelector
1547
+ *
1548
+ * Focal selector.
1549
+ */
1550
+ type FocalSelector = {
1551
+ /**
1552
+ * X coordinate.
1553
+ */
1554
+ x?: number;
1555
+ /**
1556
+ * Y coordinate.
1557
+ */
1558
+ y?: number;
1559
+ };
1560
+ /**
1561
+ * FontCaps
1562
+ *
1563
+ * The text's capitalization values.
1564
+ */
1565
+ type FontCaps = 'allCaps' | 'smallCaps';
1566
+ /**
1567
+ * FontColorDetails
1568
+ */
1569
+ type FontColorDetails = {
1570
+ rgb?: FontColorRgb & unknown;
1571
+ cmyk?: FontColorCmyk & unknown;
1572
+ gray?: FontColorGray & unknown;
1573
+ lab?: FontColorLab & unknown;
1574
+ };
1575
+ /**
1576
+ * MaskFormatType
1577
+ *
1578
+ * Soft mask or binary mask.
1579
+ */
1580
+ type MaskFormatType = 'binary' | 'soft';
1581
+ /**
1582
+ * ImageModeType
1583
+ *
1584
+ * The image mode.
1585
+ */
1586
+ type ImageModeType = 'grayscale' | 'rgb' | 'cmyk';
1587
+ /**
1588
+ * ImageSize
1589
+ *
1590
+ * The size of the image
1591
+ */
1592
+ type ImageSize = {
1593
+ width: number;
1594
+ height: number;
1595
+ };
1596
+ /**
1597
+ * DocumentCreateLayer
1598
+ */
1599
+ type DocumentCreateLayer = {
1600
+ type: LayerType;
1601
+ input: StorageDetails & unknown;
1602
+ name?: string;
1603
+ /**
1604
+ * is the layer locked
1605
+ */
1606
+ locked?: boolean;
1607
+ /**
1608
+ * is the layer visible
1609
+ */
1610
+ visible?: boolean;
1611
+ adjustments?: AdjustmentDetails;
1612
+ bounds?: Bounds;
1613
+ children?: Array<ChildrenLayerDetails>;
1614
+ mask?: MaskDetails;
1615
+ smartObject?: SmartObject & unknown;
1616
+ fill?: FillDetails;
1617
+ text?: TextLayerDetails & unknown;
1618
+ blendOptions?: BlendDetails & unknown;
1619
+ };
1620
+ /**
1621
+ * DocumentOperationLayer
1622
+ */
1623
+ type DocumentOperationLayer = {
1624
+ /**
1625
+ * Indicates the layer to edit, by it's ID or name. Note the object is currently empty but leaves room for further enhancements. The layer block should contain changes from the original manifest. If you apply it to a group layer, you will be affecting the attributes of the group layer itself, not the child layers. This edit is supported for layer type `smartObject` and `fillLayer` only.
1626
+ */
1627
+ edit?: {
1628
+ [key: string]: unknown;
1629
+ };
1630
+ move?: MoveDetails;
1631
+ add?: LayerPosition;
1632
+ delete: DeleteDetails;
1633
+ /**
1634
+ * The layer ID.
1635
+ */
1636
+ id: number;
1637
+ /**
1638
+ * The layer index. Required when deleting a layer, otherwise not used.
1639
+ */
1640
+ index?: number;
1641
+ /**
1642
+ * A tree of layer objects representing the PSD layer structure extracted from the PSD document.
1643
+ */
1644
+ children?: Array<ChildrenLayerDetails>;
1645
+ type?: LayerType;
1646
+ input?: StorageDetails;
1647
+ name?: string;
1648
+ /**
1649
+ * is the layer locked
1650
+ */
1651
+ locked?: boolean;
1652
+ /**
1653
+ * is the layer visible
1654
+ */
1655
+ visible?: boolean;
1656
+ adjustments?: AdjustmentDetails;
1657
+ mask?: MaskDetails;
1658
+ bounds?: Bounds;
1659
+ smartObject?: SmartObject & unknown;
1660
+ fill?: FillDetails;
1661
+ text?: TextLayerDetails & unknown;
1662
+ blendOptions?: BlendDetails & unknown;
1663
+ horizontalAlign?: HorizontalAlignType;
1664
+ verticalAlign?: VerticalAlignType;
1665
+ /**
1666
+ * Indicates if the pixels need to proportionally fill into the entire canvas of the document.
1667
+ */
1668
+ fillToCanvas?: boolean;
1669
+ };
1670
+ /**
1671
+ * SmartObjectLayer
1672
+ */
1673
+ type SmartObjectLayer = {
1674
+ add?: LayerPosition;
1675
+ /**
1676
+ * the layer id
1677
+ */
1678
+ id?: number;
1679
+ name?: string;
1680
+ /**
1681
+ * is the layer locked
1682
+ */
1683
+ locked?: boolean;
1684
+ /**
1685
+ * is the layer visible
1686
+ */
1687
+ visible?: boolean;
1688
+ input: StorageDetails;
1689
+ bounds?: Bounds;
1690
+ };
1691
+ /**
1692
+ * TextOptionsLayer
1693
+ */
1694
+ type TextOptionsLayer = {
1695
+ /**
1696
+ * The name of the layer you want to insert. Use either ID or name.
1697
+ */
1698
+ name?: string;
1699
+ /**
1700
+ * The ID of the layer you want to insert. Use either ID or name.
1701
+ */
1702
+ id?: number;
1703
+ bounds?: Bounds;
1704
+ /**
1705
+ * Is the layer editable.
1706
+ */
1707
+ locked?: boolean;
1708
+ /**
1709
+ * Is the layer visible.
1710
+ */
1711
+ visible?: boolean;
1712
+ text?: TextDetails & unknown;
1713
+ };
1714
+ /**
1715
+ * RenditionLinks
1716
+ *
1717
+ * The rendition links.
1718
+ */
1719
+ type RenditionLinks = {
1720
+ /**
1721
+ * Array of rendition objects.
1722
+ */
1723
+ renditions?: Array<RenditionLinkDetails>;
1724
+ };
1725
+ /**
1726
+ * ManageMissingFonts
1727
+ *
1728
+ * Action to take if there are one or more missing fonts in the document. Using `fail` - the job will not succeed and the status will be set to `failed` with the details of the error provided in the `details` section in the status. Using `useDefault` - the job will succeed, however all the missing fonts will use the font: ArialMT.
1729
+ */
1730
+ type ManageMissingFonts = 'useDefault' | 'fail';
1731
+ /**
1732
+ * MaskFormat
1733
+ */
1734
+ type MaskFormat = {
1735
+ format?: MaskFormatType;
1736
+ };
1737
+ /**
1738
+ * MaskDetails
1739
+ */
1740
+ type MaskDetails = {
1741
+ input?: StorageDetails;
1742
+ /**
1743
+ * Indicates if this is a clipped layer
1744
+ */
1745
+ clip?: boolean;
1746
+ /**
1747
+ * Indicates a mask is enabled on that layer or not
1748
+ */
1749
+ enabled?: boolean;
1750
+ /**
1751
+ * Indicates a mask is linked to the layer or not
1752
+ */
1753
+ linked?: boolean;
1754
+ offset?: Offset;
1755
+ };
1756
+ /**
1757
+ * ChannelModeType
1758
+ *
1759
+ * The document's bit/channel depth.
1760
+ */
1761
+ type ChannelModeType = 'bitmap' | 'greyscale' | 'indexed' | 'rgb' | 'cmyk' | 'hsl' | 'hsb' | 'multichannel' | 'duotone' | 'lab' | 'xyz';
1762
+ /**
1763
+ * MoveDetails
1764
+ */
1765
+ type MoveDetails = {
1766
+ moveChildren?: boolean;
1767
+ insertAbove?: LayerReference;
1768
+ insertBelow?: LayerReference;
1769
+ insertInto?: LayerReference;
1770
+ insertTop?: boolean;
1771
+ insertBottom?: boolean;
1772
+ };
1773
+ /**
1774
+ * DocumentManifestOptions
1775
+ *
1776
+ * Available options to apply to all input files.
1777
+ */
1778
+ type DocumentManifestOptions = {
1779
+ thumbnails?: Thumbnails & unknown;
1780
+ };
1781
+ /**
1782
+ * DocumentCreateOptions
1783
+ */
1784
+ type DocumentCreateOptions = {
1785
+ manageMissingFonts?: ManageMissingFonts & unknown;
1786
+ /**
1787
+ * The PostScript name of the font to be used as the global default for the document. If this font is also missing, the option specified in `manageMissingFonts` will take effect.
1788
+ */
1789
+ globalFont?: string;
1790
+ /**
1791
+ * array of custom fonts needed in this document
1792
+ */
1793
+ fonts?: Array<StorageDetails>;
1794
+ document: DocumentDetails;
1795
+ /**
1796
+ * Array of layers to be created in the document.
1797
+ */
1798
+ layers?: Array<DocumentCreateLayer>;
1799
+ };
1800
+ /**
1801
+ * DocumentOperationOptions
1802
+ */
1803
+ type DocumentOperationOptions = {
1804
+ manageMissingFonts?: ManageMissingFonts & unknown;
1805
+ /**
1806
+ * The PostScript name of the font to be used as the global default. If this font is also missing, the option specified in `manageMissingFonts` will take effect
1807
+ */
1808
+ globalFont?: string;
1809
+ /**
1810
+ * array of custom fonts needed in this document
1811
+ */
1812
+ fonts?: Array<StorageDetails>;
1813
+ document?: OperationDocument;
1814
+ /**
1815
+ * Array of layers to be created in the document.
1816
+ */
1817
+ layers?: Array<DocumentOperationLayer>;
1818
+ };
1819
+ /**
1820
+ * SmartObjectOptions
1821
+ */
1822
+ type SmartObjectOptions = {
1823
+ /**
1824
+ * Array of Smart Object layers to be created in the document
1825
+ */
1826
+ layers: Array<SmartObjectLayer>;
1827
+ };
1828
+ /**
1829
+ * ActionOptions
1830
+ */
1831
+ type ActionOptions = {
1832
+ /**
1833
+ * Array of Photoshop Actions to play.
1834
+ */
1835
+ actions: Array<Action>;
1836
+ /**
1837
+ * array of custom pattern preset to be used in Photoshop Actions
1838
+ */
1839
+ patterns?: Array<StorageDetails>;
1840
+ /**
1841
+ * array of custom fonts needed in this document
1842
+ */
1843
+ fonts?: Array<StorageDetails>;
1844
+ /**
1845
+ * array of custom brushes needed in this document
1846
+ */
1847
+ brushes?: Array<StorageDetails>;
1848
+ };
1849
+ /**
1850
+ * ActionJsonOptions
1851
+ */
1852
+ type ActionJsonOptions = {
1853
+ /**
1854
+ * Array of Photoshop JSON-formatted Actions to play.
1855
+ */
1856
+ actionJSON: Array<{
1857
+ [key: string]: unknown;
1858
+ }>;
1859
+ /**
1860
+ * array of custom pattern preset to be used in Photoshop Actions
1861
+ */
1862
+ patterns?: Array<StorageDetails>;
1863
+ /**
1864
+ * array of custom fonts needed in this document
1865
+ */
1866
+ fonts?: Array<StorageDetails>;
1867
+ /**
1868
+ * array of custom brushes needed in this document
1869
+ */
1870
+ brushes?: Array<StorageDetails>;
1871
+ /**
1872
+ * Array of references to additional images, which can be referred by actionJson commands.
1873
+ */
1874
+ additionalImages?: Array<StorageDetails>;
1875
+ };
1876
+ /**
1877
+ * ActionJsonCreateOptions
1878
+ *
1879
+ * This block is needed only if you want to specify which action to convert from the ActionSet.
1880
+ */
1881
+ type ActionJsonCreateOptions = {
1882
+ /**
1883
+ * Array of action objects.
1884
+ */
1885
+ actions: [ActionDetails];
1886
+ };
1887
+ /**
1888
+ * CropOptions
1889
+ */
1890
+ type CropOptions = {
1891
+ unit: UnitType & unknown;
1892
+ /**
1893
+ * The width to be added as padding.
1894
+ */
1895
+ width: number;
1896
+ /**
1897
+ * The height to be added as padding.
1898
+ */
1899
+ height: number;
1900
+ };
1901
+ /**
1902
+ * DepthBlurDetails
1903
+ */
1904
+ type DepthBlurDetails = {
1905
+ /**
1906
+ * The distance of the point to be in focus. 0 would be the nearest point, 100 would be the furthest point.
1907
+ */
1908
+ focalDistance?: number;
1909
+ /**
1910
+ * The range of the focal point.
1911
+ */
1912
+ focalRange?: number;
1913
+ focalSelector?: FocalSelector & unknown;
1914
+ /**
1915
+ * If enabled uses select subject to automatically select the prominent subject for focus. Also would override focalDistance.
1916
+ */
1917
+ focusSubject?: boolean;
1918
+ /**
1919
+ * The amount of blur to apply.
1920
+ */
1921
+ blurStrength?: number;
1922
+ /**
1923
+ * The amount of haze to apply.
1924
+ */
1925
+ haze?: number;
1926
+ /**
1927
+ * The value of the temperature to apply. -50 would be coldest and 50 would be the warmest setting.
1928
+ */
1929
+ temp?: number;
1930
+ /**
1931
+ * The amount of the tint to apply.
1932
+ */
1933
+ tint?: number;
1934
+ /**
1935
+ * The amount of the saturation to apply. -50 implies fully unsaturated colors and 50 will fully saturate the colors.
1936
+ */
1937
+ saturation?: number;
1938
+ /**
1939
+ * The amount of the brightness to apply.
1940
+ */
1941
+ brightness?: number;
1942
+ /**
1943
+ * The amount of the graining to add to the image.
1944
+ */
1945
+ grain?: number;
1946
+ };
1947
+ /**
1948
+ * TextOptions
1949
+ */
1950
+ type TextOptions = {
1951
+ manageMissingFonts?: ManageMissingFonts & unknown;
1952
+ /**
1953
+ * The PostScript name of the font to be used as the global default. If this font is also missing, the option specified in `manageMissingFonts` will take effect
1954
+ */
1955
+ globalFont?: string;
1956
+ /**
1957
+ * Array of text layer objects you wish to act upon.
1958
+ */
1959
+ layers: Array<TextOptionsLayer>;
1960
+ /**
1961
+ * Array of custom fonts needed in this document.
1962
+ */
1963
+ fonts?: Array<StorageDetails>;
1964
+ };
1965
+ /**
1966
+ * ArtboardDetails
1967
+ */
1968
+ type ArtboardDetails = {
1969
+ /**
1970
+ * An array of hashes describing the input files to edit. Each input object will be either 'external', 'adobe', 'azure' or 'dropbox'.
1971
+ */
1972
+ artboard: Array<StorageDetails>;
1973
+ };
1974
+ /**
1975
+ * OrientationType
1976
+ *
1977
+ * The text orientation.
1978
+ */
1979
+ type OrientationType = 'horizontal' | 'vertical';
1980
+ /**
1981
+ * ManifestJobStatusOutputDetails
1982
+ */
1983
+ type ManifestJobStatusOutputDetails = {
1984
+ /**
1985
+ * the original input href
1986
+ */
1987
+ input?: string;
1988
+ /**
1989
+ * Created timestamp of the job (YYYY-DD-MMThh:mm:ss.mmmmmZ)
1990
+ */
1991
+ created?: string;
1992
+ /**
1993
+ * Modified timestamp of the job (YYYY-DD-MMThh:mm:ss.mmmmmZ)
1994
+ */
1995
+ modified?: string;
1996
+ status?: JobStatus;
1997
+ document?: ManifestJobDocumentDetails;
1998
+ /**
1999
+ * A tree of layer objects representing the PSD layer structure extracted from the PSD document.
2000
+ */
2001
+ layers?: Array<LayerDetails>;
2002
+ };
2003
+ /**
2004
+ * JobOutputDetails
2005
+ */
2006
+ type JobOutputDetails = {
2007
+ /**
2008
+ * the original input href
2009
+ */
2010
+ input?: string;
2011
+ /**
2012
+ * Created timestamp of the job (YYYY-DD-MMThh:mm:ss.mmmmmZ)
2013
+ */
2014
+ created?: string;
2015
+ /**
2016
+ * Modified timestamp of the job (YYYY-DD-MMThh:mm:ss.mmmmmZ)
2017
+ */
2018
+ modified?: string;
2019
+ status?: JobOutputStatus;
2020
+ _links?: RenditionLinks;
2021
+ };
2022
+ /**
2023
+ * ColorProfileType
2024
+ *
2025
+ * The name of the color profile.
2026
+ */
2027
+ type ColorProfileType = 'Adobe RGB (1998)' | 'Apple RGB' | 'ColorMatch RGB' | 'sRGB IEC61966-2.1' | 'Dot Gain 10%' | 'Dot Gain 15%' | 'Dot Gain 20%' | 'Dot Gain 25%' | 'Dot Gain 30%' | 'Gray Gamma 1.8' | 'Gray Gamma 2.2';
2028
+ /**
2029
+ * SelfLink
2030
+ *
2031
+ * Self link.
2032
+ */
2033
+ type SelfLink = {
2034
+ /**
2035
+ * Job Status URL.
2036
+ */
2037
+ href?: string;
2038
+ };
2039
+ /**
2040
+ * SmartObject
2041
+ *
2042
+ * An object describing the attributes specific to creating or editing a smart object. `SmartObject` properties operate on the input smart object file. When creating a linked smart object, this is a required. When creating an embedded smart object, it is optional.
2043
+ */
2044
+ type SmartObject = {
2045
+ /**
2046
+ * Indicates if this Smart Object is linked. Currently we support Embedded Smart Object only which means "linked = false".
2047
+ */
2048
+ linked?: boolean;
2049
+ };
2050
+ /**
2051
+ * JobStatus
2052
+ *
2053
+ * Job status.
2054
+ */
2055
+ type JobStatus = 'pending' | 'running' | 'succeeded' | 'failed';
2056
+ /**
2057
+ * JobOutputStatus
2058
+ *
2059
+ * The child job status. Using `pending` - the request has been accepted and is waiting to start. Using `running` - the child job is running. Using `uploading` - files have been generated and are uploading to destination. Using `succeeded` - the child job has succeeded. Using `failed` - the child job has failed.
2060
+ */
2061
+ type JobOutputStatus = 'pending' | 'running' | 'uploading' | 'succeeded' | 'failed';
2062
+ /**
2063
+ * StorageType
2064
+ *
2065
+ * Storage platforms supported.
2066
+ */
2067
+ type StorageType = 'external' | 'azure' | 'dropbox';
2068
+ /**
2069
+ * TextDetails
2070
+ *
2071
+ * Supported text layer attributes.
2072
+ */
2073
+ type TextDetails = {
2074
+ /**
2075
+ * The content of the text layer.
2076
+ */
2077
+ content?: string;
2078
+ orientation?: OrientationType;
2079
+ /**
2080
+ * The text's rotation in angle.
2081
+ */
2082
+ rotate?: number;
2083
+ antiAlias?: AntiAliasType & unknown;
2084
+ eastAsianFeatures?: EastAsianFeatures & unknown;
2085
+ /**
2086
+ * Array of character style objects. Any of the `characterStyles` property is required.
2087
+ */
2088
+ characterStyles?: Array<CharacterStyleDetails>;
2089
+ /**
2090
+ * Array of paragraph style objects. Any of the `paragraphStyles` properties is required.
2091
+ */
2092
+ paragraphStyles?: Array<ParagraphStyleDetails>;
2093
+ textType?: TextType & unknown;
2094
+ };
2095
+ /**
2096
+ * TextStyleType
2097
+ *
2098
+ * Base line direction for text style.
2099
+ */
2100
+ type TextStyleType = 'cross' | 'rotated' | 'withSream';
2101
+ /**
2102
+ * TextType
2103
+ *
2104
+ * The type of text's contents, point or paragraph.
2105
+ */
2106
+ type TextType = 'point' | 'paragraph';
2107
+ /**
2108
+ * Thumbnails
2109
+ *
2110
+ * Include pre-signed GET URLs to small preview thumbnails for any renderable layer.
2111
+ */
2112
+ type Thumbnails = {
2113
+ type?: ThumbnailType & unknown;
2114
+ };
2115
+ /**
2116
+ * Trim
2117
+ */
2118
+ type Trim = {
2119
+ basedOn: BasedOnType;
2120
+ };
2121
+ /**
2122
+ * TrimToCanvasType
2123
+ *
2124
+ * Use this if the renditions needs to be of Canvas size. Using `True` trims the renditions to Canvas size, while `False` makes the renditions Layer Size.
2125
+ */
2126
+ type TrimToCanvasType = true | false;
2127
+ /**
2128
+ * ImageFormatType
2129
+ *
2130
+ * The desired image format. Using `image/vnd.adobe.photoshop` - create a new PSD file. Using `image/jpeg`, `image/png`, `image/tiff` - create a new JPEG, PNG or TIFF rendition. Certain image modes (RGB, CMYK, greyscale, etc.) must be converted to another image mode before a rendition can be created. With TIFF requested, Multichannel and Duotone will convert to RGB. With PNG requested, CMYK, HSL, HSB, Multichannel, Duotone, Lab and XYZ will convert to RGB.
2131
+ */
2132
+ type ImageFormatType = 'image/vnd.adobe.photoshop' | 'image/jpeg' | 'image/png' | 'image/tiff' | 'vnd.adobe.photoshop';
2133
+ /**
2134
+ * LayerType
2135
+ *
2136
+ * The layer type. Using `layer` - a pixel layer. Using `textLayer` - a text layer. Using `adjustmentLayer` - an adjustment layer. Using `layerSection` - a grouping layer. Using `smartObject` - a smart object. Using `backgroundLayer` - a background layer. Using `fillLayer` - a fill layer.
2137
+ */
2138
+ type LayerType = 'layer' | 'textLayer' | 'adjustmentLayer' | 'smartObject' | 'fillLayer' | 'backgroundLayer' | 'layerSection';
2139
+ /**
2140
+ * ThumbnailType
2141
+ *
2142
+ * Desired image format.
2143
+ */
2144
+ type ThumbnailType = 'image/jpeg' | 'image/png' | 'image/tiff';
2145
+ /**
2146
+ * UnitType
2147
+ *
2148
+ * Unit for width and height.
2149
+ */
2150
+ type UnitType = 'Pixels' | 'Percent';
2151
+ /**
2152
+ * HorizontalAlignType
2153
+ *
2154
+ * Indicates the relative horizontal position of the layer with respect to the canvas of the document.
2155
+ */
2156
+ type HorizontalAlignType = 'left' | 'center' | 'right';
2157
+ /**
2158
+ * VerticalAlignType
2159
+ *
2160
+ * Indicates the relative vertical position of the layer with respect to the canvas of the document.
2161
+ */
2162
+ type VerticalAlignType = 'top' | 'center' | 'bottom';
2163
+ type UrlResource = {
2164
+ /**
2165
+ * The URL of the resource. Only these listed domains are accepted in the request:
2166
+ * <ul><li><code>amazonaws.com</code></li><li><code>windows.net</code></li><li><code>dropboxusercontent.com</code></li><li><code>assets.frame.io</code></li><li><code>storage.googleapis.com</code></li></ul>
2167
+ */
2168
+ url: string;
2169
+ };
2170
+ type RemoveBgInputImage = {
2171
+ /**
2172
+ * The source path for the input image. Dimensions of the image should not be greater than 6000px X 6000px. The image media type must be `image/jpeg`, `image/png`, `image/webp`, or `image/tiff`.
2173
+ */
2174
+ source: UrlResource;
2175
+ };
2176
+ /**
2177
+ * The mode of background removal.
2178
+ */
2179
+ type RemoveBgMode = 'cutout' | 'mask' | 'psd';
2180
+ /**
2181
+ * The media type of the output image. By default this will match the input source file format.
2182
+ */
2183
+ type RemoveBgOutputImageMediaType = 'image/jpeg' | 'image/png' | 'image/webp' | 'image/vnd.adobe.photoshop';
2184
+ type RemoveBgOutputImageOptions = {
2185
+ mediaType?: RemoveBgOutputImageMediaType;
2186
+ };
2187
+ type RemoveBgColor = {
2188
+ /**
2189
+ * The red value of the color.
2190
+ */
2191
+ red: number;
2192
+ /**
2193
+ * The green value of the color.
2194
+ */
2195
+ green: number;
2196
+ /**
2197
+ * The blue value of the color.
2198
+ */
2199
+ blue: number;
2200
+ /**
2201
+ * The transparency value. 0 is fully transparent and 1 is fully opaque.
2202
+ */
2203
+ alpha: number;
2204
+ };
2205
+ type RemoveBackgroundV2Request = {
2206
+ /**
2207
+ * The image to be processed.
2208
+ */
2209
+ image: RemoveBgInputImage;
2210
+ mode?: RemoveBgMode;
2211
+ /**
2212
+ * The options for the output image.
2213
+ */
2214
+ output?: RemoveBgOutputImageOptions;
2215
+ /**
2216
+ * If true, the image returned is cropped to the cutout border. Transparent pixels are removed.
2217
+ */
2218
+ trim?: boolean;
2219
+ /**
2220
+ * The background color.
2221
+ */
2222
+ backgroundColor?: RemoveBgColor;
2223
+ /**
2224
+ * If the value is greater than 0, automatically removes colored reflections that have been left on the main subject by the background.
2225
+ */
2226
+ colorDecontamination?: number;
2227
+ };
2228
+ type JobLinkResponse = {
2229
+ /**
2230
+ * The job ID for the asynchronous job.
2231
+ */
2232
+ jobId: string;
2233
+ /**
2234
+ * The URL to check the status of the asynchronous job.
2235
+ */
2236
+ statusUrl: string;
2237
+ };
2238
+ type JobStatusPollPayload = {
2239
+ status: JobStatus;
2240
+ /**
2241
+ * The job ID.
2242
+ */
2243
+ jobId: string;
2244
+ };
2245
+ /**
2246
+ * Succeeded
2247
+ */
2248
+ type JobStatusSucceededResponse = {
2249
+ status: 'succeeded';
2250
+ /**
2251
+ * The job ID.
2252
+ */
2253
+ jobId: string;
2254
+ result: {
2255
+ outputs?: Array<{
2256
+ destination?: {
2257
+ /**
2258
+ * The output URL
2259
+ */
2260
+ url?: string;
2261
+ };
2262
+ /**
2263
+ * The media type of the output
2264
+ */
2265
+ mediaType?: string;
2266
+ }>;
2267
+ };
2268
+ };
2269
+ type FillMaskedAreasInputImage = {
2270
+ /**
2271
+ * The source of the input image. Dimensions of the image should not be greater than (4000px X 4000px).
2272
+ */
2273
+ source: UrlResource;
2274
+ };
2275
+ type FillMaskedAreasRequest = {
2276
+ /**
2277
+ * The image to be processed.
2278
+ */
2279
+ image: FillMaskedAreasInputImage;
2280
+ /**
2281
+ * The areas of the image represented by this list of masks will be inpainted.
2282
+ */
2283
+ masks: Array<FillMaskedAreasInputImage>;
2284
+ };
2285
+ /**
2286
+ * The media type of the input image.
2287
+ */
2288
+ type MaskBodyPartsImageMediaType = 'image/jpeg' | 'image/png';
2289
+ type MaskBodyPartsInputImage = {
2290
+ /**
2291
+ * The source of the input image. Dimensions of the image should not be greater than (4000px X 4000px).
2292
+ */
2293
+ source: UrlResource;
2294
+ };
2295
+ /**
2296
+ * The media type of the mask.
2297
+ */
2298
+ type MaskBodyPartsMaskMediaType = 'image/png';
2299
+ type MaskBodyPartsInputMask = {
2300
+ /**
2301
+ * The URL of the mask. Dimensions of the mask should not be greater than (4000px X 4000px).
2302
+ */
2303
+ source: UrlResource;
2304
+ };
2305
+ type MaskBodyPartsRequest = {
2306
+ /**
2307
+ * The input image.
2308
+ */
2309
+ image: MaskBodyPartsInputImage;
2310
+ /**
2311
+ * The mask of the subject in the input image.
2312
+ */
2313
+ mask: MaskBodyPartsInputMask;
2314
+ };
2315
+ /**
2316
+ * The media type of the input image.
2317
+ */
2318
+ type MaskObjectsInputImageMediaType = 'image/jpeg' | 'image/png';
2319
+ type MaskObjectsInputImage = {
2320
+ /**
2321
+ * The source of the input image. Dimensions of the image should not be greater than (4000px X 4000px).
2322
+ */
2323
+ source: UrlResource;
2324
+ };
2325
+ type MaskObjectsRequest = {
2326
+ /**
2327
+ * The input image.
2328
+ */
2329
+ image: MaskObjectsInputImage;
2330
+ };
2331
+ /**
2332
+ * The media type of the input image.
2333
+ */
2334
+ type RefineMaskImageMediaType = 'image/jpeg' | 'image/png';
2335
+ type RefineMaskInputImage = {
2336
+ /**
2337
+ * The source of the input image. Dimensions of the image should not be greater than (4000px X 4000px).
2338
+ */
2339
+ source: UrlResource;
2340
+ };
2341
+ type RefineMaskRequest = {
2342
+ /**
2343
+ * The input image.
2344
+ */
2345
+ image: RefineMaskInputImage;
2346
+ /**
2347
+ * The mask in the input image that needs to be refined.
2348
+ */
2349
+ mask: RefineMaskInputImage;
2350
+ /**
2351
+ * When `true`, this returns an RGBA image where the masked area has been further refined with color decontamination. A `false` value (default) means that the output will simply be the refined mask.
2352
+ */
2353
+ colorDecontamination?: boolean;
2354
+ };
2355
+ type OutputImageDetails = {
2356
+ /**
2357
+ * Details of the location where the output image is located.
2358
+ */
2359
+ destination: UrlResource;
2360
+ /**
2361
+ * Media type of the output image.
2362
+ */
2363
+ mediaType: 'image/jpeg' | 'image/png';
2364
+ };
2365
+ type FillMaskedAreasJobApiResponse = {
2366
+ status: JobStatus;
2367
+ /**
2368
+ * The job ID.
2369
+ */
2370
+ jobId: string;
2371
+ /**
2372
+ * The output image.
2373
+ */
2374
+ image: OutputImageDetails;
2375
+ };
2376
+ type ImageBoundingBox = {
2377
+ /**
2378
+ * The x coordinate of the upper-left corner of the bounding box. The origin (0,0) is at the upper-left corner of the image.
2379
+ */
2380
+ x: number;
2381
+ /**
2382
+ * The y coordinate of the upper-left corner of the bounding box. The origin (0,0) is at the upper-left corner of the image.
2383
+ */
2384
+ y: number;
2385
+ /**
2386
+ * The width of the bounding box, starting from the x coordinate.
2387
+ */
2388
+ width: number;
2389
+ /**
2390
+ * The height of the bounding box, starting from the y coordinate.
2391
+ */
2392
+ height: number;
2393
+ };
2394
+ type MaskBodyPartsOutputImage = {
2395
+ /**
2396
+ * The label of the identified body part.
2397
+ */
2398
+ label: string;
2399
+ /**
2400
+ * The bounding box of the identified body part.
2401
+ */
2402
+ boundingBox: ImageBoundingBox;
2403
+ /**
2404
+ * The probability or confidence score of the match.
2405
+ */
2406
+ score: number;
2407
+ /**
2408
+ * Details of the location where the mask of the identified body part is located.
2409
+ */
2410
+ destination: UrlResource;
2411
+ /**
2412
+ * Media type of the mask of the identified body part.
2413
+ */
2414
+ mediaType: 'image/png';
2415
+ };
2416
+ type MaskBodyPartsJobApiResponse = {
2417
+ status: JobStatus;
2418
+ /**
2419
+ * The job ID.
2420
+ */
2421
+ jobId: string;
2422
+ /**
2423
+ * An array of output image masks.
2424
+ */
2425
+ masks: Array<MaskBodyPartsOutputImage>;
2426
+ };
2427
+ type MaskObjectsOutputImage = {
2428
+ /**
2429
+ * The label of the identified object or area of interest.
2430
+ */
2431
+ label: string;
2432
+ /**
2433
+ * The bounding box of the object or area of interest.
2434
+ */
2435
+ boundingBox: ImageBoundingBox;
2436
+ /**
2437
+ * The probability or confidence score of the match.
2438
+ */
2439
+ score: number;
2440
+ /**
2441
+ * Details of the location where the mask is located.
2442
+ */
2443
+ destination: UrlResource;
2444
+ /**
2445
+ * Media type of the mask.
2446
+ */
2447
+ mediaType: 'image/png';
2448
+ };
2449
+ type MaskObjectsJobApiResponse = {
2450
+ status: JobStatus;
2451
+ /**
2452
+ * The job ID.
2453
+ */
2454
+ jobId: string;
2455
+ /**
2456
+ * List of masks representing foreground objects.
2457
+ */
2458
+ semanticMasks: Array<MaskObjectsOutputImage>;
2459
+ /**
2460
+ * List of masks representing background regions.
2461
+ */
2462
+ backgroundMasks: Array<MaskObjectsOutputImage>;
2463
+ };
2464
+ type RefineMaskOutputImage = {
2465
+ /**
2466
+ * Details of the location where the refined mask or image is located.
2467
+ */
2468
+ destination: UrlResource;
2469
+ /**
2470
+ * Media type of the refined mask or image.
2471
+ */
2472
+ mediaType: 'image/jpeg' | 'image/png';
2473
+ /**
2474
+ * The bounding box of the refined mask or image.
2475
+ */
2476
+ boundingBox: ImageBoundingBox;
2477
+ };
2478
+ type RefineMaskJobApiResponse = {
2479
+ status: JobStatus;
2480
+ /**
2481
+ * The job ID.
2482
+ */
2483
+ jobId: string;
2484
+ /**
2485
+ * The refined mask. This will only be attached to the response when mask is specified as an input. Only applicable when colorDecontamination is false.
2486
+ */
2487
+ mask?: RefineMaskOutputImage;
2488
+ /**
2489
+ * The image with color decontamination. This will only be attached to the response when mask is specified as an input. Only applicable when colorDecontamination is true.
2490
+ */
2491
+ image?: RefineMaskOutputImage;
2492
+ };
2493
+ type JobStatusResponse = {
2494
+ status: JobStatus;
2495
+ /**
2496
+ * The results of the job if completed.
2497
+ */
2498
+ results: {
2499
+ [key: string]: unknown;
2500
+ };
2501
+ };
2502
+ /**
2503
+ * Response when a job is currently being processed. The job has started but is not yet complete.
2504
+ */
2505
+ type JobStatusRunning = {
2506
+ /**
2507
+ * The job ID.
2508
+ */
2509
+ jobId: string;
2510
+ /**
2511
+ * The status of the job.
2512
+ */
2513
+ status: 'running';
2514
+ };
2515
+ /**
2516
+ * Response when a job has completed successfully. In addition to the jobId and status, the response includes the results of the job which vary depending on the operation.
2517
+ */
2518
+ type JobStatusSucceeded = {
2519
+ /**
2520
+ * The job ID.
2521
+ */
2522
+ jobId: string;
2523
+ /**
2524
+ * The status of the job.
2525
+ */
2526
+ status: 'succeeded';
2527
+ };
2528
+ /**
2529
+ * Response when a job has failed during processing. Contains error details explaining what went wrong.
2530
+ */
2531
+ type JobStatusFailed = {
2532
+ /**
2533
+ * The job ID.
2534
+ */
2535
+ jobId: string;
2536
+ /**
2537
+ * The status of the job.
2538
+ */
2539
+ status: 'failed';
2540
+ /**
2541
+ * The error code.
2542
+ */
2543
+ error_code: string;
2544
+ /**
2545
+ * The error message.
2546
+ */
2547
+ message: string;
2548
+ };
2549
+ /**
2550
+ * Response when a job has been created but processing has not yet begun. This status indicates the job is queued and waiting to start.
2551
+ */
2552
+ type JobStatusNotStarted = {
2553
+ /**
2554
+ * The job ID.
2555
+ */
2556
+ jobId: string;
2557
+ /**
2558
+ * The status of the job.
2559
+ */
2560
+ status: 'not_started';
2561
+ };
2562
+ type SenseiJobStatusData = {
2563
+ body?: never;
2564
+ headers?: {
2565
+ /**
2566
+ * The IMS organization ID. This only needs to be sent if you want to receive the job status through Adobe I/O Events.
2567
+ */
2568
+ 'x-gw-ims-org-id'?: string;
2569
+ };
2570
+ path: {
2571
+ /**
2572
+ * The job ID.
2573
+ */
2574
+ jobId: string;
2575
+ };
2576
+ query?: never;
2577
+ url: '/sensei/status/{jobId}';
2578
+ };
2579
+ type SenseiJobStatusResponses = {
2580
+ /**
2581
+ * Job status
2582
+ */
2583
+ 200: SenseiJobApiResponse;
2584
+ };
2585
+ type SenseiJobStatusResponse = SenseiJobStatusResponses[keyof SenseiJobStatusResponses];
2586
+ type RemoveBackgroundAsyncData = {
2587
+ /**
2588
+ * The input image and the cutout mask parameters
2589
+ */
2590
+ body: RemoveBackgroundRequest;
2591
+ headers?: {
2592
+ /**
2593
+ * The IMS organization ID. This only needs to be sent if you want to receive the job status through Adobe I/O Events.
2594
+ */
2595
+ 'x-gw-ims-org-id'?: string;
2596
+ };
2597
+ path?: never;
2598
+ query?: never;
2599
+ url: '/sensei/cutout';
2600
+ };
2601
+ type RemoveBackgroundAsyncErrors = {
2602
+ /**
2603
+ * Input Validation Error
2604
+ */
2605
+ 400: InputValidationError;
2606
+ /**
2607
+ * Trial Limit Exceeded Error
2608
+ */
2609
+ 402: TrialLimitExceededError;
2610
+ /**
2611
+ * Unauthorized
2612
+ */
2613
+ 403: JobError;
2614
+ /**
2615
+ * Requested Resource Was Not Found
2616
+ */
2617
+ 404: JobError;
2618
+ /**
2619
+ * Unable to upload asset
2620
+ */
2621
+ 409: JobError;
2622
+ /**
2623
+ * Asset Link Invalid
2624
+ */
2625
+ 410: JobError;
2626
+ /**
2627
+ * Too many requests
2628
+ */
2629
+ 429: JobError;
2630
+ /**
2631
+ * Internal Server Error
2632
+ */
2633
+ 500: JobError;
2634
+ };
2635
+ type RemoveBackgroundAsyncError = RemoveBackgroundAsyncErrors[keyof RemoveBackgroundAsyncErrors];
2636
+ type RemoveBackgroundAsyncResponses = {
2637
+ /**
2638
+ * Success
2639
+ */
2640
+ 202: JobStatusLinkResponse;
2641
+ };
2642
+ type RemoveBackgroundAsyncResponse = RemoveBackgroundAsyncResponses[keyof RemoveBackgroundAsyncResponses];
2643
+ type RemoveBackgroundData = {
2644
+ body: RemoveBackgroundV2Request;
2645
+ headers: {
2646
+ /**
2647
+ * The bearer token for the user. This is the access token.
2648
+ */
2649
+ Authorization: string;
2650
+ /**
2651
+ * The API key/Client ID
2652
+ */
2653
+ 'x-api-key': string;
2654
+ /**
2655
+ * The content type of the request. The value is `application/json`.
2656
+ */
2657
+ 'Content-Type': string;
2658
+ };
2659
+ path?: never;
2660
+ query?: never;
2661
+ url: '/v2/remove-background';
2662
+ };
2663
+ type RemoveBackgroundErrors = {
2664
+ /**
2665
+ * Unauthorized
2666
+ */
2667
+ 401: JobError;
2668
+ /**
2669
+ * Forbidden
2670
+ */
2671
+ 403: JobError;
2672
+ /**
2673
+ * Too Many Requests
2674
+ */
2675
+ 429: JobError;
2676
+ /**
2677
+ * Internal Server Error
2678
+ */
2679
+ 500: JobError;
2680
+ };
2681
+ type RemoveBackgroundError = RemoveBackgroundErrors[keyof RemoveBackgroundErrors];
2682
+ type RemoveBackgroundResponses = {
2683
+ /**
2684
+ * Accepted
2685
+ */
2686
+ 202: JobLinkResponse;
2687
+ };
2688
+ type RemoveBackgroundResponse = RemoveBackgroundResponses[keyof RemoveBackgroundResponses];
2689
+ type FacadeJobStatusData = {
2690
+ body?: never;
2691
+ path: {
2692
+ /**
2693
+ * The job ID from the response of the Remove Background API call.
2694
+ */
2695
+ jobId: string;
2696
+ };
2697
+ query?: never;
2698
+ url: '/v2/status/{jobId}';
2699
+ };
2700
+ type FacadeJobStatusErrors = {
2701
+ /**
2702
+ * Bad Request
2703
+ */
2704
+ 400: JobError;
2705
+ /**
2706
+ * Requested Resource Was Not Found
2707
+ */
2708
+ 404: JobError;
2709
+ /**
2710
+ * Internal Server Error
2711
+ */
2712
+ 500: JobError;
2713
+ };
2714
+ type FacadeJobStatusError = FacadeJobStatusErrors[keyof FacadeJobStatusErrors];
2715
+ type FacadeJobStatusResponses = {
2716
+ /**
2717
+ * Success
2718
+ */
2719
+ 200: JobStatusPollPayload | JobStatusSucceededResponse;
2720
+ };
2721
+ type FacadeJobStatusResponse = FacadeJobStatusResponses[keyof FacadeJobStatusResponses];
2722
+ type CreateMaskAsyncData = {
2723
+ /**
2724
+ * The input image and the mask parameters
2725
+ */
2726
+ body: CreateMaskRequest;
2727
+ headers?: {
2728
+ /**
2729
+ * The IMS organization ID. This only needs to be sent if you want to receive the job status through Adobe I/O Events.
2730
+ */
2731
+ 'x-gw-ims-org-id'?: string;
2732
+ };
2733
+ path?: never;
2734
+ query?: never;
2735
+ url: '/sensei/mask';
2736
+ };
2737
+ type CreateMaskAsyncErrors = {
2738
+ /**
2739
+ * Input Validation Error
2740
+ */
2741
+ 400: InputValidationError;
2742
+ /**
2743
+ * Trial Limit Exceeded Error
2744
+ */
2745
+ 402: TrialLimitExceededError;
2746
+ /**
2747
+ * Unauthorized
2748
+ */
2749
+ 403: JobError;
2750
+ /**
2751
+ * Requested Resource Was Not Found
2752
+ */
2753
+ 404: JobError;
2754
+ /**
2755
+ * Unable to upload asset
2756
+ */
2757
+ 409: JobError;
2758
+ /**
2759
+ * Asset Link Invalid
2760
+ */
2761
+ 410: JobError;
2762
+ /**
2763
+ * Too many requests
2764
+ */
2765
+ 429: JobError;
2766
+ /**
2767
+ * Internal Server Error
2768
+ */
2769
+ 500: JobError;
2770
+ };
2771
+ type CreateMaskAsyncError = CreateMaskAsyncErrors[keyof CreateMaskAsyncErrors];
2772
+ type CreateMaskAsyncResponses = {
2773
+ /**
2774
+ * Success
2775
+ */
2776
+ 202: JobStatusLinkResponse;
2777
+ };
2778
+ type CreateMaskAsyncResponse = CreateMaskAsyncResponses[keyof CreateMaskAsyncResponses];
2779
+ type PsJobStatusData = {
2780
+ body?: never;
2781
+ headers?: {
2782
+ /**
2783
+ * The IMS organization ID. This only needs to be sent if you want to receive the job status through Adobe I/O Events.
2784
+ */
2785
+ 'x-gw-ims-org-id'?: string;
2786
+ };
2787
+ path: {
2788
+ /**
2789
+ * The job ID.
2790
+ */
2791
+ jobId: string;
2792
+ };
2793
+ query?: never;
2794
+ url: '/pie/psdService/status/{jobId}';
2795
+ };
2796
+ type PsJobStatusResponses = {
2797
+ /**
2798
+ * Job Status
2799
+ */
2800
+ 200: PsJobResponse;
2801
+ };
2802
+ type PsJobStatusResponse = PsJobStatusResponses[keyof PsJobStatusResponses];
2803
+ type GetDocumentManifestAsyncData = {
2804
+ /**
2805
+ * The PSD file with the layer information you want to extract.
2806
+ */
2807
+ body: DocumentManifestRequest;
2808
+ headers?: {
2809
+ /**
2810
+ * The IMS organization ID. This only needs to be sent if you want to receive the job status through Adobe I/O Events.
2811
+ */
2812
+ 'x-gw-ims-org-id'?: string;
2813
+ };
2814
+ path?: never;
2815
+ query?: never;
2816
+ url: '/pie/psdService/documentManifest';
2817
+ };
2818
+ type GetDocumentManifestAsyncErrors = {
2819
+ /**
2820
+ * Input Validation Error
2821
+ */
2822
+ 400: InputValidationError;
2823
+ /**
2824
+ * Trial Limit Exceeded Error
2825
+ */
2826
+ 402: TrialLimitExceededError;
2827
+ /**
2828
+ * Forbidden
2829
+ */
2830
+ 403: JobError;
2831
+ /**
2832
+ * Requested Resource Was Not Found
2833
+ */
2834
+ 404: JobError;
2835
+ /**
2836
+ * Internal Server Error
2837
+ */
2838
+ 500: JobError;
2839
+ };
2840
+ type GetDocumentManifestAsyncError = GetDocumentManifestAsyncErrors[keyof GetDocumentManifestAsyncErrors];
2841
+ type GetDocumentManifestAsyncResponses = {
2842
+ /**
2843
+ * Success
2844
+ */
2845
+ 202: JobStatusLinkResponse;
2846
+ };
2847
+ type GetDocumentManifestAsyncResponse = GetDocumentManifestAsyncResponses[keyof GetDocumentManifestAsyncResponses];
2848
+ type CreateDocumentAsyncData = {
2849
+ /**
2850
+ * The input psd file to create a new psd from
2851
+ */
2852
+ body: CreateDocumentRequest;
2853
+ headers?: {
2854
+ /**
2855
+ * The IMS organization ID. This only needs to be sent if you want to receive the job status through Adobe I/O Events.
2856
+ */
2857
+ 'x-gw-ims-org-id'?: string;
2858
+ };
2859
+ path?: never;
2860
+ query?: never;
2861
+ url: '/pie/psdService/documentCreate';
2862
+ };
2863
+ type CreateDocumentAsyncErrors = {
2864
+ /**
2865
+ * Input Validation Error
2866
+ */
2867
+ 400: InputValidationError;
2868
+ /**
2869
+ * Trial Limit Exceeded Error
2870
+ */
2871
+ 402: TrialLimitExceededError;
2872
+ /**
2873
+ * Forbidden
2874
+ */
2875
+ 403: JobError;
2876
+ /**
2877
+ * Requested Resource Was Not Found
2878
+ */
2879
+ 404: JobError;
2880
+ /**
2881
+ * Unable to upload asset
2882
+ */
2883
+ 409: JobError;
2884
+ /**
2885
+ * Asset Link Invalid
2886
+ */
2887
+ 410: JobError;
2888
+ /**
2889
+ * Internal Server Error
2890
+ */
2891
+ 500: JobError;
2892
+ };
2893
+ type CreateDocumentAsyncError = CreateDocumentAsyncErrors[keyof CreateDocumentAsyncErrors];
2894
+ type CreateDocumentAsyncResponses = {
2895
+ /**
2896
+ * Success
2897
+ */
2898
+ 202: JobStatusLinkResponse;
2899
+ };
2900
+ type CreateDocumentAsyncResponse = CreateDocumentAsyncResponses[keyof CreateDocumentAsyncResponses];
2901
+ type ModifyDocumentAsyncData = {
2902
+ /**
2903
+ * The input psd file to apply edits to and generate renditions and/or save as a new psd
2904
+ */
2905
+ body: ModifyDocumentRequest;
2906
+ headers?: {
2907
+ /**
2908
+ * The IMS organization ID. This only needs to be sent if you want to receive the job status through Adobe I/O Events.
2909
+ */
2910
+ 'x-gw-ims-org-id'?: string;
2911
+ };
2912
+ path?: never;
2913
+ query?: never;
2914
+ url: '/pie/psdService/documentOperations';
2915
+ };
2916
+ type ModifyDocumentAsyncErrors = {
2917
+ /**
2918
+ * Input Validation Error
2919
+ */
2920
+ 400: InputValidationError;
2921
+ /**
2922
+ * Trial Limit Exceeded Error
2923
+ */
2924
+ 402: TrialLimitExceededError;
2925
+ /**
2926
+ * Forbidden
2927
+ */
2928
+ 403: JobError;
2929
+ /**
2930
+ * Requested Resource Was Not Found
2931
+ */
2932
+ 404: JobError;
2933
+ /**
2934
+ * Unable to upload asset
2935
+ */
2936
+ 409: JobError;
2937
+ /**
2938
+ * Asset Link Invalid
2939
+ */
2940
+ 410: JobError;
2941
+ /**
2942
+ * Internal Server Error
2943
+ */
2944
+ 500: JobError;
2945
+ };
2946
+ type ModifyDocumentAsyncError = ModifyDocumentAsyncErrors[keyof ModifyDocumentAsyncErrors];
2947
+ type ModifyDocumentAsyncResponses = {
2948
+ /**
2949
+ * Success
2950
+ */
2951
+ 202: JobStatusLinkResponse;
2952
+ };
2953
+ type ModifyDocumentAsyncResponse = ModifyDocumentAsyncResponses[keyof ModifyDocumentAsyncResponses];
2954
+ type CreateRenditionAsyncData = {
2955
+ /**
2956
+ * The input psd file to create renditions from
2957
+ */
2958
+ body: CreateRenditionRequest;
2959
+ headers?: {
2960
+ /**
2961
+ * The IMS organization ID. This only needs to be sent if you want to receive the job status through Adobe I/O Events
2962
+ */
2963
+ 'x-gw-ims-org-id'?: string;
2964
+ };
2965
+ path?: never;
2966
+ query?: never;
2967
+ url: '/pie/psdService/renditionCreate';
2968
+ };
2969
+ type CreateRenditionAsyncErrors = {
2970
+ /**
2971
+ * Input Validation Error
2972
+ */
2973
+ 400: InputValidationError;
2974
+ /**
2975
+ * Trial Limit Exceeded Error
2976
+ */
2977
+ 402: TrialLimitExceededError;
2978
+ /**
2979
+ * Forbidden
2980
+ */
2981
+ 403: JobError;
2982
+ /**
2983
+ * Requested Resource Was Not Found
2984
+ */
2985
+ 404: JobError;
2986
+ /**
2987
+ * Unable to upload asset
2988
+ */
2989
+ 409: JobError;
2990
+ /**
2991
+ * Asset Link Invalid
2992
+ */
2993
+ 410: JobError;
2994
+ /**
2995
+ * Internal Server Error
2996
+ */
2997
+ 500: JobError;
2998
+ };
2999
+ type CreateRenditionAsyncError = CreateRenditionAsyncErrors[keyof CreateRenditionAsyncErrors];
3000
+ type CreateRenditionAsyncResponses = {
3001
+ /**
3002
+ * Success
3003
+ */
3004
+ 202: JobStatusLinkResponse;
3005
+ };
3006
+ type CreateRenditionAsyncResponse = CreateRenditionAsyncResponses[keyof CreateRenditionAsyncResponses];
3007
+ type ReplaceSmartObjectAsyncData = {
3008
+ /**
3009
+ * The input psd file to apply edits for replacing embedded smart object to and generate renditions and/or save as a new psd
3010
+ */
3011
+ body: ReplaceSmartObjectRequest;
3012
+ headers?: {
3013
+ /**
3014
+ * The IMS organization ID. This only needs to be sent if you want to receive the job status through Adobe I/O Events
3015
+ */
3016
+ 'x-gw-ims-org-id'?: string;
3017
+ };
3018
+ path?: never;
3019
+ query?: never;
3020
+ url: '/pie/psdService/smartObject';
3021
+ };
3022
+ type ReplaceSmartObjectAsyncErrors = {
3023
+ /**
3024
+ * Input Validation Error
3025
+ */
3026
+ 400: InputValidationError;
3027
+ /**
3028
+ * Trial Limit Exceeded Error
3029
+ */
3030
+ 402: TrialLimitExceededError;
3031
+ /**
3032
+ * Forbidden
3033
+ */
3034
+ 403: JobError;
3035
+ /**
3036
+ * Requested Resource Was Not Found
3037
+ */
3038
+ 404: JobError;
3039
+ /**
3040
+ * Unable to upload asset
3041
+ */
3042
+ 409: JobError;
3043
+ /**
3044
+ * Asset Link Invalid
3045
+ */
3046
+ 410: JobError;
3047
+ /**
3048
+ * Internal Server Error
3049
+ */
3050
+ 500: JobError;
3051
+ };
3052
+ type ReplaceSmartObjectAsyncError = ReplaceSmartObjectAsyncErrors[keyof ReplaceSmartObjectAsyncErrors];
3053
+ type ReplaceSmartObjectAsyncResponses = {
3054
+ /**
3055
+ * Success
3056
+ */
3057
+ 202: JobStatusLinkResponse;
3058
+ };
3059
+ type ReplaceSmartObjectAsyncResponse = ReplaceSmartObjectAsyncResponses[keyof ReplaceSmartObjectAsyncResponses];
3060
+ type PlayPhotoshopActionsAsyncData = {
3061
+ /**
3062
+ * The input file to apply Photoshop Actions to and generate renditions and/or save as a new image
3063
+ */
3064
+ body: PlayPhotoshopActionsRequest;
3065
+ headers?: {
3066
+ /**
3067
+ * The IMS organization ID. This only needs to be sent if you want to receive the job status through Adobe I/O Events
3068
+ */
3069
+ 'x-gw-ims-org-id'?: string;
3070
+ };
3071
+ path?: never;
3072
+ query?: never;
3073
+ url: '/pie/psdService/photoshopActions';
3074
+ };
3075
+ type PlayPhotoshopActionsAsyncErrors = {
3076
+ /**
3077
+ * Input Validation Error
3078
+ */
3079
+ 400: InputValidationError;
3080
+ /**
3081
+ * Trial Limit Exceeded Error
3082
+ */
3083
+ 402: TrialLimitExceededError;
3084
+ /**
3085
+ * Forbidden
3086
+ */
3087
+ 403: JobError;
3088
+ /**
3089
+ * Requested Resource Was Not Found
3090
+ */
3091
+ 404: JobError;
3092
+ /**
3093
+ * Unable to upload asset
3094
+ */
3095
+ 409: JobError;
3096
+ /**
3097
+ * Asset Link Invalid
3098
+ */
3099
+ 410: JobError;
3100
+ /**
3101
+ * Internal Server Error
3102
+ */
3103
+ 500: JobError;
3104
+ };
3105
+ type PlayPhotoshopActionsAsyncError = PlayPhotoshopActionsAsyncErrors[keyof PlayPhotoshopActionsAsyncErrors];
3106
+ type PlayPhotoshopActionsAsyncResponses = {
3107
+ /**
3108
+ * Success
3109
+ */
3110
+ 202: JobStatusLinkResponse;
3111
+ };
3112
+ type PlayPhotoshopActionsAsyncResponse = PlayPhotoshopActionsAsyncResponses[keyof PlayPhotoshopActionsAsyncResponses];
3113
+ type PlayPhotoshopActionsJsonAsyncData = {
3114
+ /**
3115
+ * The input psd file to apply Photoshop actionJSON to and generate renditions and/or save as a new image
3116
+ */
3117
+ body: PlayPhotoshopActionsJsonRequest;
3118
+ headers?: {
3119
+ /**
3120
+ * The IMS organization ID. This only needs to be sent if you want to receive the job status through Adobe I/O Events
3121
+ */
3122
+ 'x-gw-ims-org-id'?: string;
3123
+ };
3124
+ path?: never;
3125
+ query?: never;
3126
+ url: '/pie/psdService/actionJSON';
3127
+ };
3128
+ type PlayPhotoshopActionsJsonAsyncErrors = {
3129
+ /**
3130
+ * Input Validation Error
3131
+ */
3132
+ 400: InputValidationError;
3133
+ /**
3134
+ * Trial Limit Exceeded Error
3135
+ */
3136
+ 402: TrialLimitExceededError;
3137
+ /**
3138
+ * Forbidden
3139
+ */
3140
+ 403: JobError;
3141
+ /**
3142
+ * Requested Resource Was Not Found
3143
+ */
3144
+ 404: JobError;
3145
+ /**
3146
+ * Unable to upload asset
3147
+ */
3148
+ 409: JobError;
3149
+ /**
3150
+ * Asset Link Invalid
3151
+ */
3152
+ 410: JobError;
3153
+ /**
3154
+ * Too many requests
3155
+ */
3156
+ 429: JobError;
3157
+ /**
3158
+ * Internal Server Error
3159
+ */
3160
+ 500: JobError;
3161
+ };
3162
+ type PlayPhotoshopActionsJsonAsyncError = PlayPhotoshopActionsJsonAsyncErrors[keyof PlayPhotoshopActionsJsonAsyncErrors];
3163
+ type PlayPhotoshopActionsJsonAsyncResponses = {
3164
+ /**
3165
+ * Success
3166
+ */
3167
+ 202: JobStatusLinkResponse;
3168
+ };
3169
+ type PlayPhotoshopActionsJsonAsyncResponse = PlayPhotoshopActionsJsonAsyncResponses[keyof PlayPhotoshopActionsJsonAsyncResponses];
3170
+ type ConvertToActionsJsonAsyncData = {
3171
+ /**
3172
+ * The input ATN file to convert to actionJSON.
3173
+ */
3174
+ body: ConvertToActionsJsonRequest;
3175
+ headers?: {
3176
+ /**
3177
+ * The IMS organization ID. This only needs to be sent if you want to receive the job status through Adobe I/O Events
3178
+ */
3179
+ 'x-gw-ims-org-id'?: string;
3180
+ };
3181
+ path?: never;
3182
+ query?: never;
3183
+ url: '/pie/psdService/actionJsonCreate';
3184
+ };
3185
+ type ConvertToActionsJsonAsyncErrors = {
3186
+ /**
3187
+ * Input Validation Error
3188
+ */
3189
+ 400: InputValidationError;
3190
+ /**
3191
+ * Trial Limit Exceeded Error
3192
+ */
3193
+ 402: TrialLimitExceededError;
3194
+ /**
3195
+ * Forbidden
3196
+ */
3197
+ 403: JobError;
3198
+ /**
3199
+ * Requested Resource Was Not Found
3200
+ */
3201
+ 404: JobError;
3202
+ /**
3203
+ * Asset Link Invalid
3204
+ */
3205
+ 410: JobError;
3206
+ /**
3207
+ * Internal Server Error
3208
+ */
3209
+ 500: JobError;
3210
+ };
3211
+ type ConvertToActionsJsonAsyncError = ConvertToActionsJsonAsyncErrors[keyof ConvertToActionsJsonAsyncErrors];
3212
+ type ConvertToActionsJsonAsyncResponses = {
3213
+ /**
3214
+ * Success
3215
+ */
3216
+ 202: JobStatusLinkResponse;
3217
+ };
3218
+ type ConvertToActionsJsonAsyncResponse = ConvertToActionsJsonAsyncResponses[keyof ConvertToActionsJsonAsyncResponses];
3219
+ type ApplyAutoCropAsyncData = {
3220
+ /**
3221
+ * The input image to apply product crop to.
3222
+ */
3223
+ body: ApplyAutoCropRequest;
3224
+ headers?: {
3225
+ /**
3226
+ * The IMS organization ID. This only needs to be sent if you want to receive the job status through Adobe I/O Events
3227
+ */
3228
+ 'x-gw-ims-org-id'?: string;
3229
+ };
3230
+ path?: never;
3231
+ query?: never;
3232
+ url: '/pie/psdService/productCrop';
3233
+ };
3234
+ type ApplyAutoCropAsyncErrors = {
3235
+ /**
3236
+ * Input Validation Error
3237
+ */
3238
+ 400: InputValidationError;
3239
+ /**
3240
+ * Trial Limit Exceeded Error
3241
+ */
3242
+ 402: TrialLimitExceededError;
3243
+ /**
3244
+ * Forbidden
3245
+ */
3246
+ 403: JobError;
3247
+ /**
3248
+ * Requested Resource Was Not Found
3249
+ */
3250
+ 404: JobError;
3251
+ /**
3252
+ * Unable to upload asset
3253
+ */
3254
+ 409: JobError;
3255
+ /**
3256
+ * Asset Link Invalid
3257
+ */
3258
+ 410: JobError;
3259
+ /**
3260
+ * Too many requests
3261
+ */
3262
+ 429: JobError;
3263
+ /**
3264
+ * Internal Server Error
3265
+ */
3266
+ 500: JobError;
3267
+ };
3268
+ type ApplyAutoCropAsyncError = ApplyAutoCropAsyncErrors[keyof ApplyAutoCropAsyncErrors];
3269
+ type ApplyAutoCropAsyncResponses = {
3270
+ /**
3271
+ * Success
3272
+ */
3273
+ 202: JobStatusLinkResponse;
3274
+ };
3275
+ type ApplyAutoCropAsyncResponse = ApplyAutoCropAsyncResponses[keyof ApplyAutoCropAsyncResponses];
3276
+ type ApplyDepthBlurAsyncData = {
3277
+ /**
3278
+ * The input image to apply depth blur to.
3279
+ */
3280
+ body: ApplyDepthBlurRequest;
3281
+ headers?: {
3282
+ /**
3283
+ * The IMS organization ID. This only needs to be sent if you want to receive the job status through Adobe I/O Events.
3284
+ */
3285
+ 'x-gw-ims-org-id'?: string;
3286
+ };
3287
+ path?: never;
3288
+ query?: never;
3289
+ url: '/pie/psdService/depthBlur';
3290
+ };
3291
+ type ApplyDepthBlurAsyncErrors = {
3292
+ /**
3293
+ * Input Validation Error
3294
+ */
3295
+ 400: InputValidationError;
3296
+ /**
3297
+ * Trial Limit Exceeded Error
3298
+ */
3299
+ 402: TrialLimitExceededError;
3300
+ /**
3301
+ * Forbidden
3302
+ */
3303
+ 403: JobError;
3304
+ /**
3305
+ * Requested Resource Was Not Found
3306
+ */
3307
+ 404: JobError;
3308
+ /**
3309
+ * Unable to upload asset
3310
+ */
3311
+ 409: JobError;
3312
+ /**
3313
+ * Asset Link Invalid
3314
+ */
3315
+ 410: JobError;
3316
+ /**
3317
+ * Too many requests
3318
+ */
3319
+ 429: JobError;
3320
+ /**
3321
+ * Internal Server Error
3322
+ */
3323
+ 500: JobError;
3324
+ };
3325
+ type ApplyDepthBlurAsyncError = ApplyDepthBlurAsyncErrors[keyof ApplyDepthBlurAsyncErrors];
3326
+ type ApplyDepthBlurAsyncResponses = {
3327
+ /**
3328
+ * Success
3329
+ */
3330
+ 202: JobStatusLinkResponse;
3331
+ };
3332
+ type ApplyDepthBlurAsyncResponse = ApplyDepthBlurAsyncResponses[keyof ApplyDepthBlurAsyncResponses];
3333
+ type EditTextLayerAsyncData = {
3334
+ /**
3335
+ * The input text to be edited.
3336
+ */
3337
+ body: EditTextLayerRequest;
3338
+ headers?: {
3339
+ /**
3340
+ * The IMS organization ID. This only needs to be sent if you want to receive the job status through Adobe I/O Events
3341
+ */
3342
+ 'x-gw-ims-org-id'?: string;
3343
+ };
3344
+ path?: never;
3345
+ query?: never;
3346
+ url: '/pie/psdService/text';
3347
+ };
3348
+ type EditTextLayerAsyncErrors = {
3349
+ /**
3350
+ * Input Validation Error
3351
+ */
3352
+ 400: InputValidationError;
3353
+ /**
3354
+ * Trial Limit Exceeded Error
3355
+ */
3356
+ 402: TrialLimitExceededError;
3357
+ /**
3358
+ * Forbidden
3359
+ */
3360
+ 403: JobError;
3361
+ /**
3362
+ * Requested Resource Was Not Found
3363
+ */
3364
+ 404: JobError;
3365
+ /**
3366
+ * Unable to upload asset
3367
+ */
3368
+ 409: JobError;
3369
+ /**
3370
+ * Asset Link Invalid
3371
+ */
3372
+ 410: JobError;
3373
+ /**
3374
+ * Too many requests
3375
+ */
3376
+ 429: JobError;
3377
+ /**
3378
+ * Internal Server Error
3379
+ */
3380
+ 500: JobError;
3381
+ };
3382
+ type EditTextLayerAsyncError = EditTextLayerAsyncErrors[keyof EditTextLayerAsyncErrors];
3383
+ type EditTextLayerAsyncResponses = {
3384
+ /**
3385
+ * success
3386
+ */
3387
+ 202: JobStatusLinkResponse;
3388
+ };
3389
+ type EditTextLayerAsyncResponse = EditTextLayerAsyncResponses[keyof EditTextLayerAsyncResponses];
3390
+ type CreateArtboardAsyncData = {
3391
+ /**
3392
+ * The input artboard to be created.
3393
+ */
3394
+ body: CreateArtboardRequest;
3395
+ headers?: {
3396
+ /**
3397
+ * The IMS organization ID. This only needs to be sent if you want to receive the job status through Adobe I/O Events
3398
+ */
3399
+ 'x-gw-ims-org-id'?: string;
3400
+ };
3401
+ path?: never;
3402
+ query?: never;
3403
+ url: '/pie/psdService/artboardCreate';
3404
+ };
3405
+ type CreateArtboardAsyncErrors = {
3406
+ /**
3407
+ * Input Validation Error
3408
+ */
3409
+ 400: InputValidationError;
3410
+ /**
3411
+ * Trial Limit Exceeded Error
3412
+ */
3413
+ 402: TrialLimitExceededError;
3414
+ /**
3415
+ * Forbidden
3416
+ */
3417
+ 403: JobError;
3418
+ /**
3419
+ * Requested Resource Was Not Found
3420
+ */
3421
+ 404: JobError;
3422
+ /**
3423
+ * Unable to upload asset
3424
+ */
3425
+ 409: JobError;
3426
+ /**
3427
+ * Asset Link Invalid
3428
+ */
3429
+ 410: JobError;
3430
+ /**
3431
+ * Internal Server Error
3432
+ */
3433
+ 500: JobError;
3434
+ };
3435
+ type CreateArtboardAsyncError = CreateArtboardAsyncErrors[keyof CreateArtboardAsyncErrors];
3436
+ type CreateArtboardAsyncResponses = {
3437
+ /**
3438
+ * success
3439
+ */
3440
+ 202: JobStatusLinkResponse;
3441
+ };
3442
+ type CreateArtboardAsyncResponse = CreateArtboardAsyncResponses[keyof CreateArtboardAsyncResponses];
3443
+ type MaskObjectsData = {
3444
+ body: MaskObjectsRequest;
3445
+ path?: never;
3446
+ query?: never;
3447
+ url: '/v1/mask-objects';
3448
+ };
3449
+ type MaskObjectsErrors = {
3450
+ /**
3451
+ * Bad Request
3452
+ */
3453
+ 400: InputValidationError;
3454
+ /**
3455
+ * Unauthorized
3456
+ */
3457
+ 401: InputValidationError;
3458
+ /**
3459
+ * Forbidden
3460
+ */
3461
+ 403: InputValidationError;
3462
+ /**
3463
+ * Resource Not Found
3464
+ */
3465
+ 404: InputValidationError;
3466
+ /**
3467
+ * Too Many Requests
3468
+ */
3469
+ 429: InputValidationError;
3470
+ /**
3471
+ * Internal Server Error
3472
+ */
3473
+ 500: JobError;
3474
+ };
3475
+ type MaskObjectsError = MaskObjectsErrors[keyof MaskObjectsErrors];
3476
+ type MaskObjectsResponses = {
3477
+ /**
3478
+ * Accepted
3479
+ */
3480
+ 202: JobLinkResponse;
3481
+ };
3482
+ type MaskObjectsResponse = MaskObjectsResponses[keyof MaskObjectsResponses];
3483
+ type MaskBodyPartsData = {
3484
+ body: MaskBodyPartsRequest;
3485
+ path?: never;
3486
+ query?: never;
3487
+ url: '/v1/mask-body-parts';
3488
+ };
3489
+ type MaskBodyPartsErrors = {
3490
+ /**
3491
+ * Bad Request
3492
+ */
3493
+ 400: InputValidationError;
3494
+ /**
3495
+ * Unauthorized
3496
+ */
3497
+ 401: InputValidationError;
3498
+ /**
3499
+ * Forbidden
3500
+ */
3501
+ 403: InputValidationError;
3502
+ /**
3503
+ * Resource Not Found
3504
+ */
3505
+ 404: InputValidationError;
3506
+ /**
3507
+ * Too Many Requests
3508
+ */
3509
+ 429: InputValidationError;
3510
+ /**
3511
+ * Internal Server Error
3512
+ */
3513
+ 500: JobError;
3514
+ };
3515
+ type MaskBodyPartsError = MaskBodyPartsErrors[keyof MaskBodyPartsErrors];
3516
+ type MaskBodyPartsResponses = {
3517
+ /**
3518
+ * Accepted
3519
+ */
3520
+ 202: JobLinkResponse;
3521
+ };
3522
+ type MaskBodyPartsResponse = MaskBodyPartsResponses[keyof MaskBodyPartsResponses];
3523
+ type RefineMaskData = {
3524
+ body: RefineMaskRequest;
3525
+ path?: never;
3526
+ query?: never;
3527
+ url: '/v1/refine-mask';
3528
+ };
3529
+ type RefineMaskErrors = {
3530
+ /**
3531
+ * Bad Request
3532
+ */
3533
+ 400: InputValidationError;
3534
+ /**
3535
+ * Unauthorized
3536
+ */
3537
+ 401: InputValidationError;
3538
+ /**
3539
+ * Forbidden
3540
+ */
3541
+ 403: InputValidationError;
3542
+ /**
3543
+ * Resource Not Found
3544
+ */
3545
+ 404: InputValidationError;
3546
+ /**
3547
+ * Too Many Requests
3548
+ */
3549
+ 429: InputValidationError;
3550
+ /**
3551
+ * Internal Server Error
3552
+ */
3553
+ 500: JobError;
3554
+ };
3555
+ type RefineMaskError = RefineMaskErrors[keyof RefineMaskErrors];
3556
+ type RefineMaskResponses = {
3557
+ /**
3558
+ * Accepted
3559
+ */
3560
+ 202: JobLinkResponse;
3561
+ };
3562
+ type RefineMaskResponse = RefineMaskResponses[keyof RefineMaskResponses];
3563
+ type FillMaskedAreasData = {
3564
+ body: FillMaskedAreasRequest;
3565
+ path?: never;
3566
+ query?: never;
3567
+ url: '/v1/fill-masked-areas';
3568
+ };
3569
+ type FillMaskedAreasErrors = {
3570
+ /**
3571
+ * Bad Request
3572
+ */
3573
+ 400: InputValidationError;
3574
+ /**
3575
+ * Unauthorized
3576
+ */
3577
+ 401: InputValidationError;
3578
+ /**
3579
+ * Forbidden
3580
+ */
3581
+ 403: InputValidationError;
3582
+ /**
3583
+ * Resource Not Found
3584
+ */
3585
+ 404: InputValidationError;
3586
+ /**
3587
+ * Too Many Requests
3588
+ */
3589
+ 429: InputValidationError;
3590
+ /**
3591
+ * Internal Server Error
3592
+ */
3593
+ 500: JobError;
3594
+ };
3595
+ type FillMaskedAreasError = FillMaskedAreasErrors[keyof FillMaskedAreasErrors];
3596
+ type FillMaskedAreasResponses = {
3597
+ /**
3598
+ * Accepted
3599
+ */
3600
+ 202: JobLinkResponse;
3601
+ };
3602
+ type FillMaskedAreasResponse = FillMaskedAreasResponses[keyof FillMaskedAreasResponses];
3603
+ type GetJobStatusData = {
3604
+ body?: never;
3605
+ path: {
3606
+ jobId: string;
3607
+ };
3608
+ query?: never;
3609
+ url: '/v1/status/{jobId}';
3610
+ };
3611
+ type GetJobStatusErrors = {
3612
+ /**
3613
+ * Internal Server Error
3614
+ */
3615
+ 500: JobError;
3616
+ };
3617
+ type GetJobStatusError = GetJobStatusErrors[keyof GetJobStatusErrors];
3618
+ type GetJobStatusResponses = {
3619
+ /**
3620
+ * The schema of a 200 response varies depending on the status of the job. A job with a `succeeded` status will include the results in the response. Result objects vary depending on the operation.
3621
+ */
3622
+ 200: ({
3623
+ status: 'not_started';
3624
+ } & JobStatusNotStarted) | ({
3625
+ status: 'running';
3626
+ } & JobStatusRunning) | ({
3627
+ status: 'succeeded';
3628
+ } & JobStatusSucceeded) | ({
3629
+ status: 'failed';
3630
+ } & JobStatusFailed);
3631
+ };
3632
+ type GetJobStatusResponse = GetJobStatusResponses[keyof GetJobStatusResponses];
3633
+ //#endregion
3634
+ //#region packages/photoshop/src/flat/sdk.gen.d.ts
3635
+ type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options$1<TData, ThrowOnError> & {
3636
+ /**
3637
+ * You can provide a client instance returned by `createClient()` instead of
3638
+ * individual options. This might be also useful if you want to implement a
3639
+ * custom client.
3640
+ */
3641
+ client?: Client;
3642
+ /**
3643
+ * You can pass arbitrary values through the `meta` object. This can be
3644
+ * used to access values that aren't defined as part of the SDK function.
3645
+ */
3646
+ meta?: Record<string, unknown>;
3647
+ };
3648
+ /**
3649
+ * Get status - mask
3650
+ *
3651
+ * This endpoint returns the status of a job for a Remove Background and Create Mask operation. The schema of a 200 response varies depending on the status of the job.
3652
+ */
3653
+ declare const senseiJobStatus: <ThrowOnError extends boolean = false>(options: Options<SenseiJobStatusData, ThrowOnError>) => RequestResult<SenseiJobStatusResponses, unknown, ThrowOnError, "fields">;
3654
+ /**
3655
+ * Remove background v1 (Deprecated)
3656
+ *
3657
+ * ⚠️ **DEPRECATED**: This endpoint is deprecated and will no longer be accessible after Oct 15, 2025. Use `/v2/remove-background` instead. For more information, see the [Deprecation Announcement](https://developer.adobe.com/firefly-services/docs/photoshop/getting_started/deprecation_announcement/). This endpoint will identify the main subject of your image and removes the background automatically. It also provides options to return a PNG file in 4 channel RGBA or 3 channel RGB format. To check the status of this process, utilize the `Get Status - Mask` endpoint.
3658
+ *
3659
+ * @deprecated
3660
+ */
3661
+ declare const removeBackgroundAsync: <ThrowOnError extends boolean = false>(options: Options<RemoveBackgroundAsyncData, ThrowOnError>) => RequestResult<RemoveBackgroundAsyncResponses, RemoveBackgroundAsyncErrors, ThrowOnError, "fields">;
3662
+ /**
3663
+ * Remove background v2
3664
+ *
3665
+ * This endpoint allows you to remove the background from an image. The request is processed asynchronously and the status of the running job can be checked with the Get Status endpoint.
3666
+ */
3667
+ declare const removeBackground: <ThrowOnError extends boolean = false>(options: Options<RemoveBackgroundData, ThrowOnError>) => RequestResult<RemoveBackgroundResponses, RemoveBackgroundErrors, ThrowOnError, "fields">;
3668
+ /**
3669
+ * Get status - v2
3670
+ *
3671
+ * Retrieve the status of a running Remove Background job by providing the job ID. The job ID is obtained from the response of the asynchronous Remove Background API call.
3672
+ */
3673
+ declare const facadeJobStatus: <ThrowOnError extends boolean = false>(options: Options<FacadeJobStatusData, ThrowOnError>) => RequestResult<FacadeJobStatusResponses, FacadeJobStatusErrors, ThrowOnError, "fields">;
3674
+ /**
3675
+ * Create mask
3676
+ *
3677
+ * ⚠️ **DEPRECATED**: This endpoint is deprecated and will no longer be accessible after Oct 15, 2025. Use `/v2/remove-background` instead. For more information, see the [Deprecation Announcement](https://developer.adobe.com/firefly-services/docs/photoshop/getting_started/deprecation_announcement/).This endpoint uses the Remove Background AI/ML model to return a PNG file with a mask applied around the subject. To check the status of this process, utilize the `Get Status - Mask` endpoint.
3678
+ *
3679
+ * @deprecated
3680
+ */
3681
+ declare const createMaskAsync: <ThrowOnError extends boolean = false>(options: Options<CreateMaskAsyncData, ThrowOnError>) => RequestResult<CreateMaskAsyncResponses, CreateMaskAsyncErrors, ThrowOnError, "fields">;
3682
+ /**
3683
+ * Get status
3684
+ *
3685
+ * Get the job status of a Photoshop job.
3686
+ */
3687
+ declare const psJobStatus: <ThrowOnError extends boolean = false>(options: Options<PsJobStatusData, ThrowOnError>) => RequestResult<PsJobStatusResponses, unknown, ThrowOnError, "fields">;
3688
+ /**
3689
+ * Extract document manifest
3690
+ *
3691
+ * Extract metadata from PSD document, including general file and layer information.
3692
+ */
3693
+ declare const getDocumentManifestAsync: <ThrowOnError extends boolean = false>(options: Options<GetDocumentManifestAsyncData, ThrowOnError>) => RequestResult<GetDocumentManifestAsyncResponses, GetDocumentManifestAsyncErrors, ThrowOnError, "fields">;
3694
+ /**
3695
+ * Create PSD
3696
+ *
3697
+ * Create new PSD with layers.
3698
+ */
3699
+ declare const createDocumentAsync: <ThrowOnError extends boolean = false>(options: Options<CreateDocumentAsyncData, ThrowOnError>) => RequestResult<CreateDocumentAsyncResponses, CreateDocumentAsyncErrors, ThrowOnError, "fields">;
3700
+ /**
3701
+ * Apply photoshop edits
3702
+ *
3703
+ * Apply basic layer edits (name, state, etc.), add/edit adjustment, pixel, and shape layers.
3704
+ */
3705
+ declare const modifyDocumentAsync: <ThrowOnError extends boolean = false>(options: Options<ModifyDocumentAsyncData, ThrowOnError>) => RequestResult<ModifyDocumentAsyncResponses, ModifyDocumentAsyncErrors, ThrowOnError, "fields">;
3706
+ /**
3707
+ * Create renditions
3708
+ *
3709
+ * Create flat image representations of a PSD in multiple formats.
3710
+ */
3711
+ declare const createRenditionAsync: <ThrowOnError extends boolean = false>(options: Options<CreateRenditionAsyncData, ThrowOnError>) => RequestResult<CreateRenditionAsyncResponses, CreateRenditionAsyncErrors, ThrowOnError, "fields">;
3712
+ /**
3713
+ * Replace smart object
3714
+ *
3715
+ * Replace Smart Object in a PSD.
3716
+ */
3717
+ declare const replaceSmartObjectAsync: <ThrowOnError extends boolean = false>(options: Options<ReplaceSmartObjectAsyncData, ThrowOnError>) => RequestResult<ReplaceSmartObjectAsyncResponses, ReplaceSmartObjectAsyncErrors, ThrowOnError, "fields">;
3718
+ /**
3719
+ * Run photoshop actions
3720
+ *
3721
+ * Executes Photoshop Action file against a PSD, JPEG, PNG, or TIFF.
3722
+ */
3723
+ declare const playPhotoshopActionsAsync: <ThrowOnError extends boolean = false>(options: Options<PlayPhotoshopActionsAsyncData, ThrowOnError>) => RequestResult<PlayPhotoshopActionsAsyncResponses, PlayPhotoshopActionsAsyncErrors, ThrowOnError, "fields">;
3724
+ /**
3725
+ * Run actionJSON
3726
+ *
3727
+ * Execute given Photoshop Action specified in actionJSON format.
3728
+ */
3729
+ declare const playPhotoshopActionsJsonAsync: <ThrowOnError extends boolean = false>(options: Options<PlayPhotoshopActionsJsonAsyncData, ThrowOnError>) => RequestResult<PlayPhotoshopActionsJsonAsyncResponses, PlayPhotoshopActionsJsonAsyncErrors, ThrowOnError, "fields">;
3730
+ /**
3731
+ * Convert to actionJSON
3732
+ *
3733
+ * Convert an ATN file to actionJSON format.
3734
+ */
3735
+ declare const convertToActionsJsonAsync: <ThrowOnError extends boolean = false>(options: Options<ConvertToActionsJsonAsyncData, ThrowOnError>) => RequestResult<ConvertToActionsJsonAsyncResponses, ConvertToActionsJsonAsyncErrors, ThrowOnError, "fields">;
3736
+ /**
3737
+ * Product crop
3738
+ *
3739
+ * This endpoint identifies the subject of the input file and automatically crops the image to keep the subject in the center. Check the status of this process with the `Get Status` endpoint.
3740
+ */
3741
+ declare const applyAutoCropAsync: <ThrowOnError extends boolean = false>(options: Options<ApplyAutoCropAsyncData, ThrowOnError>) => RequestResult<ApplyAutoCropAsyncResponses, ApplyAutoCropAsyncErrors, ThrowOnError, "fields">;
3742
+ /**
3743
+ * Depth blur
3744
+ *
3745
+ * Apply depth blur to an image input.
3746
+ */
3747
+ declare const applyDepthBlurAsync: <ThrowOnError extends boolean = false>(options: Options<ApplyDepthBlurAsyncData, ThrowOnError>) => RequestResult<ApplyDepthBlurAsyncResponses, ApplyDepthBlurAsyncErrors, ThrowOnError, "fields">;
3748
+ /**
3749
+ * Edit text layer
3750
+ *
3751
+ * Change the contents of a text layer in a PSD, e.g. for localization.
3752
+ */
3753
+ declare const editTextLayerAsync: <ThrowOnError extends boolean = false>(options: Options<EditTextLayerAsyncData, ThrowOnError>) => RequestResult<EditTextLayerAsyncResponses, EditTextLayerAsyncErrors, ThrowOnError, "fields">;
3754
+ /**
3755
+ * Create artboards
3756
+ *
3757
+ * Create artboards from multiple PSD inputs.
3758
+ */
3759
+ declare const createArtboardAsync: <ThrowOnError extends boolean = false>(options: Options<CreateArtboardAsyncData, ThrowOnError>) => RequestResult<CreateArtboardAsyncResponses, CreateArtboardAsyncErrors, ThrowOnError, "fields">;
3760
+ /**
3761
+ * Generate object and background masks
3762
+ *
3763
+ * Given an image, this API generates semantic masks for the foreground objects and a list of background masks that segment the background elements of the image. Each mask includes a label and a URL for the mask image. To check the status of this process, utilize the `Get Status - V1` endpoint.
3764
+ */
3765
+ declare const maskObjects: <ThrowOnError extends boolean = false>(options: Options<MaskObjectsData, ThrowOnError>) => RequestResult<MaskObjectsResponses, MaskObjectsErrors, ThrowOnError, "fields">;
3766
+ /**
3767
+ * Generate human item masks
3768
+ *
3769
+ * This endpoint processes an input image of a human, then identifies and creates masks for various items and sections on the body including sunglasses, hats, upper body apparel, lower body apparel, left arm, right arm, and more. The API returns an array of masks corresponding to each detected item and body part. To check the status of this process, utilize the `Get Status - V1` endpoint.
3770
+ */
3771
+ declare const maskBodyParts: <ThrowOnError extends boolean = false>(options: Options<MaskBodyPartsData, ThrowOnError>) => RequestResult<MaskBodyPartsResponses, MaskBodyPartsErrors, ThrowOnError, "fields">;
3772
+ /**
3773
+ * Refine mask
3774
+ *
3775
+ * This endpoint allows you to refine and improve the quality of existing masks. The API will enhance the edges and details of the provided masks to create more precise and accurate results. To check the status of this process, utilize the `Get Status - V1` endpoint.
3776
+ */
3777
+ declare const refineMask: <ThrowOnError extends boolean = false>(options: Options<RefineMaskData, ThrowOnError>) => RequestResult<RefineMaskResponses, RefineMaskErrors, ThrowOnError, "fields">;
3778
+ /**
3779
+ * Fill masked areas
3780
+ *
3781
+ * This endpoint allows you to inpaint masked areas within an image. The API will remove the objects represented by these masks and inpaint the specified areas. Provide a list of masks corresponding to the regions you wish to modify. To check the status of this process, utilize the `Get Status - V1` endpoint.
3782
+ */
3783
+ declare const fillMaskedAreas: <ThrowOnError extends boolean = false>(options: Options<FillMaskedAreasData, ThrowOnError>) => RequestResult<FillMaskedAreasResponses, FillMaskedAreasErrors, ThrowOnError, "fields">;
3784
+ /**
3785
+ * Get status - v1
3786
+ *
3787
+ * This endpoint allows you to check the status of an asynchronous job for a masking operation. The schema of a 200 response varies depending on the status of the job. A job with a `succeeded` status will include the results in the response and the result objects vary depending on the operation.
3788
+ */
3789
+ declare const getJobStatus: <ThrowOnError extends boolean = false>(options: Options<GetJobStatusData, ThrowOnError>) => RequestResult<GetJobStatusResponses, GetJobStatusErrors, ThrowOnError, "fields">;
3790
+ //#endregion
3791
+ export { type Action, type ActionDetails, type ActionJsonCreateOptions, type ActionJsonOptions, type ActionOptions, type ActionOutputDetails, type AdjustmentDetails, type AlignmentType, type AntiAliasType, type ApplyAutoCropAsyncData, type ApplyAutoCropAsyncError, type ApplyAutoCropAsyncErrors, type ApplyAutoCropAsyncResponse, type ApplyAutoCropAsyncResponses, type ApplyAutoCropRequest, type ApplyDepthBlurAsyncData, type ApplyDepthBlurAsyncError, type ApplyDepthBlurAsyncErrors, type ApplyDepthBlurAsyncResponse, type ApplyDepthBlurAsyncResponses, type ApplyDepthBlurRequest, type ArtboardDetails, type AutoKernType, type BasedOnType, type BaselineType, type BlendDetails, type BlendModeType, type Bounds, type BrightnessContrast, type CanvasSize, type ChannelDetails, type ChannelModeType, type ChannelType, type CharacterStyleDetails, type ChildrenLayerDetails, type ClientOptions, type ColorBalance, type ColorDetails, type ColorProfileType, type ColorSpaceType, type CompressionType, type ConvertToActionsJsonAsyncData, type ConvertToActionsJsonAsyncError, type ConvertToActionsJsonAsyncErrors, type ConvertToActionsJsonAsyncResponse, type ConvertToActionsJsonAsyncResponses, type ConvertToActionsJsonRequest, type CreateArtboardAsyncData, type CreateArtboardAsyncError, type CreateArtboardAsyncErrors, type CreateArtboardAsyncResponse, type CreateArtboardAsyncResponses, type CreateArtboardRequest, type CreateDocumentAsyncData, type CreateDocumentAsyncError, type CreateDocumentAsyncErrors, type CreateDocumentAsyncResponse, type CreateDocumentAsyncResponses, type CreateDocumentRequest, type CreateMaskAsyncData, type CreateMaskAsyncError, type CreateMaskAsyncErrors, type CreateMaskAsyncResponse, type CreateMaskAsyncResponses, type CreateMaskRequest, type CreateRenditionAsyncData, type CreateRenditionAsyncError, type CreateRenditionAsyncErrors, type CreateRenditionAsyncResponse, type CreateRenditionAsyncResponses, type CreateRenditionRequest, type CropOptions, type DeleteDetails, type DepthBlurDetails, type DepthType, type DocumentCreateLayer, type DocumentCreateOptions, type DocumentDetails, type DocumentManifestOptions, type DocumentManifestRequest, type DocumentOperationLayer, type DocumentOperationOptions, type EastAsianFeatures, type EditTextLayerAsyncData, type EditTextLayerAsyncError, type EditTextLayerAsyncErrors, type EditTextLayerAsyncResponse, type EditTextLayerAsyncResponses, type EditTextLayerRequest, type ErrorDetails, type ExposureDetails, type FacadeJobStatusData, type FacadeJobStatusError, type FacadeJobStatusErrors, type FacadeJobStatusResponse, type FacadeJobStatusResponses, type FillDetails, type FillMaskedAreasData, type FillMaskedAreasError, type FillMaskedAreasErrors, type FillMaskedAreasInputImage, type FillMaskedAreasJobApiResponse, type FillMaskedAreasRequest, type FillMaskedAreasResponse, type FillMaskedAreasResponses, type FillType, type FocalSelector, type FontCaps, type FontColorCmyk, type FontColorDetails, type FontColorGray, type FontColorLab, type FontColorRgb, type GetDocumentManifestAsyncData, type GetDocumentManifestAsyncError, type GetDocumentManifestAsyncErrors, type GetDocumentManifestAsyncResponse, type GetDocumentManifestAsyncResponses, type GetJobStatusData, type GetJobStatusError, type GetJobStatusErrors, type GetJobStatusResponse, type GetJobStatusResponses, type HorizontalAlignType, type HueSaturation, type IccProfileDetails, type ImageBoundingBox, type ImageFormatType, type ImageModeType, type ImageSize, type InputValidationError, type InputValidationErrorDetail, type JobError, type JobLinkResponse, type JobOutputDetails, type JobOutputStatus, type JobStatus, type JobStatusFailed, type JobStatusLink, type JobStatusLinkResponse, type JobStatusNotStarted, type JobStatusPollPayload, type JobStatusResponse, type JobStatusRunning, type JobStatusSucceeded, type JobStatusSucceededResponse, type LayerDetails, type LayerMaskDetails, type LayerPosition, type LayerReference, type LayerType, type ManageMissingFonts, type ManifestJobAdjustmentDetails, type ManifestJobApiResponse, type ManifestJobDocumentDetails, type ManifestJobStatusOutputDetails, type MaskBodyPartsData, type MaskBodyPartsError, type MaskBodyPartsErrors, type MaskBodyPartsImageMediaType, type MaskBodyPartsInputImage, type MaskBodyPartsInputMask, type MaskBodyPartsJobApiResponse, type MaskBodyPartsMaskMediaType, type MaskBodyPartsOutputImage, type MaskBodyPartsRequest, type MaskBodyPartsResponse, type MaskBodyPartsResponses, type MaskDetails, type MaskFormat, type MaskFormatType, type MaskObjectsData, type MaskObjectsError, type MaskObjectsErrors, type MaskObjectsInputImage, type MaskObjectsInputImageMediaType, type MaskObjectsJobApiResponse, type MaskObjectsOutputImage, type MaskObjectsRequest, type MaskObjectsResponse, type MaskObjectsResponses, type ModifyDocumentAsyncData, type ModifyDocumentAsyncError, type ModifyDocumentAsyncErrors, type ModifyDocumentAsyncResponse, type ModifyDocumentAsyncResponses, type ModifyDocumentRequest, type MoveDetails, type Offset, type OperationDocument, type Options, type OrientationType, type OutputImageDetails, type ParagraphStyleAlignmentType, type ParagraphStyleDetails, type PlayPhotoshopActionsAsyncData, type PlayPhotoshopActionsAsyncError, type PlayPhotoshopActionsAsyncErrors, type PlayPhotoshopActionsAsyncResponse, type PlayPhotoshopActionsAsyncResponses, type PlayPhotoshopActionsJsonAsyncData, type PlayPhotoshopActionsJsonAsyncError, type PlayPhotoshopActionsJsonAsyncErrors, type PlayPhotoshopActionsJsonAsyncResponse, type PlayPhotoshopActionsJsonAsyncResponses, type PlayPhotoshopActionsJsonRequest, type PlayPhotoshopActionsRequest, type PsJobApiResponse, type PsJobResponse, type PsJobStatusData, type PsJobStatusResponse, type PsJobStatusResponses, type PsOutputDetails, type RefineMaskData, type RefineMaskError, type RefineMaskErrors, type RefineMaskImageMediaType, type RefineMaskInputImage, type RefineMaskJobApiResponse, type RefineMaskOutputImage, type RefineMaskRequest, type RefineMaskResponse, type RefineMaskResponses, type RemoveBackgroundAsyncData, type RemoveBackgroundAsyncError, type RemoveBackgroundAsyncErrors, type RemoveBackgroundAsyncResponse, type RemoveBackgroundAsyncResponses, type RemoveBackgroundData, type RemoveBackgroundError, type RemoveBackgroundErrors, type RemoveBackgroundRequest, type RemoveBackgroundResponse, type RemoveBackgroundResponses, type RemoveBackgroundV2Request, type RemoveBgColor, type RemoveBgInputImage, type RemoveBgMode, type RemoveBgOutputImageMediaType, type RemoveBgOutputImageOptions, type RenditionLinkDetails, type RenditionLinks, type ReplaceSmartObjectAsyncData, type ReplaceSmartObjectAsyncError, type ReplaceSmartObjectAsyncErrors, type ReplaceSmartObjectAsyncResponse, type ReplaceSmartObjectAsyncResponses, type ReplaceSmartObjectRequest, type RgbColor, type SelfLink, type SenseiColor, type SenseiJobApiResponse, type SenseiJobStatusData, type SenseiJobStatusResponse, type SenseiJobStatusResponses, type SenseiOutputDetails, type SmartObject, type SmartObjectDetails, type SmartObjectLayer, type SmartObjectOptions, type SmartObjectOutputDetails, type SolidColor, type StorageDetails, type StorageType, type TextDetails, type TextLayerCharacterStyleDetails, type TextLayerDetails, type TextLayerParagraphStyleDetails, type TextOptions, type TextOptionsLayer, type TextStyleType, type TextType, type ThumbnailType, type Thumbnails, type TrialLimitExceededError, type Trim, type TrimToCanvasType, type UnitType, type UrlResource, type VerticalAlignType, applyAutoCropAsync, applyDepthBlurAsync, convertToActionsJsonAsync, createArtboardAsync, createDocumentAsync, createMaskAsync, createRenditionAsync, editTextLayerAsync, facadeJobStatus, fillMaskedAreas, getDocumentManifestAsync, getJobStatus, maskBodyParts, maskObjects, modifyDocumentAsync, playPhotoshopActionsAsync, playPhotoshopActionsJsonAsync, psJobStatus, refineMask, removeBackground, removeBackgroundAsync, replaceSmartObjectAsync, senseiJobStatus };
3792
+ //# sourceMappingURL=flat.d.cts.map