/** * 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 { CreateSubscriptionPricingPlan2XXResponse } from '../models'; import type { CreateSubscriptionPricingPlanRequest } from '../models'; import type { GetSubscriptionPricingPlan2XXResponse } from '../models'; import type { ListSubscriptionPricingPlans2XXResponse } from '../models'; import type { StatusAndSystemTime } from '../models'; import type { UpdateSubscriptionPricingPlan2XXResponse } from '../models'; import type { UpdateSubscriptionPricingPlanRequest } from '../models'; /** * SubscriptionPricingPlanManagementApi - axios parameter creator * @export */ export declare const SubscriptionPricingPlanManagementApiAxiosParamCreator: (configuration?: Configuration) => { /** * Bir plan oluşturmak için, ürün referans numarası, isim, fiyat, para birimi, ödeme periyodu gibi aşağıda detayları paylaşılan parametrelerlerin gönderilmesi gerekir. Bir aboneliğin deneme sürecinin olması istenirse trialPeriodDays parametresi kullanılabilir. Eğer bu parametre gönderilirse, belirtilen değer süresince abonelik başlatılmaz ve karttan hiçbir şekilde ödeme alınmaz. İstekte belirtilen Payment Interval parametresi ödeme periyodunu belirtir. Bir plan oluştururken “WEEKLY” parametresi gönderilirse, iyzico belirtilen tutarı her hafta karttan çekecektir. Bu periyodun özelleştirilmesi de mümkündür. Örneğin ödemenin 2 haftada bir alınmasını isterseniz, PaymentInterval değerini “WEEKLY” ve paymentIntervalCount değerini 2 olarak göndermeniz gerekmektedir. NOT : planPaymentType parametresi zorunludur ve şu an için sadece RECURRING değerini alabilir. * @summary Create Subscription Pricing Plan * @param {string} subscriptionProductReferenceCode Abonelik ürününün referans kodu * @param {CreateSubscriptionPricingPlanRequest} [createSubscriptionPricingPlanRequest] CreateSubscriptionPlanRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSubscriptionPricingPlan: (subscriptionProductReferenceCode: string, createSubscriptionPricingPlanRequest?: CreateSubscriptionPricingPlanRequest, options?: RawAxiosRequestConfig) => Promise; /** * Bir plan ancak kendisine bağlı herhangi bir abonelik yoksa silinebilir. Silme işlemi için üye işeyeri plan referans kodunu kullanmalıdır. İstek success veya failure olarak cevaplanır. Success ise plan başaırı ile silinmiş demektir. * @summary Delete Subscription Pricing Plan * @param {string} pricingPlanReferenceCode Abonelik ödeme planı referans kodu * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSubscriptionPricingPlan: (pricingPlanReferenceCode: string, options?: RawAxiosRequestConfig) => Promise; /** * Üye işyerleri bir planın tüm detaylarını hem merchant panelinden hem de API istekleri üzerinden görebilir. * @summary Get Subscription Pricing Plan * @param {string} pricingPlanReferenceCode Abonelik ödeme planı referans kodu * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSubscriptionPricingPlan: (pricingPlanReferenceCode: string, options?: RawAxiosRequestConfig) => Promise; /** * Tüm planlar ve bağlı olduğu ürünler bu istek sonucu görülebilir. Cevap sayfalar halinde iletilir * @summary List Subscription Pricing Plans * @param {number} page Page number * @param {number} count Count of items * @param {string} subscriptionProductReferenceCode Abonelik ürününün referans kodu * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSubscriptionPricingPlans: (page: number, count: number, subscriptionProductReferenceCode: string, options?: RawAxiosRequestConfig) => Promise; /** * Bu metod sadece name ve trialPeriodDays parametrelerinin güncellenmesine izin verir. Plan güncellemesi yapabilmek için o plana ait eşsiz referans kodu kullanılmalıdır. Güncellemenin hem API hem de iyzico merchant paneli üzerinden yapılması mümkündür. * @summary Update Subscription Pricing Plan * @param {string} pricingPlanReferenceCode Abonelik ödeme planı referans kodu * @param {UpdateSubscriptionPricingPlanRequest} [updateSubscriptionPricingPlanRequest] UpdateSubscriptionPricingPlanRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSubscriptionPricingPlan: (pricingPlanReferenceCode: string, updateSubscriptionPricingPlanRequest?: UpdateSubscriptionPricingPlanRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * SubscriptionPricingPlanManagementApi - functional programming interface * @export */ export declare const SubscriptionPricingPlanManagementApiFp: (configuration?: Configuration) => { /** * Bir plan oluşturmak için, ürün referans numarası, isim, fiyat, para birimi, ödeme periyodu gibi aşağıda detayları paylaşılan parametrelerlerin gönderilmesi gerekir. Bir aboneliğin deneme sürecinin olması istenirse trialPeriodDays parametresi kullanılabilir. Eğer bu parametre gönderilirse, belirtilen değer süresince abonelik başlatılmaz ve karttan hiçbir şekilde ödeme alınmaz. İstekte belirtilen Payment Interval parametresi ödeme periyodunu belirtir. Bir plan oluştururken “WEEKLY” parametresi gönderilirse, iyzico belirtilen tutarı her hafta karttan çekecektir. Bu periyodun özelleştirilmesi de mümkündür. Örneğin ödemenin 2 haftada bir alınmasını isterseniz, PaymentInterval değerini “WEEKLY” ve paymentIntervalCount değerini 2 olarak göndermeniz gerekmektedir. NOT : planPaymentType parametresi zorunludur ve şu an için sadece RECURRING değerini alabilir. * @summary Create Subscription Pricing Plan * @param {string} subscriptionProductReferenceCode Abonelik ürününün referans kodu * @param {CreateSubscriptionPricingPlanRequest} [createSubscriptionPricingPlanRequest] CreateSubscriptionPlanRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSubscriptionPricingPlan(subscriptionProductReferenceCode: string, createSubscriptionPricingPlanRequest?: CreateSubscriptionPricingPlanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Bir plan ancak kendisine bağlı herhangi bir abonelik yoksa silinebilir. Silme işlemi için üye işeyeri plan referans kodunu kullanmalıdır. İstek success veya failure olarak cevaplanır. Success ise plan başaırı ile silinmiş demektir. * @summary Delete Subscription Pricing Plan * @param {string} pricingPlanReferenceCode Abonelik ödeme planı referans kodu * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSubscriptionPricingPlan(pricingPlanReferenceCode: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Üye işyerleri bir planın tüm detaylarını hem merchant panelinden hem de API istekleri üzerinden görebilir. * @summary Get Subscription Pricing Plan * @param {string} pricingPlanReferenceCode Abonelik ödeme planı referans kodu * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSubscriptionPricingPlan(pricingPlanReferenceCode: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Tüm planlar ve bağlı olduğu ürünler bu istek sonucu görülebilir. Cevap sayfalar halinde iletilir * @summary List Subscription Pricing Plans * @param {number} page Page number * @param {number} count Count of items * @param {string} subscriptionProductReferenceCode Abonelik ürününün referans kodu * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSubscriptionPricingPlans(page: number, count: number, subscriptionProductReferenceCode: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Bu metod sadece name ve trialPeriodDays parametrelerinin güncellenmesine izin verir. Plan güncellemesi yapabilmek için o plana ait eşsiz referans kodu kullanılmalıdır. Güncellemenin hem API hem de iyzico merchant paneli üzerinden yapılması mümkündür. * @summary Update Subscription Pricing Plan * @param {string} pricingPlanReferenceCode Abonelik ödeme planı referans kodu * @param {UpdateSubscriptionPricingPlanRequest} [updateSubscriptionPricingPlanRequest] UpdateSubscriptionPricingPlanRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSubscriptionPricingPlan(pricingPlanReferenceCode: string, updateSubscriptionPricingPlanRequest?: UpdateSubscriptionPricingPlanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * SubscriptionPricingPlanManagementApi - factory interface * @export */ export declare const SubscriptionPricingPlanManagementApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Bir plan oluşturmak için, ürün referans numarası, isim, fiyat, para birimi, ödeme periyodu gibi aşağıda detayları paylaşılan parametrelerlerin gönderilmesi gerekir. Bir aboneliğin deneme sürecinin olması istenirse trialPeriodDays parametresi kullanılabilir. Eğer bu parametre gönderilirse, belirtilen değer süresince abonelik başlatılmaz ve karttan hiçbir şekilde ödeme alınmaz. İstekte belirtilen Payment Interval parametresi ödeme periyodunu belirtir. Bir plan oluştururken “WEEKLY” parametresi gönderilirse, iyzico belirtilen tutarı her hafta karttan çekecektir. Bu periyodun özelleştirilmesi de mümkündür. Örneğin ödemenin 2 haftada bir alınmasını isterseniz, PaymentInterval değerini “WEEKLY” ve paymentIntervalCount değerini 2 olarak göndermeniz gerekmektedir. NOT : planPaymentType parametresi zorunludur ve şu an için sadece RECURRING değerini alabilir. * @summary Create Subscription Pricing Plan * @param {string} subscriptionProductReferenceCode Abonelik ürününün referans kodu * @param {CreateSubscriptionPricingPlanRequest} [createSubscriptionPricingPlanRequest] CreateSubscriptionPlanRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSubscriptionPricingPlan(subscriptionProductReferenceCode: string, createSubscriptionPricingPlanRequest?: CreateSubscriptionPricingPlanRequest, options?: any): AxiosPromise; /** * Bir plan ancak kendisine bağlı herhangi bir abonelik yoksa silinebilir. Silme işlemi için üye işeyeri plan referans kodunu kullanmalıdır. İstek success veya failure olarak cevaplanır. Success ise plan başaırı ile silinmiş demektir. * @summary Delete Subscription Pricing Plan * @param {string} pricingPlanReferenceCode Abonelik ödeme planı referans kodu * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSubscriptionPricingPlan(pricingPlanReferenceCode: string, options?: any): AxiosPromise; /** * Üye işyerleri bir planın tüm detaylarını hem merchant panelinden hem de API istekleri üzerinden görebilir. * @summary Get Subscription Pricing Plan * @param {string} pricingPlanReferenceCode Abonelik ödeme planı referans kodu * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSubscriptionPricingPlan(pricingPlanReferenceCode: string, options?: any): AxiosPromise; /** * Tüm planlar ve bağlı olduğu ürünler bu istek sonucu görülebilir. Cevap sayfalar halinde iletilir * @summary List Subscription Pricing Plans * @param {number} page Page number * @param {number} count Count of items * @param {string} subscriptionProductReferenceCode Abonelik ürününün referans kodu * @param {*} [options] Override http request option. * @throws {RequiredError} */ listSubscriptionPricingPlans(page: number, count: number, subscriptionProductReferenceCode: string, options?: any): AxiosPromise; /** * Bu metod sadece name ve trialPeriodDays parametrelerinin güncellenmesine izin verir. Plan güncellemesi yapabilmek için o plana ait eşsiz referans kodu kullanılmalıdır. Güncellemenin hem API hem de iyzico merchant paneli üzerinden yapılması mümkündür. * @summary Update Subscription Pricing Plan * @param {string} pricingPlanReferenceCode Abonelik ödeme planı referans kodu * @param {UpdateSubscriptionPricingPlanRequest} [updateSubscriptionPricingPlanRequest] UpdateSubscriptionPricingPlanRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSubscriptionPricingPlan(pricingPlanReferenceCode: string, updateSubscriptionPricingPlanRequest?: UpdateSubscriptionPricingPlanRequest, options?: any): AxiosPromise; }; /** * SubscriptionPricingPlanManagementApi - interface * @export * @interface SubscriptionPricingPlanManagementApi */ export interface SubscriptionPricingPlanManagementApiInterface { /** * Bir plan oluşturmak için, ürün referans numarası, isim, fiyat, para birimi, ödeme periyodu gibi aşağıda detayları paylaşılan parametrelerlerin gönderilmesi gerekir. Bir aboneliğin deneme sürecinin olması istenirse trialPeriodDays parametresi kullanılabilir. Eğer bu parametre gönderilirse, belirtilen değer süresince abonelik başlatılmaz ve karttan hiçbir şekilde ödeme alınmaz. İstekte belirtilen Payment Interval parametresi ödeme periyodunu belirtir. Bir plan oluştururken “WEEKLY” parametresi gönderilirse, iyzico belirtilen tutarı her hafta karttan çekecektir. Bu periyodun özelleştirilmesi de mümkündür. Örneğin ödemenin 2 haftada bir alınmasını isterseniz, PaymentInterval değerini “WEEKLY” ve paymentIntervalCount değerini 2 olarak göndermeniz gerekmektedir. NOT : planPaymentType parametresi zorunludur ve şu an için sadece RECURRING değerini alabilir. * @summary Create Subscription Pricing Plan * @param {string} subscriptionProductReferenceCode Abonelik ürününün referans kodu * @param {CreateSubscriptionPricingPlanRequest} [createSubscriptionPricingPlanRequest] CreateSubscriptionPlanRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SubscriptionPricingPlanManagementApiInterface */ createSubscriptionPricingPlan(subscriptionProductReferenceCode: string, createSubscriptionPricingPlanRequest?: CreateSubscriptionPricingPlanRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Bir plan ancak kendisine bağlı herhangi bir abonelik yoksa silinebilir. Silme işlemi için üye işeyeri plan referans kodunu kullanmalıdır. İstek success veya failure olarak cevaplanır. Success ise plan başaırı ile silinmiş demektir. * @summary Delete Subscription Pricing Plan * @param {string} pricingPlanReferenceCode Abonelik ödeme planı referans kodu * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SubscriptionPricingPlanManagementApiInterface */ deleteSubscriptionPricingPlan(pricingPlanReferenceCode: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Üye işyerleri bir planın tüm detaylarını hem merchant panelinden hem de API istekleri üzerinden görebilir. * @summary Get Subscription Pricing Plan * @param {string} pricingPlanReferenceCode Abonelik ödeme planı referans kodu * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SubscriptionPricingPlanManagementApiInterface */ getSubscriptionPricingPlan(pricingPlanReferenceCode: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Tüm planlar ve bağlı olduğu ürünler bu istek sonucu görülebilir. Cevap sayfalar halinde iletilir * @summary List Subscription Pricing Plans * @param {number} page Page number * @param {number} count Count of items * @param {string} subscriptionProductReferenceCode Abonelik ürününün referans kodu * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SubscriptionPricingPlanManagementApiInterface */ listSubscriptionPricingPlans(page: number, count: number, subscriptionProductReferenceCode: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Bu metod sadece name ve trialPeriodDays parametrelerinin güncellenmesine izin verir. Plan güncellemesi yapabilmek için o plana ait eşsiz referans kodu kullanılmalıdır. Güncellemenin hem API hem de iyzico merchant paneli üzerinden yapılması mümkündür. * @summary Update Subscription Pricing Plan * @param {string} pricingPlanReferenceCode Abonelik ödeme planı referans kodu * @param {UpdateSubscriptionPricingPlanRequest} [updateSubscriptionPricingPlanRequest] UpdateSubscriptionPricingPlanRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SubscriptionPricingPlanManagementApiInterface */ updateSubscriptionPricingPlan(pricingPlanReferenceCode: string, updateSubscriptionPricingPlanRequest?: UpdateSubscriptionPricingPlanRequest, options?: RawAxiosRequestConfig): AxiosPromise; } /** * SubscriptionPricingPlanManagementApi - object-oriented interface * @export * @class SubscriptionPricingPlanManagementApi * @extends {BaseAPI} */ export declare class SubscriptionPricingPlanManagementApi extends BaseAPI implements SubscriptionPricingPlanManagementApiInterface { /** * Bir plan oluşturmak için, ürün referans numarası, isim, fiyat, para birimi, ödeme periyodu gibi aşağıda detayları paylaşılan parametrelerlerin gönderilmesi gerekir. Bir aboneliğin deneme sürecinin olması istenirse trialPeriodDays parametresi kullanılabilir. Eğer bu parametre gönderilirse, belirtilen değer süresince abonelik başlatılmaz ve karttan hiçbir şekilde ödeme alınmaz. İstekte belirtilen Payment Interval parametresi ödeme periyodunu belirtir. Bir plan oluştururken “WEEKLY” parametresi gönderilirse, iyzico belirtilen tutarı her hafta karttan çekecektir. Bu periyodun özelleştirilmesi de mümkündür. Örneğin ödemenin 2 haftada bir alınmasını isterseniz, PaymentInterval değerini “WEEKLY” ve paymentIntervalCount değerini 2 olarak göndermeniz gerekmektedir. NOT : planPaymentType parametresi zorunludur ve şu an için sadece RECURRING değerini alabilir. * @summary Create Subscription Pricing Plan * @param {string} subscriptionProductReferenceCode Abonelik ürününün referans kodu * @param {CreateSubscriptionPricingPlanRequest} [createSubscriptionPricingPlanRequest] CreateSubscriptionPlanRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SubscriptionPricingPlanManagementApi */ createSubscriptionPricingPlan(subscriptionProductReferenceCode: string, createSubscriptionPricingPlanRequest?: CreateSubscriptionPricingPlanRequest, options?: RawAxiosRequestConfig): Promise>; /** * Bir plan ancak kendisine bağlı herhangi bir abonelik yoksa silinebilir. Silme işlemi için üye işeyeri plan referans kodunu kullanmalıdır. İstek success veya failure olarak cevaplanır. Success ise plan başaırı ile silinmiş demektir. * @summary Delete Subscription Pricing Plan * @param {string} pricingPlanReferenceCode Abonelik ödeme planı referans kodu * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SubscriptionPricingPlanManagementApi */ deleteSubscriptionPricingPlan(pricingPlanReferenceCode: string, options?: RawAxiosRequestConfig): Promise>; /** * Üye işyerleri bir planın tüm detaylarını hem merchant panelinden hem de API istekleri üzerinden görebilir. * @summary Get Subscription Pricing Plan * @param {string} pricingPlanReferenceCode Abonelik ödeme planı referans kodu * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SubscriptionPricingPlanManagementApi */ getSubscriptionPricingPlan(pricingPlanReferenceCode: string, options?: RawAxiosRequestConfig): Promise>; /** * Tüm planlar ve bağlı olduğu ürünler bu istek sonucu görülebilir. Cevap sayfalar halinde iletilir * @summary List Subscription Pricing Plans * @param {number} page Page number * @param {number} count Count of items * @param {string} subscriptionProductReferenceCode Abonelik ürününün referans kodu * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SubscriptionPricingPlanManagementApi */ listSubscriptionPricingPlans(page: number, count: number, subscriptionProductReferenceCode: string, options?: RawAxiosRequestConfig): Promise>; /** * Bu metod sadece name ve trialPeriodDays parametrelerinin güncellenmesine izin verir. Plan güncellemesi yapabilmek için o plana ait eşsiz referans kodu kullanılmalıdır. Güncellemenin hem API hem de iyzico merchant paneli üzerinden yapılması mümkündür. * @summary Update Subscription Pricing Plan * @param {string} pricingPlanReferenceCode Abonelik ödeme planı referans kodu * @param {UpdateSubscriptionPricingPlanRequest} [updateSubscriptionPricingPlanRequest] UpdateSubscriptionPricingPlanRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SubscriptionPricingPlanManagementApi */ updateSubscriptionPricingPlan(pricingPlanReferenceCode: string, updateSubscriptionPricingPlanRequest?: UpdateSubscriptionPricingPlanRequest, options?: RawAxiosRequestConfig): Promise>; }