@ringer-tel/ivy/models/ComponentsSchemasLink.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.5
 * 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 { mapValues } from '../runtime';
/**
 * Represents a HATEOAS link.
 * @export
 * @interface ComponentsSchemasLink
 */
export interface ComponentsSchemasLink {
    /**
     * The target URI of the link.
     * @type {string}
     * @memberof ComponentsSchemasLink
     */
    href: string;
    /**
     * The relation type of the link.
     * @type {string}
     * @memberof ComponentsSchemasLink
     */
    rel: string;
    /**
     * A human-readable title for the link.
     * @type {string}
     * @memberof ComponentsSchemasLink
     */
    title?: string | null;
    /**
     * The HTTP method to use for the link's action.
     * @type {string}
     * @memberof ComponentsSchemasLink
     */
    method?: ComponentsSchemasLinkMethodEnum;
}


/**
 * @export
 */
export const ComponentsSchemasLinkMethodEnum = {
    Get: 'GET',
    Post: 'POST',
    Put: 'PUT',
    Patch: 'PATCH',
    Delete: 'DELETE',
    Options: 'OPTIONS',
    Head: 'HEAD'
} as const;
export type ComponentsSchemasLinkMethodEnum = typeof ComponentsSchemasLinkMethodEnum[keyof typeof ComponentsSchemasLinkMethodEnum];


/**
 * Check if a given object implements the ComponentsSchemasLink interface.
 */
export function instanceOfComponentsSchemasLink(value: object): value is ComponentsSchemasLink {
    if (!('href' in value) || value['href'] === undefined) return false;
    if (!('rel' in value) || value['rel'] === undefined) return false;
    return true;
}

export function ComponentsSchemasLinkFromJSON(json: any): ComponentsSchemasLink {
    return ComponentsSchemasLinkFromJSONTyped(json, false);
}

export function ComponentsSchemasLinkFromJSONTyped(json: any, ignoreDiscriminator: boolean): ComponentsSchemasLink {
    if (json == null) {
        return json;
    }
    return {
        
        'href': json['href'],
        'rel': json['rel'],
        'title': json['title'] == null ? undefined : json['title'],
        'method': json['method'] == null ? undefined : json['method'],
    };
}

export function ComponentsSchemasLinkToJSON(json: any): ComponentsSchemasLink {
    return ComponentsSchemasLinkToJSONTyped(json, false);
}

export function ComponentsSchemasLinkToJSONTyped(value?: ComponentsSchemasLink | null, ignoreDiscriminator: boolean = false): any {
    if (value == null) {
        return value;
    }

    return {
        
        'href': value['href'],
        'rel': value['rel'],
        'title': value['title'],
        'method': value['method'],
    };
}