/** * 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 { CreateLinkRequestBody, LinkSchema, LinksSchema } from '../models/index'; export interface CreateLinkRequest { createLinkRequestBody: CreateLinkRequestBody; } export interface DeleteLinkRequest { linkId: string; } export interface LinkOptionsRequest { linkId: string; } export interface ListLinksRequest { filterStatus?: ListLinksFilterStatusEnum; filterCreatedFrom?: Date; filterCreatedTo?: Date; filterModifiedFrom?: Date; filterModifiedTo?: Date; pageSize?: number; pageNumber?: number; pageAfter?: string; pageBefore?: string; } export interface RefreshLinkRequest { linkId: string; } export interface ShowLinkRequest { linkId: string; } /** * */ export declare class LinksApi extends runtime.BaseAPI { /** * Creates request options for createLink without sending the request */ createLinkRequestOpts(requestParameters: CreateLinkRequest): Promise; /** * Creates a new link in your account. ### Link\'s Attributes Here is a table that describes the attributes of the link object: | Attribute | Type | Description | |----------------------------|--------|-----------------------------------------------------------------------------| | `name` | string | The full name of the link. | | `status` | string | The current status of the link (e.g., active, inactive). | | `timestamps.created` | string | The date and time when the link was created (ISO 8601 format). | | `timestamps.modified` | string | The date and time when the link was last modified (ISO 8601 format). | * Create Link */ createLinkRaw(requestParameters: CreateLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Creates a new link in your account. ### Link\'s Attributes Here is a table that describes the attributes of the link object: | Attribute | Type | Description | |----------------------------|--------|-----------------------------------------------------------------------------| | `name` | string | The full name of the link. | | `status` | string | The current status of the link (e.g., active, inactive). | | `timestamps.created` | string | The date and time when the link was created (ISO 8601 format). | | `timestamps.modified` | string | The date and time when the link was last modified (ISO 8601 format). | * Create Link */ createLink(requestParameters: CreateLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for deleteLink without sending the request */ deleteLinkRequestOpts(requestParameters: DeleteLinkRequest): Promise; /** * This endpoint allows you to delete a specific link from your account. Once deleted, the link\'s information will be permanently removed and cannot be recovered. * Delete Link */ deleteLinkRaw(requestParameters: DeleteLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint allows you to delete a specific link from your account. Once deleted, the link\'s information will be permanently removed and cannot be recovered. * Delete Link */ deleteLink(requestParameters: DeleteLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for linkOptions without sending the request */ linkOptionsRequestOpts(requestParameters: LinkOptionsRequest): Promise; /** * Enable CORS by returning correct headers * Link Options */ linkOptionsRaw(requestParameters: LinkOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Link Options */ linkOptions(requestParameters: LinkOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for linksOptions without sending the request */ linksOptionsRequestOpts(): Promise; /** * Enable CORS by returning correct headers * Links Options */ linksOptionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Enable CORS by returning correct headers * Links Options */ linksOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for listLinks without sending the request */ listLinksRequestOpts(requestParameters: ListLinksRequest): Promise; /** * Returns a collection of your account links ## Overview Returns a collection of your account links, sorted by the time they were inserted into the system in ascending order. ### Links Endpoints Pagination The links 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 Links */ listLinksRaw(requestParameters: ListLinksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns a collection of your account links ## Overview Returns a collection of your account links, sorted by the time they were inserted into the system in ascending order. ### Links Endpoints Pagination The links 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 Links */ listLinks(requestParameters?: ListLinksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for refreshLink without sending the request */ refreshLinkRequestOpts(requestParameters: RefreshLinkRequest): Promise; /** * Re-queues this link for a fresh Crawl4AI fetch. No request body. Returns the link with status reset to pending. * Re-fetch Link */ refreshLinkRaw(requestParameters: RefreshLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Re-queues this link for a fresh Crawl4AI fetch. No request body. Returns the link with status reset to pending. * Re-fetch Link */ refreshLink(requestParameters: RefreshLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for showLink without sending the request */ showLinkRequestOpts(requestParameters: ShowLinkRequest): Promise; /** * This endpoint retrieves details of a specific link from your account. You can view information such as name, and other relevant attributes of the link. * Show Link */ showLinkRaw(requestParameters: ShowLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * This endpoint retrieves details of a specific link from your account. You can view information such as name, and other relevant attributes of the link. * Show Link */ showLink(requestParameters: ShowLinkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * @export */ export declare const ListLinksFilterStatusEnum: { readonly Active: "active"; readonly Archived: "archived"; }; export type ListLinksFilterStatusEnum = typeof ListLinksFilterStatusEnum[keyof typeof ListLinksFilterStatusEnum]; //# sourceMappingURL=LinksApi.d.ts.map