diff --git a/openapi/v1.0.0.yaml b/openapi/v1.0.0.yaml index 96d64fc..420fd8e 100644 --- a/openapi/v1.0.0.yaml +++ b/openapi/v1.0.0.yaml @@ -6849,6 +6849,114 @@ components: required: [fileId, url, name, path, transformation] required: [type, created_at, request, data] + DamFileCreateEvent: + allOf: + - $ref: "#/components/schemas/BaseWebhookEvent" + - type: object + description: | + Triggered when a file is created. + properties: + type: + type: string + const: "file.created" + description: Type of the webhook event. + created_at: + type: string + format: date-time + description: Timestamp of when the event occurred in ISO8601 format. + data: + $ref: "#/components/schemas/FileDetails" + required: [type, created_at, data] + + DamFileUpdateEvent: + allOf: + - $ref: "#/components/schemas/BaseWebhookEvent" + - type: object + description: | + Triggered when a file is updated. + properties: + type: + type: string + const: "file.updated" + description: Type of the webhook event. + created_at: + type: string + format: date-time + description: Timestamp of when the event occurred in ISO8601 format. + data: + $ref: "#/components/schemas/FileDetails" + required: [type, created_at, data] + + DamFileVersionCreateEvent: + allOf: + - $ref: "#/components/schemas/BaseWebhookEvent" + - type: object + description: | + Triggered when a file version is created. + properties: + type: + type: string + const: "file-version.created" + description: Type of the webhook event. + created_at: + type: string + format: date-time + description: Timestamp of when the event occurred in ISO8601 format. + data: + $ref: "#/components/schemas/FileVersionDetails" + required: [type, created_at, data] + + DamFileDeleteEvent: + allOf: + - $ref: "#/components/schemas/BaseWebhookEvent" + - type: object + description: | + Triggered when a file is deleted. + properties: + type: + type: string + const: "file.deleted" + description: Type of the webhook event. + created_at: + type: string + format: date-time + description: Timestamp of when the event occurred in ISO8601 format. + data: + type: object + properties: + fileId: + type: string + description: The unique `fileId` of the deleted file. + required: [fileId] + required: [type, created_at, data] + + DamFileVersionDeleteEvent: + allOf: + - $ref: "#/components/schemas/BaseWebhookEvent" + - type: object + description: | + Triggered when a file version is deleted. + properties: + type: + type: string + const: "file-version.deleted" + description: Type of the webhook event. + created_at: + type: string + format: date-time + description: Timestamp of when the event occurred in ISO8601 format. + data: + type: object + properties: + fileId: + type: string + description: The unique `fileId` of the deleted file. + versionId: + type: string + description: The unique `versionId` of the deleted file version. + required: [fileId, versionId] + required: [type, created_at, data] + SrcOptions: title: Source Options description: Options for generating ImageKit URLs with transformations. See the [Transformations guide](https://imagekit.io/docs/transformations). @@ -7833,569 +7941,569 @@ components: Only works if the base asset is an image. See [gradient](https://imagekit.io/docs/effects-and-enhancements#gradient---e-gradient). additionalProperties: false - examples: - UploadResponseWithEmbeddedMetadata: - fileId: 6673f88237b244ef54d60180 - name: test-image.jpg - size: 117079 - versionInfo: - id: 6673f88237b244ef54d60180 - name: Version 1 - filePath: "/test-image.jpg" - url: https://ik.imagekit.io/demo/test-image.jpg - fileType: image - height: 500 - width: 1000 - orientation: 1 - thumbnailUrl: https://ik.imagekit.io/demo/tr:n-ik_ml_thumbnail/test-image.jpg - AITags: null - metadata: + examples: + UploadResponseWithEmbeddedMetadata: + fileId: 6673f88237b244ef54d60180 + name: test-image.jpg + size: 117079 + versionInfo: + id: 6673f88237b244ef54d60180 + name: Version 1 + filePath: "/test-image.jpg" + url: https://ik.imagekit.io/demo/test-image.jpg + fileType: image height: 500 width: 1000 + orientation: 1 + thumbnailUrl: https://ik.imagekit.io/demo/tr:n-ik_ml_thumbnail/test-image.jpg + AITags: null + metadata: + height: 500 + width: 1000 + size: 117079 + format: jpg + hasColorProfile: false + quality: 0 + density: 72 + hasTransparency: false + exif: + image: + ImageDescription: The description aka caption (ref2019.1) + Orientation: 1 + XResolution: 72 + YResolution: 72 + ResolutionUnit: 2 + Artist: Creator1 (ref2019.1) + YCbCrPositioning: 1 + Copyright: Copyright (Notice) 2019.1 IPTC - www.iptc.org (ref2019.1) + ExifOffset: 260 + thumbnail: {} + exif: + ExifVersion: "0232" + DateTimeOriginal: 2019:10:16 19:01:03 + ComponentsConfiguration: "\x01\x02\x03\0" + FlashpixVersion: "0100" + ColorSpace: 65535 + ExifImageWidth: 1000 + ExifImageHeight: 500 + gps: {} + interoperability: {} + makernote: {} + pHash: 17949d3d3573ebca + embeddedMetadata: + Orientation: Horizontal (normal) + ExifVersion: "0232" + ImageDescription: The description aka caption (ref2019.1) + XResolution: 72 + YResolution: 72 + ResolutionUnit: inches + Artist: Creator1 (ref2019.1) + Copyright: Copyright (Notice) 2019.1 IPTC - www.iptc.org (ref2019.1) + DateTimeOriginal: "2019-10-16T19:01:03.000Z" + OffsetTimeOriginal: "+00:00" + ComponentsConfiguration: Y,Cb,Cr,- + FlashpixVersion: "0100" + ColorSpace: Uncalibrated + ObjectAttributeReference: A Genre (ref2019.1) + ObjectName: The Title (ref2019.1) + SubjectReference: + - IPTC:1ref2019.1 + - IPTC:2ref2019.1 + - IPTC:3ref2019.1 + Keywords: + - Keyword1ref2019.1 + - Keyword2ref2019.1 + - Keyword3ref2019.1 + SpecialInstructions: An Instruction (ref2019.1) + TimeCreated: 19:01:03+00:00 + Byline: Creator1 (ref2019.1) + BylineTitle: Creator's Job Title (ref2019.1) + Sublocation: Sublocation (Core) (ref2019.1) + ProvinceState: Province/State(Core)(ref2019.1) + CountryPrimaryLocationCode: R19 + CountryPrimaryLocationName: Country (Core) (ref2019.1) + OriginalTransmissionReference: Job Id (ref2019.1) + CopyrightNotice: Copyright (Notice) 2019.1 IPTC - www.iptc.org (ref2019.1) + CaptionAbstract: The description aka caption (ref2019.1) + WriterEditor: Description Writer (ref2019.1) + ApplicationRecordVersion: 4 + CountryCode: R19 + CreatorCity: "Creator's CI: City (ref2019.1)" + CreatorCountry: "Creator's CI: Country (ref2019.1)" + CreatorAddress: "Creator's CI: Address, line 1 (ref2019.1)" + CreatorPostalCode: "Creator's CI: Postcode (ref2019.1)" + CreatorRegion: "Creator's CI: State/Province (ref2019.1)" + CreatorWorkEmail: "Creator's CI: Email@1, Email@2 (ref2019.1)" + CreatorWorkTelephone: "Creator's CI: Phone # 1, Phone # 2 (ref2019.1)" + CreatorWorkURL: http://www.Creators.CI/WebAddress/ref2019.1 + IntellectualGenre: A Genre (ref2019.1) + Location: Sublocation (Core) (ref2019.1) + Scene: + - IPTC-Scene-Code1 (ref2019.1) + - IPTC-Scene-Code2 (ref2019.1) + SubjectCode: + - IPTC:1ref2019.1 + - IPTC:2ref2019.1 + - IPTC:3ref2019.1 + AboutCvTermCvId: http://example.com/cv/about/ref2019.1 + AboutCvTermId: http://example.com/cv/about/ref2019.1/code987 + AboutCvTermName: CV-Term Name 1 (ref2019.1) + AboutCvTermRefinedAbout: http://example.com/cv/refinements2/ref2019.1/codeX145 + AdditionalModelInformation: Additional Model Info (ref2019.1) + ArtworkCircaDateCreated: "AO Circa Date: between 1550 and 1600 (ref2019.1)" + ArtworkContentDescription: AO Content Description 1 (ref2019.1) + ArtworkContributionDescription: AO Contribution Description 1 (ref2019.1) + ArtworkCopyrightNotice: AO Copyright Notice 1 (ref2019.1) + ArtworkCreator: + - AO Creator Name 1a (ref2019.1) + - AO Creator Name 1b (ref2019.1) + ArtworkCreatorID: + - AO Creator Id 1a (ref2019.1) + - AO Creator Id 1b (ref2019.1) + ArtworkCopyrightOwnerID: AO Current Copyright Owner ID 1 (ref2019.1) + ArtworkCopyrightOwnerName: AO Current Copyright Owner Name 1 (ref2019.1) + ArtworkLicensorID: AO Current Licensor ID 1 (ref2019.1) + ArtworkLicensorName: AO Current Licensor Name 1 (ref2019.1) + ArtworkDateCreated: "1919-10-16T19:01:00.000Z" + ArtworkPhysicalDescription: AO Physical Description 1 (ref2019.1) + ArtworkSource: AO Source 1 (ref2019.1) + ArtworkSourceInventoryNo: AO Source Inventory No 1 (ref2019.1) + ArtworkSourceInvURL: AO Source Inventory URL (ref2019.1) + ArtworkStylePeriod: + - AO Style Baroque (ref2019.1) + - AO Style Italian Baroque (ref2019.1) + ArtworkTitle: AO Title 1 (ref2019.1) + DigitalImageGUID: http://example.com/imageGUIDs/TestGUID12345/ref2019.1 + DigitalSourceType: http://cv.iptc.org/newscodes/digitalsourcetype/softwareImage + EmbeddedEncodedRightsExpr: The Encoded Rights Expression (ref2019.1) + EmbeddedEncodedRightsExprType: IANA Media Type of ERE (ref2019.1) + EmbeddedEncodedRightsExprLangID: http://example.org/RELids/id4711/ref2019.1 + Event: An Event (ref2019.1) + GenreCvId: http://example.com/cv/genre/ref2019.1 + GenreCvTermId: http://example.com/cv/genre/ref2019.1/code1369 + GenreCvTermName: Genre CV-Term Name 1 (ref2019.1) + GenreCvTermRefinedAbout: http://example.com/cv/genrerefinements2/ref2019.1/codeY864 + ImageRegionName: + - Listener 1 + - Listener 2 + - Speaker 1 + ImageRegionOrganisationInImageName: + - Organisation name no 1 in region persltr2 (ref2019.1) + - Organisation name no 1 in region persltr2 (ref2019.1) + - Organisation name no 1 in region persltr3 (ref2019.1) + ImageRegionPersonInImage: + - Person name no 1 in region persltr2 (ref2019.1) + - Person name no 1 in region persltr3 (ref2019.1) + - Person name no 1 in region persltr1 (ref2019.1) + ImageRegionBoundaryH: + - 0.385 + ImageRegionBoundaryShape: + - rectangle + - circle + - polygon + ImageRegionBoundaryUnit: + - relative + - relative + - relative + ImageRegionBoundaryW: + - 0.127 + ImageRegionBoundaryX: + - 0.31 + - 0.59 + ImageRegionBoundaryY: + - 0.18 + - 0.426 + ImageRegionCtypeName: + - Region Boundary Content Type Name (ref2019.1) + - Region Boundary Content Type Name (ref2019.1) + - Region Boundary Content Type Name (ref2019.1) + ImageRegionCtypeIdentifier: + - https://example.org/rctype/type2019.1a + - https://example.org/rctype/type2019.1b + - https://example.org/rctype/type2019.1a + - https://example.org/rctype/type2019.1b + - https://example.org/rctype/type2019.1a + - https://example.org/rctype/type2019.1b + ImageRegionID: + - persltr2 + - persltr3 + - persltr1 + ImageRegionRoleName: + - Region Boundary Content Role Name (ref2019.1) + - Region Boundary Content Role Name (ref2019.1) + - Region Boundary Content Role Name (ref2019.1) + ImageRegionRoleIdentifier: + - https://example.org/rrole/role2019.1a + - https://example.org/rrole/role2019.1b + - https://example.org/rrole/role2019.1a + - https://example.org/rrole/role2019.1b + - https://example.org/rrole/role2019.1a + - https://example.org/rrole/role2019.1b + ImageRegionBoundaryRx: + - 0.068 + ImageRegionBoundaryVerticesX: + - 0.05 + - 0.148 + - 0.375 + ImageRegionBoundaryVerticesY: + - 0.713 + - 0.041 + - 0.863 + LinkedEncodedRightsExpr: http://example.org/linkedrightsexpression/id986/ref2019.1 + LinkedEncodedRightsExprType: IANA Media Type of ERE (ref2019.1) + LinkedEncodedRightsExprLangID: http://example.org/RELids/id4712/ref2019.1 + LocationCreatedCity: City (Location created1) (ref2019.1) + LocationCreatedCountryCode: R17 + LocationCreatedCountryName: CountryName (Location created1) (ref2019.1) + LocationCreatedLocationId: Location Id (Location created1) (ref2019.1) + LocationCreatedLocationName: Location Name (Location created1) (ref2019.1) + LocationCreatedProvinceState: Province/State (Location created1) (ref2019.1) + LocationCreatedSublocation: Sublocation (Location created1) (ref2019.1) + LocationCreatedWorldRegion: Worldregion (Location created1) (ref2019.1) + LocationCreatedGPSAltitude: 480 m + LocationCreatedGPSLatitude: 48,16.5N + LocationCreatedGPSLongitude: 16,20.28E + LocationShownCity: + - City (Location shown1) (ref2019.1) + - City (Location shown2) (ref2019.1) + LocationShownCountryCode: + - R17 + - R17 + LocationShownCountryName: + - CountryName (Location shown1) (ref2019.1) + - CountryName (Location shown2) (ref2019.1) + LocationShownLocationId: + - Location Id 1a(Location shown1) (ref2019.1) + - Location Id 1b(Location shown1) (ref2019.1) + - Location Id 2a(Location shown2) (ref2019.1) + - Location Id 2b(Location shown2) (ref2019.1) + LocationShownLocationName: + - Location Name (Location shown1) (ref2019.1) + - Location Name (Location shown2) (ref2019.1) + LocationShownProvinceState: + - Province/State (Location shown1) (ref2019.1) + - Province/State (Location shown2) (ref2019.1) + LocationShownSublocation: + - Sublocation (Location shown1) (ref2019.1) + - Sublocation (Location shown2) (ref2019.1) + LocationShownWorldRegion: + - Worldregion (Location shown1) (ref2019.1) + - Worldregion (Location shown2) (ref2019.1) + LocationShownGPSAltitude: + - 140 m + - 120 m + LocationShownGPSLatitude: + - 48,8.82N + - 47,57.12N + LocationShownGPSLongitude: + - 17,5.88E + - 16,49.8E + MaxAvailHeight: 20 + MaxAvailWidth: 19 + ModelAge: + - 25 + - 27 + - 30 + OrganisationInImageCode: + - Organisation Code 1 (ref2019.1) + - Organisation Code 2 (ref2019.1) + - Organisation Code 3 (ref2019.1) + OrganisationInImageName: + - Organisation Name 1 (ref2019.1) + - Organisation Name 2 (ref2019.1) + - Organisation Name 3 (ref2019.1) + PersonInImage: + - Person Shown 1 (ref2019.1) + - Person Shown 2 (ref2019.1) + PersonInImageCvTermCvId: + - http://example.com/cv/test99/ref2019.1 + PersonInImageCvTermId: + - http://example.com/cv/test99/code987/ref2019.1 + PersonInImageCvTermName: + - Person Characteristic Name 1 (ref2019.1) + PersonInImageCvTermRefinedAbout: + - http://example.com/cv/refinements987/codeY765/ref2019.1 + PersonInImageDescription: + - Person Description 1 (ref2019.1) + PersonInImageId: + - http://wikidata.org/item/Q123456789/ref2019.1 + - http://freebase.com/m/987654321/ref2019.1 + PersonInImageName: + - Person Name 1 (ref2019.1) + ProductInImageDescription: + - Product Description 1 (ref2019.1) + ProductInImageGTIN: + - 123456782019.1 + ProductInImageName: + - Product Name 1 (ref2019.1) + RegistryEntryRole: + - Registry Entry Role ID 1 (ref2019.1) + - Registry Entry Role ID 2 (ref2019.1) + RegistryItemID: + - Registry Image ID 1 (ref2019.1) + - Registry Image ID 2 (ref2019.1) + RegistryOrganisationID: + - Registry Organisation ID 1 (ref2019.1) + - Registry Organisation ID 2 (ref2019.1) + Creator: Creator1 (ref2019.1) + Description: The description aka caption (ref2019.1) + Rights: Copyright (Notice) 2019.1 IPTC - www.iptc.org (ref2019.1) + Subject: + - Keyword1ref2019.1 + - Keyword2ref2019.1 + - Keyword3ref2019.1 + Title: The Title (ref2019.1) + AuthorsPosition: Creator's Job Title (ref2019.1) + CaptionWriter: Description Writer (ref2019.1) + City: City (Core) (ref2019.1) + Country: Country (Core) (ref2019.1) + Credit: Credit Line (ref2019.1) + DateCreated: "2019-10-16T00:00:00.000Z" + Headline: The Headline (ref2019.1) + Instructions: An Instruction (ref2019.1) + Source: Source (ref2019.1) + State: Province/State(Core)(ref2019.1) + TransmissionReference: Job Id (ref2019.1) + CopyrightOwnerID: + - Copyright Owner Id 1 (ref2019.1) + - Copyright Owner Id 2 (ref2019.1) + CopyrightOwnerName: + - Copyright Owner Name 1 (ref2019.1) + - Copyright Owner Name 2 (ref2019.1) + ImageCreatorID: Image Creator Id 1 (ref2019.1) + ImageCreatorName: Image Creator Name 1 (ref2019.1) + ImageCreatorImageID: Image Creator Image ID (ref2019.1) + ImageSupplierID: Image Supplier Id (ref2019.1) + ImageSupplierName: Image Supplier Name (ref2019.1) + ImageSupplierImageID: Image Supplier Image ID (ref2019.1) + LicensorCity: + - Licensor City 1 (ref2019.1) + - Licensor City 2 (ref2019.1) + LicensorCountry: + - Licensor Country 1 (ref2019.1) + - Licensor Country 2 (ref2019.1) + LicensorEmail: + - Licensor Email 1 (ref2019.1) + - Licensor Email 2 (ref2019.1) + LicensorExtendedAddress: + - Licensor Ext Addr 1 (ref2019.1) + - Licensor Ext Addr 2 (ref2019.1) + LicensorID: + - Licensor ID 1 (ref2019.1) + - Licensor ID 2 (ref2019.1) + LicensorName: + - Licensor Name 1 (ref2019.1) + - Licensor Name 2 (ref2019.1) + LicensorPostalCode: + - Licensor Postcode 1 (ref2019.1) + - Licensor Postcode 2 (ref2019.1) + LicensorRegion: + - Licensor Region 1 (ref2019.1) + - Licensor Region 2 (ref2019.1) + LicensorStreetAddress: + - Licensor Street Addr 1 (ref2019.1) + - Licensor Street Addr 2 (ref2019.1) + LicensorTelephone1: + - Licensor Phone1 1 (ref2019.1) + - Licensor Phone1 2 (ref2019.1) + LicensorTelephone2: + - Licensor Phone2 1 (ref2019.1) + - Licensor Phone2 2 (ref2019.1) + LicensorURL: + - Licensor URL 1 (ref2019.1) + - Licensor URL 2 (ref2019.1) + ModelReleaseID: + - Model Release ID 1 (ref2019.1) + - Model Release ID 2 (ref2019.1) + PropertyReleaseID: + - Property Release ID 1 (ref2019.1) + - Property Release ID 2 (ref2019.1) + Rating: 1 + UsageTerms: Rights Usage Terms (ref2019.1) + WebStatement: http://www.WebStatementOfRights.org/2019.1 + DateTimeCreated: "2019-10-16T00:00:00.000Z" + Caption: The description aka caption (ref2019.1) + Writer: Description Writer (ref2019.1) + UploadResponseImage: + fileId: 6673f88237b244ef54d60180 + name: test-image.jpg size: 117079 + versionInfo: + id: 6673f88237b244ef54d60180 + name: Version 1 + filePath: "/test-image.jpg" + url: https://ik.imagekit.io/demo/test-image.jpg + fileType: image + height: 500 + width: 1000 + orientation: 1 + thumbnailUrl: https://ik.imagekit.io/demo/tr:n-ik_ml_thumbnail/test-image.jpg + UploadResonseVideo: + fileId: 6673f99b37b244ef54d98f11 + name: test-video.mp4 + size: 1378305 + versionInfo: + id: 6673f99b37b244ef54d98f11 + name: Version 1 + filePath: "/test-video.mp4" + url: https://ik.imagekit.io/demo/test-video.mp4 + height: 720 + width: 720 + bitRate: 1453966 + duration: 7 + audioCodec: aac + videoCodec: h264 + fileType: non-image + metadata: + height: 720 + width: 720 + bitRate: 1453966 + duration: 7 + audioCodec: aac + videoCodec: h264 + size: 1378305 + ImageMetadata: + height: 68 + width: 100 + size: 7749 format: jpg - hasColorProfile: false + hasColorProfile: true quality: 0 density: 72 hasTransparency: false + pHash: f06830ca9f1e3e90 exif: image: - ImageDescription: The description aka caption (ref2019.1) + Make: Canon + Model: Canon EOS 40D Orientation: 1 XResolution: 72 YResolution: 72 ResolutionUnit: 2 - Artist: Creator1 (ref2019.1) - YCbCrPositioning: 1 - Copyright: Copyright (Notice) 2019.1 IPTC - www.iptc.org (ref2019.1) - ExifOffset: 260 - thumbnail: {} + Software: GIMP 2.4.5 + ModifyDate: 2008:07:31 10:38:11 + YCbCrPositioning: 2 + ExifOffset: 214 + GPSInfo: 978 + thumbnail: + Compression: 6 + XResolution: 72 + YResolution: 72 + ResolutionUnit: 2 + ThumbnailOffset: 1090 + ThumbnailLength: 1378 exif: - ExifVersion: "0232" - DateTimeOriginal: 2019:10:16 19:01:03 - ComponentsConfiguration: "\x01\x02\x03\0" + ExposureTime: 0.00625 + FNumber: 7.1 + ExposureProgram: 1 + ISO: 100 + ExifVersion: "0221" + DateTimeOriginal: 2008:05:30 15:56:01 + CreateDate: 2008:05:30 15:56:01 + ShutterSpeedValue: 7.375 + ApertureValue: 5.625 + ExposureCompensation: 0 + MeteringMode: 5 + Flash: 9 + FocalLength: 135 + SubSecTime: "00" + SubSecTimeOriginal: "00" + SubSecTimeDigitized: "00" FlashpixVersion: "0100" - ColorSpace: 65535 - ExifImageWidth: 1000 - ExifImageHeight: 500 - gps: {} - interoperability: {} + ColorSpace: 1 + ExifImageWidth: 100 + ExifImageHeight: 68 + InteropOffset: 948 + FocalPlaneXResolution: 4438.356164383562 + FocalPlaneYResolution: 4445.969125214408 + FocalPlaneResolutionUnit: 2 + CustomRendered: 0 + ExposureMode: 1 + WhiteBalance: 0 + SceneCaptureType: 0 + gps: + GPSVersionID: + - 2 + - 2 + - 0 + - 0 + interoperability: + InteropIndex: R98 + InteropVersion: "0100" makernote: {} - pHash: 17949d3d3573ebca - embeddedMetadata: - Orientation: Horizontal (normal) - ExifVersion: "0232" - ImageDescription: The description aka caption (ref2019.1) - XResolution: 72 - YResolution: 72 - ResolutionUnit: inches - Artist: Creator1 (ref2019.1) - Copyright: Copyright (Notice) 2019.1 IPTC - www.iptc.org (ref2019.1) - DateTimeOriginal: "2019-10-16T19:01:03.000Z" - OffsetTimeOriginal: "+00:00" - ComponentsConfiguration: Y,Cb,Cr,- - FlashpixVersion: "0100" - ColorSpace: Uncalibrated - ObjectAttributeReference: A Genre (ref2019.1) - ObjectName: The Title (ref2019.1) - SubjectReference: - - IPTC:1ref2019.1 - - IPTC:2ref2019.1 - - IPTC:3ref2019.1 - Keywords: - - Keyword1ref2019.1 - - Keyword2ref2019.1 - - Keyword3ref2019.1 - SpecialInstructions: An Instruction (ref2019.1) - TimeCreated: 19:01:03+00:00 - Byline: Creator1 (ref2019.1) - BylineTitle: Creator's Job Title (ref2019.1) - Sublocation: Sublocation (Core) (ref2019.1) - ProvinceState: Province/State(Core)(ref2019.1) - CountryPrimaryLocationCode: R19 - CountryPrimaryLocationName: Country (Core) (ref2019.1) - OriginalTransmissionReference: Job Id (ref2019.1) - CopyrightNotice: Copyright (Notice) 2019.1 IPTC - www.iptc.org (ref2019.1) - CaptionAbstract: The description aka caption (ref2019.1) - WriterEditor: Description Writer (ref2019.1) - ApplicationRecordVersion: 4 - CountryCode: R19 - CreatorCity: "Creator's CI: City (ref2019.1)" - CreatorCountry: "Creator's CI: Country (ref2019.1)" - CreatorAddress: "Creator's CI: Address, line 1 (ref2019.1)" - CreatorPostalCode: "Creator's CI: Postcode (ref2019.1)" - CreatorRegion: "Creator's CI: State/Province (ref2019.1)" - CreatorWorkEmail: "Creator's CI: Email@1, Email@2 (ref2019.1)" - CreatorWorkTelephone: "Creator's CI: Phone # 1, Phone # 2 (ref2019.1)" - CreatorWorkURL: http://www.Creators.CI/WebAddress/ref2019.1 - IntellectualGenre: A Genre (ref2019.1) - Location: Sublocation (Core) (ref2019.1) - Scene: - - IPTC-Scene-Code1 (ref2019.1) - - IPTC-Scene-Code2 (ref2019.1) - SubjectCode: - - IPTC:1ref2019.1 - - IPTC:2ref2019.1 - - IPTC:3ref2019.1 - AboutCvTermCvId: http://example.com/cv/about/ref2019.1 - AboutCvTermId: http://example.com/cv/about/ref2019.1/code987 - AboutCvTermName: CV-Term Name 1 (ref2019.1) - AboutCvTermRefinedAbout: http://example.com/cv/refinements2/ref2019.1/codeX145 - AdditionalModelInformation: Additional Model Info (ref2019.1) - ArtworkCircaDateCreated: "AO Circa Date: between 1550 and 1600 (ref2019.1)" - ArtworkContentDescription: AO Content Description 1 (ref2019.1) - ArtworkContributionDescription: AO Contribution Description 1 (ref2019.1) - ArtworkCopyrightNotice: AO Copyright Notice 1 (ref2019.1) - ArtworkCreator: - - AO Creator Name 1a (ref2019.1) - - AO Creator Name 1b (ref2019.1) - ArtworkCreatorID: - - AO Creator Id 1a (ref2019.1) - - AO Creator Id 1b (ref2019.1) - ArtworkCopyrightOwnerID: AO Current Copyright Owner ID 1 (ref2019.1) - ArtworkCopyrightOwnerName: AO Current Copyright Owner Name 1 (ref2019.1) - ArtworkLicensorID: AO Current Licensor ID 1 (ref2019.1) - ArtworkLicensorName: AO Current Licensor Name 1 (ref2019.1) - ArtworkDateCreated: "1919-10-16T19:01:00.000Z" - ArtworkPhysicalDescription: AO Physical Description 1 (ref2019.1) - ArtworkSource: AO Source 1 (ref2019.1) - ArtworkSourceInventoryNo: AO Source Inventory No 1 (ref2019.1) - ArtworkSourceInvURL: AO Source Inventory URL (ref2019.1) - ArtworkStylePeriod: - - AO Style Baroque (ref2019.1) - - AO Style Italian Baroque (ref2019.1) - ArtworkTitle: AO Title 1 (ref2019.1) - DigitalImageGUID: http://example.com/imageGUIDs/TestGUID12345/ref2019.1 - DigitalSourceType: http://cv.iptc.org/newscodes/digitalsourcetype/softwareImage - EmbeddedEncodedRightsExpr: The Encoded Rights Expression (ref2019.1) - EmbeddedEncodedRightsExprType: IANA Media Type of ERE (ref2019.1) - EmbeddedEncodedRightsExprLangID: http://example.org/RELids/id4711/ref2019.1 - Event: An Event (ref2019.1) - GenreCvId: http://example.com/cv/genre/ref2019.1 - GenreCvTermId: http://example.com/cv/genre/ref2019.1/code1369 - GenreCvTermName: Genre CV-Term Name 1 (ref2019.1) - GenreCvTermRefinedAbout: http://example.com/cv/genrerefinements2/ref2019.1/codeY864 - ImageRegionName: - - Listener 1 - - Listener 2 - - Speaker 1 - ImageRegionOrganisationInImageName: - - Organisation name no 1 in region persltr2 (ref2019.1) - - Organisation name no 1 in region persltr2 (ref2019.1) - - Organisation name no 1 in region persltr3 (ref2019.1) - ImageRegionPersonInImage: - - Person name no 1 in region persltr2 (ref2019.1) - - Person name no 1 in region persltr3 (ref2019.1) - - Person name no 1 in region persltr1 (ref2019.1) - ImageRegionBoundaryH: - - 0.385 - ImageRegionBoundaryShape: - - rectangle - - circle - - polygon - ImageRegionBoundaryUnit: - - relative - - relative - - relative - ImageRegionBoundaryW: - - 0.127 - ImageRegionBoundaryX: - - 0.31 - - 0.59 - ImageRegionBoundaryY: - - 0.18 - - 0.426 - ImageRegionCtypeName: - - Region Boundary Content Type Name (ref2019.1) - - Region Boundary Content Type Name (ref2019.1) - - Region Boundary Content Type Name (ref2019.1) - ImageRegionCtypeIdentifier: - - https://example.org/rctype/type2019.1a - - https://example.org/rctype/type2019.1b - - https://example.org/rctype/type2019.1a - - https://example.org/rctype/type2019.1b - - https://example.org/rctype/type2019.1a - - https://example.org/rctype/type2019.1b - ImageRegionID: - - persltr2 - - persltr3 - - persltr1 - ImageRegionRoleName: - - Region Boundary Content Role Name (ref2019.1) - - Region Boundary Content Role Name (ref2019.1) - - Region Boundary Content Role Name (ref2019.1) - ImageRegionRoleIdentifier: - - https://example.org/rrole/role2019.1a - - https://example.org/rrole/role2019.1b - - https://example.org/rrole/role2019.1a - - https://example.org/rrole/role2019.1b - - https://example.org/rrole/role2019.1a - - https://example.org/rrole/role2019.1b - ImageRegionBoundaryRx: - - 0.068 - ImageRegionBoundaryVerticesX: - - 0.05 - - 0.148 - - 0.375 - ImageRegionBoundaryVerticesY: - - 0.713 - - 0.041 - - 0.863 - LinkedEncodedRightsExpr: http://example.org/linkedrightsexpression/id986/ref2019.1 - LinkedEncodedRightsExprType: IANA Media Type of ERE (ref2019.1) - LinkedEncodedRightsExprLangID: http://example.org/RELids/id4712/ref2019.1 - LocationCreatedCity: City (Location created1) (ref2019.1) - LocationCreatedCountryCode: R17 - LocationCreatedCountryName: CountryName (Location created1) (ref2019.1) - LocationCreatedLocationId: Location Id (Location created1) (ref2019.1) - LocationCreatedLocationName: Location Name (Location created1) (ref2019.1) - LocationCreatedProvinceState: Province/State (Location created1) (ref2019.1) - LocationCreatedSublocation: Sublocation (Location created1) (ref2019.1) - LocationCreatedWorldRegion: Worldregion (Location created1) (ref2019.1) - LocationCreatedGPSAltitude: 480 m - LocationCreatedGPSLatitude: 48,16.5N - LocationCreatedGPSLongitude: 16,20.28E - LocationShownCity: - - City (Location shown1) (ref2019.1) - - City (Location shown2) (ref2019.1) - LocationShownCountryCode: - - R17 - - R17 - LocationShownCountryName: - - CountryName (Location shown1) (ref2019.1) - - CountryName (Location shown2) (ref2019.1) - LocationShownLocationId: - - Location Id 1a(Location shown1) (ref2019.1) - - Location Id 1b(Location shown1) (ref2019.1) - - Location Id 2a(Location shown2) (ref2019.1) - - Location Id 2b(Location shown2) (ref2019.1) - LocationShownLocationName: - - Location Name (Location shown1) (ref2019.1) - - Location Name (Location shown2) (ref2019.1) - LocationShownProvinceState: - - Province/State (Location shown1) (ref2019.1) - - Province/State (Location shown2) (ref2019.1) - LocationShownSublocation: - - Sublocation (Location shown1) (ref2019.1) - - Sublocation (Location shown2) (ref2019.1) - LocationShownWorldRegion: - - Worldregion (Location shown1) (ref2019.1) - - Worldregion (Location shown2) (ref2019.1) - LocationShownGPSAltitude: - - 140 m - - 120 m - LocationShownGPSLatitude: - - 48,8.82N - - 47,57.12N - LocationShownGPSLongitude: - - 17,5.88E - - 16,49.8E - MaxAvailHeight: 20 - MaxAvailWidth: 19 - ModelAge: - - 25 - - 27 - - 30 - OrganisationInImageCode: - - Organisation Code 1 (ref2019.1) - - Organisation Code 2 (ref2019.1) - - Organisation Code 3 (ref2019.1) - OrganisationInImageName: - - Organisation Name 1 (ref2019.1) - - Organisation Name 2 (ref2019.1) - - Organisation Name 3 (ref2019.1) - PersonInImage: - - Person Shown 1 (ref2019.1) - - Person Shown 2 (ref2019.1) - PersonInImageCvTermCvId: - - http://example.com/cv/test99/ref2019.1 - PersonInImageCvTermId: - - http://example.com/cv/test99/code987/ref2019.1 - PersonInImageCvTermName: - - Person Characteristic Name 1 (ref2019.1) - PersonInImageCvTermRefinedAbout: - - http://example.com/cv/refinements987/codeY765/ref2019.1 - PersonInImageDescription: - - Person Description 1 (ref2019.1) - PersonInImageId: - - http://wikidata.org/item/Q123456789/ref2019.1 - - http://freebase.com/m/987654321/ref2019.1 - PersonInImageName: - - Person Name 1 (ref2019.1) - ProductInImageDescription: - - Product Description 1 (ref2019.1) - ProductInImageGTIN: - - 123456782019.1 - ProductInImageName: - - Product Name 1 (ref2019.1) - RegistryEntryRole: - - Registry Entry Role ID 1 (ref2019.1) - - Registry Entry Role ID 2 (ref2019.1) - RegistryItemID: - - Registry Image ID 1 (ref2019.1) - - Registry Image ID 2 (ref2019.1) - RegistryOrganisationID: - - Registry Organisation ID 1 (ref2019.1) - - Registry Organisation ID 2 (ref2019.1) - Creator: Creator1 (ref2019.1) - Description: The description aka caption (ref2019.1) - Rights: Copyright (Notice) 2019.1 IPTC - www.iptc.org (ref2019.1) - Subject: - - Keyword1ref2019.1 - - Keyword2ref2019.1 - - Keyword3ref2019.1 - Title: The Title (ref2019.1) - AuthorsPosition: Creator's Job Title (ref2019.1) - CaptionWriter: Description Writer (ref2019.1) - City: City (Core) (ref2019.1) - Country: Country (Core) (ref2019.1) - Credit: Credit Line (ref2019.1) - DateCreated: "2019-10-16T00:00:00.000Z" - Headline: The Headline (ref2019.1) - Instructions: An Instruction (ref2019.1) - Source: Source (ref2019.1) - State: Province/State(Core)(ref2019.1) - TransmissionReference: Job Id (ref2019.1) - CopyrightOwnerID: - - Copyright Owner Id 1 (ref2019.1) - - Copyright Owner Id 2 (ref2019.1) - CopyrightOwnerName: - - Copyright Owner Name 1 (ref2019.1) - - Copyright Owner Name 2 (ref2019.1) - ImageCreatorID: Image Creator Id 1 (ref2019.1) - ImageCreatorName: Image Creator Name 1 (ref2019.1) - ImageCreatorImageID: Image Creator Image ID (ref2019.1) - ImageSupplierID: Image Supplier Id (ref2019.1) - ImageSupplierName: Image Supplier Name (ref2019.1) - ImageSupplierImageID: Image Supplier Image ID (ref2019.1) - LicensorCity: - - Licensor City 1 (ref2019.1) - - Licensor City 2 (ref2019.1) - LicensorCountry: - - Licensor Country 1 (ref2019.1) - - Licensor Country 2 (ref2019.1) - LicensorEmail: - - Licensor Email 1 (ref2019.1) - - Licensor Email 2 (ref2019.1) - LicensorExtendedAddress: - - Licensor Ext Addr 1 (ref2019.1) - - Licensor Ext Addr 2 (ref2019.1) - LicensorID: - - Licensor ID 1 (ref2019.1) - - Licensor ID 2 (ref2019.1) - LicensorName: - - Licensor Name 1 (ref2019.1) - - Licensor Name 2 (ref2019.1) - LicensorPostalCode: - - Licensor Postcode 1 (ref2019.1) - - Licensor Postcode 2 (ref2019.1) - LicensorRegion: - - Licensor Region 1 (ref2019.1) - - Licensor Region 2 (ref2019.1) - LicensorStreetAddress: - - Licensor Street Addr 1 (ref2019.1) - - Licensor Street Addr 2 (ref2019.1) - LicensorTelephone1: - - Licensor Phone1 1 (ref2019.1) - - Licensor Phone1 2 (ref2019.1) - LicensorTelephone2: - - Licensor Phone2 1 (ref2019.1) - - Licensor Phone2 2 (ref2019.1) - LicensorURL: - - Licensor URL 1 (ref2019.1) - - Licensor URL 2 (ref2019.1) - ModelReleaseID: - - Model Release ID 1 (ref2019.1) - - Model Release ID 2 (ref2019.1) - PropertyReleaseID: - - Property Release ID 1 (ref2019.1) - - Property Release ID 2 (ref2019.1) - Rating: 1 - UsageTerms: Rights Usage Terms (ref2019.1) - WebStatement: http://www.WebStatementOfRights.org/2019.1 - DateTimeCreated: "2019-10-16T00:00:00.000Z" - Caption: The description aka caption (ref2019.1) - Writer: Description Writer (ref2019.1) - UploadResponseImage: - fileId: 6673f88237b244ef54d60180 - name: test-image.jpg - size: 117079 - versionInfo: - id: 6673f88237b244ef54d60180 - name: Version 1 - filePath: "/test-image.jpg" - url: https://ik.imagekit.io/demo/test-image.jpg - fileType: image - height: 500 - width: 1000 - orientation: 1 - thumbnailUrl: https://ik.imagekit.io/demo/tr:n-ik_ml_thumbnail/test-image.jpg - UploadResonseVideo: - fileId: 6673f99b37b244ef54d98f11 - name: test-video.mp4 - size: 1378305 - versionInfo: - id: 6673f99b37b244ef54d98f11 - name: Version 1 - filePath: "/test-video.mp4" - url: https://ik.imagekit.io/demo/test-video.mp4 - height: 720 - width: 720 - bitRate: 1453966 - duration: 7 - audioCodec: aac - videoCodec: h264 - fileType: non-image - metadata: + VideoMetadata: height: 720 - width: 720 - bitRate: 1453966 - duration: 7 + width: 1280 + bitRate: 546524 + duration: 70 audioCodec: aac videoCodec: h264 - size: 1378305 - ImageMetadata: - height: 68 - width: 100 - size: 7749 - format: jpg - hasColorProfile: true - quality: 0 - density: 72 - hasTransparency: false - pHash: f06830ca9f1e3e90 - exif: - image: - Make: Canon - Model: Canon EOS 40D - Orientation: 1 - XResolution: 72 - YResolution: 72 - ResolutionUnit: 2 - Software: GIMP 2.4.5 - ModifyDate: 2008:07:31 10:38:11 - YCbCrPositioning: 2 - ExifOffset: 214 - GPSInfo: 978 - thumbnail: - Compression: 6 - XResolution: 72 - YResolution: 72 - ResolutionUnit: 2 - ThumbnailOffset: 1090 - ThumbnailLength: 1378 - exif: - ExposureTime: 0.00625 - FNumber: 7.1 - ExposureProgram: 1 - ISO: 100 - ExifVersion: "0221" - DateTimeOriginal: 2008:05:30 15:56:01 - CreateDate: 2008:05:30 15:56:01 - ShutterSpeedValue: 7.375 - ApertureValue: 5.625 - ExposureCompensation: 0 - MeteringMode: 5 - Flash: 9 - FocalLength: 135 - SubSecTime: "00" - SubSecTimeOriginal: "00" - SubSecTimeDigitized: "00" - FlashpixVersion: "0100" - ColorSpace: 1 - ExifImageWidth: 100 - ExifImageHeight: 68 - InteropOffset: 948 - FocalPlaneXResolution: 4438.356164383562 - FocalPlaneYResolution: 4445.969125214408 - FocalPlaneResolutionUnit: 2 - CustomRendered: 0 - ExposureMode: 1 - WhiteBalance: 0 - SceneCaptureType: 0 - gps: - GPSVersionID: - - 2 - - 2 - - 0 - - 0 - interoperability: - InteropIndex: R98 - InteropVersion: "0100" - makernote: {} - VideoMetadata: - height: 720 - width: 1280 - bitRate: 546524 - duration: 70 - audioCodec: aac - videoCodec: h264 - size: 23490 - - securitySchemes: - basicAuth: - description: >- - Basic HTTP authentication. Allowed headers-- Authorization: Basic - | Authorization: Basic - - ImageKit API uses API keys to authenticate requests. You can view and manage your API keys in [the dashboard](https://imagekit.io/dashboard/developer/api-keys). - - All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. - scheme: basic - type: http - responses: - Forbidden: - description: Forbidden. - content: - application/json: - schema: - type: object - properties: - message: - type: string - examples: - - Your account cannot be authenticated. - - Your request contains expired private API key. - - Your account is disabled. - help: - type: string - example: For support kindly contact us at support@imagekit.io. - Unauthorized: - description: Unauthorized request. - content: - application/json: - schema: - type: object - properties: - message: - type: string - example: Your request does not contain private API key. - help: - type: string - example: For support kindly contact us at support@imagekit.io. - RateLimitExceeded: - description: The request exceeded the rate limit. Contains headers indicating the limits and a message detailing the error. - headers: - X-RateLimit-Limit: - schema: - type: integer - description: The maximum number of requests that can be made to this endpoint in the interval specified by `X-RateLimit-Interval` response header. - X-RateLimit-Reset: - schema: - type: integer - description: The amount of time in milliseconds before you can make another request to this endpoint. Pause/sleep your workflow for this duration. - X-RateLimit-Interval: - schema: - type: integer - description: The duration of the interval in milliseconds for which this rate limit was exceeded. - content: - application/json: - schema: - type: object - properties: - message: - type: string - description: A description of the error, providing details about why the rate limit has been exceeded. + size: 23490 + + securitySchemes: + basicAuth: + description: >- + Basic HTTP authentication. Allowed headers-- Authorization: Basic + | Authorization: Basic + + ImageKit API uses API keys to authenticate requests. You can view and manage your API keys in [the dashboard](https://imagekit.io/dashboard/developer/api-keys). + + All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. + scheme: basic + type: http + responses: + Forbidden: + description: Forbidden. + content: + application/json: + schema: + type: object + properties: + message: + type: string + examples: + - Your account cannot be authenticated. + - Your request contains expired private API key. + - Your account is disabled. + help: + type: string + example: For support kindly contact us at support@imagekit.io. + Unauthorized: + description: Unauthorized request. + content: + application/json: + schema: + type: object + properties: + message: + type: string + example: Your request does not contain private API key. + help: + type: string + example: For support kindly contact us at support@imagekit.io. + RateLimitExceeded: + description: The request exceeded the rate limit. Contains headers indicating the limits and a message detailing the error. + headers: + X-RateLimit-Limit: + schema: + type: integer + description: The maximum number of requests that can be made to this endpoint in the interval specified by `X-RateLimit-Interval` response header. + X-RateLimit-Reset: + schema: + type: integer + description: The amount of time in milliseconds before you can make another request to this endpoint. Pause/sleep your workflow for this duration. + X-RateLimit-Interval: + schema: + type: integer + description: The duration of the interval in milliseconds for which this rate limit was exceeded. + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A description of the error, providing details about why the rate limit has been exceeded. webhooks: video.transformation.accepted: @@ -8510,5 +8618,85 @@ webhooks: "200": description: Acknowledge + file.created: + post: + operationId: file-created + summary: File created + description: | + Triggered when a file is created. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/DamFileCreateEvent" + responses: + "200": + description: Acknowledge + + file.updated: + post: + operationId: file-updated + summary: File updated + description: | + Triggered when a file is updated. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/DamFileUpdateEvent" + responses: + "200": + description: Acknowledge + + file.deleted: + post: + operationId: file-deleted + summary: File deleted + description: | + Triggered when a file is deleted. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/DamFileDeleteEvent" + responses: + "200": + description: Acknowledge + + file-version.created: + post: + operationId: file-version-created + summary: File version created + description: | + Triggered when a file version is created. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/DamFileVersionCreateEvent" + responses: + "200": + description: Acknowledge + + file-version.deleted: + post: + operationId: file-version-deleted + summary: File version deleted + description: | + Triggered when a file version is deleted. + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/DamFileVersionDeleteEvent" + responses: + "200": + description: Acknowledge + security: - basicAuth: [] diff --git a/stainless-config/main.yaml b/stainless-config/main.yaml index e746d1a..023c464 100644 --- a/stainless-config/main.yaml +++ b/stainless-config/main.yaml @@ -251,6 +251,11 @@ resources: UploadPreTransformErrorEvent: '#/components/schemas/UploadPreTransformErrorEvent' UploadPostTransformSuccessEvent: '#/components/schemas/UploadPostTransformSuccessEvent' UploadPostTransformErrorEvent: '#/components/schemas/UploadPostTransformErrorEvent' + DamFileCreateEvent: '#/components/schemas/DamFileCreateEvent' + DamFileUpdateEvent: '#/components/schemas/DamFileUpdateEvent' + DamFileDeleteEvent: '#/components/schemas/DamFileDeleteEvent' + DamFileVersionCreateEvent: '#/components/schemas/DamFileVersionCreateEvent' + DamFileVersionDeleteEvent: '#/components/schemas/DamFileVersionDeleteEvent' methods: unwrap: