All files / codegen/apis CreditsApi.ts

44.06% Statements 141/320
100% Branches 0/0
0% Functions 0/12
44.06% Lines 141/320

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 3211x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x                                                         1x 1x 1x 1x 1x 1x       1x 1x 1x 1x 1x 1x                                                   1x 1x 1x 1x 1x 1x     1x 1x 1x 1x 1x 1x                                                         1x 1x 1x 1x 1x 1x     1x 1x 1x 1x 1x 1x                                                         1x 1x 1x 1x 1x 1x       1x 1x 1x 1x 1x 1x                                                           1x 1x 1x 1x 1x 1x       1x 1x 1x 1x 1x 1x                                                   1x 1x 1x 1x 1x 1x       1x 1x  
/* tslint:disable */
/* eslint-disable */
/**
 * Octane API
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * The version of the OpenAPI document: 1.0.0
 * 
 *
 * 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 {
    CreateCreditGrantArgs,
    CreateCreditGrantArgsFromJSON,
    CreateCreditGrantArgsToJSON,
    CreditGrant,
    CreditGrantFromJSON,
    CreditGrantToJSON,
    CreditLedger,
    CreditLedgerFromJSON,
    CreditLedgerToJSON,
    ListCreditGrants,
    ListCreditGrantsFromJSON,
    ListCreditGrantsToJSON,
    ListCreditGrantsArgs,
    ListCreditGrantsArgsFromJSON,
    ListCreditGrantsArgsToJSON,
    VoidCreditGrantArgs,
    VoidCreditGrantArgsFromJSON,
    VoidCreditGrantArgsToJSON,
} from '../models';
 
export interface CreditsGrantGetRequest {
    listCreditGrantsArgs: ListCreditGrantsArgs;
}
 
export interface CreditsGrantGrantUuidGrantPostRequest {
    grantUuid: string;
}
 
export interface CreditsGrantGrantUuidVoidPostRequest {
    grantUuid: string;
    voidCreditGrantArgs?: VoidCreditGrantArgs;
}
 
export interface CreditsGrantPostRequest {
    createCreditGrantArgs: CreateCreditGrantArgs;
}
 
export interface CreditsLedgerCustomerNameAsOfStrGetRequest {
    asOfStr: string;
    customerName: string;
}
 
export interface CreditsLedgerCustomerNameGetRequest {
    customerName: string;
}
 
/**
 * 
 */
export class CreditsApi extends runtime.BaseAPI {
 
