yellowgrid-api-ts 3.2.27-dev.0 → 3.2.28-dev.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/api.d.ts CHANGED
@@ -1567,6 +1567,170 @@ export interface EdTechProSetupModel {
1567
1567
  */
1568
1568
  'installed'?: boolean;
1569
1569
  }
1570
+ /**
1571
+ * Service Event DTO
1572
+ */
1573
+ export interface EventDTO {
1574
+ /**
1575
+ * Service Event Title
1576
+ */
1577
+ 'title'?: string;
1578
+ /**
1579
+ * Service Event Type
1580
+ */
1581
+ 'type'?: EventDTOTypeEnum;
1582
+ /**
1583
+ * Service Impacted
1584
+ */
1585
+ 'service'?: EventDTOServiceEnum;
1586
+ /**
1587
+ * Event Status Description
1588
+ */
1589
+ 'statusName'?: string;
1590
+ /**
1591
+ * Event Type Description
1592
+ */
1593
+ 'typeName'?: string;
1594
+ /**
1595
+ * Service Event ID
1596
+ */
1597
+ 'id'?: number;
1598
+ /**
1599
+ * Service Event Status
1600
+ */
1601
+ 'status'?: EventDTOStatusEnum;
1602
+ /**
1603
+ * Service Event Updates
1604
+ */
1605
+ 'updates'?: Array<EventUpdateDTO>;
1606
+ }
1607
+ export declare const EventDTOTypeEnum: {
1608
+ readonly NUMBER_0: 0;
1609
+ readonly NUMBER_1: 1;
1610
+ };
1611
+ export type EventDTOTypeEnum = typeof EventDTOTypeEnum[keyof typeof EventDTOTypeEnum];
1612
+ export declare const EventDTOServiceEnum: {
1613
+ readonly NUMBER_0: 0;
1614
+ readonly NUMBER_1: 1;
1615
+ };
1616
+ export type EventDTOServiceEnum = typeof EventDTOServiceEnum[keyof typeof EventDTOServiceEnum];
1617
+ export declare const EventDTOStatusEnum: {
1618
+ readonly NUMBER_0: 0;
1619
+ readonly NUMBER_1: 1;
1620
+ readonly NUMBER_2: 2;
1621
+ };
1622
+ export type EventDTOStatusEnum = typeof EventDTOStatusEnum[keyof typeof EventDTOStatusEnum];
1623
+ /**
1624
+ * Service Event Request DTO
1625
+ */
1626
+ export interface EventRequestDTO {
1627
+ /**
1628
+ * Service Event Title
1629
+ */
1630
+ 'title'?: string;
1631
+ /**
1632
+ * Service Event Type
1633
+ */
1634
+ 'type'?: EventRequestDTOTypeEnum;
1635
+ /**
1636
+ * Service Impacted
1637
+ */
1638
+ 'service'?: EventRequestDTOServiceEnum;
1639
+ }
1640
+ export declare const EventRequestDTOTypeEnum: {
1641
+ readonly NUMBER_0: 0;
1642
+ readonly NUMBER_1: 1;
1643
+ };
1644
+ export type EventRequestDTOTypeEnum = typeof EventRequestDTOTypeEnum[keyof typeof EventRequestDTOTypeEnum];
1645
+ export declare const EventRequestDTOServiceEnum: {
1646
+ readonly NUMBER_0: 0;
1647
+ readonly NUMBER_1: 1;
1648
+ };
1649
+ export type EventRequestDTOServiceEnum = typeof EventRequestDTOServiceEnum[keyof typeof EventRequestDTOServiceEnum];
1650
+ /**
1651
+ * Service Event Subscribption Model
1652
+ */
1653
+ export interface EventSubscriptionModel {
1654
+ /**
1655
+ * id
1656
+ */
1657
+ 'id'?: string;
1658
+ /**
1659
+ * email
1660
+ */
1661
+ 'email'?: string;
1662
+ }
1663
+ /**
1664
+ * Service Event Update DTO
1665
+ */
1666
+ export interface EventUpdateDTO {
1667
+ /**
1668
+ * Service Event Update Message
1669
+ */
1670
+ 'message'?: string;
1671
+ /**
1672
+ * Service Event Update Type
1673
+ */
1674
+ 'type'?: EventUpdateDTOTypeEnum;
1675
+ /**
1676
+ * Service Event Update Type Description
1677
+ */
1678
+ 'typeName'?: string;
1679
+ /**
1680
+ * Date Time
1681
+ */
1682
+ 'createdAt'?: string;
1683
+ }
1684
+ export declare const EventUpdateDTOTypeEnum: {
1685
+ readonly NUMBER_0: 0;
1686
+ readonly NUMBER_1: 1;
1687
+ readonly NUMBER_2: 2;
1688
+ };
1689
+ export type EventUpdateDTOTypeEnum = typeof EventUpdateDTOTypeEnum[keyof typeof EventUpdateDTOTypeEnum];
1690
+ /**
1691
+ * Event Update Entity
1692
+ */
1693
+ export interface EventUpdateEntity {
1694
+ /**
1695
+ * id
1696
+ */
1697
+ 'id'?: number;
1698
+ /**
1699
+ * eventId
1700
+ */
1701
+ 'eventId'?: number;
1702
+ /**
1703
+ * message
1704
+ */
1705
+ 'message'?: string;
1706
+ /**
1707
+ * type
1708
+ */
1709
+ 'type'?: number;
1710
+ /**
1711
+ * createdAt
1712
+ */
1713
+ 'createdAt'?: string;
1714
+ }
1715
+ /**
1716
+ * Service Event Update Request DTO
1717
+ */
1718
+ export interface EventUpdateRequestDTO {
1719
+ /**
1720
+ * Service Event Update Message
1721
+ */
1722
+ 'message'?: string;
1723
+ /**
1724
+ * Service Event Update Type
1725
+ */
1726
+ 'type'?: EventUpdateRequestDTOTypeEnum;
1727
+ }
1728
+ export declare const EventUpdateRequestDTOTypeEnum: {
1729
+ readonly NUMBER_0: 0;
1730
+ readonly NUMBER_1: 1;
1731
+ readonly NUMBER_2: 2;
1732
+ };
1733
+ export type EventUpdateRequestDTOTypeEnum = typeof EventUpdateRequestDTOTypeEnum[keyof typeof EventUpdateRequestDTOTypeEnum];
1570
1734
  /**
1571
1735
  * Fraud Management
1572
1736
  */
