wallee/dist/services/SubscribersService.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 { SortingOrder, Subscriber, SubscriberCreate, SubscriberListResponse, SubscriberSearchResponse, SubscriberUpdate } from '../models/index';
export interface DeleteSubscriptionsSubscribersIdRequest {
    id: number;
    space: number;
}
export interface GetSubscriptionsSubscribersRequest {
    space: number;
    after?: number;
    before?: number;
    expand?: Set<string>;
    limit?: number;
    order?: SortingOrder;
}
export interface GetSubscriptionsSubscribersIdRequest {
    id: number;
    space: number;
    expand?: Set<string>;
}
export interface GetSubscriptionsSubscribersSearchRequest {
    space: number;
    expand?: Set<string>;
    limit?: number;
    offset?: number;
    order?: string;
    query?: string;
}
export interface PatchSubscriptionsSubscribersIdRequest {
    id: number;
    space: number;
    subscriberUpdate: SubscriberUpdate;
    expand?: Set<string>;
}
export interface PostSubscriptionsSubscribersRequest {
    space: number;
    subscriberCreate: SubscriberCreate;
    expand?: Set<string>;
}
/**
 *
 */
export declare class SubscribersService extends runtime.BaseAPI {
    constructor(configuration: runtime.Configuration);
    /**
     * Delete a subscriber
     
     */
    deleteSubscriptionsSubscribersIdRaw(requestParameters: DeleteSubscriptionsSubscribersIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     * Delete a subscriber
     
     */
    deleteSubscriptionsSubscribersId(requestParameters: DeleteSubscriptionsSubscribersIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     * List all subscribers
     
     */
    getSubscriptionsSubscribersRaw(requestParameters: GetSubscriptionsSubscribersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubscriberListResponse>>;
    /**
     * List all subscribers
     
     */
    getSubscriptionsSubscribers(requestParameters: GetSubscriptionsSubscribersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubscriberListResponse>;
    /**
     * Retrieve a subscriber
     
     */
    getSubscriptionsSubscribersIdRaw(requestParameters: GetSubscriptionsSubscribersIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Subscriber>>;
    /**
     * Retrieve a subscriber
     
     */
    getSubscriptionsSubscribersId(requestParameters: GetSubscriptionsSubscribersIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Subscriber>;
    /**
     * Search subscribers
     
     */
    getSubscriptionsSubscribersSearchRaw(requestParameters: GetSubscriptionsSubscribersSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubscriberSearchResponse>>;
    /**
     * Search subscribers
     
     */
    getSubscriptionsSubscribersSearch(requestParameters: GetSubscriptionsSubscribersSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubscriberSearchResponse>;
    /**
     * Update a subscriber
     
     */
    patchSubscriptionsSubscribersIdRaw(requestParameters: PatchSubscriptionsSubscribersIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Subscriber>>;
    /**
     * Update a subscriber
     
     */
    patchSubscriptionsSubscribersId(requestParameters: PatchSubscriptionsSubscribersIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Subscriber>;
    /**
     * Create a subscriber
     
     */
    postSubscriptionsSubscribersRaw(requestParameters: PostSubscriptionsSubscribersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Subscriber>>;
    /**
     * Create a subscriber
     
     */
    postSubscriptionsSubscribers(requestParameters: PostSubscriptionsSubscribersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Subscriber>;
}