/** * Iyzico API * Iyzico Open API Declaration * * The version of the OpenAPI document: 0.1.15 * Contact: oguz.ozcan@vennyx.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import { type RequestArgs, BaseAPI } from '../base'; import type { GetSubscription2XXResponse } from '../models'; import type { LocaleAndConversationId } from '../models'; import type { SearchInSubscriptions2XXResponse } from '../models'; import type { StatusAndSystemTime } from '../models'; import type { UpgradeSubscriptionRequest } from '../models'; /** * SubscriptionsApi - axios parameter creator * @export */ export declare const SubscriptionsApiAxiosParamCreator: (configuration?: Configuration) => { /** * PENDING ( Beklemede ) durumunda olan aboneliği aktifleştirir. * @summary Activate Subscription * @param {string} subscriptionReferenceCode Abonelik için üretilen eşsiz referans kodu. * @param {*} [options] Override http request option. * @throws {RequiredError} */ activateSubscription: (subscriptionReferenceCode: string, options?: RawAxiosRequestConfig) => Promise; /** * Bir aboneliği iptal etmeye yarar * @summary Cancel Subscription * @param {string} subscriptionReferenceCode Reference code of the subscription * @param {LocaleAndConversationId} [localeAndConversationId] CancelSubscriptionRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelSubscription: (subscriptionReferenceCode: string, localeAndConversationId?: LocaleAndConversationId, options?: RawAxiosRequestConfig) => Promise; /** * Bir aboneliğin detaylarını getirir. * @summary Get Subscription * @param {string} subscriptionReferenceCode Abonelik referans kodu * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSubscription: (subscriptionReferenceCode: string, options?: RawAxiosRequestConfig) => Promise; /** * Abonelikler arasında arama yapar. * @summary Search In Subscriptions * @param {number} page Page number * @param {number} count Count of items * @param {string} [subscriptionReferenceCode] Abonelik referans kodu * @param {string} [startDate] Abonelik başlangıç tarihi. * @param {string} [endDate] Abonelik bitiş tarihi. * @param {SearchInSubscriptionsSubscriptionStatusEnum} [subscriptionStatus] Abonelik durumu. * @param {string} [pricingPlanReferenceCode] Abonelikte kullanılan plan refereans numarası. * @param {string} [customerReferenceCode] Müşteri referans kodu. * @param {string} [parentReferenceCode] Abonelik güncellemelerinde üye işeyerinin eşleştirme yapılabileceği eşsiz referans kodu. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchInSubscriptions: (page: number, count: number, subscriptionReferenceCode?: string, startDate?: string, endDate?: string, subscriptionStatus?: SearchInSubscriptionsSubscriptionStatusEnum, pricingPlanReferenceCode?: string, customerReferenceCode?: string, parentReferenceCode?: string, options?: RawAxiosRequestConfig) => Promise; /** * Abonelik planını abonelik süresince değiştirmek veya yükseltmek mümkündür. Bunun için tek gerekli koşul, güncelleme yapılacak yeni plan, aboneliğin bağlı olduğu mevcut ürüne ait olmalıdır. NOT : Güncelleme yapılacak planların PaymentInterval ve PaymentIntervalCount parametreleri aynı olmalıdır. * @summary Upgrade Subscription * @param {string} subscriptionReferenceCode Abonelik referans kodu * @param {UpgradeSubscriptionRequest} [upgradeSubscriptionRequest] UpgradeSubscriptionRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ upgradeSubscription: (subscriptionReferenceCode: string, upgradeSubscriptionRequest?: UpgradeSubscriptionRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * SubscriptionsApi - functional programming interface * @export */ export declare const SubscriptionsApiFp: (configuration?: Configuration) => { /** * PENDING ( Beklemede ) durumunda olan aboneliği aktifleştirir. * @summary Activate Subscription * @param {string} subscriptionReferenceCode Abonelik için üretilen eşsiz referans kodu. * @param {*} [options] Override http request option. * @throws {RequiredError} */ activateSubscription(subscriptionReferenceCode: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Bir aboneliği iptal etmeye yarar * @summary Cancel Subscription * @param {string} subscriptionReferenceCode Reference code of the subscription * @param {LocaleAndConversationId} [localeAndConversationId] CancelSubscriptionRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelSubscription(subscriptionReferenceCode: string, localeAndConversationId?: LocaleAndConversationId, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Bir aboneliğin detaylarını getirir. * @summary Get Subscription * @param {string} subscriptionReferenceCode Abonelik referans kodu * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSubscription(subscriptionReferenceCode: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Abonelikler arasında arama yapar. * @summary Search In Subscriptions * @param {number} page Page number * @param {number} count Count of items * @param {string} [subscriptionReferenceCode] Abonelik referans kodu * @param {string} [startDate] Abonelik başlangıç tarihi. * @param {string} [endDate] Abonelik bitiş tarihi. * @param {SearchInSubscriptionsSubscriptionStatusEnum} [subscriptionStatus] Abonelik durumu. * @param {string} [pricingPlanReferenceCode] Abonelikte kullanılan plan refereans numarası. * @param {string} [customerReferenceCode] Müşteri referans kodu. * @param {string} [parentReferenceCode] Abonelik güncellemelerinde üye işeyerinin eşleştirme yapılabileceği eşsiz referans kodu. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchInSubscriptions(page: number, count: number, subscriptionReferenceCode?: string, startDate?: string, endDate?: string, subscriptionStatus?: SearchInSubscriptionsSubscriptionStatusEnum, pricingPlanReferenceCode?: string, customerReferenceCode?: string, parentReferenceCode?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Abonelik planını abonelik süresince değiştirmek veya yükseltmek mümkündür. Bunun için tek gerekli koşul, güncelleme yapılacak yeni plan, aboneliğin bağlı olduğu mevcut ürüne ait olmalıdır. NOT : Güncelleme yapılacak planların PaymentInterval ve PaymentIntervalCount parametreleri aynı olmalıdır. * @summary Upgrade Subscription * @param {string} subscriptionReferenceCode Abonelik referans kodu * @param {UpgradeSubscriptionRequest} [upgradeSubscriptionRequest] UpgradeSubscriptionRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ upgradeSubscription(subscriptionReferenceCode: string, upgradeSubscriptionRequest?: UpgradeSubscriptionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * SubscriptionsApi - factory interface * @export */ export declare const SubscriptionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * PENDING ( Beklemede ) durumunda olan aboneliği aktifleştirir. * @summary Activate Subscription * @param {string} subscriptionReferenceCode Abonelik için üretilen eşsiz referans kodu. * @param {*} [options] Override http request option. * @throws {RequiredError} */ activateSubscription(subscriptionReferenceCode: string, options?: any): AxiosPromise; /** * Bir aboneliği iptal etmeye yarar * @summary Cancel Subscription * @param {string} subscriptionReferenceCode Reference code of the subscription * @param {LocaleAndConversationId} [localeAndConversationId] CancelSubscriptionRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelSubscription(subscriptionReferenceCode: string, localeAndConversationId?: LocaleAndConversationId, options?: any): AxiosPromise; /** * Bir aboneliğin detaylarını getirir. * @summary Get Subscription * @param {string} subscriptionReferenceCode Abonelik referans kodu * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSubscription(subscriptionReferenceCode: string, options?: any): AxiosPromise; /** * Abonelikler arasında arama yapar. * @summary Search In Subscriptions * @param {number} page Page number * @param {number} count Count of items * @param {string} [subscriptionReferenceCode] Abonelik referans kodu * @param {string} [startDate] Abonelik başlangıç tarihi. * @param {string} [endDate] Abonelik bitiş tarihi. * @param {SearchInSubscriptionsSubscriptionStatusEnum} [subscriptionStatus] Abonelik durumu. * @param {string} [pricingPlanReferenceCode] Abonelikte kullanılan plan refereans numarası. * @param {string} [customerReferenceCode] Müşteri referans kodu. * @param {string} [parentReferenceCode] Abonelik güncellemelerinde üye işeyerinin eşleştirme yapılabileceği eşsiz referans kodu. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchInSubscriptions(page: number, count: number, subscriptionReferenceCode?: string, startDate?: string, endDate?: string, subscriptionStatus?: SearchInSubscriptionsSubscriptionStatusEnum, pricingPlanReferenceCode?: string, customerReferenceCode?: string, parentReferenceCode?: string, options?: any): AxiosPromise; /** * Abonelik planını abonelik süresince değiştirmek veya yükseltmek mümkündür. Bunun için tek gerekli koşul, güncelleme yapılacak yeni plan, aboneliğin bağlı olduğu mevcut ürüne ait olmalıdır. NOT : Güncelleme yapılacak planların PaymentInterval ve PaymentIntervalCount parametreleri aynı olmalıdır. * @summary Upgrade Subscription * @param {string} subscriptionReferenceCode Abonelik referans kodu * @param {UpgradeSubscriptionRequest} [upgradeSubscriptionRequest] UpgradeSubscriptionRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ upgradeSubscription(subscriptionReferenceCode: string, upgradeSubscriptionRequest?: UpgradeSubscriptionRequest, options?: any): AxiosPromise; }; /** * SubscriptionsApi - interface * @export * @interface SubscriptionsApi */ export interface SubscriptionsApiInterface { /** * PENDING ( Beklemede ) durumunda olan aboneliği aktifleştirir. * @summary Activate Subscription * @param {string} subscriptionReferenceCode Abonelik için üretilen eşsiz referans kodu. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SubscriptionsApiInterface */ activateSubscription(subscriptionReferenceCode: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Bir aboneliği iptal etmeye yarar * @summary Cancel Subscription * @param {string} subscriptionReferenceCode Reference code of the subscription * @param {LocaleAndConversationId} [localeAndConversationId] CancelSubscriptionRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SubscriptionsApiInterface */ cancelSubscription(subscriptionReferenceCode: string, localeAndConversationId?: LocaleAndConversationId, options?: RawAxiosRequestConfig): AxiosPromise; /** * Bir aboneliğin detaylarını getirir. * @summary Get Subscription * @param {string} subscriptionReferenceCode Abonelik referans kodu * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SubscriptionsApiInterface */ getSubscription(subscriptionReferenceCode: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Abonelikler arasında arama yapar. * @summary Search In Subscriptions * @param {number} page Page number * @param {number} count Count of items * @param {string} [subscriptionReferenceCode] Abonelik referans kodu * @param {string} [startDate] Abonelik başlangıç tarihi. * @param {string} [endDate] Abonelik bitiş tarihi. * @param {SearchInSubscriptionsSubscriptionStatusEnum} [subscriptionStatus] Abonelik durumu. * @param {string} [pricingPlanReferenceCode] Abonelikte kullanılan plan refereans numarası. * @param {string} [customerReferenceCode] Müşteri referans kodu. * @param {string} [parentReferenceCode] Abonelik güncellemelerinde üye işeyerinin eşleştirme yapılabileceği eşsiz referans kodu. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SubscriptionsApiInterface */ searchInSubscriptions(page: number, count: number, subscriptionReferenceCode?: string, startDate?: string, endDate?: string, subscriptionStatus?: SearchInSubscriptionsSubscriptionStatusEnum, pricingPlanReferenceCode?: string, customerReferenceCode?: string, parentReferenceCode?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Abonelik planını abonelik süresince değiştirmek veya yükseltmek mümkündür. Bunun için tek gerekli koşul, güncelleme yapılacak yeni plan, aboneliğin bağlı olduğu mevcut ürüne ait olmalıdır. NOT : Güncelleme yapılacak planların PaymentInterval ve PaymentIntervalCount parametreleri aynı olmalıdır. * @summary Upgrade Subscription * @param {string} subscriptionReferenceCode Abonelik referans kodu * @param {UpgradeSubscriptionRequest} [upgradeSubscriptionRequest] UpgradeSubscriptionRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SubscriptionsApiInterface */ upgradeSubscription(subscriptionReferenceCode: string, upgradeSubscriptionRequest?: UpgradeSubscriptionRequest, options?: RawAxiosRequestConfig): AxiosPromise; } /** * SubscriptionsApi - object-oriented interface * @export * @class SubscriptionsApi * @extends {BaseAPI} */ export declare class SubscriptionsApi extends BaseAPI implements SubscriptionsApiInterface { /** * PENDING ( Beklemede ) durumunda olan aboneliği aktifleştirir. * @summary Activate Subscription * @param {string} subscriptionReferenceCode Abonelik için üretilen eşsiz referans kodu. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SubscriptionsApi */ activateSubscription(subscriptionReferenceCode: string, options?: RawAxiosRequestConfig): Promise>; /** * Bir aboneliği iptal etmeye yarar * @summary Cancel Subscription * @param {string} subscriptionReferenceCode Reference code of the subscription * @param {LocaleAndConversationId} [localeAndConversationId] CancelSubscriptionRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SubscriptionsApi */ cancelSubscription(subscriptionReferenceCode: string, localeAndConversationId?: LocaleAndConversationId, options?: RawAxiosRequestConfig): Promise>; /** * Bir aboneliğin detaylarını getirir. * @summary Get Subscription * @param {string} subscriptionReferenceCode Abonelik referans kodu * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SubscriptionsApi */ getSubscription(subscriptionReferenceCode: string, options?: RawAxiosRequestConfig): Promise>; /** * Abonelikler arasında arama yapar. * @summary Search In Subscriptions * @param {number} page Page number * @param {number} count Count of items * @param {string} [subscriptionReferenceCode] Abonelik referans kodu * @param {string} [startDate] Abonelik başlangıç tarihi. * @param {string} [endDate] Abonelik bitiş tarihi. * @param {SearchInSubscriptionsSubscriptionStatusEnum} [subscriptionStatus] Abonelik durumu. * @param {string} [pricingPlanReferenceCode] Abonelikte kullanılan plan refereans numarası. * @param {string} [customerReferenceCode] Müşteri referans kodu. * @param {string} [parentReferenceCode] Abonelik güncellemelerinde üye işeyerinin eşleştirme yapılabileceği eşsiz referans kodu. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SubscriptionsApi */ searchInSubscriptions(page: number, count: number, subscriptionReferenceCode?: string, startDate?: string, endDate?: string, subscriptionStatus?: SearchInSubscriptionsSubscriptionStatusEnum, pricingPlanReferenceCode?: string, customerReferenceCode?: string, parentReferenceCode?: string, options?: RawAxiosRequestConfig): Promise>; /** * Abonelik planını abonelik süresince değiştirmek veya yükseltmek mümkündür. Bunun için tek gerekli koşul, güncelleme yapılacak yeni plan, aboneliğin bağlı olduğu mevcut ürüne ait olmalıdır. NOT : Güncelleme yapılacak planların PaymentInterval ve PaymentIntervalCount parametreleri aynı olmalıdır. * @summary Upgrade Subscription * @param {string} subscriptionReferenceCode Abonelik referans kodu * @param {UpgradeSubscriptionRequest} [upgradeSubscriptionRequest] UpgradeSubscriptionRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SubscriptionsApi */ upgradeSubscription(subscriptionReferenceCode: string, upgradeSubscriptionRequest?: UpgradeSubscriptionRequest, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const SearchInSubscriptionsSubscriptionStatusEnum: { readonly ACTIVE: "ACTIVE"; readonly PENDING: "PENDING"; }; export type SearchInSubscriptionsSubscriptionStatusEnum = typeof SearchInSubscriptionsSubscriptionStatusEnum[keyof typeof SearchInSubscriptionsSubscriptionStatusEnum];