/** * SmartyMeet Dev03 API REST * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 1.0.1 * Contact: developer@smartymeet.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import type { AdSchema, AdsSchema, CreateAdRequestBody, UpdateAdRequestBody } from '../models/index'; export interface AdOptionsRequest { adId: string; } export interface CreateAdRequest { createAdRequestBody: CreateAdRequestBody; } export interface DeleteAdRequest { adId: string; } export interface ListAdsRequest { filterStatus?: ListAdsFilterStatusEnum; filterJobId?: string; filterCreatedFrom?: Date; filterCreatedTo?: Date; filterModifiedFrom?: Date; filterModifiedTo?: Date; pageSize?: number; pageNumber?: number; pageAfter?: string; pageBefore?: string; } export interface ShowAdRequest { adId: string; } export interface UpdateAdRequest { adId: string; updateAdRequestBody: UpdateAdRequestBody; } /** * */ export declare class AdsApi extends runtime.BaseAPI { /** * Creates request options for adOptions without sending the request */ adOptionsRequestOpts(requestParameters: AdOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Ad Options */ adOptionsRaw(requestParameters: AdOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Ad Options */ adOptions(requestParameters: AdOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for adsOptions without sending the request */ adsOptionsRequestOpts(): Promise; /** * Enable CORS by returning correct headers * Ads Options */ adsOptionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Ads Options */ adsOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for createAd without sending the request */ createAdRequestOpts(requestParameters: CreateAdRequest): Promise; /** * Creates a new ad in your account. ### Ad\'s Attributes Here is a table that describes the attributes of the ad object: | Attribute | Type | Description | |----------------------------|--------|-----------------------------------------------------------------------------| | `jobId` | string | The ID of the job this ad is generated for. | | `status` | string | The current status of the ad (e.g., active, archived). | | `platforms` | object | Platform-specific ad copy keyed by platform name and language. | | `images` | array | List of AI-generated images with platform and S3 key. | | `timestamps.created` | string | The date and time when the ad was created (ISO 8601 format). | | `timestamps.modified` | string | The date and time when the ad was last modified (ISO 8601 format). | * Create Ad */ createAdRaw(requestParameters: CreateAdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Creates a new ad in your account. ### Ad\'s Attributes Here is a table that describes the attributes of the ad object: | Attribute | Type | Description | |----------------------------|--------|-----------------------------------------------------------------------------| | `jobId` | string | The ID of the job this ad is generated for. | | `status` | string | The current status of the ad (e.g., active, archived). | | `platforms` | object | Platform-specific ad copy keyed by platform name and language. | | `images` | array | List of AI-generated images with platform and S3 key. | | `timestamps.created` | string | The date and time when the ad was created (ISO 8601 format). | | `timestamps.modified` | string | The date and time when the ad was last modified (ISO 8601 format). | * Create Ad */ createAd(requestParameters: CreateAdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for deleteAd without sending the request */ deleteAdRequestOpts(requestParameters: DeleteAdRequest): Promise; /** * This endpoint allows you to delete a specific ad from your account. Once deleted, the ad\'s information will be permanently removed and cannot be recovered. * Delete Ad */ deleteAdRaw(requestParameters: DeleteAdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows you to delete a specific ad from your account. Once deleted, the ad\'s information will be permanently removed and cannot be recovered. * Delete Ad */ deleteAd(requestParameters: DeleteAdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for listAds without sending the request */ listAdsRequestOpts(requestParameters: ListAdsRequest): Promise; /** * Returns a collection of your account ads ## Overview Returns a collection of your account ads, sorted by the time they were inserted into the system in ascending order. ### Ads Endpoints Pagination The ads endpoints support two versions of pagination: traditional and cursor-based. Note that the parameters for these pagination methods cannot coexist; using them together will result in a bad request error. :::tip Pagination tip Ensure that when using traditional pagination, you use `pageNumber`, and when using cursor-based pagination, you use either `pageAfter` or `pageBefore`, but not both together. ::: #### More information For more information, see the [pagination documentation](/docs/pagination). * List Ads */ listAdsRaw(requestParameters: ListAdsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns a collection of your account ads ## Overview Returns a collection of your account ads, sorted by the time they were inserted into the system in ascending order. ### Ads Endpoints Pagination The ads endpoints support two versions of pagination: traditional and cursor-based. Note that the parameters for these pagination methods cannot coexist; using them together will result in a bad request error. :::tip Pagination tip Ensure that when using traditional pagination, you use `pageNumber`, and when using cursor-based pagination, you use either `pageAfter` or `pageBefore`, but not both together. ::: #### More information For more information, see the [pagination documentation](/docs/pagination). * List Ads */ listAds(requestParameters?: ListAdsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for showAd without sending the request */ showAdRequestOpts(requestParameters: ShowAdRequest): Promise; /** * This endpoint retrieves details of a specific ad from your account. You can view information such as platform copy, images, status, and other relevant attributes of the ad. * Show Ad */ showAdRaw(requestParameters: ShowAdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint retrieves details of a specific ad from your account. You can view information such as platform copy, images, status, and other relevant attributes of the ad. * Show Ad */ showAd(requestParameters: ShowAdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for updateAd without sending the request */ updateAdRequestOpts(requestParameters: UpdateAdRequest): Promise; /** * This endpoint allows you to update details of a specific ad in your account. You can modify information such as status, settings, and other relevant attributes of the ad. Only the fields provided in the request will be updated. * Update Ad */ updateAdRaw(requestParameters: UpdateAdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows you to update details of a specific ad in your account. You can modify information such as status, settings, and other relevant attributes of the ad. Only the fields provided in the request will be updated. * Update Ad */ updateAd(requestParameters: UpdateAdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * @export */ export declare const ListAdsFilterStatusEnum: { readonly Active: "active"; readonly Archived: "archived"; }; export type ListAdsFilterStatusEnum = typeof ListAdsFilterStatusEnum[keyof typeof ListAdsFilterStatusEnum]; //# sourceMappingURL=AdsApi.d.ts.map