@@ -1741,170 +1905,6 @@ export declare const HostingRegionDTOCodeEnum: {
1741
1905
  readonly UsWestOr1: "US-WEST-OR-1";
1742
1906
  };
1743
1907
  export type HostingRegionDTOCodeEnum = typeof HostingRegionDTOCodeEnum[keyof typeof HostingRegionDTOCodeEnum];
1744
- /**
1745
- * Incident DTO
1746
- */
1747
- export interface IncidentDTO {
1748
- /**
1749
- * Incident Title
1750
- */
1751
- 'title'?: string;
1752
- /**
1753
- * Incident Severity
1754
- */
1755
- 'severity'?: IncidentDTOSeverityEnum;
1756
- /**
1757
- * Service Impacted
1758
- */
1759
- 'service'?: IncidentDTOServiceEnum;
1760
- /**
1761
- * Incident Status Description
1762
- */
1763
- 'statusName'?: string;
1764
- /**
1765
- * Incident Severity Description
1766
- */
1767
- 'severityName'?: string;
1768
- /**
1769
- * Incident ID
1770
- */
1771
- 'id'?: number;
1772
- /**
1773
- * Incident Status
1774
- */
1775
- 'status'?: IncidentDTOStatusEnum;
1776
- /**
1777
- * Incident Updates
1778
- */
1779
- 'updates'?: Array<IncidentUpdateDTO>;
1780
- }
1781
- export declare const IncidentDTOSeverityEnum: {
1782
- readonly NUMBER_0: 0;
1783
- readonly NUMBER_1: 1;
1784
- };
1785
- export type IncidentDTOSeverityEnum = typeof IncidentDTOSeverityEnum[keyof typeof IncidentDTOSeverityEnum];
1786
- export declare const IncidentDTOServiceEnum: {
1787
- readonly NUMBER_0: 0;
1788
- readonly NUMBER_1: 1;
1789
- };
1790
- export type IncidentDTOServiceEnum = typeof IncidentDTOServiceEnum[keyof typeof IncidentDTOServiceEnum];
1791
- export declare const IncidentDTOStatusEnum: {
1792
- readonly NUMBER_0: 0;
1793
- readonly NUMBER_1: 1;
1794
- readonly NUMBER_2: 2;
1795
- };
1796
- export type IncidentDTOStatusEnum = typeof IncidentDTOStatusEnum[keyof typeof IncidentDTOStatusEnum];
1797
- /**
1798
- * Incident Request DTO
1799
- */
1800
- export interface IncidentRequestDTO {
1801
- /**
1802
- * Incident Title
1803
- */
1804
- 'title'?: string;
1805
- /**
1806
- * Incident Severity
1807
- */
1808
- 'severity'?: IncidentRequestDTOSeverityEnum;
1809
- /**
1810
- * Service Impacted
1811
- */
1812
- 'service'?: IncidentRequestDTOServiceEnum;
1813
- }
1814
- export declare const IncidentRequestDTOSeverityEnum: {
1815
- readonly NUMBER_0: 0;
1816
- readonly NUMBER_1: 1;
1817
- };
1818
- export type IncidentRequestDTOSeverityEnum = typeof IncidentRequestDTOSeverityEnum[keyof typeof IncidentRequestDTOSeverityEnum];
1819
- export declare const IncidentRequestDTOServiceEnum: {
1820
- readonly NUMBER_0: 0;
1821
- readonly NUMBER_1: 1;
1822
- };
1823
- export type IncidentRequestDTOServiceEnum = typeof IncidentRequestDTOServiceEnum[keyof typeof IncidentRequestDTOServiceEnum];
1824
- /**
1825
- * Incident Subscribption Model
1826
- */
1827
- export interface IncidentSubscriptionModel {
1828
- /**
1829
- * id
1830
- */
1831
- 'id'?: string;
1832
- /**
1833
- * email
1834
- */
1835
- 'email'?: string;
1836
- }
1837
- /**
1838
- * Incident Update DTO
1839
- */
1840
- export interface IncidentUpdateDTO {
1841
- /**
1842
- * Incident Update Message
1843
- */
1844
- 'message'?: string;
1845
- /**
1846
- * Incident Update Type
1847
- */
1848
- 'type'?: IncidentUpdateDTOTypeEnum;
1849
- /**
1850
- * Incident Update Type Description
1851
- */
1852
- 'typeName'?: string;
1853
- /**
1854
- * Date Time
1855
- */
1856
- 'createdAt'?: string;
1857
- }
1858
- export declare const IncidentUpdateDTOTypeEnum: {
1859
- readonly NUMBER_0: 0;
1860
- readonly NUMBER_1: 1;
1861
- readonly NUMBER_2: 2;
1862
- };
1863
- export type IncidentUpdateDTOTypeEnum = typeof IncidentUpdateDTOTypeEnum[keyof typeof IncidentUpdateDTOTypeEnum];
1864
- /**
1865
- * IncidentUpdatesEntity
1866
- */
1867
- export interface IncidentUpdateEntity {
1868
- /**
1869
- * id
1870
- */
1871
- 'id'?: number;
1872
- /**
1873
- * incidentId
1874
- */
1875
- 'incidentId'?: number;
1876
- /**
1877
- * message
1878
- */
1879
- 'message'?: string;
1880
- /**
1881
- * type
1882
- */
1883
- 'type'?: number;
1884
- /**
1885
- * createdAt
1886
- */
1887
- 'createdAt'?: string;
1888
- }
1889
- /**
1890
- * Incident Update Request DTO
1891
- */
1892
- export interface IncidentUpdateRequestDTO {
1893
- /**
1894
- * Incident Update Message
1895
- */
1896
- 'message'?: string;
1897
- /**
1898
- * Incident Update Type
1899
- */
1900
- 'type'?: IncidentUpdateRequestDTOTypeEnum;
1901
- }
1902
- export declare const IncidentUpdateRequestDTOTypeEnum: {
1903
- readonly NUMBER_0: 0;
1904
- readonly NUMBER_1: 1;
1905
- readonly NUMBER_2: 2;
1906
- };
1907
- export type IncidentUpdateRequestDTOTypeEnum = typeof IncidentUpdateRequestDTOTypeEnum[keyof typeof IncidentUpdateRequestDTOTypeEnum];
1908
1908
  /**
1909
1909
  * InstanceFailoverIpsEntity
1910
1910
  */
