//#region src/runtime.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ declare const BASE_PATH: string; interface ConfigurationParameters { basePath?: string; fetchApi?: FetchAPI; middleware?: Middleware[]; queryParamsStringify?: (params: HTTPQuery) => string; username?: string; password?: string; apiKey?: string | Promise | ((name: string) => string | Promise); accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string | Promise); headers?: HTTPHeaders; credentials?: RequestCredentials; } declare class Configuration { private configuration; constructor(configuration?: ConfigurationParameters); set config(configuration: Configuration); get basePath(): string; get fetchApi(): FetchAPI | undefined; get middleware(): Middleware[]; get queryParamsStringify(): (params: HTTPQuery) => string; get username(): string | undefined; get password(): string | undefined; get apiKey(): ((name: string) => string | Promise) | undefined; get accessToken(): ((name?: string, scopes?: string[]) => string | Promise) | undefined; get headers(): HTTPHeaders | undefined; get credentials(): RequestCredentials | undefined; } declare const DefaultConfig: Configuration; /** * This is the base class for all generated API classes. */ declare class BaseAPI { protected configuration: Configuration; private static readonly jsonRegex; private middleware; constructor(configuration?: Configuration); withMiddleware(this: T, ...middlewares: Middleware[]): T; withPreMiddleware(this: T, ...preMiddlewares: Array): T; withPostMiddleware(this: T, ...postMiddlewares: Array): T; /** * Check if the given MIME is a JSON MIME. * JSON MIME examples: * application/json * application/json; charset=UTF8 * APPLICATION/JSON * application/vnd.company+json * @param mime - MIME (Multipurpose Internet Mail Extensions) * @return True if the given MIME is JSON, false otherwise. */ protected isJsonMime(mime: string | null | undefined): boolean; protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise; private createFetchParams; private fetchApi; /** * Create a shallow clone of `this` by constructing a new instance * and then shallow cloning data members. */ private clone; } declare class ResponseError extends Error { response: Response; name: "ResponseError"; constructor(response: Response, msg?: string); } declare class FetchError extends Error { cause: Error; name: "FetchError"; constructor(cause: Error, msg?: string); } declare class RequiredError extends Error { field: string; name: "RequiredError"; constructor(field: string, msg?: string); } declare const COLLECTION_FORMATS: { csv: string; ssv: string; tsv: string; pipes: string; }; type FetchAPI = WindowOrWorkerGlobalScope['fetch']; type Json = any; type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD'; type HTTPHeaders = { [key: string]: string; }; type HTTPQuery = { [key: string]: string | number | null | boolean | Array | Set | HTTPQuery; }; type HTTPBody = Json | FormData | URLSearchParams; type HTTPRequestInit = { headers?: HTTPHeaders; method: HTTPMethod; credentials?: RequestCredentials; body?: HTTPBody; }; type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original'; type InitOverrideFunction = (requestContext: { init: HTTPRequestInit; context: RequestOpts; }) => Promise; interface FetchParams { url: string; init: RequestInit; } interface RequestOpts { path: string; method: HTTPMethod; headers: HTTPHeaders; query?: HTTPQuery; body?: HTTPBody; } declare function querystring(params: HTTPQuery, prefix?: string): string; declare function exists(json: any, key: string): boolean; declare function mapValues(data: any, fn: (item: any) => any): { [key: string]: any; }; declare function canConsumeForm(consumes: Consume[]): boolean; interface Consume { contentType: string; } interface RequestContext { fetch: FetchAPI; url: string; init: RequestInit; } interface ResponseContext { fetch: FetchAPI; url: string; init: RequestInit; response: Response; } interface ErrorContext { fetch: FetchAPI; url: string; init: RequestInit; error: unknown; response?: Response; } interface Middleware { pre?(context: RequestContext): Promise; post?(context: ResponseContext): Promise; onError?(context: ErrorContext): Promise; } interface ApiResponse { raw: Response; value(): Promise; } interface ResponseTransformer { (json: any): T; } declare class JSONApiResponse { raw: Response; private transformer; constructor(raw: Response, transformer?: ResponseTransformer); value(): Promise; } declare class VoidApiResponse { raw: Response; constructor(raw: Response); value(): Promise; } declare class BlobApiResponse { raw: Response; constructor(raw: Response); value(): Promise; } declare class TextApiResponse { raw: Response; constructor(raw: Response); value(): Promise; } //#endregion //#region src/models/BSDsResponse.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface BSDsResponse */ interface BSDsResponse { /** * * @type {Array} * @memberof BSDsResponse */ bsds?: Array; } /** * Check if a given object implements the BSDsResponse interface. */ declare function instanceOfBSDsResponse(value: object): value is BSDsResponse; declare function BSDsResponseFromJSON(json: any): BSDsResponse; declare function BSDsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): BSDsResponse; declare function BSDsResponseToJSON(json: any): BSDsResponse; declare function BSDsResponseToJSONTyped(value?: BSDsResponse | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/apis/BSDsApi.d.ts /** * */ declare class BSDsApi extends BaseAPI { /** * Creates request options for getBSDs without sending the request */ getBSDsRequestOpts(): Promise; /** * Fetch all Branded Short Domains * Get BSDs */ getBSDsRaw(initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Fetch all Branded Short Domains * Get BSDs */ getBSDs(initOverrides?: RequestInit | InitOverrideFunction): Promise; } //#endregion //#region src/models/MobileOS.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @enum {string} */ declare enum MobileOS { ios = "ios", android = "android" } declare function instanceOfMobileOS(value: any): boolean; declare function MobileOSFromJSON(json: any): MobileOS; declare function MobileOSFromJSONTyped(json: any, ignoreDiscriminator: boolean): MobileOS; declare function MobileOSToJSON(value?: MobileOS | null): any; declare function MobileOSToJSONTyped(value: any, ignoreDiscriminator: boolean): MobileOS; //#endregion //#region src/models/InstallPreference.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @enum {string} */ declare enum InstallPreference { no_install = "no_install", auto_install = "auto_install", promote_install = "promote_install" } declare function instanceOfInstallPreference(value: any): boolean; declare function InstallPreferenceFromJSON(json: any): InstallPreference; declare function InstallPreferenceFromJSONTyped(json: any, ignoreDiscriminator: boolean): InstallPreference; declare function InstallPreferenceToJSON(value?: InstallPreference | null): any; declare function InstallPreferenceToJSONTyped(value: any, ignoreDiscriminator: boolean): InstallPreference; //#endregion //#region src/models/DeeplinkRule.d.ts /** * * @export * @interface DeeplinkRule */ interface DeeplinkRule { /** * * @type {string} * @memberof DeeplinkRule */ guid?: string; /** * * @type {string} * @memberof DeeplinkRule */ bitlink?: string; /** * * @type {string} * @memberof DeeplinkRule */ app_uri_path?: string; /** * * @type {string} * @memberof DeeplinkRule */ install_url?: string; /** * * @type {string} * @memberof DeeplinkRule */ app_guid?: string; /** * * @type {MobileOS} * @memberof DeeplinkRule */ os?: MobileOS; /** * * @type {InstallPreference} * @memberof DeeplinkRule */ install_type?: InstallPreference; /** * ISO timestamp * @type {string} * @memberof DeeplinkRule */ created?: string; /** * ISO timestamp * @type {string} * @memberof DeeplinkRule */ modified?: string; /** * * @type {string} * @memberof DeeplinkRule */ brand_guid?: string; } /** * Check if a given object implements the DeeplinkRule interface. */ declare function instanceOfDeeplinkRule(value: object): value is DeeplinkRule; declare function DeeplinkRuleFromJSON(json: any): DeeplinkRule; declare function DeeplinkRuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeeplinkRule; declare function DeeplinkRuleToJSON(json: any): DeeplinkRule; declare function DeeplinkRuleToJSONTyped(value?: DeeplinkRule | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/BitlinkBody.d.ts /** * * @export * @interface BitlinkBody */ interface BitlinkBody { /** * * @type {{ [key: string]: string; }} * @memberof BitlinkBody */ references?: { [key: string]: string; }; /** * * @type {string} * @memberof BitlinkBody */ link?: string; /** * * @type {string} * @memberof BitlinkBody */ id?: string; /** * * @type {string} * @memberof BitlinkBody */ long_url?: string; /** * * @type {string} * @memberof BitlinkBody */ title?: string; /** * * @type {boolean} * @memberof BitlinkBody */ archived?: boolean; /** * * @type {string} * @memberof BitlinkBody */ created_at?: string; /** * * @type {string} * @memberof BitlinkBody */ created_by?: string; /** * * @type {string} * @memberof BitlinkBody */ client_id?: string; /** * list of previously edited backhalfs for the bitlink - these are in reverse chronological order, with the most recently edited backhalf first * @type {Array} * @memberof BitlinkBody */ custom_bitlinks?: Array; /** * * @type {Array} * @memberof BitlinkBody */ tags?: Array; /** * * @type {Array} * @memberof BitlinkBody */ launchpad_ids?: Array; /** * a list of qr code ids that are associated with this bitlink * @type {Array} * @memberof BitlinkBody */ qr_code_ids?: Array; /** * * @type {Array} * @memberof BitlinkBody */ deeplinks?: Array; /** * * @type {boolean} * @memberof BitlinkBody */ is_deleted?: boolean; /** * * @type {Array} * @memberof BitlinkBody */ campaign_ids?: Array; /** * Optional expiration timestamp for the bitlink (e.g., 2025-01-28T14:30:00+0000) * @type {string} * @memberof BitlinkBody */ expiration_at?: string; } /** * Check if a given object implements the BitlinkBody interface. */ declare function instanceOfBitlinkBody(value: object): value is BitlinkBody; declare function BitlinkBodyFromJSON(json: any): BitlinkBody; declare function BitlinkBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): BitlinkBody; declare function BitlinkBodyToJSON(json: any): BitlinkBody; declare function BitlinkBodyToJSONTyped(value?: BitlinkBody | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/BitlinkUpdateBody.d.ts /** * * @export * @interface BitlinkUpdateBody */ interface BitlinkUpdateBody { /** * * @type {string} * @memberof BitlinkUpdateBody */ title?: string; /** * * @type {boolean} * @memberof BitlinkUpdateBody */ archived?: boolean; /** * * @type {Array} * @memberof BitlinkUpdateBody */ tags?: Array; /** * * @type {Array} * @memberof BitlinkUpdateBody */ deeplinks?: Array; /** * * @type {string} * @memberof BitlinkUpdateBody */ long_url?: string; /** * Optional expiration timestamp for the bitlink (e.g., 2025-01-28T14:30:00+0000). Minimum expiration time is 5 minutes from now and maximum is 1 year. * @type {string} * @memberof BitlinkUpdateBody */ expiration_at?: string; } /** * Check if a given object implements the BitlinkUpdateBody interface. */ declare function instanceOfBitlinkUpdateBody(value: object): value is BitlinkUpdateBody; declare function BitlinkUpdateBodyFromJSON(json: any): BitlinkUpdateBody; declare function BitlinkUpdateBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): BitlinkUpdateBody; declare function BitlinkUpdateBodyToJSON(json: any): BitlinkUpdateBody; declare function BitlinkUpdateBodyToJSONTyped(value?: BitlinkUpdateBody | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/BitlinksPagination.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface BitlinksPagination */ interface BitlinksPagination { /** * * @type {string} * @memberof BitlinksPagination */ next?: string; /** * * @type {string} * @memberof BitlinksPagination */ search_after?: string; /** * * @type {number} * @memberof BitlinksPagination */ size?: number; } /** * Check if a given object implements the BitlinksPagination interface. */ declare function instanceOfBitlinksPagination(value: object): value is BitlinksPagination; declare function BitlinksPaginationFromJSON(json: any): BitlinksPagination; declare function BitlinksPaginationFromJSONTyped(json: any, ignoreDiscriminator: boolean): BitlinksPagination; declare function BitlinksPaginationToJSON(json: any): BitlinksPagination; declare function BitlinksPaginationToJSONTyped(value?: BitlinksPagination | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/Bitlinks.d.ts /** * * @export * @interface Bitlinks */ interface Bitlinks { /** * * @type {Array} * @memberof Bitlinks */ links?: Array; /** * * @type {BitlinksPagination} * @memberof Bitlinks */ pagination?: BitlinksPagination; } /** * Check if a given object implements the Bitlinks interface. */ declare function instanceOfBitlinks(value: object): value is Bitlinks; declare function BitlinksFromJSON(json: any): Bitlinks; declare function BitlinksFromJSONTyped(json: any, ignoreDiscriminator: boolean): Bitlinks; declare function BitlinksToJSON(json: any): Bitlinks; declare function BitlinksToJSONTyped(value?: Bitlinks | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/BulkUpdate.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface BulkUpdate */ interface BulkUpdate { /** * * @type {Array} * @memberof BulkUpdate */ links?: Array; } /** * Check if a given object implements the BulkUpdate interface. */ declare function instanceOfBulkUpdate(value: object): value is BulkUpdate; declare function BulkUpdateFromJSON(json: any): BulkUpdate; declare function BulkUpdateFromJSONTyped(json: any, ignoreDiscriminator: boolean): BulkUpdate; declare function BulkUpdateToJSON(json: any): BulkUpdate; declare function BulkUpdateToJSONTyped(value?: BulkUpdate | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/BulkUpdateRequest.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface BulkUpdateRequest */ interface BulkUpdateRequest { /** * archive or edit_tags * @type {BulkUpdateRequestActionEnum} * @memberof BulkUpdateRequest */ action: BulkUpdateRequestActionEnum; /** * * @type {boolean} * @memberof BulkUpdateRequest */ archive?: boolean; /** * * @type {Array} * @memberof BulkUpdateRequest */ add_tags?: Array; /** * * @type {Array} * @memberof BulkUpdateRequest */ remove_tags?: Array; /** * this is limited to 100 bitlink ids * @type {Array} * @memberof BulkUpdateRequest */ links?: Array; } /** * @export * @enum {string} */ declare enum BulkUpdateRequestActionEnum { archive = "archive", edit_tags = "edit_tags" } /** * Check if a given object implements the BulkUpdateRequest interface. */ declare function instanceOfBulkUpdateRequest(value: object): value is BulkUpdateRequest; declare function BulkUpdateRequestFromJSON(json: any): BulkUpdateRequest; declare function BulkUpdateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): BulkUpdateRequest; declare function BulkUpdateRequestToJSON(json: any): BulkUpdateRequest; declare function BulkUpdateRequestToJSONTyped(value?: BulkUpdateRequest | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/OtherMetrics.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface OtherMetrics */ interface OtherMetrics { /** * * @type {number} * @memberof OtherMetrics */ other_city_clicks?: number; /** * * @type {number} * @memberof OtherMetrics */ no_city_clicks?: number; } /** * Check if a given object implements the OtherMetrics interface. */ declare function instanceOfOtherMetrics(value: object): value is OtherMetrics; declare function OtherMetricsFromJSON(json: any): OtherMetrics; declare function OtherMetricsFromJSONTyped(json: any, ignoreDiscriminator: boolean): OtherMetrics; declare function OtherMetricsToJSON(json: any): OtherMetrics; declare function OtherMetricsToJSONTyped(value?: OtherMetrics | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/CityMetric.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface CityMetric */ interface CityMetric { /** * * @type {number} * @memberof CityMetric */ clicks?: number; /** * * @type {string} * @memberof CityMetric */ city?: string; /** * * @type {string} * @memberof CityMetric */ subregion?: string; /** * * @type {string} * @memberof CityMetric */ region?: string; /** * * @type {string} * @memberof CityMetric */ country?: string; } /** * Check if a given object implements the CityMetric interface. */ declare function instanceOfCityMetric(value: object): value is CityMetric; declare function CityMetricFromJSON(json: any): CityMetric; declare function CityMetricFromJSONTyped(json: any, ignoreDiscriminator: boolean): CityMetric; declare function CityMetricToJSON(json: any): CityMetric; declare function CityMetricToJSONTyped(value?: CityMetric | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/CityMetrics.d.ts /** * * @export * @interface CityMetrics */ interface CityMetrics { /** * * @type {string} * @memberof CityMetrics */ unit?: string; /** * * @type {number} * @memberof CityMetrics */ units?: number; /** * * @type {CityMetricsFacetEnum} * @memberof CityMetrics */ facet?: CityMetricsFacetEnum; /** * * @type {string} * @memberof CityMetrics */ unit_reference?: string; /** * * @type {Array} * @memberof CityMetrics */ metrics?: Array; /** * * @type {OtherMetrics} * @memberof CityMetrics */ other_metrics?: OtherMetrics; } /** * @export * @enum {string} */ declare enum CityMetricsFacetEnum { countries = "countries", cities = "cities", devices = "devices", referrers = "referrers", referrers_by_domain = "referrers_by_domain", referring_domains = "referring_domains", referring_networks = "referring_networks", shorten_counts = "shorten_counts", destinations = "destinations" } /** * Check if a given object implements the CityMetrics interface. */ declare function instanceOfCityMetrics(value: object): value is CityMetrics; declare function CityMetricsFromJSON(json: any): CityMetrics; declare function CityMetricsFromJSONTyped(json: any, ignoreDiscriminator: boolean): CityMetrics; declare function CityMetricsToJSON(json: any): CityMetrics; declare function CityMetricsToJSONTyped(value?: CityMetrics | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/ClickMetric.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface ClickMetric */ interface ClickMetric { /** * * @type {number} * @memberof ClickMetric */ clicks?: number; /** * * @type {string} * @memberof ClickMetric */ value?: string; } /** * Check if a given object implements the ClickMetric interface. */ declare function instanceOfClickMetric(value: object): value is ClickMetric; declare function ClickMetricFromJSON(json: any): ClickMetric; declare function ClickMetricFromJSONTyped(json: any, ignoreDiscriminator: boolean): ClickMetric; declare function ClickMetricToJSON(json: any): ClickMetric; declare function ClickMetricToJSONTyped(value?: ClickMetric | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/ClickMetrics.d.ts /** * * @export * @interface ClickMetrics */ interface ClickMetrics { /** * * @type {string} * @memberof ClickMetrics */ unit?: string; /** * * @type {number} * @memberof ClickMetrics */ units?: number; /** * * @type {ClickMetricsFacetEnum} * @memberof ClickMetrics */ facet?: ClickMetricsFacetEnum; /** * * @type {string} * @memberof ClickMetrics */ unit_reference?: string; /** * * @type {Array} * @memberof ClickMetrics */ metrics?: Array; } /** * @export * @enum {string} */ declare enum ClickMetricsFacetEnum { countries = "countries", cities = "cities", devices = "devices", referrers = "referrers", referrers_by_domain = "referrers_by_domain", referring_domains = "referring_domains", referring_networks = "referring_networks", shorten_counts = "shorten_counts", destinations = "destinations" } /** * Check if a given object implements the ClickMetrics interface. */ declare function instanceOfClickMetrics(value: object): value is ClickMetrics; declare function ClickMetricsFromJSON(json: any): ClickMetrics; declare function ClickMetricsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ClickMetrics; declare function ClickMetricsToJSON(json: any): ClickMetrics; declare function ClickMetricsToJSONTyped(value?: ClickMetrics | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/LinkClicks.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface LinkClicks */ interface LinkClicks { /** * * @type {number} * @memberof LinkClicks */ clicks?: number; /** * * @type {string} * @memberof LinkClicks */ date?: string; } /** * Check if a given object implements the LinkClicks interface. */ declare function instanceOfLinkClicks(value: object): value is LinkClicks; declare function LinkClicksFromJSON(json: any): LinkClicks; declare function LinkClicksFromJSONTyped(json: any, ignoreDiscriminator: boolean): LinkClicks; declare function LinkClicksToJSON(json: any): LinkClicks; declare function LinkClicksToJSONTyped(value?: LinkClicks | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/Clicks.d.ts /** * * @export * @interface Clicks */ interface Clicks { /** * * @type {Array} * @memberof Clicks */ link_clicks?: Array; /** * * @type {number} * @memberof Clicks */ units?: number; /** * * @type {ClicksUnitEnum} * @memberof Clicks */ unit?: ClicksUnitEnum; /** * * @type {string} * @memberof Clicks */ unit_reference?: string; } /** * @export * @enum {string} */ declare enum ClicksUnitEnum { minute = "minute", hour = "hour", day = "day", week = "week", month = "month" } /** * Check if a given object implements the Clicks interface. */ declare function instanceOfClicks(value: object): value is Clicks; declare function ClicksFromJSON(json: any): Clicks; declare function ClicksFromJSONTyped(json: any, ignoreDiscriminator: boolean): Clicks; declare function ClicksToJSON(json: any): Clicks; declare function ClicksToJSONTyped(value?: Clicks | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/ClicksSummary.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface ClicksSummary */ interface ClicksSummary { /** * * @type {number} * @memberof ClicksSummary */ total_clicks?: number; /** * * @type {number} * @memberof ClicksSummary */ units?: number; /** * * @type {ClicksSummaryUnitEnum} * @memberof ClicksSummary */ unit?: ClicksSummaryUnitEnum; /** * * @type {string} * @memberof ClicksSummary */ unit_reference?: string; } /** * @export * @enum {string} */ declare enum ClicksSummaryUnitEnum { minute = "minute", hour = "hour", day = "day", week = "week", month = "month" } /** * Check if a given object implements the ClicksSummary interface. */ declare function instanceOfClicksSummary(value: object): value is ClicksSummary; declare function ClicksSummaryFromJSON(json: any): ClicksSummary; declare function ClicksSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): ClicksSummary; declare function ClicksSummaryToJSON(json: any): ClicksSummary; declare function ClicksSummaryToJSONTyped(value?: ClicksSummary | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/DeviceMetric.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface DeviceMetric */ interface DeviceMetric { /** * * @type {number} * @memberof DeviceMetric */ clicks?: number; /** * * @type {string} * @memberof DeviceMetric */ device_type?: string; } /** * Check if a given object implements the DeviceMetric interface. */ declare function instanceOfDeviceMetric(value: object): value is DeviceMetric; declare function DeviceMetricFromJSON(json: any): DeviceMetric; declare function DeviceMetricFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeviceMetric; declare function DeviceMetricToJSON(json: any): DeviceMetric; declare function DeviceMetricToJSONTyped(value?: DeviceMetric | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/DeviceMetrics.d.ts /** * * @export * @interface DeviceMetrics */ interface DeviceMetrics { /** * * @type {string} * @memberof DeviceMetrics */ unit?: string; /** * * @type {number} * @memberof DeviceMetrics */ units?: number; /** * * @type {DeviceMetricsFacetEnum} * @memberof DeviceMetrics */ facet?: DeviceMetricsFacetEnum; /** * * @type {string} * @memberof DeviceMetrics */ unit_reference?: string; /** * * @type {Array} * @memberof DeviceMetrics */ metrics?: Array; } /** * @export * @enum {string} */ declare enum DeviceMetricsFacetEnum { countries = "countries", cities = "cities", devices = "devices", referrers = "referrers", referrers_by_domain = "referrers_by_domain", referring_domains = "referring_domains", referring_networks = "referring_networks", shorten_counts = "shorten_counts", destinations = "destinations" } /** * Check if a given object implements the DeviceMetrics interface. */ declare function instanceOfDeviceMetrics(value: object): value is DeviceMetrics; declare function DeviceMetricsFromJSON(json: any): DeviceMetrics; declare function DeviceMetricsFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeviceMetrics; declare function DeviceMetricsToJSON(json: any): DeviceMetrics; declare function DeviceMetricsToJSONTyped(value?: DeviceMetrics | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/ExpandBitlink.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface ExpandBitlink */ interface ExpandBitlink { /** * * @type {string} * @memberof ExpandBitlink */ bitlink_id?: string; } /** * Check if a given object implements the ExpandBitlink interface. */ declare function instanceOfExpandBitlink(value: object): value is ExpandBitlink; declare function ExpandBitlinkFromJSON(json: any): ExpandBitlink; declare function ExpandBitlinkFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExpandBitlink; declare function ExpandBitlinkToJSON(json: any): ExpandBitlink; declare function ExpandBitlinkToJSONTyped(value?: ExpandBitlink | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/ExpandedBitlink.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface ExpandedBitlink */ interface ExpandedBitlink { /** * * @type {string} * @memberof ExpandedBitlink */ link?: string; /** * * @type {string} * @memberof ExpandedBitlink */ id?: string; /** * * @type {string} * @memberof ExpandedBitlink */ long_url?: string; /** * * @type {string} * @memberof ExpandedBitlink */ created_at?: string; } /** * Check if a given object implements the ExpandedBitlink interface. */ declare function instanceOfExpandedBitlink(value: object): value is ExpandedBitlink; declare function ExpandedBitlinkFromJSON(json: any): ExpandedBitlink; declare function ExpandedBitlinkFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExpandedBitlink; declare function ExpandedBitlinkToJSON(json: any): ExpandedBitlink; declare function ExpandedBitlinkToJSONTyped(value?: ExpandedBitlink | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/Deeplink.d.ts /** * * @export * @interface Deeplink */ interface Deeplink { /** * * @type {string} * @memberof Deeplink */ app_id?: string; /** * * @type {string} * @memberof Deeplink */ app_uri_path?: string; /** * * @type {string} * @memberof Deeplink */ install_url?: string; /** * * @type {InstallPreference} * @memberof Deeplink */ install_type?: InstallPreference; } /** * Check if a given object implements the Deeplink interface. */ declare function instanceOfDeeplink(value: object): value is Deeplink; declare function DeeplinkFromJSON(json: any): Deeplink; declare function DeeplinkFromJSONTyped(json: any, ignoreDiscriminator: boolean): Deeplink; declare function DeeplinkToJSON(json: any): Deeplink; declare function DeeplinkToJSONTyped(value?: Deeplink | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/FullShorten.d.ts /** * Either long_url (for new bitlinks) or bitlink_id (for adding keywords to existing bitlinks) must be provided, but not both. * @export * @interface FullShorten */ interface FullShorten { /** * URL to be shortened. Required when creating new bitlinks. Cannot be used with bitlink_id. * @type {string} * @memberof FullShorten */ long_url?: string; /** * * @type {string} * @memberof FullShorten */ domain?: string; /** * Always include a specific group and custom domain in your shorten calls. * @type {string} * @memberof FullShorten */ group_guid?: string; /** * * @type {string} * @memberof FullShorten */ title?: string; /** * * @type {Array} * @memberof FullShorten */ tags?: Array; /** * * @type {Array} * @memberof FullShorten */ deeplinks?: Array; /** * * @type {boolean} * @memberof FullShorten */ force_new_link?: boolean; /** * Custom keyword for creating keyword overrides. If provided, creates an override at domain/keyword * @type {string} * @memberof FullShorten */ keyword?: string; /** * Existing bitlink ID to add a keyword override to. Format: domain/hash. Cannot be used with long_url * @type {string} * @memberof FullShorten */ bitlink_id?: string; /** * Optional expiration timestamp for the bitlink (e.g., 2025-01-28T14:30:00+0000). Minimum expiration time is 5 minutes from now and maximum is 1 year. * @type {string} * @memberof FullShorten */ expiration_at?: string; } /** * Check if a given object implements the FullShorten interface. */ declare function instanceOfFullShorten(value: object): value is FullShorten; declare function FullShortenFromJSON(json: any): FullShorten; declare function FullShortenFromJSONTyped(json: any, ignoreDiscriminator: boolean): FullShorten; declare function FullShortenToJSON(json: any): FullShorten; declare function FullShortenToJSONTyped(value?: FullShorten | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/DeletedLink.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface DeletedLink */ interface DeletedLink { /** * * @type {string} * @memberof DeletedLink */ id?: string; } /** * Check if a given object implements the DeletedLink interface. */ declare function instanceOfDeletedLink(value: object): value is DeletedLink; declare function DeletedLinkFromJSON(json: any): DeletedLink; declare function DeletedLinkFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeletedLink; declare function DeletedLinkToJSON(json: any): DeletedLink; declare function DeletedLinkToJSONTyped(value?: DeletedLink | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/LinkDeletionResponse.d.ts /** * * @export * @interface LinkDeletionResponse */ interface LinkDeletionResponse { /** * * @type {Array} * @memberof LinkDeletionResponse */ links_deleted?: Array; } /** * Check if a given object implements the LinkDeletionResponse interface. */ declare function instanceOfLinkDeletionResponse(value: object): value is LinkDeletionResponse; declare function LinkDeletionResponseFromJSON(json: any): LinkDeletionResponse; declare function LinkDeletionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): LinkDeletionResponse; declare function LinkDeletionResponseToJSON(json: any): LinkDeletionResponse; declare function LinkDeletionResponseToJSONTyped(value?: LinkDeletionResponse | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/Metric.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface Metric */ interface Metric { /** * * @type {string} * @memberof Metric */ key?: string; /** * * @type {number} * @memberof Metric */ value?: number; } /** * Check if a given object implements the Metric interface. */ declare function instanceOfMetric(value: object): value is Metric; declare function MetricFromJSON(json: any): Metric; declare function MetricFromJSONTyped(json: any, ignoreDiscriminator: boolean): Metric; declare function MetricToJSON(json: any): Metric; declare function MetricToJSONTyped(value?: Metric | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/ReferrersByDomain.d.ts /** * * @export * @interface ReferrersByDomain */ interface ReferrersByDomain { /** * * @type {string} * @memberof ReferrersByDomain */ network?: string; /** * * @type {Array} * @memberof ReferrersByDomain */ referrers?: Array; } /** * Check if a given object implements the ReferrersByDomain interface. */ declare function instanceOfReferrersByDomain(value: object): value is ReferrersByDomain; declare function ReferrersByDomainFromJSON(json: any): ReferrersByDomain; declare function ReferrersByDomainFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReferrersByDomain; declare function ReferrersByDomainToJSON(json: any): ReferrersByDomain; declare function ReferrersByDomainToJSONTyped(value?: ReferrersByDomain | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/ReferrersByDomains.d.ts /** * * @export * @interface ReferrersByDomains */ interface ReferrersByDomains { /** * * @type {string} * @memberof ReferrersByDomains */ unit?: string; /** * * @type {number} * @memberof ReferrersByDomains */ units?: number; /** * * @type {ReferrersByDomainsFacetEnum} * @memberof ReferrersByDomains */ facet?: ReferrersByDomainsFacetEnum; /** * * @type {string} * @memberof ReferrersByDomains */ unit_reference?: string; /** * * @type {Array} * @memberof ReferrersByDomains */ referrers_by_domain?: Array; } /** * @export * @enum {string} */ declare enum ReferrersByDomainsFacetEnum { referrers_by_domains = "referrers_by_domains" } /** * Check if a given object implements the ReferrersByDomains interface. */ declare function instanceOfReferrersByDomains(value: object): value is ReferrersByDomains; declare function ReferrersByDomainsFromJSON(json: any): ReferrersByDomains; declare function ReferrersByDomainsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReferrersByDomains; declare function ReferrersByDomainsToJSON(json: any): ReferrersByDomains; declare function ReferrersByDomainsToJSONTyped(value?: ReferrersByDomains | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/Shorten.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface Shorten */ interface Shorten { /** * * @type {string} * @memberof Shorten */ long_url: string; /** * * @type {string} * @memberof Shorten */ domain?: string; /** * * @type {string} * @memberof Shorten */ group_guid?: string; /** * * @type {boolean} * @memberof Shorten */ force_new_link?: boolean; } /** * Check if a given object implements the Shorten interface. */ declare function instanceOfShorten(value: object): value is Shorten; declare function ShortenFromJSON(json: any): Shorten; declare function ShortenFromJSONTyped(json: any, ignoreDiscriminator: boolean): Shorten; declare function ShortenToJSON(json: any): Shorten; declare function ShortenToJSONTyped(value?: Shorten | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/ShortenBitlinkBody.d.ts /** * * @export * @interface ShortenBitlinkBody */ interface ShortenBitlinkBody { /** * * @type {{ [key: string]: string; }} * @memberof ShortenBitlinkBody */ references?: { [key: string]: string; }; /** * * @type {string} * @memberof ShortenBitlinkBody */ link?: string; /** * * @type {string} * @memberof ShortenBitlinkBody */ id?: string; /** * * @type {string} * @memberof ShortenBitlinkBody */ long_url?: string; /** * * @type {boolean} * @memberof ShortenBitlinkBody */ archived?: boolean; /** * * @type {string} * @memberof ShortenBitlinkBody */ created_at?: string; /** * list of previously edited backhalfs for the bitlink - these are in reverse chronological order, with the most recently edited backhalf first * @type {Array} * @memberof ShortenBitlinkBody */ custom_bitlinks?: Array; /** * * @type {Array} * @memberof ShortenBitlinkBody */ tags?: Array; /** * * @type {Array} * @memberof ShortenBitlinkBody */ deeplinks?: Array; } /** * Check if a given object implements the ShortenBitlinkBody interface. */ declare function instanceOfShortenBitlinkBody(value: object): value is ShortenBitlinkBody; declare function ShortenBitlinkBodyFromJSON(json: any): ShortenBitlinkBody; declare function ShortenBitlinkBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): ShortenBitlinkBody; declare function ShortenBitlinkBodyToJSON(json: any): ShortenBitlinkBody; declare function ShortenBitlinkBodyToJSONTyped(value?: ShortenBitlinkBody | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/ClickLink.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface ClickLink */ interface ClickLink { /** * * @type {number} * @memberof ClickLink */ clicks?: number; /** * * @type {string} * @memberof ClickLink */ id?: string; } /** * Check if a given object implements the ClickLink interface. */ declare function instanceOfClickLink(value: object): value is ClickLink; declare function ClickLinkFromJSON(json: any): ClickLink; declare function ClickLinkFromJSONTyped(json: any, ignoreDiscriminator: boolean): ClickLink; declare function ClickLinkToJSON(json: any): ClickLink; declare function ClickLinkToJSONTyped(value?: ClickLink | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/SortedLinks.d.ts /** * * @export * @interface SortedLinks */ interface SortedLinks { /** * * @type {Array} * @memberof SortedLinks */ links?: Array; /** * * @type {Array} * @memberof SortedLinks */ sorted_links?: Array; } /** * Check if a given object implements the SortedLinks interface. */ declare function instanceOfSortedLinks(value: object): value is SortedLinks; declare function SortedLinksFromJSON(json: any): SortedLinks; declare function SortedLinksFromJSONTyped(json: any, ignoreDiscriminator: boolean): SortedLinks; declare function SortedLinksToJSON(json: any): SortedLinks; declare function SortedLinksToJSONTyped(value?: SortedLinks | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/TimeUnit.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * the unit of time queried for (minute, hour, day, week, month) * @export * @enum {string} */ declare enum TimeUnit { minute = "minute", hour = "hour", day = "day", week = "week", month = "month" } declare function instanceOfTimeUnit(value: any): boolean; declare function TimeUnitFromJSON(json: any): TimeUnit; declare function TimeUnitFromJSONTyped(json: any, ignoreDiscriminator: boolean): TimeUnit; declare function TimeUnitToJSON(value?: TimeUnit | null): any; declare function TimeUnitToJSONTyped(value: any, ignoreDiscriminator: boolean): TimeUnit; //#endregion //#region src/models/EngagementSubtotal.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Engagement-count subtotal for a single bitlink or decoupled QR code. The `id` references either a bitlink (`/`) or a QR code guid, and `engagements` is the combined count of bitlink clicks or QR code scans for that entity. * * @export * @interface EngagementSubtotal */ interface EngagementSubtotal { /** * * @type {number} * @memberof EngagementSubtotal */ engagements?: number; /** * * @type {string} * @memberof EngagementSubtotal */ id?: string; } /** * Check if a given object implements the EngagementSubtotal interface. */ declare function instanceOfEngagementSubtotal(value: object): value is EngagementSubtotal; declare function EngagementSubtotalFromJSON(json: any): EngagementSubtotal; declare function EngagementSubtotalFromJSONTyped(json: any, ignoreDiscriminator: boolean): EngagementSubtotal; declare function EngagementSubtotalToJSON(json: any): EngagementSubtotal; declare function EngagementSubtotalToJSONTyped(value?: EngagementSubtotal | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/QRCodeTypeEnum.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * The type of dynamic/static content the QR serves, e.g. Link In Bio page, micro site, bitlink, email, text, Wifi, etc. * @export * @enum {string} */ declare enum QRCodeTypeEnum { bitlink = "bitlink", long_url = "long_url", link_in_bio = "link_in_bio", v_card = "v_card", wifi = "wifi", email = "email", phone = "phone", text = "text" } declare function instanceOfQRCodeTypeEnum(value: any): boolean; declare function QRCodeTypeEnumFromJSON(json: any): QRCodeTypeEnum; declare function QRCodeTypeEnumFromJSONTyped(json: any, ignoreDiscriminator: boolean): QRCodeTypeEnum; declare function QRCodeTypeEnumToJSON(value?: QRCodeTypeEnum | null): any; declare function QRCodeTypeEnumToJSONTyped(value: any, ignoreDiscriminator: boolean): QRCodeTypeEnum; //#endregion //#region src/models/QRCodeMinimal.d.ts /** * * @export * @interface QRCodeMinimal */ interface QRCodeMinimal { /** * * @type {string} * @memberof QRCodeMinimal */ qrcode_id?: string; /** * * @type {string} * @memberof QRCodeMinimal */ group_guid?: string; /** * * @type {string} * @memberof QRCodeMinimal */ title?: string; /** * Set to true if the QR code's customization values have been changed from their default setting * @type {boolean} * @memberof QRCodeMinimal */ is_customized?: boolean; /** * A serialized string of the QR code's content * @type {string} * @memberof QRCodeMinimal */ serialized_content?: string; /** * * @type {QRCodeTypeEnum} * @memberof QRCodeMinimal */ qr_code_type?: QRCodeTypeEnum; /** * A list of destination URLs that the qr code leads to. * @type {Array} * @memberof QRCodeMinimal */ long_urls?: Array; /** * The bitlink ID associated with the qr code. Not all qr codes are associated with one. * @type {string} * @memberof QRCodeMinimal */ bitlink_id?: string; /** * Set to true if QR code has GS1 values. * @type {boolean} * @memberof QRCodeMinimal */ is_gs1?: boolean; /** * User that created the code. * @type {string} * @memberof QRCodeMinimal */ created_by?: string; /** * A list of tags associated with QR code * @type {Array} * @memberof QRCodeMinimal */ tags?: Array; /** * * @type {boolean} * @memberof QRCodeMinimal */ archived?: boolean; /** * Optional expiration timestamp for the QR code's bitlink (e.g., 2025-01-28T14:30:00+0000) * @type {string} * @memberof QRCodeMinimal */ expiration_at?: string; /** * * @type {string} * @memberof QRCodeMinimal */ created?: string; /** * * @type {string} * @memberof QRCodeMinimal */ modified?: string; } /** * Check if a given object implements the QRCodeMinimal interface. */ declare function instanceOfQRCodeMinimal(value: object): value is QRCodeMinimal; declare function QRCodeMinimalFromJSON(json: any): QRCodeMinimal; declare function QRCodeMinimalFromJSONTyped(json: any, ignoreDiscriminator: boolean): QRCodeMinimal; declare function QRCodeMinimalToJSON(json: any): QRCodeMinimal; declare function QRCodeMinimalToJSONTyped(value?: QRCodeMinimal | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/TopLinksAndQRCodes.d.ts /** * Response shape for top bitlinks and decoupled QR codes in a group, ranked together by engagement count. `links` and `qr_codes` are independent lists (a link and a decoupled QR code are never the same entity); `sorted_engagements` is the unified descending-by-engagement ordering across both, with each entry's id referencing either a bitlink or a QR code guid. Coupled QRCs are listed by their bitlink ID. * * @export * @interface TopLinksAndQRCodes */ interface TopLinksAndQRCodes { /** * * @type {Array} * @memberof TopLinksAndQRCodes */ links?: Array; /** * * @type {Array} * @memberof TopLinksAndQRCodes */ qr_codes?: Array; /** * * @type {Array} * @memberof TopLinksAndQRCodes */ sorted_engagements?: Array; } /** * Check if a given object implements the TopLinksAndQRCodes interface. */ declare function instanceOfTopLinksAndQRCodes(value: object): value is TopLinksAndQRCodes; declare function TopLinksAndQRCodesFromJSON(json: any): TopLinksAndQRCodes; declare function TopLinksAndQRCodesFromJSONTyped(json: any, ignoreDiscriminator: boolean): TopLinksAndQRCodes; declare function TopLinksAndQRCodesToJSON(json: any): TopLinksAndQRCodes; declare function TopLinksAndQRCodesToJSONTyped(value?: TopLinksAndQRCodes | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/Engagement.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface Engagement */ interface Engagement { /** * * @type {number} * @memberof Engagement */ lib_button_clicks?: number; /** * * @type {number} * @memberof Engagement */ clicks?: number; /** * * @type {number} * @memberof Engagement */ scans?: number; } /** * Check if a given object implements the Engagement interface. */ declare function instanceOfEngagement(value: object): value is Engagement; declare function EngagementFromJSON(json: any): Engagement; declare function EngagementFromJSONTyped(json: any, ignoreDiscriminator: boolean): Engagement; declare function EngagementToJSON(json: any): Engagement; declare function EngagementToJSONTyped(value?: Engagement | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/Engagements.d.ts /** * * @export * @interface Engagements */ interface Engagements { /** * * @type {number} * @memberof Engagements */ engagement_count?: number; /** * * @type {Engagement} * @memberof Engagements */ engagements?: Engagement; /** * * @type {string} * @memberof Engagements */ date?: string; } /** * Check if a given object implements the Engagements interface. */ declare function instanceOfEngagements(value: object): value is Engagements; declare function EngagementsFromJSON(json: any): Engagements; declare function EngagementsFromJSONTyped(json: any, ignoreDiscriminator: boolean): Engagements; declare function EngagementsToJSON(json: any): Engagements; declare function EngagementsToJSONTyped(value?: Engagements | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/TotalEngagements.d.ts /** * * @export * @interface TotalEngagements */ interface TotalEngagements { /** * * @type {Array} * @memberof TotalEngagements */ engagements?: Array; /** * * @type {number} * @memberof TotalEngagements */ units?: number; /** * * @type {TotalEngagementsUnitEnum} * @memberof TotalEngagements */ unit?: TotalEngagementsUnitEnum; /** * * @type {string} * @memberof TotalEngagements */ unit_reference?: string; } /** * @export * @enum {string} */ declare enum TotalEngagementsUnitEnum { minute = "minute", hour = "hour", day = "day", week = "week", month = "month" } /** * Check if a given object implements the TotalEngagements interface. */ declare function instanceOfTotalEngagements(value: object): value is TotalEngagements; declare function TotalEngagementsFromJSON(json: any): TotalEngagements; declare function TotalEngagementsFromJSONTyped(json: any, ignoreDiscriminator: boolean): TotalEngagements; declare function TotalEngagementsToJSON(json: any): TotalEngagements; declare function TotalEngagementsToJSONTyped(value?: TotalEngagements | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/TotalEngagementsSummary.d.ts /** * * @export * @interface TotalEngagementsSummary */ interface TotalEngagementsSummary { /** * * @type {number} * @memberof TotalEngagementsSummary */ total_engagements?: number; /** * * @type {Engagement} * @memberof TotalEngagementsSummary */ engagements?: Engagement; /** * * @type {number} * @memberof TotalEngagementsSummary */ units?: number; /** * * @type {TotalEngagementsSummaryUnitEnum} * @memberof TotalEngagementsSummary */ unit?: TotalEngagementsSummaryUnitEnum; /** * * @type {string} * @memberof TotalEngagementsSummary */ unit_reference?: string; } /** * @export * @enum {string} */ declare enum TotalEngagementsSummaryUnitEnum { minute = "minute", hour = "hour", day = "day", week = "week", month = "month" } /** * Check if a given object implements the TotalEngagementsSummary interface. */ declare function instanceOfTotalEngagementsSummary(value: object): value is TotalEngagementsSummary; declare function TotalEngagementsSummaryFromJSON(json: any): TotalEngagementsSummary; declare function TotalEngagementsSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): TotalEngagementsSummary; declare function TotalEngagementsSummaryToJSON(json: any): TotalEngagementsSummary; declare function TotalEngagementsSummaryToJSONTyped(value?: TotalEngagementsSummary | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/apis/BitlinksApi.d.ts interface CreateBitlinkRequest { shorten: Shorten; } interface CreateFullBitlinkRequest { full_shorten: FullShorten; } interface DeleteBitlinkRequest { bitlink: string; } interface ExpandBitlinkRequest { expand_bitlink: ExpandBitlink; } interface GetBitlinkRequest { bitlink: string; } interface GetBitlinksByGroupRequest { group_guid: string; size?: number; search_after?: string; query?: string; hostname_path_query?: string; created_before?: number; created_after?: number; archived?: GetBitlinksByGroupArchivedEnum; deeplinks?: GetBitlinksByGroupDeeplinksEnum; domain_deeplinks?: GetBitlinksByGroupDomainDeeplinksEnum; campaign_guid?: string; channel_guid?: string; custom_bitlink?: GetBitlinksByGroupCustomBitlinkEnum; has_qr_codes?: GetBitlinksByGroupHasQrCodesEnum; is_expired?: GetBitlinksByGroupIsExpiredEnum; has_expiration?: GetBitlinksByGroupHasExpirationEnum; tags?: Array; launchpad_ids?: Array; encoding_login?: Array; } interface GetClicksForBitlinkRequest { bitlink: string; unit: TimeUnit; units: number; unit_reference?: string; } interface GetClicksSummaryForBitlinkRequest { bitlink: string; unit: TimeUnit; units: number; unit_reference?: string; } interface GetEngagementsRequest { bitlink: string; unit: TimeUnit; units: number; unit_reference?: string; } interface GetEngagementsSummaryRequest { bitlink: string; unit: TimeUnit; units: number; unit_reference?: string; } interface GetMetricsForBitlinkByCitiesRequest { bitlink: string; unit: TimeUnit; units: number; size?: number; unit_reference?: string; } interface GetMetricsForBitlinkByCountriesRequest { bitlink: string; unit: TimeUnit; units: number; size?: number; unit_reference?: string; } interface GetMetricsForBitlinkByDevicesRequest { bitlink: string; unit: TimeUnit; units: number; size?: number; unit_reference?: string; } interface GetMetricsForBitlinkByReferrerNameRequest { bitlink: string; unit: TimeUnit; units: number; size?: number; unit_reference?: string; } interface GetMetricsForBitlinkByReferrersRequest { bitlink: string; unit: TimeUnit; units: number; size?: number; unit_reference?: string; } interface GetMetricsForBitlinkByReferrersByDomainsRequest { bitlink: string; unit: TimeUnit; units: number; size?: number; unit_reference?: string; } interface GetMetricsForBitlinkByReferringDomainsRequest { bitlink: string; unit: TimeUnit; units: number; size?: number; unit_reference?: string; } interface GetSortedBitlinksRequest { group_guid: string; sort: GetSortedBitlinksSortEnum; unit?: TimeUnit; units?: number; unit_reference?: string; size?: number; } interface GetTopLinksAndQRCodesByEngagementsRequest { group_guid: string; unit?: TimeUnit; units?: number; unit_reference?: string; size?: number; } interface UpdateBitlinkRequest { bitlink: string; bitlink_update_body: BitlinkUpdateBody; } interface UpdateBitlinksByGroupRequest { group_guid: string; bulk_update_request: BulkUpdateRequest; } /** * */ declare class BitlinksApi extends BaseAPI { /** * Creates request options for createBitlink without sending the request */ createBitlinkRequestOpts(requestParameters: CreateBitlinkRequest): Promise; /** * Converts a long url to a Bitlink. You may see errors returned from this endpoint - \"BRANDED_LINK_MONTHLY_LIMIT_EXCEEDED\" occurs if you have shortened more links than your account is configured for for the month, and \"DNS_CONFIGURATION_ERROR\" occurs if you are attempting to shorten links against a custom domain which doesn\'t have DNS properly configured. * Shorten a Link */ createBitlinkRaw(requestParameters: CreateBitlinkRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Converts a long url to a Bitlink. You may see errors returned from this endpoint - \"BRANDED_LINK_MONTHLY_LIMIT_EXCEEDED\" occurs if you have shortened more links than your account is configured for for the month, and \"DNS_CONFIGURATION_ERROR\" occurs if you are attempting to shorten links against a custom domain which doesn\'t have DNS properly configured. * Shorten a Link */ createBitlink(requestParameters: CreateBitlinkRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for createFullBitlink without sending the request */ createFullBitlinkRequestOpts(requestParameters: CreateFullBitlinkRequest): Promise; /** * Converts a long url to a Bitlink and sets additional parameters. You may see errors returned from this endpoint - \"BRANDED_LINK_MONTHLY_LIMIT_EXCEEDED\" occurs if you have shortened more links than your account is configured for for the month, and \"DNS_CONFIGURATION_ERROR\" occurs if you are attempting to shorten links against a custom domain which doesn\'t have DNS properly configured. * Create a Bitlink */ createFullBitlinkRaw(requestParameters: CreateFullBitlinkRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Converts a long url to a Bitlink and sets additional parameters. You may see errors returned from this endpoint - \"BRANDED_LINK_MONTHLY_LIMIT_EXCEEDED\" occurs if you have shortened more links than your account is configured for for the month, and \"DNS_CONFIGURATION_ERROR\" occurs if you are attempting to shorten links against a custom domain which doesn\'t have DNS properly configured. * Create a Bitlink */ createFullBitlink(requestParameters: CreateFullBitlinkRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for deleteBitlink without sending the request */ deleteBitlinkRequestOpts(requestParameters: DeleteBitlinkRequest): Promise; /** * Delete an unedited hash Bitlink. * Delete a Bitlink */ deleteBitlinkRaw(requestParameters: DeleteBitlinkRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Delete an unedited hash Bitlink. * Delete a Bitlink */ deleteBitlink(requestParameters: DeleteBitlinkRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for expandBitlink without sending the request */ expandBitlinkRequestOpts(requestParameters: ExpandBitlinkRequest): Promise; /** * Returns the short link and long URL for the specified link. * Expand a Bitlink */ expandBitlinkRaw(requestParameters: ExpandBitlinkRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns the short link and long URL for the specified link. * Expand a Bitlink */ expandBitlink(requestParameters: ExpandBitlinkRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getBitlink without sending the request */ getBitlinkRequestOpts(requestParameters: GetBitlinkRequest): Promise; /** * Returns information for the specified link. * Retrieve a Bitlink */ getBitlinkRaw(requestParameters: GetBitlinkRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns information for the specified link. * Retrieve a Bitlink */ getBitlink(requestParameters: GetBitlinkRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getBitlinksByGroup without sending the request */ getBitlinksByGroupRequestOpts(requestParameters: GetBitlinksByGroupRequest): Promise; /** * Returns a paginated collection of Bitlinks for a group. The list of custom bitlinks has newest entries first. * Retrieve Bitlinks by Group */ getBitlinksByGroupRaw(requestParameters: GetBitlinksByGroupRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns a paginated collection of Bitlinks for a group. The list of custom bitlinks has newest entries first. * Retrieve Bitlinks by Group */ getBitlinksByGroup(requestParameters: GetBitlinksByGroupRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getClicksForBitlink without sending the request */ getClicksForBitlinkRequestOpts(requestParameters: GetClicksForBitlinkRequest): Promise; /** * Returns the click counts for the specified link in an array based on a date. * Get Clicks for a Bitlink */ getClicksForBitlinkRaw(requestParameters: GetClicksForBitlinkRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns the click counts for the specified link in an array based on a date. * Get Clicks for a Bitlink */ getClicksForBitlink(requestParameters: GetClicksForBitlinkRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getClicksSummaryForBitlink without sending the request */ getClicksSummaryForBitlinkRequestOpts(requestParameters: GetClicksSummaryForBitlinkRequest): Promise; /** * Returns the click counts for the specified link rolled up into a single field. * Get a Clicks Summary for a Bitlink */ getClicksSummaryForBitlinkRaw(requestParameters: GetClicksSummaryForBitlinkRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns the click counts for the specified link rolled up into a single field. * Get a Clicks Summary for a Bitlink */ getClicksSummaryForBitlink(requestParameters: GetClicksSummaryForBitlinkRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getEngagements without sending the request */ getEngagementsRequestOpts(requestParameters: GetEngagementsRequest): Promise; /** * Returns an array of engagement counts for the specified link. The array is comprised of button click, click and scan counts for each time window, where the window is based on the provided unit. * Get Engagement Counts for a Bitlink */ getEngagementsRaw(requestParameters: GetEngagementsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns an array of engagement counts for the specified link. The array is comprised of button click, click and scan counts for each time window, where the window is based on the provided unit. * Get Engagement Counts for a Bitlink */ getEngagements(requestParameters: GetEngagementsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getEngagementsSummary without sending the request */ getEngagementsSummaryRequestOpts(requestParameters: GetEngagementsSummaryRequest): Promise; /** * Returns the engagement counts for the specified link rolled up into a single field. * Get an Engagement Count Summary for a Bitlink */ getEngagementsSummaryRaw(requestParameters: GetEngagementsSummaryRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns the engagement counts for the specified link rolled up into a single field. * Get an Engagement Count Summary for a Bitlink */ getEngagementsSummary(requestParameters: GetEngagementsSummaryRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getMetricsForBitlinkByCities without sending the request */ getMetricsForBitlinkByCitiesRequestOpts(requestParameters: GetMetricsForBitlinkByCitiesRequest): Promise; /** * Returns the city origins of click traffic for the specified link. * Get Metrics for a Bitlink by City */ getMetricsForBitlinkByCitiesRaw(requestParameters: GetMetricsForBitlinkByCitiesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns the city origins of click traffic for the specified link. * Get Metrics for a Bitlink by City */ getMetricsForBitlinkByCities(requestParameters: GetMetricsForBitlinkByCitiesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getMetricsForBitlinkByCountries without sending the request */ getMetricsForBitlinkByCountriesRequestOpts(requestParameters: GetMetricsForBitlinkByCountriesRequest): Promise; /** * Returns the country origins of click traffic for the specified link. * Get Metrics for a Bitlink by Country */ getMetricsForBitlinkByCountriesRaw(requestParameters: GetMetricsForBitlinkByCountriesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns the country origins of click traffic for the specified link. * Get Metrics for a Bitlink by Country */ getMetricsForBitlinkByCountries(requestParameters: GetMetricsForBitlinkByCountriesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getMetricsForBitlinkByDevices without sending the request */ getMetricsForBitlinkByDevicesRequestOpts(requestParameters: GetMetricsForBitlinkByDevicesRequest): Promise; /** * Returns the device types generating click traffic to the specified link. * Get Metrics for a Bitlink by Device Type */ getMetricsForBitlinkByDevicesRaw(requestParameters: GetMetricsForBitlinkByDevicesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns the device types generating click traffic to the specified link. * Get Metrics for a Bitlink by Device Type */ getMetricsForBitlinkByDevices(requestParameters: GetMetricsForBitlinkByDevicesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getMetricsForBitlinkByReferrerName without sending the request */ getMetricsForBitlinkByReferrerNameRequestOpts(requestParameters: GetMetricsForBitlinkByReferrerNameRequest): Promise; /** * Returns referrer click counts for the specified link. * Get Metrics for a Bitlink by Referrer Name */ getMetricsForBitlinkByReferrerNameRaw(requestParameters: GetMetricsForBitlinkByReferrerNameRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns referrer click counts for the specified link. * Get Metrics for a Bitlink by Referrer Name */ getMetricsForBitlinkByReferrerName(requestParameters: GetMetricsForBitlinkByReferrerNameRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getMetricsForBitlinkByReferrers without sending the request */ getMetricsForBitlinkByReferrersRequestOpts(requestParameters: GetMetricsForBitlinkByReferrersRequest): Promise; /** * Returns referrer click counts for the specified link. * Get Metrics for a Bitlink by Referrers */ getMetricsForBitlinkByReferrersRaw(requestParameters: GetMetricsForBitlinkByReferrersRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns referrer click counts for the specified link. * Get Metrics for a Bitlink by Referrers */ getMetricsForBitlinkByReferrers(requestParameters: GetMetricsForBitlinkByReferrersRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getMetricsForBitlinkByReferrersByDomains without sending the request */ getMetricsForBitlinkByReferrersByDomainsRequestOpts(requestParameters: GetMetricsForBitlinkByReferrersByDomainsRequest): Promise; /** * Returns click metrics grouped by referrers for the specified link. * Get Metrics for a Bitlink by Referrers by Domain */ getMetricsForBitlinkByReferrersByDomainsRaw(requestParameters: GetMetricsForBitlinkByReferrersByDomainsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns click metrics grouped by referrers for the specified link. * Get Metrics for a Bitlink by Referrers by Domain */ getMetricsForBitlinkByReferrersByDomains(requestParameters: GetMetricsForBitlinkByReferrersByDomainsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getMetricsForBitlinkByReferringDomains without sending the request */ getMetricsForBitlinkByReferringDomainsRequestOpts(requestParameters: GetMetricsForBitlinkByReferringDomainsRequest): Promise; /** * Returns the referring domain click counts for the specified link. * Get Metrics for a Bitlink by Referring Domains */ getMetricsForBitlinkByReferringDomainsRaw(requestParameters: GetMetricsForBitlinkByReferringDomainsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns the referring domain click counts for the specified link. * Get Metrics for a Bitlink by Referring Domains */ getMetricsForBitlinkByReferringDomains(requestParameters: GetMetricsForBitlinkByReferringDomainsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getSortedBitlinks without sending the request */ getSortedBitlinksRequestOpts(requestParameters: GetSortedBitlinksRequest): Promise; /** * Returns a list of Bitlinks sorted by group. The list of custom bitlinks has newest entries first. * Retrieve Sorted Bitlinks for Group */ getSortedBitlinksRaw(requestParameters: GetSortedBitlinksRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns a list of Bitlinks sorted by group. The list of custom bitlinks has newest entries first. * Retrieve Sorted Bitlinks for Group */ getSortedBitlinks(requestParameters: GetSortedBitlinksRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getTopLinksAndQRCodesByEngagements without sending the request */ getTopLinksAndQRCodesByEngagementsRequestOpts(requestParameters: GetTopLinksAndQRCodesByEngagementsRequest): Promise; /** * Returns the bitlinks and decoupled QR codes in a group with the most engagements over the requested time window, ranked together in descending order by engagement count. Bitlinks and decoupled QR codes are returned in separate lists; `sorted_links` preserves the unified descending-by-count ordering across both, with each entry\'s id referencing either a bitlink or a QR code guid. * Retrieve Top Links and Decoupled QR Codes by Engagements */ getTopLinksAndQRCodesByEngagementsRaw(requestParameters: GetTopLinksAndQRCodesByEngagementsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns the bitlinks and decoupled QR codes in a group with the most engagements over the requested time window, ranked together in descending order by engagement count. Bitlinks and decoupled QR codes are returned in separate lists; `sorted_links` preserves the unified descending-by-count ordering across both, with each entry\'s id referencing either a bitlink or a QR code guid. * Retrieve Top Links and Decoupled QR Codes by Engagements */ getTopLinksAndQRCodesByEngagements(requestParameters: GetTopLinksAndQRCodesByEngagementsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for updateBitlink without sending the request */ updateBitlinkRequestOpts(requestParameters: UpdateBitlinkRequest): Promise; /** * Updates fields in the specified link. To redirect the link (i.e. to update the Long URL), use the long_url parameter. This will always charge an encode limit. * Update a Bitlink */ updateBitlinkRaw(requestParameters: UpdateBitlinkRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Updates fields in the specified link. To redirect the link (i.e. to update the Long URL), use the long_url parameter. This will always charge an encode limit. * Update a Bitlink */ updateBitlink(requestParameters: UpdateBitlinkRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for updateBitlinksByGroup without sending the request */ updateBitlinksByGroupRequestOpts(requestParameters: UpdateBitlinksByGroupRequest): Promise; /** * Bulk update can add or remove tags or archive up to 100 links at a time; The response includes a list of bitlink ids that were updated. * Bulk update bitlinks */ updateBitlinksByGroupRaw(requestParameters: UpdateBitlinksByGroupRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Bulk update can add or remove tags or archive up to 100 links at a time; The response includes a list of bitlink ids that were updated. * Bulk update bitlinks */ updateBitlinksByGroup(requestParameters: UpdateBitlinksByGroupRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; } /** * @export * @enum {string} */ declare enum GetBitlinksByGroupArchivedEnum { on = "on", off = "off", both = "both" } /** * @export * @enum {string} */ declare enum GetBitlinksByGroupDeeplinksEnum { on = "on", off = "off", both = "both" } /** * @export * @enum {string} */ declare enum GetBitlinksByGroupDomainDeeplinksEnum { on = "on", off = "off", both = "both" } /** * @export * @enum {string} */ declare enum GetBitlinksByGroupCustomBitlinkEnum { on = "on", off = "off", both = "both" } /** * @export * @enum {string} */ declare enum GetBitlinksByGroupHasQrCodesEnum { on = "on", off = "off", both = "both" } /** * @export * @enum {string} */ declare enum GetBitlinksByGroupIsExpiredEnum { on = "on", off = "off", both = "both" } /** * @export * @enum {string} */ declare enum GetBitlinksByGroupHasExpirationEnum { on = "on", off = "off", both = "both" } /** * @export * @enum {string} */ declare enum GetSortedBitlinksSortEnum { clicks = "clicks" } //#endregion //#region src/models/Campaign.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface Campaign */ interface Campaign { /** * * @type {{ [key: string]: string; }} * @memberof Campaign */ references?: { [key: string]: string; }; /** * * @type {string} * @memberof Campaign */ guid?: string; /** * * @type {string} * @memberof Campaign */ group_guid?: string; /** * * @type {string} * @memberof Campaign */ created_by?: string; /** * * @type {string} * @memberof Campaign */ name?: string; /** * * @type {string} * @memberof Campaign */ description?: string; /** * ISO timestamp * @type {string} * @memberof Campaign */ created?: string; /** * ISO timestamp * @type {string} * @memberof Campaign */ modified?: string; } /** * Check if a given object implements the Campaign interface. */ declare function instanceOfCampaign(value: object): value is Campaign; declare function CampaignFromJSON(json: any): Campaign; declare function CampaignFromJSONTyped(json: any, ignoreDiscriminator: boolean): Campaign; declare function CampaignToJSON(json: any): Campaign; declare function CampaignToJSONTyped(value?: Campaign | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/CampaignModify.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface CampaignModify */ interface CampaignModify { /** * * @type {string} * @memberof CampaignModify */ group_guid?: string; /** * * @type {string} * @memberof CampaignModify */ name?: string; /** * * @type {string} * @memberof CampaignModify */ description?: string; /** * * @type {Array} * @memberof CampaignModify */ channel_guids?: Array; } /** * Check if a given object implements the CampaignModify interface. */ declare function instanceOfCampaignModify(value: object): value is CampaignModify; declare function CampaignModifyFromJSON(json: any): CampaignModify; declare function CampaignModifyFromJSONTyped(json: any, ignoreDiscriminator: boolean): CampaignModify; declare function CampaignModifyToJSON(json: any): CampaignModify; declare function CampaignModifyToJSONTyped(value?: CampaignModify | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/Campaigns.d.ts /** * * @export * @interface Campaigns */ interface Campaigns { /** * * @type {Array} * @memberof Campaigns */ campaigns?: Array; } /** * Check if a given object implements the Campaigns interface. */ declare function instanceOfCampaigns(value: object): value is Campaigns; declare function CampaignsFromJSON(json: any): Campaigns; declare function CampaignsFromJSONTyped(json: any, ignoreDiscriminator: boolean): Campaigns; declare function CampaignsToJSON(json: any): Campaigns; declare function CampaignsToJSONTyped(value?: Campaigns | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/Channel.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface Channel */ interface Channel { /** * * @type {string} * @memberof Channel */ name?: string; /** * * @type {string} * @memberof Channel */ guid?: string; /** * ISO TIMESTAMP * @type {string} * @memberof Channel */ created?: string; /** * ISO_TIMESTAMP * @type {string} * @memberof Channel */ modified?: string; /** * * @type {string} * @memberof Channel */ group_guid?: string; /** * * @type {{ [key: string]: string; }} * @memberof Channel */ references?: { [key: string]: string; }; } /** * Check if a given object implements the Channel interface. */ declare function instanceOfChannel(value: object): value is Channel; declare function ChannelFromJSON(json: any): Channel; declare function ChannelFromJSONTyped(json: any, ignoreDiscriminator: boolean): Channel; declare function ChannelToJSON(json: any): Channel; declare function ChannelToJSONTyped(value?: Channel | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/BaseChannelBitlink.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface BaseChannelBitlink */ interface BaseChannelBitlink { /** * * @type {string} * @memberof BaseChannelBitlink */ campaign_guid?: string; /** * * @type {string} * @memberof BaseChannelBitlink */ bitlink_id?: string; } /** * Check if a given object implements the BaseChannelBitlink interface. */ declare function instanceOfBaseChannelBitlink(value: object): value is BaseChannelBitlink; declare function BaseChannelBitlinkFromJSON(json: any): BaseChannelBitlink; declare function BaseChannelBitlinkFromJSONTyped(json: any, ignoreDiscriminator: boolean): BaseChannelBitlink; declare function BaseChannelBitlinkToJSON(json: any): BaseChannelBitlink; declare function BaseChannelBitlinkToJSONTyped(value?: BaseChannelBitlink | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/ChannelModify.d.ts /** * * @export * @interface ChannelModify */ interface ChannelModify { /** * * @type {string} * @memberof ChannelModify */ name?: string; /** * * @type {string} * @memberof ChannelModify */ guid?: string; /** * ISO TIMESTAMP * @type {string} * @memberof ChannelModify */ created?: string; /** * ISO_TIMESTAMP * @type {string} * @memberof ChannelModify */ modified?: string; /** * * @type {string} * @memberof ChannelModify */ group_guid?: string; /** * * @type {Array} * @memberof ChannelModify */ bitlinks?: Array; } /** * Check if a given object implements the ChannelModify interface. */ declare function instanceOfChannelModify(value: object): value is ChannelModify; declare function ChannelModifyFromJSON(json: any): ChannelModify; declare function ChannelModifyFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChannelModify; declare function ChannelModifyToJSON(json: any): ChannelModify; declare function ChannelModifyToJSONTyped(value?: ChannelModify | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/Channels.d.ts /** * * @export * @interface Channels */ interface Channels { /** * * @type {Array} * @memberof Channels */ channels?: Array; } /** * Check if a given object implements the Channels interface. */ declare function instanceOfChannels(value: object): value is Channels; declare function ChannelsFromJSON(json: any): Channels; declare function ChannelsFromJSONTyped(json: any, ignoreDiscriminator: boolean): Channels; declare function ChannelsToJSON(json: any): Channels; declare function ChannelsToJSONTyped(value?: Channels | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/apis/CampaignsApi.d.ts interface CreateCampaignRequest { campaign_modify: CampaignModify; } interface CreateChannelRequest { channel_modify: ChannelModify; } interface GetCampaignRequest { campaign_guid: string; } interface GetCampaignsRequest { group_guid?: string; } interface GetChannelRequest { channel_guid: string; } interface GetChannelsRequest { group_guid?: string; campaign_guid?: string; } interface UpdateCampaignRequest { campaign_guid: string; campaign_modify: CampaignModify; } interface UpdateChannelRequest { channel_guid: string; channel_modify: ChannelModify; } /** * */ declare class CampaignsApi extends BaseAPI { /** * Creates request options for createCampaign without sending the request */ createCampaignRequestOpts(requestParameters: CreateCampaignRequest): Promise; /** * Creates a new campaign. * Create Campaign */ createCampaignRaw(requestParameters: CreateCampaignRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Creates a new campaign. * Create Campaign */ createCampaign(requestParameters: CreateCampaignRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for createChannel without sending the request */ createChannelRequestOpts(requestParameters: CreateChannelRequest): Promise; /** * Creates a new channel. * Create Channel */ createChannelRaw(requestParameters: CreateChannelRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Creates a new channel. * Create Channel */ createChannel(requestParameters: CreateChannelRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getCampaign without sending the request */ getCampaignRequestOpts(requestParameters: GetCampaignRequest): Promise; /** * Returns details for a campaign. * Retrieve a Campaign */ getCampaignRaw(requestParameters: GetCampaignRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns details for a campaign. * Retrieve a Campaign */ getCampaign(requestParameters: GetCampaignRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getCampaigns without sending the request */ getCampaignsRequestOpts(requestParameters: GetCampaignsRequest): Promise; /** * Returns the campaigns for the current authenticated user. * Retrieve Campaigns */ getCampaignsRaw(requestParameters: GetCampaignsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns the campaigns for the current authenticated user. * Retrieve Campaigns */ getCampaigns(requestParameters?: GetCampaignsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getChannel without sending the request */ getChannelRequestOpts(requestParameters: GetChannelRequest): Promise; /** * Returns a channel\'s details. * Get a Channel */ getChannelRaw(requestParameters: GetChannelRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns a channel\'s details. * Get a Channel */ getChannel(requestParameters: GetChannelRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getChannels without sending the request */ getChannelsRequestOpts(requestParameters: GetChannelsRequest): Promise; /** * Returns the channels available to a user. * Retrieve Channels */ getChannelsRaw(requestParameters: GetChannelsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns the channels available to a user. * Retrieve Channels */ getChannels(requestParameters?: GetChannelsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for updateCampaign without sending the request */ updateCampaignRequestOpts(requestParameters: UpdateCampaignRequest): Promise; /** * Updates a campaign\'s details. * Update Campaign */ updateCampaignRaw(requestParameters: UpdateCampaignRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Updates a campaign\'s details. * Update Campaign */ updateCampaign(requestParameters: UpdateCampaignRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for updateChannel without sending the request */ updateChannelRequestOpts(requestParameters: UpdateChannelRequest): Promise; /** * Updates an existing channel. * Update a Channel */ updateChannelRaw(requestParameters: UpdateChannelRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Updates an existing channel. * Update a Channel */ updateChannel(requestParameters: UpdateChannelRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; } //#endregion //#region src/models/AddCustomBitlink.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface AddCustomBitlink */ interface AddCustomBitlink { /** * * @type {string} * @memberof AddCustomBitlink */ custom_bitlink?: string; /** * * @type {string} * @memberof AddCustomBitlink */ bitlink_id?: string; } /** * Check if a given object implements the AddCustomBitlink interface. */ declare function instanceOfAddCustomBitlink(value: object): value is AddCustomBitlink; declare function AddCustomBitlinkFromJSON(json: any): AddCustomBitlink; declare function AddCustomBitlinkFromJSONTyped(json: any, ignoreDiscriminator: boolean): AddCustomBitlink; declare function AddCustomBitlinkToJSON(json: any): AddCustomBitlink; declare function AddCustomBitlinkToJSONTyped(value?: AddCustomBitlink | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/CustomBitlinkHistory.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface CustomBitlinkHistory */ interface CustomBitlinkHistory { /** * * @type {string} * @memberof CustomBitlinkHistory */ group_guid?: string; /** * * @type {string} * @memberof CustomBitlinkHistory */ keyword?: string; /** * * @type {string} * @memberof CustomBitlinkHistory */ bsd?: string; /** * * @type {string} * @memberof CustomBitlinkHistory */ hash?: string; /** * * @type {string} * @memberof CustomBitlinkHistory */ login?: string; /** * * @type {string} * @memberof CustomBitlinkHistory */ long_url?: string; /** * * @type {string} * @memberof CustomBitlinkHistory */ created?: string; /** * * @type {string} * @memberof CustomBitlinkHistory */ first_created?: string; /** * * @type {string} * @memberof CustomBitlinkHistory */ deactivated?: string; /** * * @type {boolean} * @memberof CustomBitlinkHistory */ is_active?: boolean; } /** * Check if a given object implements the CustomBitlinkHistory interface. */ declare function instanceOfCustomBitlinkHistory(value: object): value is CustomBitlinkHistory; declare function CustomBitlinkHistoryFromJSON(json: any): CustomBitlinkHistory; declare function CustomBitlinkHistoryFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomBitlinkHistory; declare function CustomBitlinkHistoryToJSON(json: any): CustomBitlinkHistory; declare function CustomBitlinkHistoryToJSONTyped(value?: CustomBitlinkHistory | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/CustomBitlink.d.ts /** * * @export * @interface CustomBitlink */ interface CustomBitlink { /** * * @type {string} * @memberof CustomBitlink */ custom_bitlink?: string; /** * * @type {BitlinkBody} * @memberof CustomBitlink */ bitlink?: BitlinkBody; /** * * @type {Array} * @memberof CustomBitlink */ bitlink_history?: Array; } /** * Check if a given object implements the CustomBitlink interface. */ declare function instanceOfCustomBitlink(value: object): value is CustomBitlink; declare function CustomBitlinkFromJSON(json: any): CustomBitlink; declare function CustomBitlinkFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomBitlink; declare function CustomBitlinkToJSON(json: any): CustomBitlink; declare function CustomBitlinkToJSONTyped(value?: CustomBitlink | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/UpdateCustomBitlink.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface UpdateCustomBitlink */ interface UpdateCustomBitlink { /** * * @type {string} * @memberof UpdateCustomBitlink */ bitlink_id?: string; } /** * Check if a given object implements the UpdateCustomBitlink interface. */ declare function instanceOfUpdateCustomBitlink(value: object): value is UpdateCustomBitlink; declare function UpdateCustomBitlinkFromJSON(json: any): UpdateCustomBitlink; declare function UpdateCustomBitlinkFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateCustomBitlink; declare function UpdateCustomBitlinkToJSON(json: any): UpdateCustomBitlink; declare function UpdateCustomBitlinkToJSONTyped(value?: UpdateCustomBitlink | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/apis/CustomBitlinksApi.d.ts interface AddCustomBitlinkRequest { add_custom_bitlink: AddCustomBitlink; } interface GetClicksForCustomBitlinkRequest { custom_bitlink: string; unit: TimeUnit; units: number; unit_reference?: string; } interface GetCustomBitlinkRequest { custom_bitlink: string; } interface GetCustomBitlinkMetricsByDestinationRequest { custom_bitlink: string; unit: TimeUnit; units: number; unit_reference?: string; } interface UpdateCustomBitlinkRequest { custom_bitlink: string; update_custom_bitlink: UpdateCustomBitlink; } /** * */ declare class CustomBitlinksApi extends BaseAPI { /** * Creates request options for addCustomBitlink without sending the request */ addCustomBitlinkRequestOpts(requestParameters: AddCustomBitlinkRequest): Promise; /** * Add a keyword (or \"custom back-half\") to a Bitlink with a Custom Domain (domains must match). This endpoint can also be used for initial redirects to a link. * Add Custom Bitlink */ addCustomBitlinkRaw(requestParameters: AddCustomBitlinkRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Add a keyword (or \"custom back-half\") to a Bitlink with a Custom Domain (domains must match). This endpoint can also be used for initial redirects to a link. * Add Custom Bitlink */ addCustomBitlink(requestParameters: AddCustomBitlinkRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getClicksForCustomBitlink without sending the request */ getClicksForCustomBitlinkRequestOpts(requestParameters: GetClicksForCustomBitlinkRequest): Promise; /** * Returns the click counts for the specified link. This returns an array with clicks based on a date. * Get Clicks for a Custom Bitlink\'s Entire History */ getClicksForCustomBitlinkRaw(requestParameters: GetClicksForCustomBitlinkRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns the click counts for the specified link. This returns an array with clicks based on a date. * Get Clicks for a Custom Bitlink\'s Entire History */ getClicksForCustomBitlink(requestParameters: GetClicksForCustomBitlinkRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getCustomBitlink without sending the request */ getCustomBitlinkRequestOpts(requestParameters: GetCustomBitlinkRequest): Promise; /** * Returns the details and history of the specified link. * Retrieve Custom Bitlink */ getCustomBitlinkRaw(requestParameters: GetCustomBitlinkRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns the details and history of the specified link. * Retrieve Custom Bitlink */ getCustomBitlink(requestParameters: GetCustomBitlinkRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getCustomBitlinkMetricsByDestination without sending the request */ getCustomBitlinkMetricsByDestinationRequestOpts(requestParameters: GetCustomBitlinkMetricsByDestinationRequest): Promise; /** * Returns click metrics for the specified link by its historical destinations. * Get Metrics for a Custom Bitlink by Destination */ getCustomBitlinkMetricsByDestinationRaw(requestParameters: GetCustomBitlinkMetricsByDestinationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns click metrics for the specified link by its historical destinations. * Get Metrics for a Custom Bitlink by Destination */ getCustomBitlinkMetricsByDestination(requestParameters: GetCustomBitlinkMetricsByDestinationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for updateCustomBitlink without sending the request */ updateCustomBitlinkRequestOpts(requestParameters: UpdateCustomBitlinkRequest): Promise; /** * Move a keyword (or custom back-half) to a different Bitlink (domains must match). * Update Custom Bitlink */ updateCustomBitlinkRaw(requestParameters: UpdateCustomBitlinkRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Move a keyword (or custom back-half) to a different Bitlink (domains must match). * Update Custom Bitlink */ updateCustomBitlink(requestParameters: UpdateCustomBitlinkRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; } //#endregion //#region src/models/OAuthApp.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface OAuthApp */ interface OAuthApp { /** * * @type {string} * @memberof OAuthApp */ name: string; /** * * @type {string} * @memberof OAuthApp */ client_id: string; /** * * @type {string} * @memberof OAuthApp */ description: string; /** * * @type {string} * @memberof OAuthApp */ link: string; /** * * @type {boolean} * @memberof OAuthApp */ require_oauth_pkce: boolean; } /** * Check if a given object implements the OAuthApp interface. */ declare function instanceOfOAuthApp(value: object): value is OAuthApp; declare function OAuthAppFromJSON(json: any): OAuthApp; declare function OAuthAppFromJSONTyped(json: any, ignoreDiscriminator: boolean): OAuthApp; declare function OAuthAppToJSON(json: any): OAuthApp; declare function OAuthAppToJSONTyped(value?: OAuthApp | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/apis/DefaultApi.d.ts interface GetOAuthAppRequest { client_id: string; } /** * */ declare class DefaultApi extends BaseAPI { /** * Creates request options for getOAuthApp without sending the request */ getOAuthAppRequestOpts(requestParameters: GetOAuthAppRequest): Promise; /** * Retrieve the details for the provided OAuth App client ID * Retrieve OAuth App */ getOAuthAppRaw(requestParameters: GetOAuthAppRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Retrieve the details for the provided OAuth App client ID * Retrieve OAuth App */ getOAuthApp(requestParameters: GetOAuthAppRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; } //#endregion //#region src/models/GetGroupLinkClicksByDevice200ResponseMetricsInner.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface GetGroupLinkClicksByDevice200ResponseMetricsInner */ interface GetGroupLinkClicksByDevice200ResponseMetricsInner { /** * * @type {number} * @memberof GetGroupLinkClicksByDevice200ResponseMetricsInner */ clicks?: number; /** * * @type {string} * @memberof GetGroupLinkClicksByDevice200ResponseMetricsInner */ value?: string; } /** * Check if a given object implements the GetGroupLinkClicksByDevice200ResponseMetricsInner interface. */ declare function instanceOfGetGroupLinkClicksByDevice200ResponseMetricsInner(value: object): value is GetGroupLinkClicksByDevice200ResponseMetricsInner; declare function GetGroupLinkClicksByDevice200ResponseMetricsInnerFromJSON(json: any): GetGroupLinkClicksByDevice200ResponseMetricsInner; declare function GetGroupLinkClicksByDevice200ResponseMetricsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetGroupLinkClicksByDevice200ResponseMetricsInner; declare function GetGroupLinkClicksByDevice200ResponseMetricsInnerToJSON(json: any): GetGroupLinkClicksByDevice200ResponseMetricsInner; declare function GetGroupLinkClicksByDevice200ResponseMetricsInnerToJSONTyped(value?: GetGroupLinkClicksByDevice200ResponseMetricsInner | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/GetGroupLinkClicksByDevice200Response.d.ts /** * * @export * @interface GetGroupLinkClicksByDevice200Response */ interface GetGroupLinkClicksByDevice200Response { /** * * @type {string} * @memberof GetGroupLinkClicksByDevice200Response */ unit?: string; /** * * @type {number} * @memberof GetGroupLinkClicksByDevice200Response */ units?: number; /** * * @type {GetGroupLinkClicksByDevice200ResponseFacetEnum} * @memberof GetGroupLinkClicksByDevice200Response */ facet?: GetGroupLinkClicksByDevice200ResponseFacetEnum; /** * * @type {string} * @memberof GetGroupLinkClicksByDevice200Response */ unit_reference?: string; /** * * @type {Array} * @memberof GetGroupLinkClicksByDevice200Response */ metrics?: Array; } /** * @export * @enum {string} */ declare enum GetGroupLinkClicksByDevice200ResponseFacetEnum { countries = "countries", cities = "cities", devices = "devices", referrers = "referrers", referrers_by_domain = "referrers_by_domain", referring_domains = "referring_domains", referring_networks = "referring_networks", shorten_counts = "shorten_counts" } /** * Check if a given object implements the GetGroupLinkClicksByDevice200Response interface. */ declare function instanceOfGetGroupLinkClicksByDevice200Response(value: object): value is GetGroupLinkClicksByDevice200Response; declare function GetGroupLinkClicksByDevice200ResponseFromJSON(json: any): GetGroupLinkClicksByDevice200Response; declare function GetGroupLinkClicksByDevice200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetGroupLinkClicksByDevice200Response; declare function GetGroupLinkClicksByDevice200ResponseToJSON(json: any): GetGroupLinkClicksByDevice200Response; declare function GetGroupLinkClicksByDevice200ResponseToJSONTyped(value?: GetGroupLinkClicksByDevice200Response | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/GetGroupTopCodeScans200Response.d.ts /** * @type GetGroupTopCodeScans200Response * * @export */ type GetGroupTopCodeScans200Response = SortedLinks | TopLinksAndQRCodes; declare function GetGroupTopCodeScans200ResponseFromJSON(json: any): GetGroupTopCodeScans200Response; declare function GetGroupTopCodeScans200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetGroupTopCodeScans200Response; declare function GetGroupTopCodeScans200ResponseToJSON(json: any): any; declare function GetGroupTopCodeScans200ResponseToJSONTyped(value?: GetGroupTopCodeScans200Response | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/Group.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface Group */ interface Group { /** * * @type {{ [key: string]: string; }} * @memberof Group */ references?: { [key: string]: string; }; /** * * @type {string} * @memberof Group */ name: string; /** * * @type {string} * @memberof Group */ guid: string; /** * * @type {string} * @memberof Group */ created: string; /** * * @type {string} * @memberof Group */ modified: string; /** * * @type {boolean} * @memberof Group */ is_active: boolean; /** * * @type {string} * @memberof Group */ role: string; /** * * @type {string} * @memberof Group */ organization_guid: string; /** * * @type {Array} * @memberof Group */ bsds: Array; } /** * Check if a given object implements the Group interface. */ declare function instanceOfGroup(value: object): value is Group; declare function GroupFromJSON(json: any): Group; declare function GroupFromJSONTyped(json: any, ignoreDiscriminator: boolean): Group; declare function GroupToJSON(json: any): Group; declare function GroupToJSONTyped(value?: Group | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/CountItem.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface CountItem */ interface CountItem { /** * * @type {string} * @memberof CountItem */ ts?: string; /** * * @type {number} * @memberof CountItem */ count?: number; } /** * Check if a given object implements the CountItem interface. */ declare function instanceOfCountItem(value: object): value is CountItem; declare function CountItemFromJSON(json: any): CountItem; declare function CountItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): CountItem; declare function CountItemToJSON(json: any): CountItem; declare function CountItemToJSONTyped(value?: CountItem | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/GroupClicks.d.ts /** * * @export * @interface GroupClicks */ interface GroupClicks { /** * * @type {string} * @memberof GroupClicks */ unit?: string; /** * * @type {number} * @memberof GroupClicks */ units?: number; /** * * @type {string} * @memberof GroupClicks */ unit_reference?: string; /** * * @type {Array} * @memberof GroupClicks */ data?: Array; } /** * Check if a given object implements the GroupClicks interface. */ declare function instanceOfGroupClicks(value: object): value is GroupClicks; declare function GroupClicksFromJSON(json: any): GroupClicks; declare function GroupClicksFromJSONTyped(json: any, ignoreDiscriminator: boolean): GroupClicks; declare function GroupClicksToJSON(json: any): GroupClicks; declare function GroupClicksToJSONTyped(value?: GroupClicks | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/GroupExportFilter.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Search constraints used to resolve links or QR codes for export. Required for links_list and qr_codes_list. * @export * @interface GroupExportFilter */ interface GroupExportFilter { /** * * @type {Array} * @memberof GroupExportFilter */ tags?: Array; /** * * @type {string} * @memberof GroupExportFilter */ domain?: string; /** * Filter by archive state. * @type {GroupExportFilterArchivedEnum} * @memberof GroupExportFilter */ archived?: GroupExportFilterArchivedEnum; /** * Free-text search query. * @type {string} * @memberof GroupExportFilter */ query?: string; /** * Include items created at or after this Unix timestamp (UTC). * @type {number} * @memberof GroupExportFilter */ created_after?: number; /** * Include items created before this Unix timestamp (UTC). * @type {number} * @memberof GroupExportFilter */ created_before?: number; /** * Filter links by campaign GUID. Ignored for qr_codes_list. * @type {string} * @memberof GroupExportFilter */ campaign_guid?: string; } /** * @export * @enum {string} */ declare enum GroupExportFilterArchivedEnum { on = "on", off = "off", both = "both" } /** * Check if a given object implements the GroupExportFilter interface. */ declare function instanceOfGroupExportFilter(value: object): value is GroupExportFilter; declare function GroupExportFilterFromJSON(json: any): GroupExportFilter; declare function GroupExportFilterFromJSONTyped(json: any, ignoreDiscriminator: boolean): GroupExportFilter; declare function GroupExportFilterToJSON(json: any): GroupExportFilter; declare function GroupExportFilterToJSONTyped(value?: GroupExportFilter | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/GroupExportRequestBody.d.ts /** * * @export * @interface GroupExportRequestBody */ interface GroupExportRequestBody { /** * Which export shape to produce. * @type {GroupExportRequestBodyExportTypeEnum} * @memberof GroupExportRequestBody */ export_type: GroupExportRequestBodyExportTypeEnum; /** * Fully qualified bitlinks (e.g. "bit.ly/abc"). Used by export_type link_engagements_batch when * the caller already knows the exact links. Mutually exclusive with filter (provide one or the other). * * @type {Array} * @memberof GroupExportRequestBody */ bitlinks?: Array; /** * Start of the metrics date range (Unix seconds, UTC). Clamped to the caller's tier data window. * For link_engagements_batch, required together with unix_to unless the tier max-history default applies. * For links_list or qr_codes_list, used when include_metrics is true. * * @type {number} * @memberof GroupExportRequestBody */ unix_from?: number; /** * End of the metrics date range (Unix seconds, UTC). See unix_from. * @type {number} * @memberof GroupExportRequestBody */ unix_to?: number; /** * * @type {GroupExportFilter} * @memberof GroupExportRequestBody */ filter?: GroupExportFilter; /** * When true on links_list or qr_codes_list, append clicks, scans, and button_clicks columns and apply * the 200-row cap. Requires unix_from and unix_to (or tier-default window behavior where applicable). * * @type {boolean} * @memberof GroupExportRequestBody */ include_metrics?: boolean; } /** * @export * @enum {string} */ declare enum GroupExportRequestBodyExportTypeEnum { link_engagements_batch = "link_engagements_batch", links_list = "links_list", qr_codes_list = "qr_codes_list" } /** * Check if a given object implements the GroupExportRequestBody interface. */ declare function instanceOfGroupExportRequestBody(value: object): value is GroupExportRequestBody; declare function GroupExportRequestBodyFromJSON(json: any): GroupExportRequestBody; declare function GroupExportRequestBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): GroupExportRequestBody; declare function GroupExportRequestBodyToJSON(json: any): GroupExportRequestBody; declare function GroupExportRequestBodyToJSONTyped(value?: GroupExportRequestBody | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/GroupExportResponse.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface GroupExportResponse */ interface GroupExportResponse { /** * * @type {GroupExportResponseExportTypeEnum} * @memberof GroupExportResponse */ export_type?: GroupExportResponseExportTypeEnum; /** * Suggested download filename for the CSV. * @type {string} * @memberof GroupExportResponse */ filename?: string; /** * * @type {string} * @memberof GroupExportResponse */ media_type?: string; /** * Number of data rows in the CSV (excluding the header row). * @type {number} * @memberof GroupExportResponse */ row_count?: number; /** * * @type {number} * @memberof GroupExportResponse */ column_count?: number; /** * CSV column headers in order. * @type {Array} * @memberof GroupExportResponse */ columns?: Array; /** * Size of the raw CSV bytes before base64 encoding. * @type {number} * @memberof GroupExportResponse */ size_bytes?: number; /** * CSV file as a data:text/csv;base64,... URI. * @type {string} * @memberof GroupExportResponse */ data_uri?: string; /** * Metrics window start (Unix seconds) when metrics are included in the export. * @type {number} * @memberof GroupExportResponse */ unix_from?: number; /** * Metrics window end (Unix seconds) when metrics are included in the export. * @type {number} * @memberof GroupExportResponse */ unix_to?: number; /** * True when the match set exceeded the per-request row cap and only the first cap rows were exported. * @type {boolean} * @memberof GroupExportResponse */ truncated?: boolean; } /** * @export * @enum {string} */ declare enum GroupExportResponseExportTypeEnum { link_engagements_batch = "link_engagements_batch", links_list = "links_list", qr_codes_list = "qr_codes_list" } /** * Check if a given object implements the GroupExportResponse interface. */ declare function instanceOfGroupExportResponse(value: object): value is GroupExportResponse; declare function GroupExportResponseFromJSON(json: any): GroupExportResponse; declare function GroupExportResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GroupExportResponse; declare function GroupExportResponseToJSON(json: any): GroupExportResponse; declare function GroupExportResponseToJSONTyped(value?: GroupExportResponse | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/GroupConsumableFeatureUsage.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface GroupConsumableFeatureUsage */ interface GroupConsumableFeatureUsage { /** * * @type {string} * @memberof GroupConsumableFeatureUsage */ name?: string; /** * * @type {string} * @memberof GroupConsumableFeatureUsage */ description?: string; /** * * @type {number} * @memberof GroupConsumableFeatureUsage */ count?: number; } /** * Check if a given object implements the GroupConsumableFeatureUsage interface. */ declare function instanceOfGroupConsumableFeatureUsage(value: object): value is GroupConsumableFeatureUsage; declare function GroupConsumableFeatureUsageFromJSON(json: any): GroupConsumableFeatureUsage; declare function GroupConsumableFeatureUsageFromJSONTyped(json: any, ignoreDiscriminator: boolean): GroupConsumableFeatureUsage; declare function GroupConsumableFeatureUsageToJSON(json: any): GroupConsumableFeatureUsage; declare function GroupConsumableFeatureUsageToJSONTyped(value?: GroupConsumableFeatureUsage | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/GroupFeatureUsage.d.ts /** * * @export * @interface GroupFeatureUsage */ interface GroupFeatureUsage { /** * the group's guid * @type {string} * @memberof GroupFeatureUsage */ group_guid: string; /** * an array of all of the group's consumable feature usage * @type {Array} * @memberof GroupFeatureUsage */ limit_usage: Array; } /** * Check if a given object implements the GroupFeatureUsage interface. */ declare function instanceOfGroupFeatureUsage(value: object): value is GroupFeatureUsage; declare function GroupFeatureUsageFromJSON(json: any): GroupFeatureUsage; declare function GroupFeatureUsageFromJSONTyped(json: any, ignoreDiscriminator: boolean): GroupFeatureUsage; declare function GroupFeatureUsageToJSON(json: any): GroupFeatureUsage; declare function GroupFeatureUsageToJSONTyped(value?: GroupFeatureUsage | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/HistoricalUsage.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface HistoricalUsage */ interface HistoricalUsage { /** * the usage count during the time period * @type {number} * @memberof HistoricalUsage */ count?: number; /** * ISO_TIMESTAMP of the beginning of the time period * @type {string} * @memberof HistoricalUsage */ unit_start?: string; } /** * Check if a given object implements the HistoricalUsage interface. */ declare function instanceOfHistoricalUsage(value: object): value is HistoricalUsage; declare function HistoricalUsageFromJSON(json: any): HistoricalUsage; declare function HistoricalUsageFromJSONTyped(json: any, ignoreDiscriminator: boolean): HistoricalUsage; declare function HistoricalUsageToJSON(json: any): HistoricalUsage; declare function HistoricalUsageToJSONTyped(value?: HistoricalUsage | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/HistoricalFeatureUsage.d.ts /** * * @export * @interface HistoricalFeatureUsage */ interface HistoricalFeatureUsage { /** * feature name * @type {string} * @memberof HistoricalFeatureUsage */ name?: string; /** * * @type {Array} * @memberof HistoricalFeatureUsage */ usage?: Array; } /** * Check if a given object implements the HistoricalFeatureUsage interface. */ declare function instanceOfHistoricalFeatureUsage(value: object): value is HistoricalFeatureUsage; declare function HistoricalFeatureUsageFromJSON(json: any): HistoricalFeatureUsage; declare function HistoricalFeatureUsageFromJSONTyped(json: any, ignoreDiscriminator: boolean): HistoricalFeatureUsage; declare function HistoricalFeatureUsageToJSON(json: any): HistoricalFeatureUsage; declare function HistoricalFeatureUsageToJSONTyped(value?: HistoricalFeatureUsage | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/GroupHistoricalUsage.d.ts /** * * @export * @interface GroupHistoricalUsage */ interface GroupHistoricalUsage { /** * the group's guid * @type {string} * @memberof GroupHistoricalUsage */ group_guid: string; /** * A unit of time (day, week, or month) * @type {string} * @memberof GroupHistoricalUsage */ unit: string; /** * Start date (format "2006-01-02") of the historical usage * @type {string} * @memberof GroupHistoricalUsage */ start_date: string; /** * End date (format "2006-01-02") of the historical usage * @type {string} * @memberof GroupHistoricalUsage */ end_date: string; /** * an array of all of the group's historical feature usage * @type {Array} * @memberof GroupHistoricalUsage */ historical_limit_usage: Array; } /** * Check if a given object implements the GroupHistoricalUsage interface. */ declare function instanceOfGroupHistoricalUsage(value: object): value is GroupHistoricalUsage; declare function GroupHistoricalUsageFromJSON(json: any): GroupHistoricalUsage; declare function GroupHistoricalUsageFromJSONTyped(json: any, ignoreDiscriminator: boolean): GroupHistoricalUsage; declare function GroupHistoricalUsageToJSON(json: any): GroupHistoricalUsage; declare function GroupHistoricalUsageToJSONTyped(value?: GroupHistoricalUsage | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/GroupPreferences.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface GroupPreferences */ interface GroupPreferences { /** * * @type {string} * @memberof GroupPreferences */ group_guid?: string; /** * * @type {string} * @memberof GroupPreferences */ domain_preference?: string; } /** * Check if a given object implements the GroupPreferences interface. */ declare function instanceOfGroupPreferences(value: object): value is GroupPreferences; declare function GroupPreferencesFromJSON(json: any): GroupPreferences; declare function GroupPreferencesFromJSONTyped(json: any, ignoreDiscriminator: boolean): GroupPreferences; declare function GroupPreferencesToJSON(json: any): GroupPreferences; declare function GroupPreferencesToJSONTyped(value?: GroupPreferences | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/GroupUpdate.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface GroupUpdate */ interface GroupUpdate { /** * * @type {string} * @memberof GroupUpdate */ name?: string; /** * * @type {string} * @memberof GroupUpdate */ organization_guid?: string; /** * * @type {Array} * @memberof GroupUpdate */ bsds?: Array; } /** * Check if a given object implements the GroupUpdate interface. */ declare function instanceOfGroupUpdate(value: object): value is GroupUpdate; declare function GroupUpdateFromJSON(json: any): GroupUpdate; declare function GroupUpdateFromJSONTyped(json: any, ignoreDiscriminator: boolean): GroupUpdate; declare function GroupUpdateToJSON(json: any): GroupUpdate; declare function GroupUpdateToJSONTyped(value?: GroupUpdate | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/Groups.d.ts /** * * @export * @interface Groups */ interface Groups { /** * * @type {Array} * @memberof Groups */ groups: Array; } /** * Check if a given object implements the Groups interface. */ declare function instanceOfGroups(value: object): value is Groups; declare function GroupsFromJSON(json: any): Groups; declare function GroupsFromJSONTyped(json: any, ignoreDiscriminator: boolean): Groups; declare function GroupsToJSON(json: any): Groups; declare function GroupsToJSONTyped(value?: Groups | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/Metrics.d.ts /** * * @export * @interface Metrics */ interface Metrics { /** * * @type {string} * @memberof Metrics */ unit?: string; /** * * @type {number} * @memberof Metrics */ units?: number; /** * * @type {MetricsFacetEnum} * @memberof Metrics */ facet?: MetricsFacetEnum; /** * * @type {string} * @memberof Metrics */ unit_reference?: string; /** * * @type {Array} * @memberof Metrics */ metrics?: Array; } /** * @export * @enum {string} */ declare enum MetricsFacetEnum { countries = "countries", cities = "cities", devices = "devices", referrers = "referrers", referrers_by_domain = "referrers_by_domain", referring_domains = "referring_domains", referring_networks = "referring_networks", shorten_counts = "shorten_counts", destinations = "destinations" } /** * Check if a given object implements the Metrics interface. */ declare function instanceOfMetrics(value: object): value is Metrics; declare function MetricsFromJSON(json: any): Metrics; declare function MetricsFromJSONTyped(json: any, ignoreDiscriminator: boolean): Metrics; declare function MetricsToJSON(json: any): Metrics; declare function MetricsToJSONTyped(value?: Metrics | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/Tags.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface Tags */ interface Tags { /** * * @type {Array} * @memberof Tags */ tags?: Array; } /** * Check if a given object implements the Tags interface. */ declare function instanceOfTags(value: object): value is Tags; declare function TagsFromJSON(json: any): Tags; declare function TagsFromJSONTyped(json: any, ignoreDiscriminator: boolean): Tags; declare function TagsToJSON(json: any): Tags; declare function TagsToJSONTyped(value?: Tags | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/TimeUnitDWM.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * the unit of time queried for (day, week, month) * @export * @enum {string} */ declare enum TimeUnitDWM { day = "day", week = "week", month = "month" } declare function instanceOfTimeUnitDWM(value: any): boolean; declare function TimeUnitDWMFromJSON(json: any): TimeUnitDWM; declare function TimeUnitDWMFromJSONTyped(json: any, ignoreDiscriminator: boolean): TimeUnitDWM; declare function TimeUnitDWMToJSON(value?: TimeUnitDWM | null): any; declare function TimeUnitDWMToJSONTyped(value: any, ignoreDiscriminator: boolean): TimeUnitDWM; //#endregion //#region src/apis/GroupsApi.d.ts interface GetGroupRequest { group_guid: string; } interface GetGroupClicksRequest { group_guid: string; unit: TimeUnit; units: number; unit_reference?: string; } interface GetGroupCodeScansByCityRequest { group_guid: string; unit: TimeUnit; units: number; unit_reference?: string; } interface GetGroupCodeScansByCountryRequest { group_guid: string; unit: TimeUnit; units: number; unit_reference?: string; } interface GetGroupCodeScansOverTimeRequest { group_guid: string; unit: TimeUnit; units: number; unit_reference?: string; } interface GetGroupFeatureUsageRequest { group_guid: string; name?: Array; } interface GetGroupHistoricalUsageRequest { group_guid: string; name?: Array; start_date?: string; end_date?: string; unit?: TimeUnitDWM; } interface GetGroupLinkClicksByCityRequest { group_guid: string; unit: TimeUnit; units: number; size?: number; unit_reference?: string; } interface GetGroupLinkClicksByCountryRequest { group_guid: string; unit: TimeUnit; units: number; size?: number; unit_reference?: string; } interface GetGroupLinkClicksByDeviceRequest { group_guid: string; unit: TimeUnit; units: number; size?: number; unit_reference?: string; } interface GetGroupLinkClicksByReferrerRequest { group_guid: string; unit: TimeUnit; units: number; size?: number; unit_reference?: string; } interface GetGroupLinkClicksOverTimeRequest { group_guid: string; unit: TimeUnit; units: number; unit_reference?: string; } interface GetGroupMetricsByCitiesRequest { group_guid: string; unit: TimeUnit; units: number; size?: number; unit_reference?: string; } interface GetGroupMetricsByCountriesRequest { group_guid: string; unit: TimeUnit; units: number; size?: number; unit_reference?: string; } interface GetGroupMetricsByDevicesRequest { group_guid: string; unit: TimeUnit; units: number; size?: number; unit_reference?: string; } interface GetGroupMetricsByReferrerRequest { group_guid: string; unit: TimeUnit; units: number; size?: number; unit_reference?: string; } interface GetGroupMetricsByReferringNetworksRequest { group_guid: string; unit: TimeUnit; units: number; size?: number; unit_reference?: string; } interface GetGroupMetricsOverTimeRequest { group_guid: string; unit: TimeUnit; units: number; unit_reference?: string; } interface GetGroupPreferencesRequest { group_guid: string; } interface GetGroupShortenCountsRequest { group_guid: string; unit: TimeUnit; units: number; unit_reference?: string; } interface GetGroupTagsRequest { group_guid: string; type?: GetGroupTagsTypeEnum; } interface GetGroupTopCodeScansRequest { group_guid: string; unit: TimeUnit; units: number; unit_reference?: string; decoupled?: boolean; } interface GetGroupTopLinkClicksRequest { group_guid: string; unit: TimeUnit; units: number; size?: number; unit_reference?: string; } interface GetGroupTopMetricsRequest { group_guid: string; unit: TimeUnit; units: number; size?: number; unit_reference?: string; } interface GetGroupsRequest { organization_guid?: string; } interface PostCreateGroupExportRequest { group_guid: string; group_export_request_body: GroupExportRequestBody; } interface UpdateGroupRequest { group_guid: string; group_update: GroupUpdate; } interface UpdateGroupPreferencesRequest { group_guid: string; group_preferences: GroupPreferences; } /** * */ declare class GroupsApi extends BaseAPI { /** * Creates request options for getGroup without sending the request */ getGroupRequestOpts(requestParameters: GetGroupRequest): Promise; /** * Returns details for a group. * Retrieve a Group */ getGroupRaw(requestParameters: GetGroupRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns details for a group. * Retrieve a Group */ getGroup(requestParameters: GetGroupRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getGroupClicks without sending the request */ getGroupClicksRequestOpts(requestParameters: GetGroupClicksRequest): Promise; /** * get number of clicks on bitlinks in a group * Get clicks by group */ getGroupClicksRaw(requestParameters: GetGroupClicksRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * get number of clicks on bitlinks in a group * Get clicks by group */ getGroupClicks(requestParameters: GetGroupClicksRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getGroupCodeScansByCity without sending the request */ getGroupCodeScansByCityRequestOpts(requestParameters: GetGroupCodeScansByCityRequest): Promise; /** * Get QR code scan metrics for a group broken down by city. * Get Scan Metrics for a Group by City */ getGroupCodeScansByCityRaw(requestParameters: GetGroupCodeScansByCityRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Get QR code scan metrics for a group broken down by city. * Get Scan Metrics for a Group by City */ getGroupCodeScansByCity(requestParameters: GetGroupCodeScansByCityRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getGroupCodeScansByCountry without sending the request */ getGroupCodeScansByCountryRequestOpts(requestParameters: GetGroupCodeScansByCountryRequest): Promise; /** * Get QR code scan metrics for a group broken down by country. * Get Scan Metrics for a Group by Country */ getGroupCodeScansByCountryRaw(requestParameters: GetGroupCodeScansByCountryRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Get QR code scan metrics for a group broken down by country. * Get Scan Metrics for a Group by Country */ getGroupCodeScansByCountry(requestParameters: GetGroupCodeScansByCountryRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getGroupCodeScansOverTime without sending the request */ getGroupCodeScansOverTimeRequestOpts(requestParameters: GetGroupCodeScansOverTimeRequest): Promise; /** * Get QR code scan metrics over time for a group. * Get Scan Metrics for a Group Over Time */ getGroupCodeScansOverTimeRaw(requestParameters: GetGroupCodeScansOverTimeRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Get QR code scan metrics over time for a group. * Get Scan Metrics for a Group Over Time */ getGroupCodeScansOverTime(requestParameters: GetGroupCodeScansOverTimeRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getGroupFeatureUsage without sending the request */ getGroupFeatureUsageRequestOpts(requestParameters: GetGroupFeatureUsageRequest): Promise; /** * Get a group\'s current feature limit usage, optionally provide limit name(s) for usage on specific limit(s) * Get limit usage for a group */ getGroupFeatureUsageRaw(requestParameters: GetGroupFeatureUsageRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Get a group\'s current feature limit usage, optionally provide limit name(s) for usage on specific limit(s) * Get limit usage for a group */ getGroupFeatureUsage(requestParameters: GetGroupFeatureUsageRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getGroupHistoricalUsage without sending the request */ getGroupHistoricalUsageRequestOpts(requestParameters: GetGroupHistoricalUsageRequest): Promise; /** * Get a group\'s historical usage for specific limit(s) and date range. Refer to GET /v4/groups/{group_guid}/feature_usage endpoint response for available limit names. * Get historical usage for a group */ getGroupHistoricalUsageRaw(requestParameters: GetGroupHistoricalUsageRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Get a group\'s historical usage for specific limit(s) and date range. Refer to GET /v4/groups/{group_guid}/feature_usage endpoint response for available limit names. * Get historical usage for a group */ getGroupHistoricalUsage(requestParameters: GetGroupHistoricalUsageRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getGroupLinkClicksByCity without sending the request */ getGroupLinkClicksByCityRequestOpts(requestParameters: GetGroupLinkClicksByCityRequest): Promise; /** * Get link clicks by city for all links in a group. * Get Group Link Clicks by City */ getGroupLinkClicksByCityRaw(requestParameters: GetGroupLinkClicksByCityRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Get link clicks by city for all links in a group. * Get Group Link Clicks by City */ getGroupLinkClicksByCity(requestParameters: GetGroupLinkClicksByCityRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getGroupLinkClicksByCountry without sending the request */ getGroupLinkClicksByCountryRequestOpts(requestParameters: GetGroupLinkClicksByCountryRequest): Promise; /** * Get link clicks by country for all links in a group. * Get Group Link Clicks by Country */ getGroupLinkClicksByCountryRaw(requestParameters: GetGroupLinkClicksByCountryRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Get link clicks by country for all links in a group. * Get Group Link Clicks by Country */ getGroupLinkClicksByCountry(requestParameters: GetGroupLinkClicksByCountryRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getGroupLinkClicksByDevice without sending the request */ getGroupLinkClicksByDeviceRequestOpts(requestParameters: GetGroupLinkClicksByDeviceRequest): Promise; /** * Get link clicks by device for all links in a group. * Get Group Link Clicks by Device */ getGroupLinkClicksByDeviceRaw(requestParameters: GetGroupLinkClicksByDeviceRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Get link clicks by device for all links in a group. * Get Group Link Clicks by Device */ getGroupLinkClicksByDevice(requestParameters: GetGroupLinkClicksByDeviceRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getGroupLinkClicksByReferrer without sending the request */ getGroupLinkClicksByReferrerRequestOpts(requestParameters: GetGroupLinkClicksByReferrerRequest): Promise; /** * Get link clicks by referrer for all links in a group. * Get Group Link Clicks by Referrer */ getGroupLinkClicksByReferrerRaw(requestParameters: GetGroupLinkClicksByReferrerRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Get link clicks by referrer for all links in a group. * Get Group Link Clicks by Referrer */ getGroupLinkClicksByReferrer(requestParameters: GetGroupLinkClicksByReferrerRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getGroupLinkClicksOverTime without sending the request */ getGroupLinkClicksOverTimeRequestOpts(requestParameters: GetGroupLinkClicksOverTimeRequest): Promise; /** * Get link clicks over time for all links in a group. * Get Group Link Clicks Over Time */ getGroupLinkClicksOverTimeRaw(requestParameters: GetGroupLinkClicksOverTimeRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Get link clicks over time for all links in a group. * Get Group Link Clicks Over Time */ getGroupLinkClicksOverTime(requestParameters: GetGroupLinkClicksOverTimeRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getGroupMetricsByCities without sending the request */ getGroupMetricsByCitiesRequestOpts(requestParameters: GetGroupMetricsByCitiesRequest): Promise; /** * Returns the geographic origins of click traffic by city for the specified group. * Get Click Metrics for a Group by City */ getGroupMetricsByCitiesRaw(requestParameters: GetGroupMetricsByCitiesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns the geographic origins of click traffic by city for the specified group. * Get Click Metrics for a Group by City */ getGroupMetricsByCities(requestParameters: GetGroupMetricsByCitiesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getGroupMetricsByCountries without sending the request */ getGroupMetricsByCountriesRequestOpts(requestParameters: GetGroupMetricsByCountriesRequest): Promise; /** * Returns the geographic origins of click traffic by country for the specified group. * Get Click Metrics for a Group by Country */ getGroupMetricsByCountriesRaw(requestParameters: GetGroupMetricsByCountriesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns the geographic origins of click traffic by country for the specified group. * Get Click Metrics for a Group by Country */ getGroupMetricsByCountries(requestParameters: GetGroupMetricsByCountriesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getGroupMetricsByDevices without sending the request */ getGroupMetricsByDevicesRequestOpts(requestParameters: GetGroupMetricsByDevicesRequest): Promise; /** * Returns the device types generating click traffic to the specified group\'s links. * Get Click Metrics for a Group by Device Type */ getGroupMetricsByDevicesRaw(requestParameters: GetGroupMetricsByDevicesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns the device types generating click traffic to the specified group\'s links. * Get Click Metrics for a Group by Device Type */ getGroupMetricsByDevices(requestParameters: GetGroupMetricsByDevicesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getGroupMetricsByReferrer without sending the request */ getGroupMetricsByReferrerRequestOpts(requestParameters: GetGroupMetricsByReferrerRequest): Promise; /** * Returns metrics by referrer for the specified group\'s links. * Get Click Metrics for a Group by Referrer */ getGroupMetricsByReferrerRaw(requestParameters: GetGroupMetricsByReferrerRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns metrics by referrer for the specified group\'s links. * Get Click Metrics for a Group by Referrer */ getGroupMetricsByReferrer(requestParameters: GetGroupMetricsByReferrerRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getGroupMetricsByReferringNetworks without sending the request */ getGroupMetricsByReferringNetworksRequestOpts(requestParameters: GetGroupMetricsByReferringNetworksRequest): Promise; /** * Returns metrics by referring networks for the specified group\'s links. * Get Click Metrics for a Group by Referring Networks */ getGroupMetricsByReferringNetworksRaw(requestParameters: GetGroupMetricsByReferringNetworksRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns metrics by referring networks for the specified group\'s links. * Get Click Metrics for a Group by Referring Networks */ getGroupMetricsByReferringNetworks(requestParameters: GetGroupMetricsByReferringNetworksRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getGroupMetricsOverTime without sending the request */ getGroupMetricsOverTimeRequestOpts(requestParameters: GetGroupMetricsOverTimeRequest): Promise; /** * Get group engagement metrics over time for all links in a group. * Get Group Metrics Over Time */ getGroupMetricsOverTimeRaw(requestParameters: GetGroupMetricsOverTimeRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Get group engagement metrics over time for all links in a group. * Get Group Metrics Over Time */ getGroupMetricsOverTime(requestParameters: GetGroupMetricsOverTimeRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getGroupPreferences without sending the request */ getGroupPreferencesRequestOpts(requestParameters: GetGroupPreferencesRequest): Promise; /** * Returns preferences for the specified group. * Retrieve Group Preferences */ getGroupPreferencesRaw(requestParameters: GetGroupPreferencesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns preferences for the specified group. * Retrieve Group Preferences */ getGroupPreferences(requestParameters: GetGroupPreferencesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getGroupShortenCounts without sending the request */ getGroupShortenCountsRequestOpts(requestParameters: GetGroupShortenCountsRequest): Promise; /** * Returns all the shorten counts for a group. * Retrieve Group Shorten Counts */ getGroupShortenCountsRaw(requestParameters: GetGroupShortenCountsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns all the shorten counts for a group. * Retrieve Group Shorten Counts */ getGroupShortenCounts(requestParameters: GetGroupShortenCountsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getGroupTags without sending the request */ getGroupTagsRequestOpts(requestParameters: GetGroupTagsRequest): Promise; /** * Returns the tags currently used in the specified group. Maximum 1000. * Retrieve Tags by Group */ getGroupTagsRaw(requestParameters: GetGroupTagsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns the tags currently used in the specified group. Maximum 1000. * Retrieve Tags by Group */ getGroupTags(requestParameters: GetGroupTagsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getGroupTopCodeScans without sending the request */ getGroupTopCodeScansRequestOpts(requestParameters: GetGroupTopCodeScansRequest): Promise; /** * Get top performing QR codes by scan count for all codes in a group. * Get Top Performing QR Codes for a Group */ getGroupTopCodeScansRaw(requestParameters: GetGroupTopCodeScansRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Get top performing QR codes by scan count for all codes in a group. * Get Top Performing QR Codes for a Group */ getGroupTopCodeScans(requestParameters: GetGroupTopCodeScansRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getGroupTopLinkClicks without sending the request */ getGroupTopLinkClicksRequestOpts(requestParameters: GetGroupTopLinkClicksRequest): Promise; /** * Get top performing links by click for all links in a group. * Get Group Top Performing Links by Click */ getGroupTopLinkClicksRaw(requestParameters: GetGroupTopLinkClicksRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Get top performing links by click for all links in a group. * Get Group Top Performing Links by Click */ getGroupTopLinkClicks(requestParameters: GetGroupTopLinkClicksRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getGroupTopMetrics without sending the request */ getGroupTopMetricsRequestOpts(requestParameters: GetGroupTopMetricsRequest): Promise; /** * Get top performing links by engagement for all links in a group. * Get Group Top Performing Links by Engagement */ getGroupTopMetricsRaw(requestParameters: GetGroupTopMetricsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Get top performing links by engagement for all links in a group. * Get Group Top Performing Links by Engagement */ getGroupTopMetrics(requestParameters: GetGroupTopMetricsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getGroups without sending the request */ getGroupsRequestOpts(requestParameters: GetGroupsRequest): Promise; /** * Returns a list of groups in the organization. * Retrieve Groups */ getGroupsRaw(requestParameters: GetGroupsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns a list of groups in the organization. * Retrieve Groups */ getGroups(requestParameters?: GetGroupsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for postCreateGroupExport without sending the request */ postCreateGroupExportRequestOpts(requestParameters: PostCreateGroupExportRequest): Promise; /** * Build a CSV export synchronously and return it inline as a base64 data URI plus metadata. The export_type field selects the CSV shape: link_engagements_batch (engagement metrics for explicit bitlinks or a filter), links_list (link metadata roster), or qr_codes_list (QR code metadata roster). Row caps apply per request: 200 rows when metrics are included (link_engagements_batch, or include_metrics on a list export); 1000 rows for metadata-only list exports. When the match set exceeds the cap, truncated is true and only the first cap rows are returned; row_count reports how many data rows are in the CSV. * Create an inline CSV export for a group */ postCreateGroupExportRaw(requestParameters: PostCreateGroupExportRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Build a CSV export synchronously and return it inline as a base64 data URI plus metadata. The export_type field selects the CSV shape: link_engagements_batch (engagement metrics for explicit bitlinks or a filter), links_list (link metadata roster), or qr_codes_list (QR code metadata roster). Row caps apply per request: 200 rows when metrics are included (link_engagements_batch, or include_metrics on a list export); 1000 rows for metadata-only list exports. When the match set exceeds the cap, truncated is true and only the first cap rows are returned; row_count reports how many data rows are in the CSV. * Create an inline CSV export for a group */ postCreateGroupExport(requestParameters: PostCreateGroupExportRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for updateGroup without sending the request */ updateGroupRequestOpts(requestParameters: UpdateGroupRequest): Promise; /** * Updates the details of a group. * Update a Group */ updateGroupRaw(requestParameters: UpdateGroupRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Updates the details of a group. * Update a Group */ updateGroup(requestParameters: UpdateGroupRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for updateGroupPreferences without sending the request */ updateGroupPreferencesRequestOpts(requestParameters: UpdateGroupPreferencesRequest): Promise; /** * Updates preferences for a group. * Update Group Preferences */ updateGroupPreferencesRaw(requestParameters: UpdateGroupPreferencesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Updates preferences for a group. * Update Group Preferences */ updateGroupPreferences(requestParameters: UpdateGroupPreferencesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; } /** * @export * @enum {string} */ declare enum GetGroupTagsTypeEnum { bitlink = "bitlink", qr_code = "qr_code" } //#endregion //#region src/models/Organization.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface Organization */ interface Organization { /** * * @type {{ [key: string]: string; }} * @memberof Organization */ references?: { [key: string]: string; }; /** * * @type {string} * @memberof Organization */ name: string; /** * * @type {boolean} * @memberof Organization */ is_active: boolean; /** * * @type {string} * @memberof Organization */ guid: string; /** * * @type {string} * @memberof Organization */ tier: string; /** * * @type {string} * @memberof Organization */ tier_family: string; /** * * @type {string} * @memberof Organization */ tier_display_name: string; /** * * @type {string} * @memberof Organization */ role: string; /** * * @type {string} * @memberof Organization */ created: string; /** * * @type {string} * @memberof Organization */ modified: string; /** * * @type {Array} * @memberof Organization */ bsds: Array; /** * SSO authentication requirement for this organization. Possible values: "none", "any". Omitted when no auth requirements are configured. * * @type {OrganizationRequireSsoEnum} * @memberof Organization */ require_sso?: OrganizationRequireSsoEnum; /** * Two-factor authentication requirement for this organization. Possible values: "none", "sms". Omitted when no auth requirements are configured. * * @type {OrganizationRequire2faEnum} * @memberof Organization */ require_2fa?: OrganizationRequire2faEnum; } /** * @export * @enum {string} */ declare enum OrganizationRequireSsoEnum { none = "none", any = "any" } /** * @export * @enum {string} */ declare enum OrganizationRequire2faEnum { none = "none", sms = "sms" } /** * Check if a given object implements the Organization interface. */ declare function instanceOfOrganization(value: object): value is Organization; declare function OrganizationFromJSON(json: any): Organization; declare function OrganizationFromJSONTyped(json: any, ignoreDiscriminator: boolean): Organization; declare function OrganizationToJSON(json: any): Organization; declare function OrganizationToJSONTyped(value?: Organization | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/Organizations.d.ts /** * * @export * @interface Organizations */ interface Organizations { /** * * @type {Array} * @memberof Organizations */ organizations: Array; } /** * Check if a given object implements the Organizations interface. */ declare function instanceOfOrganizations(value: object): value is Organizations; declare function OrganizationsFromJSON(json: any): Organizations; declare function OrganizationsFromJSONTyped(json: any, ignoreDiscriminator: boolean): Organizations; declare function OrganizationsToJSON(json: any): Organizations; declare function OrganizationsToJSONTyped(value?: Organizations | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/PlanLimit.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface PlanLimit */ interface PlanLimit { /** * * @type {string} * @memberof PlanLimit */ name?: string; /** * * @type {string} * @memberof PlanLimit */ description?: string; /** * * @type {number} * @memberof PlanLimit */ limit?: number; /** * * @type {number} * @memberof PlanLimit */ count?: number; } /** * Check if a given object implements the PlanLimit interface. */ declare function instanceOfPlanLimit(value: object): value is PlanLimit; declare function PlanLimitFromJSON(json: any): PlanLimit; declare function PlanLimitFromJSONTyped(json: any, ignoreDiscriminator: boolean): PlanLimit; declare function PlanLimitToJSON(json: any): PlanLimit; declare function PlanLimitToJSONTyped(value?: PlanLimit | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/PlanLimits.d.ts /** * * @export * @interface PlanLimits */ interface PlanLimits { /** * * @type {{ [key: string]: string; }} * @memberof PlanLimits */ references?: { [key: string]: string; }; /** * * @type {string} * @memberof PlanLimits */ organization_guid?: string; /** * * @type {Array} * @memberof PlanLimits */ plan_limits?: Array; } /** * Check if a given object implements the PlanLimits interface. */ declare function instanceOfPlanLimits(value: object): value is PlanLimits; declare function PlanLimitsFromJSON(json: any): PlanLimits; declare function PlanLimitsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PlanLimits; declare function PlanLimitsToJSON(json: any): PlanLimits; declare function PlanLimitsToJSONTyped(value?: PlanLimits | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/apis/OrganizationsApi.d.ts interface GetOrganizationRequest { organization_guid: string; } interface GetOrganizationShortenCountsRequest { organization_guid: string; unit: TimeUnit; units: number; unit_reference?: string; } interface GetOrganizationShortenCountsByGroupRequest { organization_guid: string; } interface GetOrganizationsRequest { include_all?: boolean; } interface GetPlanLimitsRequest { organization_guid: string; } /** * */ declare class OrganizationsApi extends BaseAPI { /** * Creates request options for getOrganization without sending the request */ getOrganizationRequestOpts(requestParameters: GetOrganizationRequest): Promise; /** * Retrive details for the specified organization. * Retrieve an Organization */ getOrganizationRaw(requestParameters: GetOrganizationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Retrive details for the specified organization. * Retrieve an Organization */ getOrganization(requestParameters: GetOrganizationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getOrganizationShortenCounts without sending the request */ getOrganizationShortenCountsRequestOpts(requestParameters: GetOrganizationShortenCountsRequest): Promise; /** * Returns the shorten counts for a specific organization over a specified time period. * Get Shorten Counts for an Organization */ getOrganizationShortenCountsRaw(requestParameters: GetOrganizationShortenCountsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns the shorten counts for a specific organization over a specified time period. * Get Shorten Counts for an Organization */ getOrganizationShortenCounts(requestParameters: GetOrganizationShortenCountsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getOrganizationShortenCountsByGroup without sending the request */ getOrganizationShortenCountsByGroupRequestOpts(requestParameters: GetOrganizationShortenCountsByGroupRequest): Promise; /** * Returns the shorten counts for a specific organization by group for the current month. * Get Shorten Counts for an Organization by Group */ getOrganizationShortenCountsByGroupRaw(requestParameters: GetOrganizationShortenCountsByGroupRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns the shorten counts for a specific organization by group for the current month. * Get Shorten Counts for an Organization by Group */ getOrganizationShortenCountsByGroup(requestParameters: GetOrganizationShortenCountsByGroupRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getOrganizations without sending the request */ getOrganizationsRequestOpts(requestParameters: GetOrganizationsRequest): Promise; /** * Retrieve a list of organizations for the authenticated user. By default, only organizations permitted by the token\'s allowed_orgs are returned. Use include_all=true to return all organizations regardless of token restrictions. Each organization is annotated with its authentication requirements (require_sso, require_2fa) when configured. * Retrieve Organizations */ getOrganizationsRaw(requestParameters: GetOrganizationsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Retrieve a list of organizations for the authenticated user. By default, only organizations permitted by the token\'s allowed_orgs are returned. Use include_all=true to return all organizations regardless of token restrictions. Each organization is annotated with its authentication requirements (require_sso, require_2fa) when configured. * Retrieve Organizations */ getOrganizations(requestParameters?: GetOrganizationsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getPlanLimits without sending the request */ getPlanLimitsRequestOpts(requestParameters: GetPlanLimitsRequest): Promise; /** * Returns all plan limits and counts available for an organization. * Get Plan Limits */ getPlanLimitsRaw(requestParameters: GetPlanLimitsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns all plan limits and counts available for an organization. * Get Plan Limits */ getPlanLimits(requestParameters: GetPlanLimitsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; } //#endregion //#region src/models/QRScans.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface QRScans */ interface QRScans { /** * * @type {number} * @memberof QRScans */ scans?: number; /** * * @type {string} * @memberof QRScans */ date?: string; } /** * Check if a given object implements the QRScans interface. */ declare function instanceOfQRScans(value: object): value is QRScans; declare function QRScansFromJSON(json: any): QRScans; declare function QRScansFromJSONTyped(json: any, ignoreDiscriminator: boolean): QRScans; declare function QRScansToJSON(json: any): QRScans; declare function QRScansToJSONTyped(value?: QRScans | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/BitlinkScans.d.ts /** * * @export * @interface BitlinkScans */ interface BitlinkScans { /** * * @type {Array} * @memberof BitlinkScans */ scans?: Array; /** * * @type {number} * @memberof BitlinkScans */ units?: number; /** * * @type {BitlinkScansUnitEnum} * @memberof BitlinkScans */ unit?: BitlinkScansUnitEnum; /** * * @type {string} * @memberof BitlinkScans */ unit_reference?: string; } /** * @export * @enum {string} */ declare enum BitlinkScansUnitEnum { minute = "minute", hour = "hour", day = "day", week = "week", month = "month" } /** * Check if a given object implements the BitlinkScans interface. */ declare function instanceOfBitlinkScans(value: object): value is BitlinkScans; declare function BitlinkScansFromJSON(json: any): BitlinkScans; declare function BitlinkScansFromJSONTyped(json: any, ignoreDiscriminator: boolean): BitlinkScans; declare function BitlinkScansToJSON(json: any): BitlinkScans; declare function BitlinkScansToJSONTyped(value?: BitlinkScans | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/BitlinkScansSummary.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface BitlinkScansSummary */ interface BitlinkScansSummary { /** * * @type {number} * @memberof BitlinkScansSummary */ total_scans?: number; /** * * @type {number} * @memberof BitlinkScansSummary */ units?: number; /** * * @type {BitlinkScansSummaryUnitEnum} * @memberof BitlinkScansSummary */ unit?: BitlinkScansSummaryUnitEnum; /** * * @type {string} * @memberof BitlinkScansSummary */ unit_reference?: string; } /** * @export * @enum {string} */ declare enum BitlinkScansSummaryUnitEnum { minute = "minute", hour = "hour", day = "day", week = "week", month = "month" } /** * Check if a given object implements the BitlinkScansSummary interface. */ declare function instanceOfBitlinkScansSummary(value: object): value is BitlinkScansSummary; declare function BitlinkScansSummaryFromJSON(json: any): BitlinkScansSummary; declare function BitlinkScansSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): BitlinkScansSummary; declare function BitlinkScansSummaryToJSON(json: any): BitlinkScansSummary; declare function BitlinkScansSummaryToJSONTyped(value?: BitlinkScansSummary | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/OtherScanMetrics.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface OtherScanMetrics */ interface OtherScanMetrics { /** * * @type {number} * @memberof OtherScanMetrics */ other_city_scans?: number; /** * * @type {number} * @memberof OtherScanMetrics */ no_city_scans?: number; } /** * Check if a given object implements the OtherScanMetrics interface. */ declare function instanceOfOtherScanMetrics(value: object): value is OtherScanMetrics; declare function OtherScanMetricsFromJSON(json: any): OtherScanMetrics; declare function OtherScanMetricsFromJSONTyped(json: any, ignoreDiscriminator: boolean): OtherScanMetrics; declare function OtherScanMetricsToJSON(json: any): OtherScanMetrics; declare function OtherScanMetricsToJSONTyped(value?: OtherScanMetrics | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/CityScanMetric.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface CityScanMetric */ interface CityScanMetric { /** * * @type {number} * @memberof CityScanMetric */ scans?: number; /** * * @type {string} * @memberof CityScanMetric */ city?: string; /** * * @type {string} * @memberof CityScanMetric */ subregion?: string; /** * * @type {string} * @memberof CityScanMetric */ region?: string; /** * * @type {string} * @memberof CityScanMetric */ country?: string; } /** * Check if a given object implements the CityScanMetric interface. */ declare function instanceOfCityScanMetric(value: object): value is CityScanMetric; declare function CityScanMetricFromJSON(json: any): CityScanMetric; declare function CityScanMetricFromJSONTyped(json: any, ignoreDiscriminator: boolean): CityScanMetric; declare function CityScanMetricToJSON(json: any): CityScanMetric; declare function CityScanMetricToJSONTyped(value?: CityScanMetric | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/CityScanMetrics.d.ts /** * * @export * @interface CityScanMetrics */ interface CityScanMetrics { /** * * @type {string} * @memberof CityScanMetrics */ unit?: string; /** * * @type {number} * @memberof CityScanMetrics */ units?: number; /** * * @type {CityScanMetricsFacetEnum} * @memberof CityScanMetrics */ facet?: CityScanMetricsFacetEnum; /** * * @type {string} * @memberof CityScanMetrics */ unit_reference?: string; /** * * @type {Array} * @memberof CityScanMetrics */ metrics?: Array; /** * * @type {OtherScanMetrics} * @memberof CityScanMetrics */ other_metrics?: OtherScanMetrics; } /** * @export * @enum {string} */ declare enum CityScanMetricsFacetEnum { countries = "countries", cities = "cities", device_os = "device_os", browsers = "browsers", destinations = "destinations" } /** * Check if a given object implements the CityScanMetrics interface. */ declare function instanceOfCityScanMetrics(value: object): value is CityScanMetrics; declare function CityScanMetricsFromJSON(json: any): CityScanMetrics; declare function CityScanMetricsFromJSONTyped(json: any, ignoreDiscriminator: boolean): CityScanMetrics; declare function CityScanMetricsToJSON(json: any): CityScanMetrics; declare function CityScanMetricsToJSONTyped(value?: CityScanMetrics | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/GradientColor.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface GradientColor */ interface GradientColor { /** * A color in hexadecimal format to be used in one of the gradient's elements * @type {string} * @memberof GradientColor */ color?: string; /** * A number between 0-100 denoting the offset of the gradient color, interpreted as a percentage * @type {number} * @memberof GradientColor */ offset?: number; } /** * Check if a given object implements the GradientColor interface. */ declare function instanceOfGradientColor(value: object): value is GradientColor; declare function GradientColorFromJSON(json: any): GradientColor; declare function GradientColorFromJSONTyped(json: any, ignoreDiscriminator: boolean): GradientColor; declare function GradientColorToJSON(json: any): GradientColor; declare function GradientColorToJSONTyped(value?: GradientColor | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/QRCodeGradient.d.ts /** * * @export * @interface QRCodeGradient */ interface QRCodeGradient { /** * The style of the gradient. Can be either linear or radial. * @type {QRCodeGradientStyleEnum} * @memberof QRCodeGradient */ style?: QRCodeGradientStyleEnum; /** * The angle by which the gradient will be rotated. Only applies to linear gradients. * @type {number} * @memberof QRCodeGradient */ angle?: number; /** * The list of hex colors and their offsets to be used in the gradient. * @type {Array} * @memberof QRCodeGradient */ colors?: Array; /** * Ignore gradient mask on corners * @type {boolean} * @memberof QRCodeGradient */ exclude_corners?: boolean; } /** * @export * @enum {string} */ declare enum QRCodeGradientStyleEnum { no_gradient = "no_gradient", linear = "linear", radial = "radial" } /** * Check if a given object implements the QRCodeGradient interface. */ declare function instanceOfQRCodeGradient(value: object): value is QRCodeGradient; declare function QRCodeGradientFromJSON(json: any): QRCodeGradient; declare function QRCodeGradientFromJSONTyped(json: any, ignoreDiscriminator: boolean): QRCodeGradient; declare function QRCodeGradientToJSON(json: any): QRCodeGradient; declare function QRCodeGradientToJSONTyped(value?: QRCodeGradient | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/QRCodeLogoPublic.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface QRCodeLogoPublic */ interface QRCodeLogoPublic { /** * A GUID for an image uploaded to Bitly * @type {string} * @memberof QRCodeLogoPublic */ image_guid?: string; } /** * Check if a given object implements the QRCodeLogoPublic interface. */ declare function instanceOfQRCodeLogoPublic(value: object): value is QRCodeLogoPublic; declare function QRCodeLogoPublicFromJSON(json: any): QRCodeLogoPublic; declare function QRCodeLogoPublicFromJSONTyped(json: any, ignoreDiscriminator: boolean): QRCodeLogoPublic; declare function QRCodeLogoPublicToJSON(json: any): QRCodeLogoPublic; declare function QRCodeLogoPublicToJSONTyped(value?: QRCodeLogoPublic | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/QRCodeDotPatternType.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @enum {string} */ declare enum QRCodeDotPatternType { standard = "standard", circle = "circle", block = "block", blob = "blob", rounded = "rounded", vertical = "vertical", horizontal = "horizontal", triangle = "triangle", heart = "heart", star = "star", diamond = "diamond" } declare function instanceOfQRCodeDotPatternType(value: any): boolean; declare function QRCodeDotPatternTypeFromJSON(json: any): QRCodeDotPatternType; declare function QRCodeDotPatternTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): QRCodeDotPatternType; declare function QRCodeDotPatternTypeToJSON(value?: QRCodeDotPatternType | null): any; declare function QRCodeDotPatternTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): QRCodeDotPatternType; //#endregion //#region src/models/QRCodeSpecSettingsPublic.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * The QR code's editable spec settings, which for now is just the error correction * @export * @interface QRCodeSpecSettingsPublic */ interface QRCodeSpecSettingsPublic { /** * The amount of error correction that the QR code was generated with * @type {number} * @memberof QRCodeSpecSettingsPublic */ error_correction?: number; } /** * Check if a given object implements the QRCodeSpecSettingsPublic interface. */ declare function instanceOfQRCodeSpecSettingsPublic(value: object): value is QRCodeSpecSettingsPublic; declare function QRCodeSpecSettingsPublicFromJSON(json: any): QRCodeSpecSettingsPublic; declare function QRCodeSpecSettingsPublicFromJSONTyped(json: any, ignoreDiscriminator: boolean): QRCodeSpecSettingsPublic; declare function QRCodeSpecSettingsPublicToJSON(json: any): QRCodeSpecSettingsPublic; declare function QRCodeSpecSettingsPublicToJSONTyped(value?: QRCodeSpecSettingsPublic | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/QRCodeCorner.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Represents one corner, both inner and outer, of a QR code, with color and shape values * @export * @interface QRCodeCorner */ interface QRCodeCorner { /** * The inner color of a corner of the QR code in hex code format * @type {string} * @memberof QRCodeCorner */ inner_color?: string; /** * The outer color of a corner of the QR code in hex code format * @type {string} * @memberof QRCodeCorner */ outer_color?: string; /** * The shape one of the QR code's corners should take * @type {QRCodeCornerShapeEnum} * @memberof QRCodeCorner */ shape?: QRCodeCornerShapeEnum; } /** * @export * @enum {string} */ declare enum QRCodeCornerShapeEnum { standard = "standard", slightly_round = "slightly_round", rounded = "rounded", extra_round = "extra_round", leaf = "leaf", leaf_inner = "leaf_inner", leaf_outer = "leaf_outer", target = "target", concave = "concave" } /** * Check if a given object implements the QRCodeCorner interface. */ declare function instanceOfQRCodeCorner(value: object): value is QRCodeCorner; declare function QRCodeCornerFromJSON(json: any): QRCodeCorner; declare function QRCodeCornerFromJSONTyped(json: any, ignoreDiscriminator: boolean): QRCodeCorner; declare function QRCodeCornerToJSON(json: any): QRCodeCorner; declare function QRCodeCornerToJSONTyped(value?: QRCodeCorner | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/QRCodeCorners.d.ts /** * An object representing all three corners of the QR code. The corners corresponding to each property are: corner_1 = top left, corner_2 = top right, and corner_3 = bottom right * @export * @interface QRCodeCorners */ interface QRCodeCorners { /** * * @type {QRCodeCorner} * @memberof QRCodeCorners */ corner_1?: QRCodeCorner; /** * * @type {QRCodeCorner} * @memberof QRCodeCorners */ corner_2?: QRCodeCorner; /** * * @type {QRCodeCorner} * @memberof QRCodeCorners */ corner_3?: QRCodeCorner; } /** * Check if a given object implements the QRCodeCorners interface. */ declare function instanceOfQRCodeCorners(value: object): value is QRCodeCorners; declare function QRCodeCornersFromJSON(json: any): QRCodeCorners; declare function QRCodeCornersFromJSONTyped(json: any, ignoreDiscriminator: boolean): QRCodeCorners; declare function QRCodeCornersToJSON(json: any): QRCodeCorners; declare function QRCodeCornersToJSONTyped(value?: QRCodeCorners | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/QRCodeFrameType.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @enum {string} */ declare enum QRCodeFrameType { none = "none", border_only = "border_only", text_bottom = "text_bottom", tooltip_bottom = "tooltip_bottom", arrow = "arrow", text_top = "text_top", text_bottom_in_frame = "text_bottom_in_frame", script = "script", text_top_and_bottom = "text_top_and_bottom", url = "url", instagram = "instagram" } declare function instanceOfQRCodeFrameType(value: any): boolean; declare function QRCodeFrameTypeFromJSON(json: any): QRCodeFrameType; declare function QRCodeFrameTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): QRCodeFrameType; declare function QRCodeFrameTypeToJSON(value?: QRCodeFrameType | null): any; declare function QRCodeFrameTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): QRCodeFrameType; //#endregion //#region src/models/QRCodeFrameRequestColors.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * An object of named colors denoting which color should go to which area of the frame * @export * @interface QRCodeFrameRequestColors */ interface QRCodeFrameRequestColors { /** * The primary color of the frame in hex code format * @type {string} * @memberof QRCodeFrameRequestColors */ primary?: string; /** * The secondary color of the frame in hex code format * @type {string} * @memberof QRCodeFrameRequestColors */ secondary?: string; /** * The background color of the frame in hex code format * @type {string} * @memberof QRCodeFrameRequestColors */ background?: string; } /** * Check if a given object implements the QRCodeFrameRequestColors interface. */ declare function instanceOfQRCodeFrameRequestColors(value: object): value is QRCodeFrameRequestColors; declare function QRCodeFrameRequestColorsFromJSON(json: any): QRCodeFrameRequestColors; declare function QRCodeFrameRequestColorsFromJSONTyped(json: any, ignoreDiscriminator: boolean): QRCodeFrameRequestColors; declare function QRCodeFrameRequestColorsToJSON(json: any): QRCodeFrameRequestColors; declare function QRCodeFrameRequestColorsToJSONTyped(value?: QRCodeFrameRequestColors | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/Text.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * An object describing text with color * @export * @interface Text */ interface Text { /** * The text to be used * @type {string} * @memberof Text */ content: string; /** * The color of the text in hex code format * @type {string} * @memberof Text */ color?: string; } /** * Check if a given object implements the Text interface. */ declare function instanceOfText(value: object): value is Text; declare function TextFromJSON(json: any): Text; declare function TextFromJSONTyped(json: any, ignoreDiscriminator: boolean): Text; declare function TextToJSON(json: any): Text; declare function TextToJSONTyped(value?: Text | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/QRCodeFrameRequestText.d.ts /** * The text to be inserted into the QR code's frame * @export * @interface QRCodeFrameRequestText */ interface QRCodeFrameRequestText { /** * * @type {Text} * @memberof QRCodeFrameRequestText */ primary?: Text; /** * * @type {Text} * @memberof QRCodeFrameRequestText */ secondary?: Text; } /** * Check if a given object implements the QRCodeFrameRequestText interface. */ declare function instanceOfQRCodeFrameRequestText(value: object): value is QRCodeFrameRequestText; declare function QRCodeFrameRequestTextFromJSON(json: any): QRCodeFrameRequestText; declare function QRCodeFrameRequestTextFromJSONTyped(json: any, ignoreDiscriminator: boolean): QRCodeFrameRequestText; declare function QRCodeFrameRequestTextToJSON(json: any): QRCodeFrameRequestText; declare function QRCodeFrameRequestTextToJSONTyped(value?: QRCodeFrameRequestText | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/QRCodeFrameRequest.d.ts /** * * @export * @interface QRCodeFrameRequest */ interface QRCodeFrameRequest { /** * * @type {QRCodeFrameType} * @memberof QRCodeFrameRequest */ id: QRCodeFrameType; /** * * @type {QRCodeFrameRequestColors} * @memberof QRCodeFrameRequest */ colors?: QRCodeFrameRequestColors; /** * * @type {QRCodeFrameRequestText} * @memberof QRCodeFrameRequest */ text?: QRCodeFrameRequestText; } /** * Check if a given object implements the QRCodeFrameRequest interface. */ declare function instanceOfQRCodeFrameRequest(value: object): value is QRCodeFrameRequest; declare function QRCodeFrameRequestFromJSON(json: any): QRCodeFrameRequest; declare function QRCodeFrameRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): QRCodeFrameRequest; declare function QRCodeFrameRequestToJSON(json: any): QRCodeFrameRequest; declare function QRCodeFrameRequestToJSONTyped(value?: QRCodeFrameRequest | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/QRCodeBranding.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface QRCodeBranding */ interface QRCodeBranding { /** * A boolean that determines if the QR code should have the bitly brand in its bottom right corner * @type {boolean} * @memberof QRCodeBranding */ bitly_brand?: boolean; } /** * Check if a given object implements the QRCodeBranding interface. */ declare function instanceOfQRCodeBranding(value: object): value is QRCodeBranding; declare function QRCodeBrandingFromJSON(json: any): QRCodeBranding; declare function QRCodeBrandingFromJSONTyped(json: any, ignoreDiscriminator: boolean): QRCodeBranding; declare function QRCodeBrandingToJSON(json: any): QRCodeBranding; declare function QRCodeBrandingToJSONTyped(value?: QRCodeBranding | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/QRCodeText.d.ts /** * Contains the center, top, and bottom text to be used in the QR code * @export * @interface QRCodeText */ interface QRCodeText { /** * * @type {Text} * @memberof QRCodeText */ center?: Text; /** * * @type {Text} * @memberof QRCodeText */ top?: Text; /** * * @type {Text} * @memberof QRCodeText */ bottom?: Text; } /** * Check if a given object implements the QRCodeText interface. */ declare function instanceOfQRCodeText(value: object): value is QRCodeText; declare function QRCodeTextFromJSON(json: any): QRCodeText; declare function QRCodeTextFromJSONTyped(json: any, ignoreDiscriminator: boolean): QRCodeText; declare function QRCodeTextToJSON(json: any): QRCodeText; declare function QRCodeTextToJSONTyped(value?: QRCodeText | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/QRCodeCustomizationsPublic.d.ts /** * Options for customizing a QR Code's appearance * @export * @interface QRCodeCustomizationsPublic */ interface QRCodeCustomizationsPublic { /** * The QR code's background color in hex code format with values for alpha channel * @type {string} * @memberof QRCodeCustomizationsPublic */ background_color?: string; /** * The QR code's dot pattern color in hex code format * @type {string} * @memberof QRCodeCustomizationsPublic */ dot_pattern_color?: string; /** * * @type {QRCodeDotPatternType} * @memberof QRCodeCustomizationsPublic */ dot_pattern_type?: QRCodeDotPatternType; /** * * @type {QRCodeCorners} * @memberof QRCodeCustomizationsPublic */ corners?: QRCodeCorners; /** * * @type {QRCodeGradient} * @memberof QRCodeCustomizationsPublic */ gradient?: QRCodeGradient; /** * * @type {QRCodeGradient} * @memberof QRCodeCustomizationsPublic */ background_gradient?: QRCodeGradient; /** * * @type {QRCodeLogoPublic} * @memberof QRCodeCustomizationsPublic */ logo?: QRCodeLogoPublic; /** * * @type {QRCodeFrameRequest} * @memberof QRCodeCustomizationsPublic */ frame?: QRCodeFrameRequest; /** * * @type {QRCodeText} * @memberof QRCodeCustomizationsPublic */ text?: QRCodeText; /** * * @type {QRCodeBranding} * @memberof QRCodeCustomizationsPublic */ branding?: QRCodeBranding; /** * * @type {QRCodeSpecSettingsPublic} * @memberof QRCodeCustomizationsPublic */ spec_settings?: QRCodeSpecSettingsPublic; } /** * Check if a given object implements the QRCodeCustomizationsPublic interface. */ declare function instanceOfQRCodeCustomizationsPublic(value: object): value is QRCodeCustomizationsPublic; declare function QRCodeCustomizationsPublicFromJSON(json: any): QRCodeCustomizationsPublic; declare function QRCodeCustomizationsPublicFromJSONTyped(json: any, ignoreDiscriminator: boolean): QRCodeCustomizationsPublic; declare function QRCodeCustomizationsPublicToJSON(json: any): QRCodeCustomizationsPublic; declare function QRCodeCustomizationsPublicToJSONTyped(value?: QRCodeCustomizationsPublic | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/QRCodeDestination.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface QRCodeDestination */ interface QRCodeDestination { /** * * @type {string} * @memberof QRCodeDestination */ bitlink_id?: string; /** * * @type {string} * @memberof QRCodeDestination */ long_url?: string; /** * * @type {string} * @memberof QRCodeDestination */ site_id?: string; } /** * Check if a given object implements the QRCodeDestination interface. */ declare function instanceOfQRCodeDestination(value: object): value is QRCodeDestination; declare function QRCodeDestinationFromJSON(json: any): QRCodeDestination; declare function QRCodeDestinationFromJSONTyped(json: any, ignoreDiscriminator: boolean): QRCodeDestination; declare function QRCodeDestinationToJSON(json: any): QRCodeDestination; declare function QRCodeDestinationToJSONTyped(value?: QRCodeDestination | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/GS1Value.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface GS1Value */ interface GS1Value { /** * A valid GS1 application identifier, qualifier, attribute, etc. * @type {string} * @memberof GS1Value */ key?: string; /** * A syntactically correct value associated with the application identifier in the key field. * @type {string} * @memberof GS1Value */ value?: string; } /** * Check if a given object implements the GS1Value interface. */ declare function instanceOfGS1Value(value: object): value is GS1Value; declare function GS1ValueFromJSON(json: any): GS1Value; declare function GS1ValueFromJSONTyped(json: any, ignoreDiscriminator: boolean): GS1Value; declare function GS1ValueToJSON(json: any): GS1Value; declare function GS1ValueToJSONTyped(value?: GS1Value | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/GS1Metadata.d.ts /** * Contains GS1 related metadata * @export * @interface GS1Metadata */ interface GS1Metadata { /** * A list of GS1 application identifiers and their values * @type {Array} * @memberof GS1Metadata */ values?: Array; } /** * Check if a given object implements the GS1Metadata interface. */ declare function instanceOfGS1Metadata(value: object): value is GS1Metadata; declare function GS1MetadataFromJSON(json: any): GS1Metadata; declare function GS1MetadataFromJSONTyped(json: any, ignoreDiscriminator: boolean): GS1Metadata; declare function GS1MetadataToJSON(json: any): GS1Metadata; declare function GS1MetadataToJSONTyped(value?: GS1Metadata | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/PublicCreateQRCodeRequest.d.ts /** * Customization and content values for a QR code created through the public API * @export * @interface PublicCreateQRCodeRequest */ interface PublicCreateQRCodeRequest { /** * The title of the QR Code * @type {string} * @memberof PublicCreateQRCodeRequest */ title?: string; /** * Identify which group to place the QR Code. * @type {string} * @memberof PublicCreateQRCodeRequest */ group_guid: string; /** * * @type {QRCodeCustomizationsPublic} * @memberof PublicCreateQRCodeRequest */ render_customizations?: QRCodeCustomizationsPublic; /** * A boolean representing if the QR code should be archived (hidden from the UI) upon creation * @type {boolean} * @memberof PublicCreateQRCodeRequest */ archived?: boolean; /** * * @type {QRCodeDestination} * @memberof PublicCreateQRCodeRequest */ destination: QRCodeDestination; /** * * @type {GS1Metadata} * @memberof PublicCreateQRCodeRequest */ gs1?: GS1Metadata; /** * Optional expiration timestamp for the QR code's bitlink (e.g., 2025-01-28T14:30:00+0000). Minimum expiration time is 5 minutes from now and maximum is 1 year. * @type {string} * @memberof PublicCreateQRCodeRequest */ expiration_at?: string; /** * A list of tags to add to the QR code * @type {Array} * @memberof PublicCreateQRCodeRequest */ tags?: Array; } /** * Check if a given object implements the PublicCreateQRCodeRequest interface. */ declare function instanceOfPublicCreateQRCodeRequest(value: object): value is PublicCreateQRCodeRequest; declare function PublicCreateQRCodeRequestFromJSON(json: any): PublicCreateQRCodeRequest; declare function PublicCreateQRCodeRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PublicCreateQRCodeRequest; declare function PublicCreateQRCodeRequestToJSON(json: any): PublicCreateQRCodeRequest; declare function PublicCreateQRCodeRequestToJSONTyped(value?: PublicCreateQRCodeRequest | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/QRCodeCustomizationsStaticPublic.d.ts /** * Appearance options for a static QR code. gradient, background_gradient, frame, text, and logo are not supported. * @export * @interface QRCodeCustomizationsStaticPublic */ interface QRCodeCustomizationsStaticPublic { /** * The QR code's background color in hex code format with values for alpha channel * @type {string} * @memberof QRCodeCustomizationsStaticPublic */ background_color?: string; /** * The QR code's dot pattern color in hex code format * @type {string} * @memberof QRCodeCustomizationsStaticPublic */ dot_pattern_color?: string; /** * * @type {QRCodeDotPatternType} * @memberof QRCodeCustomizationsStaticPublic */ dot_pattern_type?: QRCodeDotPatternType; /** * * @type {QRCodeCorners} * @memberof QRCodeCustomizationsStaticPublic */ corners?: QRCodeCorners; /** * * @type {QRCodeBranding} * @memberof QRCodeCustomizationsStaticPublic */ branding?: QRCodeBranding; /** * * @type {QRCodeSpecSettingsPublic} * @memberof QRCodeCustomizationsStaticPublic */ spec_settings?: QRCodeSpecSettingsPublic; } /** * Check if a given object implements the QRCodeCustomizationsStaticPublic interface. */ declare function instanceOfQRCodeCustomizationsStaticPublic(value: object): value is QRCodeCustomizationsStaticPublic; declare function QRCodeCustomizationsStaticPublicFromJSON(json: any): QRCodeCustomizationsStaticPublic; declare function QRCodeCustomizationsStaticPublicFromJSONTyped(json: any, ignoreDiscriminator: boolean): QRCodeCustomizationsStaticPublic; declare function QRCodeCustomizationsStaticPublicToJSON(json: any): QRCodeCustomizationsStaticPublic; declare function QRCodeCustomizationsStaticPublicToJSONTyped(value?: QRCodeCustomizationsStaticPublic | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/PublicCreateStaticQRCodeRequest.d.ts /** * Request body for generating a static QR code image. Customizations such as gradient, background_gradient, frame, text and logo are not supported. * @export * @interface PublicCreateStaticQRCodeRequest */ interface PublicCreateStaticQRCodeRequest { /** * The raw content to encode in the QR code (e.g. a URL). * @type {string} * @memberof PublicCreateStaticQRCodeRequest */ content: string; /** * The group (brand) GUID used for access control and analytics. * @type {string} * @memberof PublicCreateStaticQRCodeRequest */ group_guid: string; /** * * @type {QRCodeCustomizationsStaticPublic} * @memberof PublicCreateStaticQRCodeRequest */ render_customizations?: QRCodeCustomizationsStaticPublic; } /** * Check if a given object implements the PublicCreateStaticQRCodeRequest interface. */ declare function instanceOfPublicCreateStaticQRCodeRequest(value: object): value is PublicCreateStaticQRCodeRequest; declare function PublicCreateStaticQRCodeRequestFromJSON(json: any): PublicCreateStaticQRCodeRequest; declare function PublicCreateStaticQRCodeRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PublicCreateStaticQRCodeRequest; declare function PublicCreateStaticQRCodeRequestToJSON(json: any): PublicCreateStaticQRCodeRequest; declare function PublicCreateStaticQRCodeRequestToJSONTyped(value?: PublicCreateStaticQRCodeRequest | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/DeletedQRCode.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface DeletedQRCode */ interface DeletedQRCode { /** * * @type {string} * @memberof DeletedQRCode */ id?: string; } /** * Check if a given object implements the DeletedQRCode interface. */ declare function instanceOfDeletedQRCode(value: object): value is DeletedQRCode; declare function DeletedQRCodeFromJSON(json: any): DeletedQRCode; declare function DeletedQRCodeFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeletedQRCode; declare function DeletedQRCodeToJSON(json: any): DeletedQRCode; declare function DeletedQRCodeToJSONTyped(value?: DeletedQRCode | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/PublicDeleteQRCodeResponse.d.ts /** * QR Code delete response * @export * @interface PublicDeleteQRCodeResponse */ interface PublicDeleteQRCodeResponse { /** * * @type {Array} * @memberof PublicDeleteQRCodeResponse */ qrcodes_deleted?: Array; /** * * @type {Array} * @memberof PublicDeleteQRCodeResponse */ links_deleted?: Array; } /** * Check if a given object implements the PublicDeleteQRCodeResponse interface. */ declare function instanceOfPublicDeleteQRCodeResponse(value: object): value is PublicDeleteQRCodeResponse; declare function PublicDeleteQRCodeResponseFromJSON(json: any): PublicDeleteQRCodeResponse; declare function PublicDeleteQRCodeResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PublicDeleteQRCodeResponse; declare function PublicDeleteQRCodeResponseToJSON(json: any): PublicDeleteQRCodeResponse; declare function PublicDeleteQRCodeResponseToJSONTyped(value?: PublicDeleteQRCodeResponse | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/PublicQRCodeImageResponse.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Wraps the image data for a QR code. * @export * @interface PublicQRCodeImageResponse */ interface PublicQRCodeImageResponse { /** * The stringified data for the QR code's image * @type {string} * @memberof PublicQRCodeImageResponse */ qr_code_image?: string; } /** * Check if a given object implements the PublicQRCodeImageResponse interface. */ declare function instanceOfPublicQRCodeImageResponse(value: object): value is PublicQRCodeImageResponse; declare function PublicQRCodeImageResponseFromJSON(json: any): PublicQRCodeImageResponse; declare function PublicQRCodeImageResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PublicQRCodeImageResponse; declare function PublicQRCodeImageResponseToJSON(json: any): PublicQRCodeImageResponse; declare function PublicQRCodeImageResponseToJSONTyped(value?: PublicQRCodeImageResponse | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/PublicStaticQRCodeResponse.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Response containing a generated static QR code image. * @export * @interface PublicStaticQRCodeResponse */ interface PublicStaticQRCodeResponse { /** * The image data, base64-encoded. Format is SVG or PNG depending on the requested format. * @type {string} * @memberof PublicStaticQRCodeResponse */ image?: string; } /** * Check if a given object implements the PublicStaticQRCodeResponse interface. */ declare function instanceOfPublicStaticQRCodeResponse(value: object): value is PublicStaticQRCodeResponse; declare function PublicStaticQRCodeResponseFromJSON(json: any): PublicStaticQRCodeResponse; declare function PublicStaticQRCodeResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PublicStaticQRCodeResponse; declare function PublicStaticQRCodeResponseToJSON(json: any): PublicStaticQRCodeResponse; declare function PublicStaticQRCodeResponseToJSONTyped(value?: PublicStaticQRCodeResponse | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/PublicUpdateQRCodeRequest.d.ts /** * Customization and content values for a QR code created through the public API * @export * @interface PublicUpdateQRCodeRequest */ interface PublicUpdateQRCodeRequest { /** * * @type {string} * @memberof PublicUpdateQRCodeRequest */ title?: string; /** * * @type {QRCodeCustomizationsPublic} * @memberof PublicUpdateQRCodeRequest */ render_customizations?: QRCodeCustomizationsPublic; /** * A boolean representing if the QR code has been archived * @type {boolean} * @memberof PublicUpdateQRCodeRequest */ archived?: boolean; /** * Optional expiration timestamp for the QR code's bitlink (e.g., 2025-01-28T14:30:00+0000). Minimum expiration time is 5 minutes from now and maximum is 1 year. * @type {string} * @memberof PublicUpdateQRCodeRequest */ expiration_at?: string; /** * A list of tags to add to the QR code * @type {Array} * @memberof PublicUpdateQRCodeRequest */ tags?: Array; } /** * Check if a given object implements the PublicUpdateQRCodeRequest interface. */ declare function instanceOfPublicUpdateQRCodeRequest(value: object): value is PublicUpdateQRCodeRequest; declare function PublicUpdateQRCodeRequestFromJSON(json: any): PublicUpdateQRCodeRequest; declare function PublicUpdateQRCodeRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PublicUpdateQRCodeRequest; declare function PublicUpdateQRCodeRequestToJSON(json: any): PublicUpdateQRCodeRequest; declare function PublicUpdateQRCodeRequestToJSONTyped(value?: PublicUpdateQRCodeRequest | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/QRCodeDetails.d.ts /** * * @export * @interface QRCodeDetails */ interface QRCodeDetails { /** * * @type {string} * @memberof QRCodeDetails */ qrcode_id?: string; /** * * @type {string} * @memberof QRCodeDetails */ group_guid?: string; /** * * @type {string} * @memberof QRCodeDetails */ title?: string; /** * * @type {GS1Metadata} * @memberof QRCodeDetails */ gs1?: GS1Metadata; /** * * @type {QRCodeCustomizationsPublic} * @memberof QRCodeDetails */ render_customizations?: QRCodeCustomizationsPublic; /** * * @type {QRCodeTypeEnum} * @memberof QRCodeDetails */ qr_code_type?: QRCodeTypeEnum; /** * The bitlink associated with the qr code. Not all qr codes are associated with one. * @type {string} * @memberof QRCodeDetails */ bitlink_id?: string; /** * A list of destination URLs that the qr code leads to. * @type {Array} * @memberof QRCodeDetails */ long_urls?: Array; /** * The serialized string of the QR code's content * @type {string} * @memberof QRCodeDetails */ serialized_content?: string; /** * * @type {boolean} * @memberof QRCodeDetails */ archived?: boolean; /** * * @type {string} * @memberof QRCodeDetails */ created?: string; /** * * @type {string} * @memberof QRCodeDetails */ modified?: string; /** * Optional expiration timestamp for the QR code's bitlink (e.g., 2025-01-28T14:30:00+0000) * @type {string} * @memberof QRCodeDetails */ expiration_at?: string; /** * A list of tags associated with QR code * @type {Array} * @memberof QRCodeDetails */ tags?: Array; } /** * Check if a given object implements the QRCodeDetails interface. */ declare function instanceOfQRCodeDetails(value: object): value is QRCodeDetails; declare function QRCodeDetailsFromJSON(json: any): QRCodeDetails; declare function QRCodeDetailsFromJSONTyped(json: any, ignoreDiscriminator: boolean): QRCodeDetails; declare function QRCodeDetailsToJSON(json: any): QRCodeDetails; declare function QRCodeDetailsToJSONTyped(value?: QRCodeDetails | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/QRPagination.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * This object specifies how to query the next set of results. * @export * @interface QRPagination */ interface QRPagination { /** * a hyperlink to the next set of results. * @type {string} * @memberof QRPagination */ next?: string; /** * the identifier of where to begin searching for the next set of results. * @type {string} * @memberof QRPagination */ search_after?: string; /** * the number of results returned from this query. * @type {number} * @memberof QRPagination */ size?: number; } /** * Check if a given object implements the QRPagination interface. */ declare function instanceOfQRPagination(value: object): value is QRPagination; declare function QRPaginationFromJSON(json: any): QRPagination; declare function QRPaginationFromJSONTyped(json: any, ignoreDiscriminator: boolean): QRPagination; declare function QRPaginationToJSON(json: any): QRPagination; declare function QRPaginationToJSONTyped(value?: QRPagination | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/QRCodesMinimal.d.ts /** * QR code paginated list Response * @export * @interface QRCodesMinimal */ interface QRCodesMinimal { /** * * @type {Array} * @memberof QRCodesMinimal */ qr_codes?: Array; /** * * @type {QRPagination} * @memberof QRCodesMinimal */ pagination?: QRPagination; } /** * Check if a given object implements the QRCodesMinimal interface. */ declare function instanceOfQRCodesMinimal(value: object): value is QRCodesMinimal; declare function QRCodesMinimalFromJSON(json: any): QRCodesMinimal; declare function QRCodesMinimalFromJSONTyped(json: any, ignoreDiscriminator: boolean): QRCodesMinimal; declare function QRCodesMinimalToJSON(json: any): QRCodesMinimal; declare function QRCodesMinimalToJSONTyped(value?: QRCodesMinimal | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/ScanMetric.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface ScanMetric */ interface ScanMetric { /** * * @type {number} * @memberof ScanMetric */ scans?: number; /** * * @type {string} * @memberof ScanMetric */ value?: string; } /** * Check if a given object implements the ScanMetric interface. */ declare function instanceOfScanMetric(value: object): value is ScanMetric; declare function ScanMetricFromJSON(json: any): ScanMetric; declare function ScanMetricFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScanMetric; declare function ScanMetricToJSON(json: any): ScanMetric; declare function ScanMetricToJSONTyped(value?: ScanMetric | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/ScanMetrics.d.ts /** * * @export * @interface ScanMetrics */ interface ScanMetrics { /** * * @type {string} * @memberof ScanMetrics */ unit?: string; /** * * @type {number} * @memberof ScanMetrics */ units?: number; /** * * @type {ScanMetricsFacetEnum} * @memberof ScanMetrics */ facet?: ScanMetricsFacetEnum; /** * * @type {string} * @memberof ScanMetrics */ unit_reference?: string; /** * * @type {Array} * @memberof ScanMetrics */ metrics?: Array; } /** * @export * @enum {string} */ declare enum ScanMetricsFacetEnum { countries = "countries", cities = "cities", device_os = "device_os", browsers = "browsers", destinations = "destinations" } /** * Check if a given object implements the ScanMetrics interface. */ declare function instanceOfScanMetrics(value: object): value is ScanMetrics; declare function ScanMetricsFromJSON(json: any): ScanMetrics; declare function ScanMetricsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScanMetrics; declare function ScanMetricsToJSON(json: any): ScanMetrics; declare function ScanMetricsToJSONTyped(value?: ScanMetrics | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/apis/QRCodesApi.d.ts interface CreateQRCodePublicRequest { public_create_qr_code_request: PublicCreateQRCodeRequest; } interface CreateStaticQRCodePublicRequest { public_create_static_qr_code_request: PublicCreateStaticQRCodeRequest; accept?: CreateStaticQRCodePublicAcceptEnum; format?: CreateStaticQRCodePublicFormatEnum; } interface DeleteQRCodeRequest { qrcode_id: string; } interface GetQRCodeByIdPublicRequest { qrcode_id: string; } interface GetQRCodeImagePublicRequest { qrcode_id: string; accept?: string; format?: GetQRCodeImagePublicFormatEnum; } interface GetScanMetricsForQRCodeRequest { qrcode_id: string; unit: TimeUnit; units: number; unit_reference?: string; } interface GetScanMetricsForQRCodeByBrowserRequest { qrcode_id: string; unit: TimeUnit; units: number; size?: number; unit_reference?: string; } interface GetScanMetricsForQRCodeByCitiesRequest { qrcode_id: string; unit: TimeUnit; units: number; size?: number; unit_reference?: string; } interface GetScanMetricsForQRCodeByCountriesRequest { qrcode_id: string; unit: TimeUnit; units: number; size?: number; unit_reference?: string; } interface GetScanMetricsForQRCodeByDevicesOSRequest { qrcode_id: string; unit: TimeUnit; units: number; size?: number; unit_reference?: string; } interface GetScanMetricsSummaryForQRCodeRequest { qrcode_id: string; unit: TimeUnit; units: number; unit_reference?: string; } interface ListQRMinimalRequest { group_guid: string; has_render_customizations?: ListQRMinimalHasRenderCustomizationsEnum; size?: number; search_after?: string; query?: string; hostname_path_query?: string; created_before?: number; created_after?: number; archived?: ListQRMinimalArchivedEnum; creating_login?: Array; qrc_type?: Array; is_gs1?: ListQRMinimalIsGs1Enum; is_expired?: ListQRMinimalIsExpiredEnum; has_expiration?: ListQRMinimalHasExpirationEnum; tags?: Array; } interface UpdateQRCodePublicRequest { qrcode_id: string; public_update_qr_code_request: PublicUpdateQRCodeRequest; } /** * */ declare class QRCodesApi extends BaseAPI { /** * Creates request options for createQRCodePublic without sending the request */ createQRCodePublicRequestOpts(requestParameters: CreateQRCodePublicRequest): Promise; /** * Create a new QR Code and return its metadata * Create a QR Code */ createQRCodePublicRaw(requestParameters: CreateQRCodePublicRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Create a new QR Code and return its metadata * Create a QR Code */ createQRCodePublic(requestParameters: CreateQRCodePublicRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for createStaticQRCodePublic without sending the request */ createStaticQRCodePublicRequestOpts(requestParameters: CreateStaticQRCodePublicRequest): Promise; /** * Generate a static QR code image without creating or saving a QR code resource. SVG and PNG output are supported via the Accept header Contact your Account Manager to discuss enabling this feature for your account. The `render_customizations` field supports basic appearance options. Customizations that require the rasterize API are not supported: `gradient`, `background_gradient`, `frame`, `text`, and `logo`. The Accept header controls the response format: - `application/json` (default): Returns a JSON object with the image as a base64-encoded byte string. - `image/svg+xml`: Returns the raw SVG image. - `image/png`: Returns the raw PNG image. * Generate a static QR Code image */ createStaticQRCodePublicRaw(requestParameters: CreateStaticQRCodePublicRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Generate a static QR code image without creating or saving a QR code resource. SVG and PNG output are supported via the Accept header Contact your Account Manager to discuss enabling this feature for your account. The `render_customizations` field supports basic appearance options. Customizations that require the rasterize API are not supported: `gradient`, `background_gradient`, `frame`, `text`, and `logo`. The Accept header controls the response format: - `application/json` (default): Returns a JSON object with the image as a base64-encoded byte string. - `image/svg+xml`: Returns the raw SVG image. - `image/png`: Returns the raw PNG image. * Generate a static QR Code image */ createStaticQRCodePublic(requestParameters: CreateStaticQRCodePublicRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for deleteQRCode without sending the request */ deleteQRCodeRequestOpts(requestParameters: DeleteQRCodeRequest): Promise; /** * Delete a QR Code that has not been redirected and is not for a custom link. Also deletes the associated link (if applicable). * Delete a QR Code */ deleteQRCodeRaw(requestParameters: DeleteQRCodeRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Delete a QR Code that has not been redirected and is not for a custom link. Also deletes the associated link (if applicable). * Delete a QR Code */ deleteQRCode(requestParameters: DeleteQRCodeRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getQRCodeByIdPublic without sending the request */ getQRCodeByIdPublicRequestOpts(requestParameters: GetQRCodeByIdPublicRequest): Promise; /** * Gets the QR code with a matching id. * Retrieve a QR Code */ getQRCodeByIdPublicRaw(requestParameters: GetQRCodeByIdPublicRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Gets the QR code with a matching id. * Retrieve a QR Code */ getQRCodeByIdPublic(requestParameters: GetQRCodeByIdPublicRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getQRCodeImagePublic without sending the request */ getQRCodeImagePublicRequestOpts(requestParameters: GetQRCodeImagePublicRequest): Promise; /** * Get the image of a given QR Code. The Accept header controls how this is returned (options are \"application/json\", \"image/svg+xml\", and \"image/png\"). If the Accept header is \"application/json\" the format query parameter will determine the image format inside of the json (which will be base64 encoded and prefixed with its mime type as would be suitable for a HTML image src tag). To Return the QR Code image itself, set the Accept header to \"image/svg+xml\" or \"image/png\", or remove the Accept header and set the format query parameter to “svg” or “png” (if no format is specified the default will be “svg”). * Retrieve a QR Code image */ getQRCodeImagePublicRaw(requestParameters: GetQRCodeImagePublicRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Get the image of a given QR Code. The Accept header controls how this is returned (options are \"application/json\", \"image/svg+xml\", and \"image/png\"). If the Accept header is \"application/json\" the format query parameter will determine the image format inside of the json (which will be base64 encoded and prefixed with its mime type as would be suitable for a HTML image src tag). To Return the QR Code image itself, set the Accept header to \"image/svg+xml\" or \"image/png\", or remove the Accept header and set the format query parameter to “svg” or “png” (if no format is specified the default will be “svg”). * Retrieve a QR Code image */ getQRCodeImagePublic(requestParameters: GetQRCodeImagePublicRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getScanMetricsForQRCode without sending the request */ getScanMetricsForQRCodeRequestOpts(requestParameters: GetScanMetricsForQRCodeRequest): Promise; /** * Returns an array of scan counts for the specified QR code. The array is comprised of scan counts for each time window, where the window is based on the provided unit. * Get Scans for a QR Code */ getScanMetricsForQRCodeRaw(requestParameters: GetScanMetricsForQRCodeRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns an array of scan counts for the specified QR code. The array is comprised of scan counts for each time window, where the window is based on the provided unit. * Get Scans for a QR Code */ getScanMetricsForQRCode(requestParameters: GetScanMetricsForQRCodeRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getScanMetricsForQRCodeByBrowser without sending the request */ getScanMetricsForQRCodeByBrowserRequestOpts(requestParameters: GetScanMetricsForQRCodeByBrowserRequest): Promise; /** * Returns the browsers generating scan traffic to the specified QR Code. * Get Scans for a QR Code by Browser */ getScanMetricsForQRCodeByBrowserRaw(requestParameters: GetScanMetricsForQRCodeByBrowserRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns the browsers generating scan traffic to the specified QR Code. * Get Scans for a QR Code by Browser */ getScanMetricsForQRCodeByBrowser(requestParameters: GetScanMetricsForQRCodeByBrowserRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getScanMetricsForQRCodeByCities without sending the request */ getScanMetricsForQRCodeByCitiesRequestOpts(requestParameters: GetScanMetricsForQRCodeByCitiesRequest): Promise; /** * Returns the city origins of scan traffic for the specified QR Code. * Get Metrics for a QR Code by City */ getScanMetricsForQRCodeByCitiesRaw(requestParameters: GetScanMetricsForQRCodeByCitiesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns the city origins of scan traffic for the specified QR Code. * Get Metrics for a QR Code by City */ getScanMetricsForQRCodeByCities(requestParameters: GetScanMetricsForQRCodeByCitiesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getScanMetricsForQRCodeByCountries without sending the request */ getScanMetricsForQRCodeByCountriesRequestOpts(requestParameters: GetScanMetricsForQRCodeByCountriesRequest): Promise; /** * Returns the country origins of scan traffic for the specified QR Code. * Get Scans for a QR Code by Country */ getScanMetricsForQRCodeByCountriesRaw(requestParameters: GetScanMetricsForQRCodeByCountriesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns the country origins of scan traffic for the specified QR Code. * Get Scans for a QR Code by Country */ getScanMetricsForQRCodeByCountries(requestParameters: GetScanMetricsForQRCodeByCountriesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getScanMetricsForQRCodeByDevicesOS without sending the request */ getScanMetricsForQRCodeByDevicesOSRequestOpts(requestParameters: GetScanMetricsForQRCodeByDevicesOSRequest): Promise; /** * Returns the device os generating scan traffic for the specified QR Code. * Get Scans for a QR Code by Device OS */ getScanMetricsForQRCodeByDevicesOSRaw(requestParameters: GetScanMetricsForQRCodeByDevicesOSRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns the device os generating scan traffic for the specified QR Code. * Get Scans for a QR Code by Device OS */ getScanMetricsForQRCodeByDevicesOS(requestParameters: GetScanMetricsForQRCodeByDevicesOSRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getScanMetricsSummaryForQRCode without sending the request */ getScanMetricsSummaryForQRCodeRequestOpts(requestParameters: GetScanMetricsSummaryForQRCodeRequest): Promise; /** * Returns the scan counts for a QR Code rolled up into a single field for a specified time window, where the window is based on the provided unit. * Get Scans Summary for a QR Code */ getScanMetricsSummaryForQRCodeRaw(requestParameters: GetScanMetricsSummaryForQRCodeRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns the scan counts for a QR Code rolled up into a single field for a specified time window, where the window is based on the provided unit. * Get Scans Summary for a QR Code */ getScanMetricsSummaryForQRCode(requestParameters: GetScanMetricsSummaryForQRCodeRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for listQRMinimal without sending the request */ listQRMinimalRequestOpts(requestParameters: ListQRMinimalRequest): Promise; /** * Retrieves a list of QR codes matching the filter settings. Values are in reverse chronological order. The pagination occurs by calling the next link in the pagination response object. * Retrieve QR Codes by Group */ listQRMinimalRaw(requestParameters: ListQRMinimalRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Retrieves a list of QR codes matching the filter settings. Values are in reverse chronological order. The pagination occurs by calling the next link in the pagination response object. * Retrieve QR Codes by Group */ listQRMinimal(requestParameters: ListQRMinimalRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for updateQRCodePublic without sending the request */ updateQRCodePublicRequestOpts(requestParameters: UpdateQRCodePublicRequest): Promise; /** * Updates the QR code with a matching id and returns it. * Update a QR Code */ updateQRCodePublicRaw(requestParameters: UpdateQRCodePublicRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Updates the QR code with a matching id and returns it. * Update a QR Code */ updateQRCodePublic(requestParameters: UpdateQRCodePublicRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; } /** * @export * @enum {string} */ declare enum CreateStaticQRCodePublicAcceptEnum { application_json = "application/json", image_svgxml = "image/svg+xml", image_png = "image/png" } /** * @export * @enum {string} */ declare enum CreateStaticQRCodePublicFormatEnum { svg = "svg", png = "png" } /** * @export * @enum {string} */ declare enum GetQRCodeImagePublicFormatEnum { svg = "svg", png = "png" } /** * @export * @enum {string} */ declare enum ListQRMinimalHasRenderCustomizationsEnum { on = "on", off = "off", both = "both" } /** * @export * @enum {string} */ declare enum ListQRMinimalArchivedEnum { on = "on", off = "off", both = "both" } /** * @export * @enum {string} */ declare enum ListQRMinimalQrcTypeEnum { bitlink = "bitlink", long_url = "long_url" } /** * @export * @enum {string} */ declare enum ListQRMinimalIsGs1Enum { on = "on", off = "off", both = "both" } /** * @export * @enum {string} */ declare enum ListQRMinimalIsExpiredEnum { on = "on", off = "off", both = "both" } /** * @export * @enum {string} */ declare enum ListQRMinimalHasExpirationEnum { on = "on", off = "off", both = "both" } //#endregion //#region src/models/MethodLimit.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface MethodLimit */ interface MethodLimit { /** * * @type {string} * @memberof MethodLimit */ name?: string; /** * * @type {number} * @memberof MethodLimit */ limit?: number; /** * * @type {number} * @memberof MethodLimit */ count?: number; } /** * Check if a given object implements the MethodLimit interface. */ declare function instanceOfMethodLimit(value: object): value is MethodLimit; declare function MethodLimitFromJSON(json: any): MethodLimit; declare function MethodLimitFromJSONTyped(json: any, ignoreDiscriminator: boolean): MethodLimit; declare function MethodLimitToJSON(json: any): MethodLimit; declare function MethodLimitToJSONTyped(value?: MethodLimit | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/PlatformLimit.d.ts /** * * @export * @interface PlatformLimit */ interface PlatformLimit { /** * * @type {string} * @memberof PlatformLimit */ endpoint?: string; /** * * @type {Array} * @memberof PlatformLimit */ methods?: Array; } /** * Check if a given object implements the PlatformLimit interface. */ declare function instanceOfPlatformLimit(value: object): value is PlatformLimit; declare function PlatformLimitFromJSON(json: any): PlatformLimit; declare function PlatformLimitFromJSONTyped(json: any, ignoreDiscriminator: boolean): PlatformLimit; declare function PlatformLimitToJSON(json: any): PlatformLimit; declare function PlatformLimitToJSONTyped(value?: PlatformLimit | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/PlatformLimits.d.ts /** * * @export * @interface PlatformLimits */ interface PlatformLimits { /** * * @type {Array} * @memberof PlatformLimits */ platform_limits?: Array; } /** * Check if a given object implements the PlatformLimits interface. */ declare function instanceOfPlatformLimits(value: object): value is PlatformLimits; declare function PlatformLimitsFromJSON(json: any): PlatformLimits; declare function PlatformLimitsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PlatformLimits; declare function PlatformLimitsToJSON(json: any): PlatformLimits; declare function PlatformLimitsToJSONTyped(value?: PlatformLimits | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/Email.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface Email */ interface Email { /** * * @type {string} * @memberof Email */ email?: string; /** * * @type {boolean} * @memberof Email */ is_primary?: boolean; /** * * @type {boolean} * @memberof Email */ is_verified?: boolean; } /** * Check if a given object implements the Email interface. */ declare function instanceOfEmail(value: object): value is Email; declare function EmailFromJSON(json: any): Email; declare function EmailFromJSONTyped(json: any, ignoreDiscriminator: boolean): Email; declare function EmailToJSON(json: any): Email; declare function EmailToJSONTyped(value?: Email | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/User.d.ts /** * * @export * @interface User */ interface User { /** * * @type {string} * @memberof User */ login: string; /** * * @type {string} * @memberof User */ name: string; /** * * @type {boolean} * @memberof User */ is_active: boolean; /** * * @type {string} * @memberof User */ created: string; /** * * @type {string} * @memberof User */ modified: string; /** * * @type {boolean} * @memberof User */ is_sso_user: boolean; /** * * @type {Array} * @memberof User */ emails: Array; /** * * @type {boolean} * @memberof User */ is_2fa_enabled: boolean; /** * * @type {string} * @memberof User */ default_group_guid?: string; } /** * Check if a given object implements the User interface. */ declare function instanceOfUser(value: object): value is User; declare function UserFromJSON(json: any): User; declare function UserFromJSONTyped(json: any, ignoreDiscriminator: boolean): User; declare function UserToJSON(json: any): User; declare function UserToJSONTyped(value?: User | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/UserUpdate.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface UserUpdate */ interface UserUpdate { /** * * @type {string} * @memberof UserUpdate */ name?: string; /** * * @type {string} * @memberof UserUpdate */ default_group_guid?: string; } /** * Check if a given object implements the UserUpdate interface. */ declare function instanceOfUserUpdate(value: object): value is UserUpdate; declare function UserUpdateFromJSON(json: any): UserUpdate; declare function UserUpdateFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserUpdate; declare function UserUpdateToJSON(json: any): UserUpdate; declare function UserUpdateToJSONTyped(value?: UserUpdate | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/apis/UserApi.d.ts interface GetPlatformLimitsRequest { path?: string; } interface UpdateUserRequest { user_update: UserUpdate; } /** * */ declare class UserApi extends BaseAPI { /** * Creates request options for getPlatformLimits without sending the request */ getPlatformLimitsRequestOpts(requestParameters: GetPlatformLimitsRequest): Promise; /** * Fetch all platform limits and counts available for an organization * Get Platform Limits */ getPlatformLimitsRaw(requestParameters: GetPlatformLimitsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Fetch all platform limits and counts available for an organization * Get Platform Limits */ getPlatformLimits(requestParameters?: GetPlatformLimitsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getUser without sending the request */ getUserRequestOpts(): Promise; /** * Returns information for the current authenticated user. * Retrieve a User */ getUserRaw(initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns information for the current authenticated user. * Retrieve a User */ getUser(initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for updateUser without sending the request */ updateUserRequestOpts(requestParameters: UpdateUserRequest): Promise; /** * Update fields in the user * Update a User */ updateUserRaw(requestParameters: UpdateUserRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Update fields in the user * Update a User */ updateUser(requestParameters: UpdateUserRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; } //#endregion //#region src/models/Webhook.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface Webhook */ interface Webhook { /** * * @type {{ [key: string]: string; }} * @memberof Webhook */ references?: { [key: string]: string; }; /** * * @type {string} * @memberof Webhook */ guid: string; /** * * @type {string} * @memberof Webhook */ created: string; /** * * @type {string} * @memberof Webhook */ modified: string; /** * * @type {string} * @memberof Webhook */ modified_by: string; /** * * @type {string} * @memberof Webhook */ alerted: string; /** * * @type {string} * @memberof Webhook */ deactivated: string; /** * * @type {boolean} * @memberof Webhook */ is_active: boolean; /** * * @type {boolean} * @memberof Webhook */ is_alert: boolean; /** * * @type {string} * @memberof Webhook */ organization_guid: string; /** * * @type {string} * @memberof Webhook */ group_guid?: string; /** * * @type {string} * @memberof Webhook */ name: string; /** * * @type {string} * @memberof Webhook */ event: string; /** * * @type {string} * @memberof Webhook */ url: string; /** * * @type {string} * @memberof Webhook */ status?: string; /** * * @type {string} * @memberof Webhook */ oauth_url?: string; /** * * @type {string} * @memberof Webhook */ client_id?: string; /** * * @type {string} * @memberof Webhook */ client_secret?: string; /** * * @type {boolean} * @memberof Webhook */ fetch_tags?: boolean; } /** * Check if a given object implements the Webhook interface. */ declare function instanceOfWebhook(value: object): value is Webhook; declare function WebhookFromJSON(json: any): Webhook; declare function WebhookFromJSONTyped(json: any, ignoreDiscriminator: boolean): Webhook; declare function WebhookToJSON(json: any): Webhook; declare function WebhookToJSONTyped(value?: Webhook | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/WebhookCreate.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface WebhookCreate */ interface WebhookCreate { /** * * @type {boolean} * @memberof WebhookCreate */ is_active?: boolean; /** * * @type {string} * @memberof WebhookCreate */ organization_guid: string; /** * * @type {string} * @memberof WebhookCreate */ group_guid?: string; /** * * @type {string} * @memberof WebhookCreate */ name: string; /** * * @type {string} * @memberof WebhookCreate */ event: string; /** * * @type {string} * @memberof WebhookCreate */ url: string; /** * * @type {string} * @memberof WebhookCreate */ oauth_url?: string; /** * * @type {string} * @memberof WebhookCreate */ client_id?: string; /** * * @type {string} * @memberof WebhookCreate */ client_secret?: string; /** * * @type {boolean} * @memberof WebhookCreate */ fetch_tags?: boolean; } /** * Check if a given object implements the WebhookCreate interface. */ declare function instanceOfWebhookCreate(value: object): value is WebhookCreate; declare function WebhookCreateFromJSON(json: any): WebhookCreate; declare function WebhookCreateFromJSONTyped(json: any, ignoreDiscriminator: boolean): WebhookCreate; declare function WebhookCreateToJSON(json: any): WebhookCreate; declare function WebhookCreateToJSONTyped(value?: WebhookCreate | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/WebhookUpdate.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface WebhookUpdate */ interface WebhookUpdate { /** * * @type {string} * @memberof WebhookUpdate */ guid: string; /** * * @type {boolean} * @memberof WebhookUpdate */ is_active?: boolean; /** * * @type {string} * @memberof WebhookUpdate */ organization_guid?: string; /** * * @type {string} * @memberof WebhookUpdate */ group_guid?: string; /** * * @type {string} * @memberof WebhookUpdate */ name?: string; /** * * @type {string} * @memberof WebhookUpdate */ event?: string; /** * * @type {string} * @memberof WebhookUpdate */ url?: string; /** * * @type {string} * @memberof WebhookUpdate */ oauth_url?: string; /** * * @type {string} * @memberof WebhookUpdate */ client_id?: string; /** * * @type {string} * @memberof WebhookUpdate */ client_secret?: string; /** * * @type {boolean} * @memberof WebhookUpdate */ fetch_tags?: boolean; } /** * Check if a given object implements the WebhookUpdate interface. */ declare function instanceOfWebhookUpdate(value: object): value is WebhookUpdate; declare function WebhookUpdateFromJSON(json: any): WebhookUpdate; declare function WebhookUpdateFromJSONTyped(json: any, ignoreDiscriminator: boolean): WebhookUpdate; declare function WebhookUpdateToJSON(json: any): WebhookUpdate; declare function WebhookUpdateToJSONTyped(value?: WebhookUpdate | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/Webhooks.d.ts /** * * @export * @interface Webhooks */ interface Webhooks { /** * * @type {Array} * @memberof Webhooks */ webhooks?: Array; } /** * Check if a given object implements the Webhooks interface. */ declare function instanceOfWebhooks(value: object): value is Webhooks; declare function WebhooksFromJSON(json: any): Webhooks; declare function WebhooksFromJSONTyped(json: any, ignoreDiscriminator: boolean): Webhooks; declare function WebhooksToJSON(json: any): Webhooks; declare function WebhooksToJSONTyped(value?: Webhooks | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/apis/WebhooksApi.d.ts interface CreateWebhookRequest { webhook_create: WebhookCreate; } interface DeleteWebhookRequest { webhook_guid: string; } interface GetWebhookRequest { webhook_guid: string; } interface GetWebhooksRequest { organization_guid: string; } interface UpdateWebhookRequest { webhook_guid: string; webhook_update: WebhookUpdate; } interface VerifyWebhookRequest { webhook_guid: string; } /** * */ declare class WebhooksApi extends BaseAPI { /** * Creates request options for createWebhook without sending the request */ createWebhookRequestOpts(requestParameters: CreateWebhookRequest): Promise; /** * Creates a webhook. * Create Webhook */ createWebhookRaw(requestParameters: CreateWebhookRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Creates a webhook. * Create Webhook */ createWebhook(requestParameters: CreateWebhookRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for deleteWebhook without sending the request */ deleteWebhookRequestOpts(requestParameters: DeleteWebhookRequest): Promise; /** * Deletes a webhook. * Delete Webhook */ deleteWebhookRaw(requestParameters: DeleteWebhookRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Deletes a webhook. * Delete Webhook */ deleteWebhook(requestParameters: DeleteWebhookRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getWebhook without sending the request */ getWebhookRequestOpts(requestParameters: GetWebhookRequest): Promise; /** * Returns a webhook. * Retrieve Webhook */ getWebhookRaw(requestParameters: GetWebhookRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Returns a webhook. * Retrieve Webhook */ getWebhook(requestParameters: GetWebhookRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for getWebhooks without sending the request */ getWebhooksRequestOpts(requestParameters: GetWebhooksRequest): Promise; /** * Fetch all webhooks available for an Organization * Get Webhooks */ getWebhooksRaw(requestParameters: GetWebhooksRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Fetch all webhooks available for an Organization * Get Webhooks */ getWebhooks(requestParameters: GetWebhooksRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for updateWebhook without sending the request */ updateWebhookRequestOpts(requestParameters: UpdateWebhookRequest): Promise; /** * Update a webhook * Update Webhook */ updateWebhookRaw(requestParameters: UpdateWebhookRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Update a webhook * Update Webhook */ updateWebhook(requestParameters: UpdateWebhookRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; /** * Creates request options for verifyWebhook without sending the request */ verifyWebhookRequestOpts(requestParameters: VerifyWebhookRequest): Promise; /** * Sends ping event to test webhook configuration. * Verify Webhook */ verifyWebhookRaw(requestParameters: VerifyWebhookRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise>; /** * Sends ping event to test webhook configuration. * Verify Webhook */ verifyWebhook(requestParameters: VerifyWebhookRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise; } //#endregion //#region src/models/FieldError.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface FieldError */ interface FieldError { /** * * @type {string} * @memberof FieldError */ field?: string; /** * * @type {string} * @memberof FieldError */ error_code?: string; /** * * @type {string} * @memberof FieldError */ message?: string; } /** * Check if a given object implements the FieldError interface. */ declare function instanceOfFieldError(value: object): value is FieldError; declare function FieldErrorFromJSON(json: any): FieldError; declare function FieldErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): FieldError; declare function FieldErrorToJSON(json: any): FieldError; declare function FieldErrorToJSONTyped(value?: FieldError | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/BadGateway.d.ts /** * BAD_GATEWAY * @export * @interface BadGateway */ interface BadGateway { /** * * @type {string} * @memberof BadGateway */ message?: string; /** * * @type {string} * @memberof BadGateway */ description?: string; /** * * @type {string} * @memberof BadGateway */ resource?: string; /** * * @type {Array} * @memberof BadGateway */ errors?: Array; } /** * Check if a given object implements the BadGateway interface. */ declare function instanceOfBadGateway(value: object): value is BadGateway; declare function BadGatewayFromJSON(json: any): BadGateway; declare function BadGatewayFromJSONTyped(json: any, ignoreDiscriminator: boolean): BadGateway; declare function BadGatewayToJSON(json: any): BadGateway; declare function BadGatewayToJSONTyped(value?: BadGateway | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/BadRequest.d.ts /** * BAD_REQUEST * @export * @interface BadRequest */ interface BadRequest { /** * * @type {string} * @memberof BadRequest */ message?: string; /** * * @type {string} * @memberof BadRequest */ description?: string; /** * * @type {string} * @memberof BadRequest */ resource?: string; /** * * @type {Array} * @memberof BadRequest */ errors?: Array; } /** * Check if a given object implements the BadRequest interface. */ declare function instanceOfBadRequest(value: object): value is BadRequest; declare function BadRequestFromJSON(json: any): BadRequest; declare function BadRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): BadRequest; declare function BadRequestToJSON(json: any): BadRequest; declare function BadRequestToJSONTyped(value?: BadRequest | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/BaseChannel.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface BaseChannel */ interface BaseChannel { /** * * @type {string} * @memberof BaseChannel */ name?: string; /** * * @type {string} * @memberof BaseChannel */ guid?: string; /** * ISO TIMESTAMP * @type {string} * @memberof BaseChannel */ created?: string; /** * ISO_TIMESTAMP * @type {string} * @memberof BaseChannel */ modified?: string; /** * * @type {string} * @memberof BaseChannel */ group_guid?: string; } /** * Check if a given object implements the BaseChannel interface. */ declare function instanceOfBaseChannel(value: object): value is BaseChannel; declare function BaseChannelFromJSON(json: any): BaseChannel; declare function BaseChannelFromJSONTyped(json: any, ignoreDiscriminator: boolean): BaseChannel; declare function BaseChannelToJSON(json: any): BaseChannel; declare function BaseChannelToJSONTyped(value?: BaseChannel | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/BaseMetrics.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface BaseMetrics */ interface BaseMetrics { /** * * @type {string} * @memberof BaseMetrics */ unit?: string; /** * * @type {number} * @memberof BaseMetrics */ units?: number; /** * * @type {BaseMetricsFacetEnum} * @memberof BaseMetrics */ facet?: BaseMetricsFacetEnum; /** * * @type {string} * @memberof BaseMetrics */ unit_reference?: string; } /** * @export * @enum {string} */ declare enum BaseMetricsFacetEnum { countries = "countries", cities = "cities", devices = "devices", referrers = "referrers", referrers_by_domain = "referrers_by_domain", referring_domains = "referring_domains", referring_networks = "referring_networks", shorten_counts = "shorten_counts", destinations = "destinations" } /** * Check if a given object implements the BaseMetrics interface. */ declare function instanceOfBaseMetrics(value: object): value is BaseMetrics; declare function BaseMetricsFromJSON(json: any): BaseMetrics; declare function BaseMetricsFromJSONTyped(json: any, ignoreDiscriminator: boolean): BaseMetrics; declare function BaseMetricsToJSON(json: any): BaseMetrics; declare function BaseMetricsToJSONTyped(value?: BaseMetrics | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/BaseScanMetrics.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface BaseScanMetrics */ interface BaseScanMetrics { /** * * @type {string} * @memberof BaseScanMetrics */ unit?: string; /** * * @type {number} * @memberof BaseScanMetrics */ units?: number; /** * * @type {BaseScanMetricsFacetEnum} * @memberof BaseScanMetrics */ facet?: BaseScanMetricsFacetEnum; /** * * @type {string} * @memberof BaseScanMetrics */ unit_reference?: string; } /** * @export * @enum {string} */ declare enum BaseScanMetricsFacetEnum { countries = "countries", cities = "cities", device_os = "device_os", browsers = "browsers", destinations = "destinations" } /** * Check if a given object implements the BaseScanMetrics interface. */ declare function instanceOfBaseScanMetrics(value: object): value is BaseScanMetrics; declare function BaseScanMetricsFromJSON(json: any): BaseScanMetrics; declare function BaseScanMetricsFromJSONTyped(json: any, ignoreDiscriminator: boolean): BaseScanMetrics; declare function BaseScanMetricsToJSON(json: any): BaseScanMetrics; declare function BaseScanMetricsToJSONTyped(value?: BaseScanMetrics | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/BitlinkUpdate.d.ts /** * * @export * @interface BitlinkUpdate */ interface BitlinkUpdate { /** * * @type {string} * @memberof BitlinkUpdate */ link?: string; /** * * @type {string} * @memberof BitlinkUpdate */ id?: string; /** * * @type {string} * @memberof BitlinkUpdate */ long_url?: string; /** * * @type {string} * @memberof BitlinkUpdate */ title?: string; /** * * @type {boolean} * @memberof BitlinkUpdate */ archived?: boolean; /** * * @type {string} * @memberof BitlinkUpdate */ created_at?: string; /** * * @type {string} * @memberof BitlinkUpdate */ created_by?: string; /** * * @type {string} * @memberof BitlinkUpdate */ client_id?: string; /** * list of previously edited backhalfs for the bitlink - these are in reverse chronological order, with the most recently edited backhalf first * @type {Array} * @memberof BitlinkUpdate */ custom_bitlinks?: Array; /** * * @type {Array} * @memberof BitlinkUpdate */ tags?: Array; /** * * @type {Array} * @memberof BitlinkUpdate */ launchpad_ids?: Array; /** * a list of qr code ids that are associated with this bitlink * @type {Array} * @memberof BitlinkUpdate */ qr_code_ids?: Array; /** * * @type {Array} * @memberof BitlinkUpdate */ deeplinks?: Array; /** * * @type {boolean} * @memberof BitlinkUpdate */ is_deleted?: boolean; /** * * @type {Array} * @memberof BitlinkUpdate */ campaign_ids?: Array; /** * Optional expiration timestamp for the bitlink (e.g., 2025-01-28T14:30:00+0000) * @type {string} * @memberof BitlinkUpdate */ expiration_at?: string; } /** * Check if a given object implements the BitlinkUpdate interface. */ declare function instanceOfBitlinkUpdate(value: object): value is BitlinkUpdate; declare function BitlinkUpdateFromJSON(json: any): BitlinkUpdate; declare function BitlinkUpdateFromJSONTyped(json: any, ignoreDiscriminator: boolean): BitlinkUpdate; declare function BitlinkUpdateToJSON(json: any): BitlinkUpdate; declare function BitlinkUpdateToJSONTyped(value?: BitlinkUpdate | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/Conflict.d.ts /** * CONFLICT * @export * @interface Conflict */ interface Conflict { /** * * @type {string} * @memberof Conflict */ message?: string; /** * * @type {string} * @memberof Conflict */ description?: string; /** * * @type {string} * @memberof Conflict */ resource?: string; /** * * @type {Array} * @memberof Conflict */ errors?: Array; } /** * Check if a given object implements the Conflict interface. */ declare function instanceOfConflict(value: object): value is Conflict; declare function ConflictFromJSON(json: any): Conflict; declare function ConflictFromJSONTyped(json: any, ignoreDiscriminator: boolean): Conflict; declare function ConflictToJSON(json: any): Conflict; declare function ConflictToJSONTyped(value?: Conflict | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/ExpectationFailed.d.ts /** * EXPECTATION_FAILED * @export * @interface ExpectationFailed */ interface ExpectationFailed { /** * * @type {string} * @memberof ExpectationFailed */ message?: string; /** * * @type {string} * @memberof ExpectationFailed */ description?: string; /** * * @type {string} * @memberof ExpectationFailed */ resource?: string; /** * * @type {Array} * @memberof ExpectationFailed */ errors?: Array; } /** * Check if a given object implements the ExpectationFailed interface. */ declare function instanceOfExpectationFailed(value: object): value is ExpectationFailed; declare function ExpectationFailedFromJSON(json: any): ExpectationFailed; declare function ExpectationFailedFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExpectationFailed; declare function ExpectationFailedToJSON(json: any): ExpectationFailed; declare function ExpectationFailedToJSONTyped(value?: ExpectationFailed | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/Forbidden.d.ts /** * FORBIDDEN * @export * @interface Forbidden */ interface Forbidden { /** * * @type {string} * @memberof Forbidden */ message?: string; /** * * @type {string} * @memberof Forbidden */ description?: string; /** * * @type {string} * @memberof Forbidden */ resource?: string; /** * * @type {Array} * @memberof Forbidden */ errors?: Array; } /** * Check if a given object implements the Forbidden interface. */ declare function instanceOfForbidden(value: object): value is Forbidden; declare function ForbiddenFromJSON(json: any): Forbidden; declare function ForbiddenFromJSONTyped(json: any, ignoreDiscriminator: boolean): Forbidden; declare function ForbiddenToJSON(json: any): Forbidden; declare function ForbiddenToJSONTyped(value?: Forbidden | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/Gone.d.ts /** * GONE * @export * @interface Gone */ interface Gone { /** * * @type {string} * @memberof Gone */ message?: string; /** * * @type {string} * @memberof Gone */ description?: string; /** * * @type {string} * @memberof Gone */ resource?: string; /** * * @type {Array} * @memberof Gone */ errors?: Array; } /** * Check if a given object implements the Gone interface. */ declare function instanceOfGone(value: object): value is Gone; declare function GoneFromJSON(json: any): Gone; declare function GoneFromJSONTyped(json: any, ignoreDiscriminator: boolean): Gone; declare function GoneToJSON(json: any): Gone; declare function GoneToJSONTyped(value?: Gone | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/HasReferences.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface HasReferences */ interface HasReferences { /** * * @type {{ [key: string]: string; }} * @memberof HasReferences */ references?: { [key: string]: string; }; } /** * Check if a given object implements the HasReferences interface. */ declare function instanceOfHasReferences(value: object): value is HasReferences; declare function HasReferencesFromJSON(json: any): HasReferences; declare function HasReferencesFromJSONTyped(json: any, ignoreDiscriminator: boolean): HasReferences; declare function HasReferencesToJSON(json: any): HasReferences; declare function HasReferencesToJSONTyped(value?: HasReferences | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/InternalError.d.ts /** * INTERNAL_ERROR * @export * @interface InternalError */ interface InternalError { /** * * @type {string} * @memberof InternalError */ message?: string; /** * * @type {string} * @memberof InternalError */ description?: string; /** * * @type {string} * @memberof InternalError */ resource?: string; /** * * @type {Array} * @memberof InternalError */ errors?: Array; } /** * Check if a given object implements the InternalError interface. */ declare function instanceOfInternalError(value: object): value is InternalError; declare function InternalErrorFromJSON(json: any): InternalError; declare function InternalErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): InternalError; declare function InternalErrorToJSON(json: any): InternalError; declare function InternalErrorToJSONTyped(value?: InternalError | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/ModelError.d.ts /** * * @export * @interface ModelError */ interface ModelError { /** * * @type {string} * @memberof ModelError */ message?: string; /** * * @type {string} * @memberof ModelError */ description?: string; /** * * @type {string} * @memberof ModelError */ resource?: string; /** * * @type {Array} * @memberof ModelError */ errors?: Array; } /** * Check if a given object implements the ModelError interface. */ declare function instanceOfModelError(value: object): value is ModelError; declare function ModelErrorFromJSON(json: any): ModelError; declare function ModelErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): ModelError; declare function ModelErrorToJSON(json: any): ModelError; declare function ModelErrorToJSONTyped(value?: ModelError | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/MonthlyLimitExceeded.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * MONTHLY_LIMIT_EXCEEDED * @export * @interface MonthlyLimitExceeded */ interface MonthlyLimitExceeded { /** * * @type {string} * @memberof MonthlyLimitExceeded */ message?: string; /** * * @type {string} * @memberof MonthlyLimitExceeded */ description?: string; /** * * @type {string} * @memberof MonthlyLimitExceeded */ resource?: string; } /** * Check if a given object implements the MonthlyLimitExceeded interface. */ declare function instanceOfMonthlyLimitExceeded(value: object): value is MonthlyLimitExceeded; declare function MonthlyLimitExceededFromJSON(json: any): MonthlyLimitExceeded; declare function MonthlyLimitExceededFromJSONTyped(json: any, ignoreDiscriminator: boolean): MonthlyLimitExceeded; declare function MonthlyLimitExceededToJSON(json: any): MonthlyLimitExceeded; declare function MonthlyLimitExceededToJSONTyped(value?: MonthlyLimitExceeded | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/NotFound.d.ts /** * NOT_FOUND * @export * @interface NotFound */ interface NotFound { /** * * @type {string} * @memberof NotFound */ message?: string; /** * * @type {string} * @memberof NotFound */ description?: string; /** * * @type {string} * @memberof NotFound */ resource?: string; /** * * @type {Array} * @memberof NotFound */ errors?: Array; } /** * Check if a given object implements the NotFound interface. */ declare function instanceOfNotFound(value: object): value is NotFound; declare function NotFoundFromJSON(json: any): NotFound; declare function NotFoundFromJSONTyped(json: any, ignoreDiscriminator: boolean): NotFound; declare function NotFoundToJSON(json: any): NotFound; declare function NotFoundToJSONTyped(value?: NotFound | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/SimplifiedError.d.ts /** * Bitly API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 4.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface SimplifiedError */ interface SimplifiedError { /** * * @type {string} * @memberof SimplifiedError */ message?: string; /** * * @type {string} * @memberof SimplifiedError */ description?: string; /** * * @type {string} * @memberof SimplifiedError */ resource?: string; } /** * Check if a given object implements the SimplifiedError interface. */ declare function instanceOfSimplifiedError(value: object): value is SimplifiedError; declare function SimplifiedErrorFromJSON(json: any): SimplifiedError; declare function SimplifiedErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): SimplifiedError; declare function SimplifiedErrorToJSON(json: any): SimplifiedError; declare function SimplifiedErrorToJSONTyped(value?: SimplifiedError | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/TemporarilyUnavailable.d.ts /** * TEMPORARILY_UNAVAILABLE * @export * @interface TemporarilyUnavailable */ interface TemporarilyUnavailable { /** * * @type {string} * @memberof TemporarilyUnavailable */ message?: string; /** * * @type {string} * @memberof TemporarilyUnavailable */ description?: string; /** * * @type {string} * @memberof TemporarilyUnavailable */ resource?: string; /** * * @type {Array} * @memberof TemporarilyUnavailable */ errors?: Array; } /** * Check if a given object implements the TemporarilyUnavailable interface. */ declare function instanceOfTemporarilyUnavailable(value: object): value is TemporarilyUnavailable; declare function TemporarilyUnavailableFromJSON(json: any): TemporarilyUnavailable; declare function TemporarilyUnavailableFromJSONTyped(json: any, ignoreDiscriminator: boolean): TemporarilyUnavailable; declare function TemporarilyUnavailableToJSON(json: any): TemporarilyUnavailable; declare function TemporarilyUnavailableToJSONTyped(value?: TemporarilyUnavailable | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/UnprocessableEntity.d.ts /** * UNPROCESSABLE_ENTITY * @export * @interface UnprocessableEntity */ interface UnprocessableEntity { /** * * @type {string} * @memberof UnprocessableEntity */ message?: string; /** * * @type {string} * @memberof UnprocessableEntity */ description?: string; /** * * @type {string} * @memberof UnprocessableEntity */ resource?: string; /** * * @type {Array} * @memberof UnprocessableEntity */ errors?: Array; } /** * Check if a given object implements the UnprocessableEntity interface. */ declare function instanceOfUnprocessableEntity(value: object): value is UnprocessableEntity; declare function UnprocessableEntityFromJSON(json: any): UnprocessableEntity; declare function UnprocessableEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): UnprocessableEntity; declare function UnprocessableEntityToJSON(json: any): UnprocessableEntity; declare function UnprocessableEntityToJSONTyped(value?: UnprocessableEntity | null, ignoreDiscriminator?: boolean): any; //#endregion //#region src/models/UpgradeRequired.d.ts /** * UPGRADE_REQUIRED * @export * @interface UpgradeRequired */ interface UpgradeRequired { /** * * @type {string} * @memberof UpgradeRequired */ message?: string; /** * * @type {string} * @memberof UpgradeRequired */ description?: string; /** * * @type {string} * @memberof UpgradeRequired */ resource?: string; /** * * @type {Array} * @memberof UpgradeRequired */ errors?: Array; } /** * Check if a given object implements the UpgradeRequired interface. */ declare function instanceOfUpgradeRequired(value: object): value is UpgradeRequired; declare function UpgradeRequiredFromJSON(json: any): UpgradeRequired; declare function UpgradeRequiredFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpgradeRequired; declare function UpgradeRequiredToJSON(json: any): UpgradeRequired; declare function UpgradeRequiredToJSONTyped(value?: UpgradeRequired | null, ignoreDiscriminator?: boolean): any; //#endregion export { AddCustomBitlink, AddCustomBitlinkFromJSON, AddCustomBitlinkFromJSONTyped, AddCustomBitlinkRequest, AddCustomBitlinkToJSON, AddCustomBitlinkToJSONTyped, ApiResponse, BASE_PATH, BSDsApi, BSDsResponse, BSDsResponseFromJSON, BSDsResponseFromJSONTyped, BSDsResponseToJSON, BSDsResponseToJSONTyped, BadGateway, BadGatewayFromJSON, BadGatewayFromJSONTyped, BadGatewayToJSON, BadGatewayToJSONTyped, BadRequest, BadRequestFromJSON, BadRequestFromJSONTyped, BadRequestToJSON, BadRequestToJSONTyped, BaseAPI, BaseChannel, BaseChannelBitlink, BaseChannelBitlinkFromJSON, BaseChannelBitlinkFromJSONTyped, BaseChannelBitlinkToJSON, BaseChannelBitlinkToJSONTyped, BaseChannelFromJSON, BaseChannelFromJSONTyped, BaseChannelToJSON, BaseChannelToJSONTyped, BaseMetrics, BaseMetricsFacetEnum, BaseMetricsFromJSON, BaseMetricsFromJSONTyped, BaseMetricsToJSON, BaseMetricsToJSONTyped, BaseScanMetrics, BaseScanMetricsFacetEnum, BaseScanMetricsFromJSON, BaseScanMetricsFromJSONTyped, BaseScanMetricsToJSON, BaseScanMetricsToJSONTyped, BitlinkBody, BitlinkBodyFromJSON, BitlinkBodyFromJSONTyped, BitlinkBodyToJSON, BitlinkBodyToJSONTyped, BitlinkScans, BitlinkScansFromJSON, BitlinkScansFromJSONTyped, BitlinkScansSummary, BitlinkScansSummaryFromJSON, BitlinkScansSummaryFromJSONTyped, BitlinkScansSummaryToJSON, BitlinkScansSummaryToJSONTyped, BitlinkScansSummaryUnitEnum, BitlinkScansToJSON, BitlinkScansToJSONTyped, BitlinkScansUnitEnum, BitlinkUpdate, BitlinkUpdateBody, BitlinkUpdateBodyFromJSON, BitlinkUpdateBodyFromJSONTyped, BitlinkUpdateBodyToJSON, BitlinkUpdateBodyToJSONTyped, BitlinkUpdateFromJSON, BitlinkUpdateFromJSONTyped, BitlinkUpdateToJSON, BitlinkUpdateToJSONTyped, Bitlinks, BitlinksApi, BitlinksFromJSON, BitlinksFromJSONTyped, BitlinksPagination, BitlinksPaginationFromJSON, BitlinksPaginationFromJSONTyped, BitlinksPaginationToJSON, BitlinksPaginationToJSONTyped, BitlinksToJSON, BitlinksToJSONTyped, BlobApiResponse, BulkUpdate, BulkUpdateFromJSON, BulkUpdateFromJSONTyped, BulkUpdateRequest, BulkUpdateRequestActionEnum, BulkUpdateRequestFromJSON, BulkUpdateRequestFromJSONTyped, BulkUpdateRequestToJSON, BulkUpdateRequestToJSONTyped, BulkUpdateToJSON, BulkUpdateToJSONTyped, COLLECTION_FORMATS, Campaign, CampaignFromJSON, CampaignFromJSONTyped, CampaignModify, CampaignModifyFromJSON, CampaignModifyFromJSONTyped, CampaignModifyToJSON, CampaignModifyToJSONTyped, CampaignToJSON, CampaignToJSONTyped, Campaigns, CampaignsApi, CampaignsFromJSON, CampaignsFromJSONTyped, CampaignsToJSON, CampaignsToJSONTyped, Channel, ChannelFromJSON, ChannelFromJSONTyped, ChannelModify, ChannelModifyFromJSON, ChannelModifyFromJSONTyped, ChannelModifyToJSON, ChannelModifyToJSONTyped, ChannelToJSON, ChannelToJSONTyped, Channels, ChannelsFromJSON, ChannelsFromJSONTyped, ChannelsToJSON, ChannelsToJSONTyped, CityMetric, CityMetricFromJSON, CityMetricFromJSONTyped, CityMetricToJSON, CityMetricToJSONTyped, CityMetrics, CityMetricsFacetEnum, CityMetricsFromJSON, CityMetricsFromJSONTyped, CityMetricsToJSON, CityMetricsToJSONTyped, CityScanMetric, CityScanMetricFromJSON, CityScanMetricFromJSONTyped, CityScanMetricToJSON, CityScanMetricToJSONTyped, CityScanMetrics, CityScanMetricsFacetEnum, CityScanMetricsFromJSON, CityScanMetricsFromJSONTyped, CityScanMetricsToJSON, CityScanMetricsToJSONTyped, ClickLink, ClickLinkFromJSON, ClickLinkFromJSONTyped, ClickLinkToJSON, ClickLinkToJSONTyped, ClickMetric, ClickMetricFromJSON, ClickMetricFromJSONTyped, ClickMetricToJSON, ClickMetricToJSONTyped, ClickMetrics, ClickMetricsFacetEnum, ClickMetricsFromJSON, ClickMetricsFromJSONTyped, ClickMetricsToJSON, ClickMetricsToJSONTyped, Clicks, ClicksFromJSON, ClicksFromJSONTyped, ClicksSummary, ClicksSummaryFromJSON, ClicksSummaryFromJSONTyped, ClicksSummaryToJSON, ClicksSummaryToJSONTyped, ClicksSummaryUnitEnum, ClicksToJSON, ClicksToJSONTyped, ClicksUnitEnum, Configuration, ConfigurationParameters, Conflict, ConflictFromJSON, ConflictFromJSONTyped, ConflictToJSON, ConflictToJSONTyped, Consume, CountItem, CountItemFromJSON, CountItemFromJSONTyped, CountItemToJSON, CountItemToJSONTyped, CreateBitlinkRequest, CreateCampaignRequest, CreateChannelRequest, CreateFullBitlinkRequest, CreateQRCodePublicRequest, CreateStaticQRCodePublicAcceptEnum, CreateStaticQRCodePublicFormatEnum, CreateStaticQRCodePublicRequest, CreateWebhookRequest, CustomBitlink, CustomBitlinkFromJSON, CustomBitlinkFromJSONTyped, CustomBitlinkHistory, CustomBitlinkHistoryFromJSON, CustomBitlinkHistoryFromJSONTyped, CustomBitlinkHistoryToJSON, CustomBitlinkHistoryToJSONTyped, CustomBitlinkToJSON, CustomBitlinkToJSONTyped, CustomBitlinksApi, Deeplink, DeeplinkFromJSON, DeeplinkFromJSONTyped, DeeplinkRule, DeeplinkRuleFromJSON, DeeplinkRuleFromJSONTyped, DeeplinkRuleToJSON, DeeplinkRuleToJSONTyped, DeeplinkToJSON, DeeplinkToJSONTyped, DefaultApi, DefaultConfig, DeleteBitlinkRequest, DeleteQRCodeRequest, DeleteWebhookRequest, DeletedLink, DeletedLinkFromJSON, DeletedLinkFromJSONTyped, DeletedLinkToJSON, DeletedLinkToJSONTyped, DeletedQRCode, DeletedQRCodeFromJSON, DeletedQRCodeFromJSONTyped, DeletedQRCodeToJSON, DeletedQRCodeToJSONTyped, DeviceMetric, DeviceMetricFromJSON, DeviceMetricFromJSONTyped, DeviceMetricToJSON, DeviceMetricToJSONTyped, DeviceMetrics, DeviceMetricsFacetEnum, DeviceMetricsFromJSON, DeviceMetricsFromJSONTyped, DeviceMetricsToJSON, DeviceMetricsToJSONTyped, Email, EmailFromJSON, EmailFromJSONTyped, EmailToJSON, EmailToJSONTyped, Engagement, EngagementFromJSON, EngagementFromJSONTyped, EngagementSubtotal, EngagementSubtotalFromJSON, EngagementSubtotalFromJSONTyped, EngagementSubtotalToJSON, EngagementSubtotalToJSONTyped, EngagementToJSON, EngagementToJSONTyped, Engagements, EngagementsFromJSON, EngagementsFromJSONTyped, EngagementsToJSON, EngagementsToJSONTyped, ErrorContext, ExpandBitlink, ExpandBitlinkFromJSON, ExpandBitlinkFromJSONTyped, ExpandBitlinkRequest, ExpandBitlinkToJSON, ExpandBitlinkToJSONTyped, ExpandedBitlink, ExpandedBitlinkFromJSON, ExpandedBitlinkFromJSONTyped, ExpandedBitlinkToJSON, ExpandedBitlinkToJSONTyped, ExpectationFailed, ExpectationFailedFromJSON, ExpectationFailedFromJSONTyped, ExpectationFailedToJSON, ExpectationFailedToJSONTyped, FetchAPI, FetchError, FetchParams, FieldError, FieldErrorFromJSON, FieldErrorFromJSONTyped, FieldErrorToJSON, FieldErrorToJSONTyped, Forbidden, ForbiddenFromJSON, ForbiddenFromJSONTyped, ForbiddenToJSON, ForbiddenToJSONTyped, FullShorten, FullShortenFromJSON, FullShortenFromJSONTyped, FullShortenToJSON, FullShortenToJSONTyped, GS1Metadata, GS1MetadataFromJSON, GS1MetadataFromJSONTyped, GS1MetadataToJSON, GS1MetadataToJSONTyped, GS1Value, GS1ValueFromJSON, GS1ValueFromJSONTyped, GS1ValueToJSON, GS1ValueToJSONTyped, GetBitlinkRequest, GetBitlinksByGroupArchivedEnum, GetBitlinksByGroupCustomBitlinkEnum, GetBitlinksByGroupDeeplinksEnum, GetBitlinksByGroupDomainDeeplinksEnum, GetBitlinksByGroupHasExpirationEnum, GetBitlinksByGroupHasQrCodesEnum, GetBitlinksByGroupIsExpiredEnum, GetBitlinksByGroupRequest, GetCampaignRequest, GetCampaignsRequest, GetChannelRequest, GetChannelsRequest, GetClicksForBitlinkRequest, GetClicksForCustomBitlinkRequest, GetClicksSummaryForBitlinkRequest, GetCustomBitlinkMetricsByDestinationRequest, GetCustomBitlinkRequest, GetEngagementsRequest, GetEngagementsSummaryRequest, GetGroupClicksRequest, GetGroupCodeScansByCityRequest, GetGroupCodeScansByCountryRequest, GetGroupCodeScansOverTimeRequest, GetGroupFeatureUsageRequest, GetGroupHistoricalUsageRequest, GetGroupLinkClicksByCityRequest, GetGroupLinkClicksByCountryRequest, GetGroupLinkClicksByDevice200Response, GetGroupLinkClicksByDevice200ResponseFacetEnum, GetGroupLinkClicksByDevice200ResponseFromJSON, GetGroupLinkClicksByDevice200ResponseFromJSONTyped, GetGroupLinkClicksByDevice200ResponseMetricsInner, GetGroupLinkClicksByDevice200ResponseMetricsInnerFromJSON, GetGroupLinkClicksByDevice200ResponseMetricsInnerFromJSONTyped, GetGroupLinkClicksByDevice200ResponseMetricsInnerToJSON, GetGroupLinkClicksByDevice200ResponseMetricsInnerToJSONTyped, GetGroupLinkClicksByDevice200ResponseToJSON, GetGroupLinkClicksByDevice200ResponseToJSONTyped, GetGroupLinkClicksByDeviceRequest, GetGroupLinkClicksByReferrerRequest, GetGroupLinkClicksOverTimeRequest, GetGroupMetricsByCitiesRequest, GetGroupMetricsByCountriesRequest, GetGroupMetricsByDevicesRequest, GetGroupMetricsByReferrerRequest, GetGroupMetricsByReferringNetworksRequest, GetGroupMetricsOverTimeRequest, GetGroupPreferencesRequest, GetGroupRequest, GetGroupShortenCountsRequest, GetGroupTagsRequest, GetGroupTagsTypeEnum, GetGroupTopCodeScans200Response, GetGroupTopCodeScans200ResponseFromJSON, GetGroupTopCodeScans200ResponseFromJSONTyped, GetGroupTopCodeScans200ResponseToJSON, GetGroupTopCodeScans200ResponseToJSONTyped, GetGroupTopCodeScansRequest, GetGroupTopLinkClicksRequest, GetGroupTopMetricsRequest, GetGroupsRequest, GetMetricsForBitlinkByCitiesRequest, GetMetricsForBitlinkByCountriesRequest, GetMetricsForBitlinkByDevicesRequest, GetMetricsForBitlinkByReferrerNameRequest, GetMetricsForBitlinkByReferrersByDomainsRequest, GetMetricsForBitlinkByReferrersRequest, GetMetricsForBitlinkByReferringDomainsRequest, GetOAuthAppRequest, GetOrganizationRequest, GetOrganizationShortenCountsByGroupRequest, GetOrganizationShortenCountsRequest, GetOrganizationsRequest, GetPlanLimitsRequest, GetPlatformLimitsRequest, GetQRCodeByIdPublicRequest, GetQRCodeImagePublicFormatEnum, GetQRCodeImagePublicRequest, GetScanMetricsForQRCodeByBrowserRequest, GetScanMetricsForQRCodeByCitiesRequest, GetScanMetricsForQRCodeByCountriesRequest, GetScanMetricsForQRCodeByDevicesOSRequest, GetScanMetricsForQRCodeRequest, GetScanMetricsSummaryForQRCodeRequest, GetSortedBitlinksRequest, GetSortedBitlinksSortEnum, GetTopLinksAndQRCodesByEngagementsRequest, GetWebhookRequest, GetWebhooksRequest, Gone, GoneFromJSON, GoneFromJSONTyped, GoneToJSON, GoneToJSONTyped, GradientColor, GradientColorFromJSON, GradientColorFromJSONTyped, GradientColorToJSON, GradientColorToJSONTyped, Group, GroupClicks, GroupClicksFromJSON, GroupClicksFromJSONTyped, GroupClicksToJSON, GroupClicksToJSONTyped, GroupConsumableFeatureUsage, GroupConsumableFeatureUsageFromJSON, GroupConsumableFeatureUsageFromJSONTyped, GroupConsumableFeatureUsageToJSON, GroupConsumableFeatureUsageToJSONTyped, GroupExportFilter, GroupExportFilterArchivedEnum, GroupExportFilterFromJSON, GroupExportFilterFromJSONTyped, GroupExportFilterToJSON, GroupExportFilterToJSONTyped, GroupExportRequestBody, GroupExportRequestBodyExportTypeEnum, GroupExportRequestBodyFromJSON, GroupExportRequestBodyFromJSONTyped, GroupExportRequestBodyToJSON, GroupExportRequestBodyToJSONTyped, GroupExportResponse, GroupExportResponseExportTypeEnum, GroupExportResponseFromJSON, GroupExportResponseFromJSONTyped, GroupExportResponseToJSON, GroupExportResponseToJSONTyped, GroupFeatureUsage, GroupFeatureUsageFromJSON, GroupFeatureUsageFromJSONTyped, GroupFeatureUsageToJSON, GroupFeatureUsageToJSONTyped, GroupFromJSON, GroupFromJSONTyped, GroupHistoricalUsage, GroupHistoricalUsageFromJSON, GroupHistoricalUsageFromJSONTyped, GroupHistoricalUsageToJSON, GroupHistoricalUsageToJSONTyped, GroupPreferences, GroupPreferencesFromJSON, GroupPreferencesFromJSONTyped, GroupPreferencesToJSON, GroupPreferencesToJSONTyped, GroupToJSON, GroupToJSONTyped, GroupUpdate, GroupUpdateFromJSON, GroupUpdateFromJSONTyped, GroupUpdateToJSON, GroupUpdateToJSONTyped, Groups, GroupsApi, GroupsFromJSON, GroupsFromJSONTyped, GroupsToJSON, GroupsToJSONTyped, HTTPBody, HTTPHeaders, HTTPMethod, HTTPQuery, HTTPRequestInit, HasReferences, HasReferencesFromJSON, HasReferencesFromJSONTyped, HasReferencesToJSON, HasReferencesToJSONTyped, HistoricalFeatureUsage, HistoricalFeatureUsageFromJSON, HistoricalFeatureUsageFromJSONTyped, HistoricalFeatureUsageToJSON, HistoricalFeatureUsageToJSONTyped, HistoricalUsage, HistoricalUsageFromJSON, HistoricalUsageFromJSONTyped, HistoricalUsageToJSON, HistoricalUsageToJSONTyped, InitOverrideFunction, InstallPreference, InstallPreferenceFromJSON, InstallPreferenceFromJSONTyped, InstallPreferenceToJSON, InstallPreferenceToJSONTyped, InternalError, InternalErrorFromJSON, InternalErrorFromJSONTyped, InternalErrorToJSON, InternalErrorToJSONTyped, JSONApiResponse, Json, LinkClicks, LinkClicksFromJSON, LinkClicksFromJSONTyped, LinkClicksToJSON, LinkClicksToJSONTyped, LinkDeletionResponse, LinkDeletionResponseFromJSON, LinkDeletionResponseFromJSONTyped, LinkDeletionResponseToJSON, LinkDeletionResponseToJSONTyped, ListQRMinimalArchivedEnum, ListQRMinimalHasExpirationEnum, ListQRMinimalHasRenderCustomizationsEnum, ListQRMinimalIsExpiredEnum, ListQRMinimalIsGs1Enum, ListQRMinimalQrcTypeEnum, ListQRMinimalRequest, MethodLimit, MethodLimitFromJSON, MethodLimitFromJSONTyped, MethodLimitToJSON, MethodLimitToJSONTyped, Metric, MetricFromJSON, MetricFromJSONTyped, MetricToJSON, MetricToJSONTyped, Metrics, MetricsFacetEnum, MetricsFromJSON, MetricsFromJSONTyped, MetricsToJSON, MetricsToJSONTyped, Middleware, MobileOS, MobileOSFromJSON, MobileOSFromJSONTyped, MobileOSToJSON, MobileOSToJSONTyped, ModelError, ModelErrorFromJSON, ModelErrorFromJSONTyped, ModelErrorToJSON, ModelErrorToJSONTyped, ModelPropertyNaming, MonthlyLimitExceeded, MonthlyLimitExceededFromJSON, MonthlyLimitExceededFromJSONTyped, MonthlyLimitExceededToJSON, MonthlyLimitExceededToJSONTyped, NotFound, NotFoundFromJSON, NotFoundFromJSONTyped, NotFoundToJSON, NotFoundToJSONTyped, OAuthApp, OAuthAppFromJSON, OAuthAppFromJSONTyped, OAuthAppToJSON, OAuthAppToJSONTyped, Organization, OrganizationFromJSON, OrganizationFromJSONTyped, OrganizationRequire2faEnum, OrganizationRequireSsoEnum, OrganizationToJSON, OrganizationToJSONTyped, Organizations, OrganizationsApi, OrganizationsFromJSON, OrganizationsFromJSONTyped, OrganizationsToJSON, OrganizationsToJSONTyped, OtherMetrics, OtherMetricsFromJSON, OtherMetricsFromJSONTyped, OtherMetricsToJSON, OtherMetricsToJSONTyped, OtherScanMetrics, OtherScanMetricsFromJSON, OtherScanMetricsFromJSONTyped, OtherScanMetricsToJSON, OtherScanMetricsToJSONTyped, PlanLimit, PlanLimitFromJSON, PlanLimitFromJSONTyped, PlanLimitToJSON, PlanLimitToJSONTyped, PlanLimits, PlanLimitsFromJSON, PlanLimitsFromJSONTyped, PlanLimitsToJSON, PlanLimitsToJSONTyped, PlatformLimit, PlatformLimitFromJSON, PlatformLimitFromJSONTyped, PlatformLimitToJSON, PlatformLimitToJSONTyped, PlatformLimits, PlatformLimitsFromJSON, PlatformLimitsFromJSONTyped, PlatformLimitsToJSON, PlatformLimitsToJSONTyped, PostCreateGroupExportRequest, PublicCreateQRCodeRequest, PublicCreateQRCodeRequestFromJSON, PublicCreateQRCodeRequestFromJSONTyped, PublicCreateQRCodeRequestToJSON, PublicCreateQRCodeRequestToJSONTyped, PublicCreateStaticQRCodeRequest, PublicCreateStaticQRCodeRequestFromJSON, PublicCreateStaticQRCodeRequestFromJSONTyped, PublicCreateStaticQRCodeRequestToJSON, PublicCreateStaticQRCodeRequestToJSONTyped, PublicDeleteQRCodeResponse, PublicDeleteQRCodeResponseFromJSON, PublicDeleteQRCodeResponseFromJSONTyped, PublicDeleteQRCodeResponseToJSON, PublicDeleteQRCodeResponseToJSONTyped, PublicQRCodeImageResponse, PublicQRCodeImageResponseFromJSON, PublicQRCodeImageResponseFromJSONTyped, PublicQRCodeImageResponseToJSON, PublicQRCodeImageResponseToJSONTyped, PublicStaticQRCodeResponse, PublicStaticQRCodeResponseFromJSON, PublicStaticQRCodeResponseFromJSONTyped, PublicStaticQRCodeResponseToJSON, PublicStaticQRCodeResponseToJSONTyped, PublicUpdateQRCodeRequest, PublicUpdateQRCodeRequestFromJSON, PublicUpdateQRCodeRequestFromJSONTyped, PublicUpdateQRCodeRequestToJSON, PublicUpdateQRCodeRequestToJSONTyped, QRCodeBranding, QRCodeBrandingFromJSON, QRCodeBrandingFromJSONTyped, QRCodeBrandingToJSON, QRCodeBrandingToJSONTyped, QRCodeCorner, QRCodeCornerFromJSON, QRCodeCornerFromJSONTyped, QRCodeCornerShapeEnum, QRCodeCornerToJSON, QRCodeCornerToJSONTyped, QRCodeCorners, QRCodeCornersFromJSON, QRCodeCornersFromJSONTyped, QRCodeCornersToJSON, QRCodeCornersToJSONTyped, QRCodeCustomizationsPublic, QRCodeCustomizationsPublicFromJSON, QRCodeCustomizationsPublicFromJSONTyped, QRCodeCustomizationsPublicToJSON, QRCodeCustomizationsPublicToJSONTyped, QRCodeCustomizationsStaticPublic, QRCodeCustomizationsStaticPublicFromJSON, QRCodeCustomizationsStaticPublicFromJSONTyped, QRCodeCustomizationsStaticPublicToJSON, QRCodeCustomizationsStaticPublicToJSONTyped, QRCodeDestination, QRCodeDestinationFromJSON, QRCodeDestinationFromJSONTyped, QRCodeDestinationToJSON, QRCodeDestinationToJSONTyped, QRCodeDetails, QRCodeDetailsFromJSON, QRCodeDetailsFromJSONTyped, QRCodeDetailsToJSON, QRCodeDetailsToJSONTyped, QRCodeDotPatternType, QRCodeDotPatternTypeFromJSON, QRCodeDotPatternTypeFromJSONTyped, QRCodeDotPatternTypeToJSON, QRCodeDotPatternTypeToJSONTyped, QRCodeFrameRequest, QRCodeFrameRequestColors, QRCodeFrameRequestColorsFromJSON, QRCodeFrameRequestColorsFromJSONTyped, QRCodeFrameRequestColorsToJSON, QRCodeFrameRequestColorsToJSONTyped, QRCodeFrameRequestFromJSON, QRCodeFrameRequestFromJSONTyped, QRCodeFrameRequestText, QRCodeFrameRequestTextFromJSON, QRCodeFrameRequestTextFromJSONTyped, QRCodeFrameRequestTextToJSON, QRCodeFrameRequestTextToJSONTyped, QRCodeFrameRequestToJSON, QRCodeFrameRequestToJSONTyped, QRCodeFrameType, QRCodeFrameTypeFromJSON, QRCodeFrameTypeFromJSONTyped, QRCodeFrameTypeToJSON, QRCodeFrameTypeToJSONTyped, QRCodeGradient, QRCodeGradientFromJSON, QRCodeGradientFromJSONTyped, QRCodeGradientStyleEnum, QRCodeGradientToJSON, QRCodeGradientToJSONTyped, QRCodeLogoPublic, QRCodeLogoPublicFromJSON, QRCodeLogoPublicFromJSONTyped, QRCodeLogoPublicToJSON, QRCodeLogoPublicToJSONTyped, QRCodeMinimal, QRCodeMinimalFromJSON, QRCodeMinimalFromJSONTyped, QRCodeMinimalToJSON, QRCodeMinimalToJSONTyped, QRCodeSpecSettingsPublic, QRCodeSpecSettingsPublicFromJSON, QRCodeSpecSettingsPublicFromJSONTyped, QRCodeSpecSettingsPublicToJSON, QRCodeSpecSettingsPublicToJSONTyped, QRCodeText, QRCodeTextFromJSON, QRCodeTextFromJSONTyped, QRCodeTextToJSON, QRCodeTextToJSONTyped, QRCodeTypeEnum, QRCodeTypeEnumFromJSON, QRCodeTypeEnumFromJSONTyped, QRCodeTypeEnumToJSON, QRCodeTypeEnumToJSONTyped, QRCodesApi, QRCodesMinimal, QRCodesMinimalFromJSON, QRCodesMinimalFromJSONTyped, QRCodesMinimalToJSON, QRCodesMinimalToJSONTyped, QRPagination, QRPaginationFromJSON, QRPaginationFromJSONTyped, QRPaginationToJSON, QRPaginationToJSONTyped, QRScans, QRScansFromJSON, QRScansFromJSONTyped, QRScansToJSON, QRScansToJSONTyped, ReferrersByDomain, ReferrersByDomainFromJSON, ReferrersByDomainFromJSONTyped, ReferrersByDomainToJSON, ReferrersByDomainToJSONTyped, ReferrersByDomains, ReferrersByDomainsFacetEnum, ReferrersByDomainsFromJSON, ReferrersByDomainsFromJSONTyped, ReferrersByDomainsToJSON, ReferrersByDomainsToJSONTyped, RequestContext, RequestOpts, RequiredError, ResponseContext, ResponseError, ResponseTransformer, ScanMetric, ScanMetricFromJSON, ScanMetricFromJSONTyped, ScanMetricToJSON, ScanMetricToJSONTyped, ScanMetrics, ScanMetricsFacetEnum, ScanMetricsFromJSON, ScanMetricsFromJSONTyped, ScanMetricsToJSON, ScanMetricsToJSONTyped, Shorten, ShortenBitlinkBody, ShortenBitlinkBodyFromJSON, ShortenBitlinkBodyFromJSONTyped, ShortenBitlinkBodyToJSON, ShortenBitlinkBodyToJSONTyped, ShortenFromJSON, ShortenFromJSONTyped, ShortenToJSON, ShortenToJSONTyped, SimplifiedError, SimplifiedErrorFromJSON, SimplifiedErrorFromJSONTyped, SimplifiedErrorToJSON, SimplifiedErrorToJSONTyped, SortedLinks, SortedLinksFromJSON, SortedLinksFromJSONTyped, SortedLinksToJSON, SortedLinksToJSONTyped, Tags, TagsFromJSON, TagsFromJSONTyped, TagsToJSON, TagsToJSONTyped, TemporarilyUnavailable, TemporarilyUnavailableFromJSON, TemporarilyUnavailableFromJSONTyped, TemporarilyUnavailableToJSON, TemporarilyUnavailableToJSONTyped, Text, TextApiResponse, TextFromJSON, TextFromJSONTyped, TextToJSON, TextToJSONTyped, TimeUnit, TimeUnitDWM, TimeUnitDWMFromJSON, TimeUnitDWMFromJSONTyped, TimeUnitDWMToJSON, TimeUnitDWMToJSONTyped, TimeUnitFromJSON, TimeUnitFromJSONTyped, TimeUnitToJSON, TimeUnitToJSONTyped, TopLinksAndQRCodes, TopLinksAndQRCodesFromJSON, TopLinksAndQRCodesFromJSONTyped, TopLinksAndQRCodesToJSON, TopLinksAndQRCodesToJSONTyped, TotalEngagements, TotalEngagementsFromJSON, TotalEngagementsFromJSONTyped, TotalEngagementsSummary, TotalEngagementsSummaryFromJSON, TotalEngagementsSummaryFromJSONTyped, TotalEngagementsSummaryToJSON, TotalEngagementsSummaryToJSONTyped, TotalEngagementsSummaryUnitEnum, TotalEngagementsToJSON, TotalEngagementsToJSONTyped, TotalEngagementsUnitEnum, UnprocessableEntity, UnprocessableEntityFromJSON, UnprocessableEntityFromJSONTyped, UnprocessableEntityToJSON, UnprocessableEntityToJSONTyped, UpdateBitlinkRequest, UpdateBitlinksByGroupRequest, UpdateCampaignRequest, UpdateChannelRequest, UpdateCustomBitlink, UpdateCustomBitlinkFromJSON, UpdateCustomBitlinkFromJSONTyped, UpdateCustomBitlinkRequest, UpdateCustomBitlinkToJSON, UpdateCustomBitlinkToJSONTyped, UpdateGroupPreferencesRequest, UpdateGroupRequest, UpdateQRCodePublicRequest, UpdateUserRequest, UpdateWebhookRequest, UpgradeRequired, UpgradeRequiredFromJSON, UpgradeRequiredFromJSONTyped, UpgradeRequiredToJSON, UpgradeRequiredToJSONTyped, User, UserApi, UserFromJSON, UserFromJSONTyped, UserToJSON, UserToJSONTyped, UserUpdate, UserUpdateFromJSON, UserUpdateFromJSONTyped, UserUpdateToJSON, UserUpdateToJSONTyped, VerifyWebhookRequest, VoidApiResponse, Webhook, WebhookCreate, WebhookCreateFromJSON, WebhookCreateFromJSONTyped, WebhookCreateToJSON, WebhookCreateToJSONTyped, WebhookFromJSON, WebhookFromJSONTyped, WebhookToJSON, WebhookToJSONTyped, WebhookUpdate, WebhookUpdateFromJSON, WebhookUpdateFromJSONTyped, WebhookUpdateToJSON, WebhookUpdateToJSONTyped, Webhooks, WebhooksApi, WebhooksFromJSON, WebhooksFromJSONTyped, WebhooksToJSON, WebhooksToJSONTyped, canConsumeForm, exists, instanceOfAddCustomBitlink, instanceOfBSDsResponse, instanceOfBadGateway, instanceOfBadRequest, instanceOfBaseChannel, instanceOfBaseChannelBitlink, instanceOfBaseMetrics, instanceOfBaseScanMetrics, instanceOfBitlinkBody, instanceOfBitlinkScans, instanceOfBitlinkScansSummary, instanceOfBitlinkUpdate, instanceOfBitlinkUpdateBody, instanceOfBitlinks, instanceOfBitlinksPagination, instanceOfBulkUpdate, instanceOfBulkUpdateRequest, instanceOfCampaign, instanceOfCampaignModify, instanceOfCampaigns, instanceOfChannel, instanceOfChannelModify, instanceOfChannels, instanceOfCityMetric, instanceOfCityMetrics, instanceOfCityScanMetric, instanceOfCityScanMetrics, instanceOfClickLink, instanceOfClickMetric, instanceOfClickMetrics, instanceOfClicks, instanceOfClicksSummary, instanceOfConflict, instanceOfCountItem, instanceOfCustomBitlink, instanceOfCustomBitlinkHistory, instanceOfDeeplink, instanceOfDeeplinkRule, instanceOfDeletedLink, instanceOfDeletedQRCode, instanceOfDeviceMetric, instanceOfDeviceMetrics, instanceOfEmail, instanceOfEngagement, instanceOfEngagementSubtotal, instanceOfEngagements, instanceOfExpandBitlink, instanceOfExpandedBitlink, instanceOfExpectationFailed, instanceOfFieldError, instanceOfForbidden, instanceOfFullShorten, instanceOfGS1Metadata, instanceOfGS1Value, instanceOfGetGroupLinkClicksByDevice200Response, instanceOfGetGroupLinkClicksByDevice200ResponseMetricsInner, instanceOfGone, instanceOfGradientColor, instanceOfGroup, instanceOfGroupClicks, instanceOfGroupConsumableFeatureUsage, instanceOfGroupExportFilter, instanceOfGroupExportRequestBody, instanceOfGroupExportResponse, instanceOfGroupFeatureUsage, instanceOfGroupHistoricalUsage, instanceOfGroupPreferences, instanceOfGroupUpdate, instanceOfGroups, instanceOfHasReferences, instanceOfHistoricalFeatureUsage, instanceOfHistoricalUsage, instanceOfInstallPreference, instanceOfInternalError, instanceOfLinkClicks, instanceOfLinkDeletionResponse, instanceOfMethodLimit, instanceOfMetric, instanceOfMetrics, instanceOfMobileOS, instanceOfModelError, instanceOfMonthlyLimitExceeded, instanceOfNotFound, instanceOfOAuthApp, instanceOfOrganization, instanceOfOrganizations, instanceOfOtherMetrics, instanceOfOtherScanMetrics, instanceOfPlanLimit, instanceOfPlanLimits, instanceOfPlatformLimit, instanceOfPlatformLimits, instanceOfPublicCreateQRCodeRequest, instanceOfPublicCreateStaticQRCodeRequest, instanceOfPublicDeleteQRCodeResponse, instanceOfPublicQRCodeImageResponse, instanceOfPublicStaticQRCodeResponse, instanceOfPublicUpdateQRCodeRequest, instanceOfQRCodeBranding, instanceOfQRCodeCorner, instanceOfQRCodeCorners, instanceOfQRCodeCustomizationsPublic, instanceOfQRCodeCustomizationsStaticPublic, instanceOfQRCodeDestination, instanceOfQRCodeDetails, instanceOfQRCodeDotPatternType, instanceOfQRCodeFrameRequest, instanceOfQRCodeFrameRequestColors, instanceOfQRCodeFrameRequestText, instanceOfQRCodeFrameType, instanceOfQRCodeGradient, instanceOfQRCodeLogoPublic, instanceOfQRCodeMinimal, instanceOfQRCodeSpecSettingsPublic, instanceOfQRCodeText, instanceOfQRCodeTypeEnum, instanceOfQRCodesMinimal, instanceOfQRPagination, instanceOfQRScans, instanceOfReferrersByDomain, instanceOfReferrersByDomains, instanceOfScanMetric, instanceOfScanMetrics, instanceOfShorten, instanceOfShortenBitlinkBody, instanceOfSimplifiedError, instanceOfSortedLinks, instanceOfTags, instanceOfTemporarilyUnavailable, instanceOfText, instanceOfTimeUnit, instanceOfTimeUnitDWM, instanceOfTopLinksAndQRCodes, instanceOfTotalEngagements, instanceOfTotalEngagementsSummary, instanceOfUnprocessableEntity, instanceOfUpdateCustomBitlink, instanceOfUpgradeRequired, instanceOfUser, instanceOfUserUpdate, instanceOfWebhook, instanceOfWebhookCreate, instanceOfWebhookUpdate, instanceOfWebhooks, mapValues, querystring }; //# sourceMappingURL=index.d.mts.map