@dodi-smart/nuki-graphql-api/dist/api/services/AddressService.d.ts

Nuki GraphQL API

import type { Address } from '../models/Address';
import type { AddressCreate } from '../models/AddressCreate';
import type { AddressUnit } from '../models/AddressUnit';
import type { AddressUnitResponse } from '../models/AddressUnitResponse';
import type { AddressUpdate } from '../models/AddressUpdate';
import type { AdvancedConfirmationResponse } from '../models/AdvancedConfirmationResponse';
import type { CancelablePromise } from '../core/CancelablePromise';
import type { BaseHttpRequest } from '../core/BaseHttpRequest';
export declare class AddressService {
    readonly httpRequest: BaseHttpRequest;
    constructor(httpRequest: BaseHttpRequest);
    /**
     * Get a list of addresses
     * @returns Address successful operation
     * @throws ApiError
     */
    getAddresses(): CancelablePromise<Array<Address>>;
    /**
     * Create an address
     * @param requestBody Address create representation
     * @returns Address Ok
     * @throws ApiError
     */
    createAddress(requestBody: AddressCreate): CancelablePromise<Address>;
    /**
     * Update an address
     * @param addressId The address id
     * @param requestBody Address update representation
     * @returns void
     * @throws ApiError
     */
    updateAddress(addressId: number, requestBody: AddressUpdate): CancelablePromise<void>;
    /**
     * Delete an address
     * @param addressId The address id
     * @returns void
     * @throws ApiError
     */
    deleteAddress(addressId: number): CancelablePromise<void>;
    /**
     * Get a list of address units
     * @param addressId The address id
     * @returns AddressUnitResponse successful operation
     * @throws ApiError
     */
    getAddressUnits(addressId: number): CancelablePromise<Array<AddressUnitResponse>>;
    /**
     * Create an address unit
     * @param addressId The address id
     * @param requestBody Address unit representation
     * @returns AddressUnitResponse Ok
     * @throws ApiError
     */
    createAddressUnit(addressId: number, requestBody: AddressUnit): CancelablePromise<AddressUnitResponse>;
    /**
     * Deletes address units asynchronously
     * @param addressId The address id
     * @param requestBody Address unit IDs to delete
     * @returns AdvancedConfirmationResponse Ok
     * @throws ApiError
     */
    deleteAddressUnits(addressId: number, requestBody: Array<string>): CancelablePromise<AdvancedConfirmationResponse>;
    /**
     * Delete an address unit
     * @param addressId The address id
     * @param id The address unit id
     * @returns AdvancedConfirmationResponse Ok
     * @throws ApiError
     */
    deleteAddressUnit(addressId: number, id: string): CancelablePromise<AdvancedConfirmationResponse>;
}
//# sourceMappingURL=AddressService.d.ts.map