acquia-dam-sdk

acquia-dam-sdk / Components / CreateOrderParams

Interface: CreateOrderParams

Properties¶

assets¶

assets: string[]

Array of asset UUIDs to include in the order

Defined in¶

src/apis/orders/requests.ts:3

conversions¶

conversions: string[]

Array of conversion UUIDs to perform on the assets for the order

Defined in¶

src/apis/orders/requests.ts:5

createArchive?¶

optional createArchive: boolean

Kick off the creation of a zip archive for the order created for the first (or only) recipient listed. Does not create zip archives for any recipient other than the first listed.

Default¶

false

Defined in¶

src/apis/orders/requests.ts:11

metadata?¶

optional metadata: object

If metadata is required for the specified order profile, it should be included here

fields¶

fields: object[]

Defined in¶

src/apis/orders/requests.ts:13

notes?¶

optional notes: string

Notes to include in the order email

Defined in¶

src/apis/orders/requests.ts:23

profile¶

profile: string

The UUID of the order profile to be used when creating this order

Defined in¶

src/apis/orders/requests.ts:25

recipients¶

recipients: string[]

Array of the current user's saved contact UUIDs who should receive the order

Defined in¶

src/apis/orders/requests.ts:27

subject?¶

optional subject: string

Subject to use in the order email, a default is used if left blank

Defined in¶

src/apis/orders/requests.ts:29