@xompass/sdk-cloud-api/models/ApiKey.ts

Xompass Client for cloud-api

import {ModelDefinition} from './BaseModels';
import {Customer} from './Customer';
import {Log} from './Log';
import {RateLimit} from './RateLimit';
declare var Object: any;

export interface ApiKeyInterface {
  name: string;
  id?: string;
  ttl?: number;
  scopes?: Array<any>;
  enabled?: boolean;
  testMode?: boolean;
  created?: Date;
  modified?: Date;
  deleted?: Date;
  customerId?: any;
  _rateLimit?: any;
  customer?: Customer;
  trackingLogs?: Log[];
  rateLimit?: RateLimit[];
}

export class ApiKey implements ApiKeyInterface {
  name: string;
  id: string;
  ttl: number = 1209600;
  scopes: Array<any>;
  enabled: boolean = true;
  testMode: boolean;
  created: Date;
  modified: Date;
  deleted: Date;
  customerId: any;
  _rateLimit: any;
  customer?: Customer;
  trackingLogs?: Log[];
  rateLimit?: RateLimit[];
  constructor(data?: ApiKeyInterface) {
    Object.assign(this, data);
  }

  /**
   * The name of the model represented by this $resource,
   * i.e. `ApiKey`.
   */
  public static getModelName(): string {
    return 'ApiKey';
  }

  /**
   * @method factory
   * @author Jonathan Casarrubias
   * @license MIT
   * This method creates an instance of ApiKey for dynamic purposes.
   */
  public static factory(data: ApiKeyInterface): ApiKey{
    return new ApiKey(data);
  }

  /**
   * @method getModelDefinition
   * @author Julien Ledun
   * @license MIT
   * This method returns an object that represents some of the model
   * definitions.
   */
  public static getModelDefinition(): ModelDefinition {
    return {
      name: 'ApiKey',
      plural: 'ApiKeys',
      path: 'ApiKeys',
      idName: 'id',
      properties: {
        name: {
          name: 'name',
          type: 'string'
        },
        id: {
          name: 'id',
          type: 'string'
        },
        ttl: {
          name: 'ttl',
          type: 'number',
          default: 1209600
        },
        scopes: {
          name: 'scopes',
          type: 'Array&lt;any&gt;'
        },
        enabled: {
          name: 'enabled',
          type: 'boolean',
          default: true
        },
        testMode: {
          name: 'testMode',
          type: 'boolean'
        },
        created: {
          name: 'created',
          type: 'Date'
        },
        modified: {
          name: 'modified',
          type: 'Date'
        },
        deleted: {
          name: 'deleted',
          type: 'Date',
          default: undefined
        },
        customerId: {
          name: 'customerId',
          type: 'any'
        },
        _rateLimit: {
          name: '_rateLimit',
          type: 'any'
        },
      },
      relations: {
        customer: {
          name: 'customer',
          type: 'Customer',
          model: 'Customer',
          relationType: 'belongsTo',
          keyFrom: 'customerId',
          keyTo: 'id'
        },
        trackingLogs: {
          name: 'trackingLogs',
          type: 'Log[]',
          model: 'Log',
          relationType: 'hasMany',
          keyFrom: 'id',
          keyTo: 'trackingModelId'
        },
        rateLimit: {
          name: 'rateLimit',
          type: 'RateLimit[]',
          model: 'RateLimit',
          relationType: 'embedsOne',
          keyFrom: '_rateLimit',
          keyTo: 'id'
        },
      }
    };
  }
}