All files / types/api departments.ts

0% Statements 0/29
100% Branches 1/1
100% Functions 1/1
0% Lines 0/29

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                                                                                                                                                                                         
import {
  api400Body, api401Body, api403Body, api500Body
} from './_shared';
 
import { TwilioAccounts } from '@/types/backend/department';
import { Validator } from '@/types/backend/validation';
 
export interface BillingItem {
  type: 'aws' | 'twilio';
  cat: string;
  price: number;
  usage: number;
  usageUnit: string;
}
 
/**
 * Get a departments bill
 * @summary Get Department Bill
 * @tags Departments
 * @body.contentType application/json
 */
export type GetDepartmentApi = {
  path: '/api/v2/departments/{id}/';
  method: 'GET';
  params: { id: Exclude<TwilioAccounts, ''> | 'all'; }
  query: { month?: 'this' | 'last'; };
  responses: {
 
    /**
     * @contentType application/json
     */
    200: {
      start: string;
      end: string;
      items: BillingItem[];
    };
 
    /**
     * @contentType application/json
     */
    400: typeof api400Body;
 
    /**
     * @contentType application/json
     */
    401: typeof api401Body;
 
    /**
     * @contentType application/json
     */
    403: typeof api403Body;
 
    /**
     * @contentType application/json
     */
    500: typeof api500Body;
  };
  security: [{
    cookie: [],
  }];
};
 
export const getDepartmentApiParamsValidator: Validator<GetDepartmentApi['params']> = {
  id: {
    required: true,
    types: {
      string: {
        exact: [
          'all',
          'Baca',
          'Crestone',
          'NSCAD',
          'Saguache',
        ],
      },
    },
  },
};
 
export const getDepartmentApiQueryValidator: Validator<GetDepartmentApi['query']> = {
  month: {
    required: false,
    types: {
      string: {
        exact: [
          'last',
          'this',
        ],
      },
    },
  },
};