@getopenpay/client/apis/SubscriptionItemsApi.d.ts

OpenPay API TypeScript SDK

/**
 * OpenPay API
 * super charge your subscription management.
 *
 * The version of the OpenAPI document: 1.2.1
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import * as runtime from '../runtime';
import type { CreateSubscriptionItemRequest, DeleteSubscriptionItemRequest, DeleteSubscriptionItemResponse, ListResponseSubscriptionItemExternal, SubscriptionItemExternal, SubscriptionItemQueryParams, UpdateSubscriptionItemRequest } from '../models/index';
export interface CreateSubscriptionItemOperationRequest {
    createSubscriptionItemRequest: CreateSubscriptionItemRequest;
}
export interface DeleteSubscriptionItemOperationRequest {
    subscriptionItemId: string;
    deleteSubscriptionItemRequest: DeleteSubscriptionItemRequest;
}
export interface GetSubscriptionItemRequest {
    subscriptionItemId: string;
}
export interface ListSubscriptionItemsRequest {
    subscriptionItemQueryParams: SubscriptionItemQueryParams;
}
export interface UpdateSubscriptionItemOperationRequest {
    subscriptionItemId: string;
    updateSubscriptionItemRequest: UpdateSubscriptionItemRequest;
}
/**
 *
 */
export declare class SubscriptionItemsApi extends runtime.BaseAPI {
    /**
     * Adds a new item to an existing subscription. No existing items will be changed or replaced.
     * Create Subscription Item
     */
    createSubscriptionItemRaw(requestParameters: CreateSubscriptionItemOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubscriptionItemExternal>>;
    /**
     * Adds a new item to an existing subscription. No existing items will be changed or replaced.
     * Create Subscription Item
     */
    createSubscriptionItem(requestParameters: CreateSubscriptionItemOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubscriptionItemExternal>;
    /**
     * Deletes an item from the subscription. Removing a subscription item  from a subscription will not cancel the subscription. Default behaviour is to remove the subscription item at time of  renewing the subscription at next billing cycle. You can override  the behaviour by setting cancel_at_end as False. After successful call to this method with drop_at_end as True,  if you want to clear the flag, use update call with drop_at_end as False.
     * Delete Subscription Item
     */
    deleteSubscriptionItemRaw(requestParameters: DeleteSubscriptionItemOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteSubscriptionItemResponse>>;
    /**
     * Deletes an item from the subscription. Removing a subscription item  from a subscription will not cancel the subscription. Default behaviour is to remove the subscription item at time of  renewing the subscription at next billing cycle. You can override  the behaviour by setting cancel_at_end as False. After successful call to this method with drop_at_end as True,  if you want to clear the flag, use update call with drop_at_end as False.
     * Delete Subscription Item
     */
    deleteSubscriptionItem(requestParameters: DeleteSubscriptionItemOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteSubscriptionItemResponse>;
    /**
     * Get Subscription Item
     */
    getSubscriptionItemRaw(requestParameters: GetSubscriptionItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubscriptionItemExternal>>;
    /**
     * Get Subscription Item
     */
    getSubscriptionItem(requestParameters: GetSubscriptionItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubscriptionItemExternal>;
    /**
     * List Subscription Items
     */
    listSubscriptionItemsRaw(requestParameters: ListSubscriptionItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListResponseSubscriptionItemExternal>>;
    /**
     * List Subscription Items
     */
    listSubscriptionItems(requestParameters: ListSubscriptionItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListResponseSubscriptionItemExternal>;
    /**
     * Update Subscription Item
     */
    updateSubscriptionItemRaw(requestParameters: UpdateSubscriptionItemOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubscriptionItemExternal>>;
    /**
     * Update Subscription Item
     */
    updateSubscriptionItem(requestParameters: UpdateSubscriptionItemOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubscriptionItemExternal>;
}