@@ -3684,9 +3684,9 @@ export interface ServiceStatusDTO {
3684
3684
  */
3685
3685
  'status'?: ServiceStatusDTOStatusEnum;
3686
3686
  /**
3687
- * Service Incidents
3687
+ * Service Events
3688
3688
  */
3689
- 'incidents'?: Array<IncidentDTO>;
3689
+ 'events'?: Array<EventDTO>;
3690
3690
  }
3691
3691
  export declare const ServiceStatusDTOStatusEnum: {
3692
3692
  readonly NUMBER_0: 0;
@@ -11697,22 +11697,22 @@ export declare const ServicesApiAxiosParamCreator: (configuration?: Configuratio
11697
11697
  * @param {*} [options] Override http request option.
11698
11698
  * @throws {RequiredError}
11699
11699
  */
11700
- patchArchiveIncident: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11700
+ patchArchiveEvent: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11701
11701
  /**
11702
11702
  *
11703
- * @param {IncidentRequestDTO} [incidentRequestDTO]
11703
+ * @param {EventRequestDTO} [eventRequestDTO]
11704
11704
  * @param {*} [options] Override http request option.
11705
11705
  * @throws {RequiredError}
11706
11706
  */
11707
- postCreateIncident: (incidentRequestDTO?: IncidentRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11707
+ postCreateEvent: (eventRequestDTO?: EventRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11708
11708
  /**
11709
11709
  *
11710
11710
  * @param {string} id Group ID
11711
- * @param {IncidentUpdateRequestDTO} [incidentUpdateRequestDTO]
11711
+ * @param {EventUpdateRequestDTO} [eventUpdateRequestDTO]
11712
11712
  * @param {*} [options] Override http request option.
11713
11713
  * @throws {RequiredError}
11714
11714
  */
11715
- postCreateIncidentUpdate: (id: string, incidentUpdateRequestDTO?: IncidentUpdateRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11715
+ postCreateEventUpdate: (id: string, eventUpdateRequestDTO?: EventUpdateRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11716
11716
  /**
11717
11717
  *
11718
11718
  * @param {string} [email] Subscription Email Address
@@ -11745,22 +11745,22 @@ export declare const ServicesApiFp: (configuration?: Configuration) => {
11745
11745
  * @param {*} [options] Override http request option.
11746
11746
  * @throws {RequiredError}
11747
11747
  */
11748
- patchArchiveIncident(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IncidentDTO>>;
11748
+ patchArchiveEvent(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EventDTO>>;
11749
11749
  /**
11750
11750
  *
11751
- * @param {IncidentRequestDTO} [incidentRequestDTO]
11751
+ * @param {EventRequestDTO} [eventRequestDTO]
11752
11752
  * @param {*} [options] Override http request option.
11753
11753
  * @throws {RequiredError}
11754
11754
  */
11755
- postCreateIncident(incidentRequestDTO?: IncidentRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IncidentDTO>>;
11755
+ postCreateEvent(eventRequestDTO?: EventRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EventDTO>>;
11756
11756
  /**
11757
11757
  *
11758
11758
  * @param {string} id Group ID
11759
- * @param {IncidentUpdateRequestDTO} [incidentUpdateRequestDTO]
11759
+ * @param {EventUpdateRequestDTO} [eventUpdateRequestDTO]
11760
11760
  * @param {*} [options] Override http request option.
11761
11761
  * @throws {RequiredError}
11762
11762
  */
11763
- postCreateIncidentUpdate(id: string, incidentUpdateRequestDTO?: IncidentUpdateRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IncidentDTO>>;
11763
+ postCreateEventUpdate(id: string, eventUpdateRequestDTO?: EventUpdateRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EventDTO>>;
11764
11764
  /**
11765
11765
  *
11766
11766
  * @param {string} [email] Subscription Email Address
@@ -11793,22 +11793,22 @@ export declare const ServicesApiFactory: (configuration?: Configuration, basePat
11793
11793
  * @param {*} [options] Override http request option.
11794
11794
  * @throws {RequiredError}
11795
11795
  */
11796
- patchArchiveIncident(id: string, options?: RawAxiosRequestConfig): AxiosPromise<IncidentDTO>;
11796
+ patchArchiveEvent(id: string, options?: RawAxiosRequestConfig): AxiosPromise<EventDTO>;
11797
11797
  /**
11798
11798
  *
11799
- * @param {IncidentRequestDTO} [incidentRequestDTO]
11799
+ * @param {EventRequestDTO} [eventRequestDTO]
11800
11800
  * @param {*} [options] Override http request option.
11801
11801
  * @throws {RequiredError}
11802
11802
  */
11803
- postCreateIncident(incidentRequestDTO?: IncidentRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<IncidentDTO>;
11803
+ postCreateEvent(eventRequestDTO?: EventRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<EventDTO>;
11804
11804
  /**
11805
11805
  *
11806
11806
  * @param {string} id Group ID
11807
- * @param {IncidentUpdateRequestDTO} [incidentUpdateRequestDTO]
11807
+ * @param {EventUpdateRequestDTO} [eventUpdateRequestDTO]
11808
11808
  * @param {*} [options] Override http request option.
11809
11809
  * @throws {RequiredError}
11810
11810
  */
11811
- postCreateIncidentUpdate(id: string, incidentUpdateRequestDTO?: IncidentUpdateRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<IncidentDTO>;
11811
+ postCreateEventUpdate(id: string, eventUpdateRequestDTO?: EventUpdateRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<EventDTO>;
11812
11812
  /**
11813
11813
  *
11814
11814
  * @param {string} [email] Subscription Email Address
@@ -11841,22 +11841,22 @@ export declare class ServicesApi extends BaseAPI {
11841
11841
  * @param {*} [options] Override http request option.
11842
11842
  * @throws {RequiredError}
11843
11843
  */
11844
- patchArchiveIncident(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IncidentDTO, any, {}>>;
11844
+ patchArchiveEvent(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EventDTO, any, {}>>;
11845
11845
  /**
11846
11846
  *
11847
- * @param {IncidentRequestDTO} [incidentRequestDTO]
11847
+ * @param {EventRequestDTO} [eventRequestDTO]
11848
11848
  * @param {*} [options] Override http request option.
11849
11849
  * @throws {RequiredError}
11850
11850
  */
11851
- postCreateIncident(incidentRequestDTO?: IncidentRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IncidentDTO, any, {}>>;
11851
+ postCreateEvent(eventRequestDTO?: EventRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EventDTO, any, {}>>;
11852
11852
  /**
11853
11853
  *
11854
11854
  * @param {string} id Group ID
11855
- * @param {IncidentUpdateRequestDTO} [incidentUpdateRequestDTO]
11855
+ * @param {EventUpdateRequestDTO} [eventUpdateRequestDTO]
11856
11856
  * @param {*} [options] Override http request option.
11857
11857
  * @throws {RequiredError}
11858
11858
  */
11859
- postCreateIncidentUpdate(id: string, incidentUpdateRequestDTO?: IncidentUpdateRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IncidentDTO, any, {}>>;
11859
+ postCreateEventUpdate(id: string, eventUpdateRequestDTO?: EventUpdateRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EventDTO, any, {}>>;
11860
11860
  /**
11861
11861
  *
11862
11862
  * @param {string} [email] Subscription Email Address