@ringer-tel/ivy/src/apis/StatementsApi.ts

TypeScript SDK for Ringer APIs

/* tslint:disable */
/* eslint-disable */
/**
 * Ringer Business API
 * This API provides comprehensive endpoints for the Ringer Business system. It includes functionality for managing customer accounts, addresses, sites, phone numbers, payments, users, and other business resources.  Operations typically require authentication and appropriate permissions. 
 *
 * The version of the OpenAPI document: 1.0.6
 * Contact: support@ringer.tel
 *
 * 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 {
  StatementListResponse,
  StatementResponse,
  StatementsComponentsSchemasError,
} from '../models/index';
import {
    StatementListResponseFromJSON,
    StatementListResponseToJSON,
    StatementResponseFromJSON,
    StatementResponseToJSON,
    StatementsComponentsSchemasErrorFromJSON,
    StatementsComponentsSchemasErrorToJSON,
} from '../models/index';

export interface GetStatementByIdRequest {
    id: number;
}

export interface ListStatementsRequest {
    pageSize?: number;
    page?: number;
}

/**
 * 
 */
export class StatementsApi extends runtime.BaseAPI {

    /**
     * Retrieves detailed information for a specific account statement by its ID.
     * Get Statement Details
     */
    async getStatementByIdRaw(requestParameters: GetStatementByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StatementResponse>> {
        if (requestParameters['id'] == null) {
            throw new runtime.RequiredError(
                'id',
                'Required parameter "id" was null or undefined when calling getStatementById().'
            );
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

        if (this.configuration && this.configuration.accessToken) {
            // oauth required
            headerParameters["Authorization"] = await this.configuration.accessToken("oAuth2", []);
        }

        const response = await this.request({
            path: `/statements/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
            method: 'GET',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);

        return new runtime.JSONApiResponse(response, (jsonValue) => StatementResponseFromJSON(jsonValue));
    }

    /**
     * Retrieves detailed information for a specific account statement by its ID.
     * Get Statement Details
     */
    async getStatementById(requestParameters: GetStatementByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StatementResponse> {
        const response = await this.getStatementByIdRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Retrieves a list of account statements (receipts) for the authenticated user\'s account. Statements are generated at the end of each service interval (e.g., monthly) and are typically paginated. 
     * List Account Statements
     */
    async listStatementsRaw(requestParameters: ListStatementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StatementListResponse>> {
        const queryParameters: any = {};

        if (requestParameters['pageSize'] != null) {
            queryParameters['page_size'] = requestParameters['pageSize'];
        }

        if (requestParameters['page'] != null) {
            queryParameters['page'] = requestParameters['page'];
        }

        const headerParameters: runtime.HTTPHeaders = {};

        if (this.configuration && this.configuration.accessToken) {
            // oauth required
            headerParameters["Authorization"] = await this.configuration.accessToken("oAuth2", []);
        }

        const response = await this.request({
            path: `/statements`,
            method: 'GET',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);

        return new runtime.JSONApiResponse(response, (jsonValue) => StatementListResponseFromJSON(jsonValue));
    }

    /**
     * Retrieves a list of account statements (receipts) for the authenticated user\'s account. Statements are generated at the end of each service interval (e.g., monthly) and are typically paginated. 
     * List Account Statements
     */
    async listStatements(requestParameters: ListStatementsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StatementListResponse> {
        const response = await this.listStatementsRaw(requestParameters, initOverrides);
        return await response.value();
    }

}