    /**
     * Returns all the credit grants under your account.
     * Get Credit Grants
     */
    async creditsGrantGetRaw(requestParameters: CreditsGrantGetRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ListCreditGrants>> {
        if (requestParameters.listCreditGrantsArgs === null || requestParameters.listCreditGrantsArgs === undefined) {
            throw new runtime.RequiredError('listCreditGrantsArgs','Required parameter requestParameters.listCreditGrantsArgs was null or undefined when calling creditsGrantGet.');
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

        headerParameters['Content-Type'] = 'application/json';

        if (this.configuration && this.configuration.accessToken) {
            const token = this.configuration.accessToken;
            const tokenString = await token("BearerApiKeyAuth", []);

            if (tokenString) {
                headerParameters["Authorization"] = `Bearer ${tokenString}`;
            }
        }
        const response = await this.request({
            path: `/credits/grant/`,
            method: 'GET',
            headers: headerParameters,
            query: queryParameters,
            body: ListCreditGrantsArgsToJSON(requestParameters.listCreditGrantsArgs),
        }, initOverrides);

        return new runtime.JSONApiResponse(response, (jsonValue) => ListCreditGrantsFromJSON(jsonValue));
    }
 
    /**
     * Returns all the credit grants under your account.
     * Get Credit Grants
     */
    async creditsGrantGet(requestParameters: CreditsGrantGetRequest, initOverrides?: RequestInit): Promise<ListCreditGrants> {
        const response = await this.creditsGrantGetRaw(requestParameters, initOverrides);
        return await response.value();
    }
 
    /**
     * Adds a credit grant to the ledger with the given grant UUID, if it was not immediately granted on creation.
     * Add Credit Grant to Ledger
     */
    async creditsGrantGrantUuidGrantPostRaw(requestParameters: CreditsGrantGrantUuidGrantPostRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>> {
        if (requestParameters.grantUuid === null || requestParameters.grantUuid === undefined) {
            throw new runtime.RequiredError('grantUuid','Required parameter requestParameters.grantUuid was null or undefined when calling creditsGrantGrantUuidGrantPost.');
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

        if (this.configuration && this.configuration.accessToken) {
            const token = this.configuration.accessToken;
            const tokenString = await token("BearerApiKeyAuth", []);

            if (tokenString) {
                headerParameters["Authorization"] = `Bearer ${tokenString}`;
            }
        }
        const response = await this.request({
            path: `/credits/grant/{grant_uuid}/grant`.replace(`{${"grant_uuid"}}`, encodeURIComponent(String(requestParameters.grantUuid))),
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);

        return new runtime.VoidApiResponse(response);
    }
 
    /**
     * Adds a credit grant to the ledger with the given grant UUID, if it was not immediately granted on creation.
     * Add Credit Grant to Ledger
     */
    async creditsGrantGrantUuidGrantPost(requestParameters: CreditsGrantGrantUuidGrantPostRequest, initOverrides?: RequestInit): Promise<void> {
        await this.creditsGrantGrantUuidGrantPostRaw(requestParameters, initOverrides);
    }
 
    /**
     * Deactivates a credit grant with the given grant UUID.
     * Void a Credit Grant
     */
    async creditsGrantGrantUuidVoidPostRaw(requestParameters: CreditsGrantGrantUuidVoidPostRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>> {
        if (requestParameters.grantUuid === null || requestParameters.grantUuid === undefined) {
            throw new runtime.RequiredError('grantUuid','Required parameter requestParameters.grantUuid was null or undefined when calling creditsGrantGrantUuidVoidPost.');
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

        headerParameters['Content-Type'] = 'application/json';

        if (this.configuration && this.configuration.accessToken) {
            const token = this.configuration.accessToken;
            const tokenString = await token("BearerApiKeyAuth", []);

            if (tokenString) {
                headerParameters["Authorization"] = `Bearer ${tokenString}`;
            }
        }
        const response = await this.request({
            path: `/credits/grant/{grant_uuid}/void`.replace(`{${"grant_uuid"}}`, encodeURIComponent(String(requestParameters.grantUuid))),
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
            body: VoidCreditGrantArgsToJSON(requestParameters.voidCreditGrantArgs),
        }, initOverrides);

        return new runtime.VoidApiResponse(response);
    }
 
    /**
     * Deactivates a credit grant with the given grant UUID.
     * Void a Credit Grant
     */
    async creditsGrantGrantUuidVoidPost(requestParameters: CreditsGrantGrantUuidVoidPostRequest, initOverrides?: RequestInit): Promise<void> {
        await this.creditsGrantGrantUuidVoidPostRaw(requestParameters, initOverrides);
    }
 
    /**
     * Creates a credit grant for one of your customers.
     * Create a Credit Grant
     */
    async creditsGrantPostRaw(requestParameters: CreditsGrantPostRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<CreditGrant>> {
        if (requestParameters.createCreditGrantArgs === null || requestParameters.createCreditGrantArgs === undefined) {
            throw new runtime.RequiredError('createCreditGrantArgs','Required parameter requestParameters.createCreditGrantArgs was null or undefined when calling creditsGrantPost.');
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

        headerParameters['Content-Type'] = 'application/json';

        if (this.configuration && this.configuration.accessToken) {
            const token = this.configuration.accessToken;
            const tokenString = await token("BearerApiKeyAuth", []);

            if (tokenString) {
                headerParameters["Authorization"] = `Bearer ${tokenString}`;
            }
        }
        const response = await this.request({
            path: `/credits/grant/`,
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
            body: CreateCreditGrantArgsToJSON(requestParameters.createCreditGrantArgs),
        }, initOverrides);

        return new runtime.JSONApiResponse(response, (jsonValue) => CreditGrantFromJSON(jsonValue));
    }
 
    /**
     * Creates a credit grant for one of your customers.
     * Create a Credit Grant
     */
    async creditsGrantPost(requestParameters: CreditsGrantPostRequest, initOverrides?: RequestInit): Promise<CreditGrant> {
        const response = await this.creditsGrantPostRaw(requestParameters, initOverrides);
        return await response.value();
    }
 
    /**
     * Returns the credit ledger for one of your customers.
     * Fetch a Credit Ledger
     */
    async creditsLedgerCustomerNameAsOfStrGetRaw(requestParameters: CreditsLedgerCustomerNameAsOfStrGetRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<CreditLedger>>> {
        if (requestParameters.asOfStr === null || requestParameters.asOfStr === undefined) {
            throw new runtime.RequiredError('asOfStr','Required parameter requestParameters.asOfStr was null or undefined when calling creditsLedgerCustomerNameAsOfStrGet.');
        }

        if (requestParameters.customerName === null || requestParameters.customerName === undefined) {
            throw new runtime.RequiredError('customerName','Required parameter requestParameters.customerName was null or undefined when calling creditsLedgerCustomerNameAsOfStrGet.');
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

        if (this.configuration && this.configuration.accessToken) {
            const token = this.configuration.accessToken;
            const tokenString = await token("BearerApiKeyAuth", []);

            if (tokenString) {
                headerParameters["Authorization"] = `Bearer ${tokenString}`;
            }
        }
        const response = await this.request({
            path: `/credits/ledger/{customer_name}/{as_of_str}`.replace(`{${"as_of_str"}}`, encodeURIComponent(String(requestParameters.asOfStr))).replace(`{${"customer_name"}}`, encodeURIComponent(String(requestParameters.customerName))),
            method: 'GET',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);

        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(CreditLedgerFromJSON));
    }
 
    /**
     * Returns the credit ledger for one of your customers.
     * Fetch a Credit Ledger
     */
    async creditsLedgerCustomerNameAsOfStrGet(requestParameters: CreditsLedgerCustomerNameAsOfStrGetRequest, initOverrides?: RequestInit): Promise<Array<CreditLedger>> {
        const response = await this.creditsLedgerCustomerNameAsOfStrGetRaw(requestParameters, initOverrides);
        return await response.value();
    }
 
    /**
     * Returns the credit ledger for one of your customers.
     * Fetch a Credit Ledger
     */
    async creditsLedgerCustomerNameGetRaw(requestParameters: CreditsLedgerCustomerNameGetRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<CreditLedger>>> {
        if (requestParameters.customerName === null || requestParameters.customerName === undefined) {
            throw new runtime.RequiredError('customerName','Required parameter requestParameters.customerName was null or undefined when calling creditsLedgerCustomerNameGet.');
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

        if (this.configuration && this.configuration.accessToken) {
            const token = this.configuration.accessToken;
            const tokenString = await token("BearerApiKeyAuth", []);

            if (tokenString) {
                headerParameters["Authorization"] = `Bearer ${tokenString}`;
            }
        }
        const response = await this.request({
            path: `/credits/ledger/{customer_name}/`.replace(`{${"customer_name"}}`, encodeURIComponent(String(requestParameters.customerName))),
            method: 'GET',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);

        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(CreditLedgerFromJSON));
    }
 
    /**
     * Returns the credit ledger for one of your customers.
     * Fetch a Credit Ledger
     */
    async creditsLedgerCustomerNameGet(requestParameters: CreditsLedgerCustomerNameGetRequest, initOverrides?: RequestInit): Promise<Array<CreditLedger>> {
        const response = await this.creditsLedgerCustomerNameGetRaw(requestParameters, initOverrides);
        return await response.value();
    }
 
}