wallee/dist/esm/services/SubscriptionsService.d.ts

TypeScript/JavaScript client for wallee

/**
 * Wallee AG TypeScript SDK
 *
 * This library allows to interact with the Wallee AG payment service.
 *
 * Copyright owner: Wallee AG
 * Website: https://en.wallee.com
 * Developer email: ecosystem-team@wallee.com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import * as runtime from '../runtime';
import type { InvoiceSearchResponse, SortingOrder, Subscription, SubscriptionCharge, SubscriptionCreateRequest, SubscriptionInitializeSubscriberPresentRequest, SubscriptionListResponse, SubscriptionSearchResponse, SubscriptionSuspension, SubscriptionUpdateRequest, SubscriptionVersion, SuspensionCreationRequest } from '../models/index';
export interface GetSubscriptionsRequest {
    space: number;
    after?: number;
    before?: number;
    expand?: Set<string>;
    limit?: number;
    order?: SortingOrder;
}
export interface GetSubscriptionsIdRequest {
    id: number;
    space: number;
    expand?: Set<string>;
}
export interface GetSubscriptionsIdInvoicesRequest {
    id: number;
    space: number;
    expand?: Set<string>;
    limit?: number;
    offset?: number;
    order?: string;
    query?: string;
}
export interface GetSubscriptionsSearchRequest {
    space: number;
    expand?: Set<string>;
    limit?: number;
    offset?: number;
    order?: string;
    query?: string;
}
export interface PatchSubscriptionsIdRequest {
    id: number;
    space: number;
    subscriptionUpdateRequest: SubscriptionUpdateRequest;
    expand?: Set<string>;
}
export interface PostSubscriptionsRequest {
    space: number;
    subscriptionCreateRequest: SubscriptionCreateRequest;
    expand?: Set<string>;
}
export interface PostSubscriptionsIdApplyChangesRequest {
    id: number;
    space: number;
    subscriptionUpdateRequest: SubscriptionUpdateRequest;
    expand?: Set<string>;
}
export interface PostSubscriptionsIdInitializeRequest {
    id: number;
    space: number;
    expand?: Set<string>;
}
export interface PostSubscriptionsIdInitializeSubscriberPresentRequest {
    id: number;
    space: number;
    subscriptionInitializeSubscriberPresentRequest: SubscriptionInitializeSubscriberPresentRequest;
    expand?: Set<string>;
}
export interface PostSubscriptionsIdReactivateRequest {
    id: number;
    space: number;
}
export interface PostSubscriptionsIdSuspendRequest {
    id: number;
    space: number;
    suspensionCreationRequest: SuspensionCreationRequest;
    expand?: Set<string>;
}
export interface PostSubscriptionsIdTerminateRequest {
    id: number;
    respectTerminationPeriod: boolean;
    space: number;
}
export interface PostSubscriptionsIdUpgradeProductRequest {
    id: number;
    respectTerminationPeriod: boolean;
    space: number;
    expand?: Set<string>;
}
/**
 *
 */
export declare class SubscriptionsService extends runtime.BaseAPI {
    constructor(configuration: runtime.Configuration);
    /**
     * List all subscriptions
     
     */
    getSubscriptionsRaw(requestParameters: GetSubscriptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubscriptionListResponse>>;
    /**
     * List all subscriptions
     
     */
    getSubscriptions(requestParameters: GetSubscriptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubscriptionListResponse>;
    /**
     * Retrieve a subscription
     
     */
    getSubscriptionsIdRaw(requestParameters: GetSubscriptionsIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Subscription>>;
    /**
     * Retrieve a subscription
     
     */
    getSubscriptionsId(requestParameters: GetSubscriptionsIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Subscription>;
    /**
     * Search subscription invoices
     
     */
    getSubscriptionsIdInvoicesRaw(requestParameters: GetSubscriptionsIdInvoicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InvoiceSearchResponse>>;
    /**
     * Search subscription invoices
     
     */
    getSubscriptionsIdInvoices(requestParameters: GetSubscriptionsIdInvoicesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InvoiceSearchResponse>;
    /**
     * Search subscriptions
     
     */
    getSubscriptionsSearchRaw(requestParameters: GetSubscriptionsSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubscriptionSearchResponse>>;
    /**
     * Search subscriptions
     
     */
    getSubscriptionsSearch(requestParameters: GetSubscriptionsSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubscriptionSearchResponse>;
    /**
     * Update a subscription
     
     */
    patchSubscriptionsIdRaw(requestParameters: PatchSubscriptionsIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Subscription>>;
    /**
     * Update a subscription
     
     */
    patchSubscriptionsId(requestParameters: PatchSubscriptionsIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Subscription>;
    /**
     * Create a subscription
     
     */
    postSubscriptionsRaw(requestParameters: PostSubscriptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubscriptionVersion>>;
    /**
     * Create a subscription
     
     */
    postSubscriptions(requestParameters: PostSubscriptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubscriptionVersion>;
    /**
     * Apply changes to a subscription
     
     */
    postSubscriptionsIdApplyChangesRaw(requestParameters: PostSubscriptionsIdApplyChangesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubscriptionVersion>>;
    /**
     * Apply changes to a subscription
     
     */
    postSubscriptionsIdApplyChanges(requestParameters: PostSubscriptionsIdApplyChangesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubscriptionVersion>;
    /**
     * Initialize a subscription
     
     */
    postSubscriptionsIdInitializeRaw(requestParameters: PostSubscriptionsIdInitializeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubscriptionCharge>>;
    /**
     * Initialize a subscription
     
     */
    postSubscriptionsIdInitialize(requestParameters: PostSubscriptionsIdInitializeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubscriptionCharge>;
    /**
     * Initialize a subscription with the subscriber present
     
     */
    postSubscriptionsIdInitializeSubscriberPresentRaw(requestParameters: PostSubscriptionsIdInitializeSubscriberPresentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubscriptionCharge>>;
    /**
     * Initialize a subscription with the subscriber present
     
     */
    postSubscriptionsIdInitializeSubscriberPresent(requestParameters: PostSubscriptionsIdInitializeSubscriberPresentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubscriptionCharge>;
    /**
     * Reactivate a suspended subscription
     
     */
    postSubscriptionsIdReactivateRaw(requestParameters: PostSubscriptionsIdReactivateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     * Reactivate a suspended subscription
     
     */
    postSubscriptionsIdReactivate(requestParameters: PostSubscriptionsIdReactivateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     * Suspend a subscription
     
     */
    postSubscriptionsIdSuspendRaw(requestParameters: PostSubscriptionsIdSuspendRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubscriptionSuspension>>;
    /**
     * Suspend a subscription
     
     */
    postSubscriptionsIdSuspend(requestParameters: PostSubscriptionsIdSuspendRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubscriptionSuspension>;
    /**
     * Terminate a subscription
     
     */
    postSubscriptionsIdTerminateRaw(requestParameters: PostSubscriptionsIdTerminateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     * Terminate a subscription
     
     */
    postSubscriptionsIdTerminate(requestParameters: PostSubscriptionsIdTerminateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     * Upgrade a subscription\'s product
     
     */
    postSubscriptionsIdUpgradeProductRaw(requestParameters: PostSubscriptionsIdUpgradeProductRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubscriptionVersion>>;
    /**
     * Upgrade a subscription\'s product
     
     */
    postSubscriptionsIdUpgradeProduct(requestParameters: PostSubscriptionsIdUpgradeProductRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubscriptionVersion>;
}