@layer-drone/protocol 1.0.0 → 1.0.1

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.
@@ -22,6 +22,7 @@ export type CreateApiTokenResponseDto = {
22
22
  | "manageProposals"
23
23
  | "approveProposals"
24
24
  | "manageProtocolTriggers"
25
+ | "manageCampaigns"
25
26
  | "all"
26
27
  >;
27
28
  };
@@ -44,6 +45,7 @@ export type CreateApiTokenRequestDto = {
44
45
  | "manageProposals"
45
46
  | "approveProposals"
46
47
  | "manageProtocolTriggers"
48
+ | "manageCampaigns"
47
49
  | "all"
48
50
  >;
49
51
  orgId: number;
@@ -67,6 +69,7 @@ export type UpdateApiTokenRequestDto = {
67
69
  | "manageProposals"
68
70
  | "approveProposals"
69
71
  | "manageProtocolTriggers"
72
+ | "manageCampaigns"
70
73
  | "all"
71
74
  >;
72
75
  };
@@ -93,10 +96,52 @@ export type UpdateApiTokenResponseDto = {
93
96
  | "manageProposals"
94
97
  | "approveProposals"
95
98
  | "manageProtocolTriggers"
99
+ | "manageCampaigns"
96
100
  | "all"
97
101
  >;
98
102
  };
99
103
 
104
+ export type CreateCampaignBody = {
105
+ id: string;
106
+ name: string;
107
+ };
108
+
109
+ export type CreateCampaignResponse = {
110
+ id: string;
111
+ name: string;
112
+ created_at: string;
113
+ updated_at: string;
114
+ };
115
+
116
+ export type GetCampaignsResponse = Array<{
117
+ id: string;
118
+ name: string;
119
+ created_at: string;
120
+ updated_at: string;
121
+ }>;
122
+
123
+ export type GetCampaignResponse = {
124
+ id: string;
125
+ name: string;
126
+ created_at: string;
127
+ updated_at: string;
128
+ };
129
+
130
+ export type UpdateCampaignBody = {
131
+ name: string;
132
+ };
133
+
134
+ export type UpdateCampaignResponse = {
135
+ id: string;
136
+ name: string;
137
+ created_at: string;
138
+ updated_at: string;
139
+ };
140
+
141
+ export type DeleteCampaignResponse = {
142
+ message: string;
143
+ };
144
+
100
145
  export type GetTimeLimitsForSunAltitudeResponse = {
101
146
  OptimalSunAltitudePeriod: {
102
147
  StartTime: Date;
@@ -724,6 +769,7 @@ export type UpdateMissionsRequestDto = {
724
769
  isOpen?: boolean;
725
770
  collateralToken?: string;
726
771
  decimals?: number;
772
+ campaigns?: Array<string>;
727
773
  }>;
728
774
  treasuryAddress: string;
729
775
  };
@@ -734,6 +780,7 @@ export type UpdateMissionsResponseDto = {
734
780
  escrowRequestsQueued: Array<string>;
735
781
  withdrawalRequestsQueued: Array<string>;
736
782
  cancelRequestsQueued: Array<string>;
783
+ campaignsUpdated: Array<string>;
737
784
  };
738
785
  };
739
786
 
@@ -755,6 +802,159 @@ export type RepriceMissionsResponseDto = {
755
802
  };
756
803
  };
757
804
 
805
+ export type CreateProposalRequestDto = {
806
+ name: string;
807
+ created_by: string;
808
+ description?: string;
809
+ source?: {
810
+ tool: "arcgis-plugin";
811
+ version?: string;
812
+ };
813
+ changes: Array<
814
+ | {
815
+ payload: {
816
+ id: string;
817
+ region_id: number;
818
+ is_flyable?: boolean;
819
+ };
820
+ action: "zone.create";
821
+ }
822
+ | {
823
+ resource_id: string;
824
+ payload: {
825
+ is_flyable: boolean;
826
+ };
827
+ action: "zone.update";
828
+ }
829
+ | {
830
+ resource_id: string;
831
+ action: "zone.delete";
832
+ }
833
+ | {
834
+ payload: {
835
+ id: string;
836
+ name: string;
837
+ };
838
+ action: "campaign.create";
839
+ }
840
+ | {
841
+ resource_id: string;
842
+ payload: {
843
+ name?: string;
844
+ };
845
+ action: "campaign.update";
846
+ }
847
+ | {
848
+ resource_id: string;
849
+ action: "campaign.delete";
850
+ }
851
+ | {
852
+ payload: {
853
+ requestor: string;
854
+ zone_id: string;
855
+ campaigns: Array<string>;
856
+ flight_plan_id: number;
857
+ amount: string | number | bigint;
858
+ collateral_token: string;
859
+ decimals: number;
860
+ capture_start_time: Date;
861
+ capture_end_time: Date;
862
+ is_reservable?: boolean;
863
+ tags?: {
864
+ [key: string]: string;
865
+ };
866
+ };
867
+ action: "mission.create";
868
+ }
869
+ | {
870
+ resource_id: string;
871
+ payload: {
872
+ amount?: string | number | bigint;
873
+ is_open?: boolean;
874
+ collateral_token?: string;
875
+ decimals?: number;
876
+ campaigns?: Array<string>;
877
+ };
878
+ action: "mission.update";
879
+ }
880
+ >;
881
+ };
882
+
883
+ export type CreateProposalResponseDto = {
884
+ proposal_id: string;
885
+ total_items_changed: number;
886
+ estimated_cost: number;
887
+ };
888
+
889
+ export type GetProposalsResponseDto = {
890
+ proposals: Array<{
891
+ id: string;
892
+ name: string;
893
+ created_at: Date;
894
+ created_by: string;
895
+ total_items: number;
896
+ pending_count: number;
897
+ dispatched_count: number;
898
+ verified_count: number;
899
+ failed_count: number;
900
+ status:
901
+ | "pending"
902
+ | "approved"
903
+ | "rejected"
904
+ | "dispatched"
905
+ | "verified"
906
+ | "error";
907
+ }>;
908
+ hasNextPage: boolean;
909
+ };
910
+
911
+ export type GetProposalResponseDto = {
912
+ id: string;
913
+ name: string;
914
+ description: string;
915
+ source: {
916
+ tool: "arcgis-plugin";
917
+ version?: string;
918
+ };
919
+ created_at: Date;
920
+ created_by: string;
921
+ total_items: number;
922
+ pending_count: number;
923
+ dispatched_count: number;
924
+ verified_count: number;
925
+ failed_count: number;
926
+ estimated_cost: string;
927
+ status:
928
+ | "pending"
929
+ | "approved"
930
+ | "rejected"
931
+ | "dispatched"
932
+ | "verified"
933
+ | "error";
934
+ changes: Array<{
935
+ id: string;
936
+ resource: string;
937
+ action: string;
938
+ resource_id: string;
939
+ payload: {
940
+ [key: string]: unknown;
941
+ };
942
+ dispatched_at: Date;
943
+ verified_at: Date;
944
+ failed_at: Date;
945
+ error: string;
946
+ }>;
947
+ };
948
+
949
+ export type ReviewProposalRequestDto = {
950
+ approved: boolean;
951
+ reviewed_by: string;
952
+ };
953
+
954
+ export type ReviewProposalResponseDto = {
955
+ review_id: string;
956
+ };
957
+
758
958
  export type TriggerPayoutRequestDto = {
759
959
  missionIds: Array<string>;
760
960
  };
@@ -1272,6 +1472,248 @@ export type ApiTokenControllerUpdateToken1Responses = {
1272
1472
  export type ApiTokenControllerUpdateToken1Response =
1273
1473
  ApiTokenControllerUpdateToken1Responses[keyof ApiTokenControllerUpdateToken1Responses];
1274
1474
 
1475
+ export type CampaignsControllerGetMany0V1Data = {
1476
+ body?: never;
1477
+ path?: never;
1478
+ query?: never;
1479
+ url: "/v1/campaigns";
1480
+ };
1481
+
1482
+ export type CampaignsControllerGetMany0V1Errors = {
1483
+ 401: unknown;
1484
+ 403: unknown;
1485
+ };
1486
+
1487
+ export type CampaignsControllerGetMany0V1Responses = {
1488
+ 200: GetCampaignsResponse;
1489
+ };
1490
+
1491
+ export type CampaignsControllerGetMany0V1Response =
1492
+ CampaignsControllerGetMany0V1Responses[keyof CampaignsControllerGetMany0V1Responses];
1493
+
1494
+ export type CampaignsControllerCreate0V1Data = {
1495
+ body: CreateCampaignBody;
1496
+ path?: never;
1497
+ query?: never;
1498
+ url: "/v1/campaigns";
1499
+ };
1500
+
1501
+ export type CampaignsControllerCreate0V1Errors = {
1502
+ 401: unknown;
1503
+ 403: unknown;
1504
+ /**
1505
+ * Campaign name already exists
1506
+ */
1507
+ 409: unknown;
1508
+ };
1509
+
1510
+ export type CampaignsControllerCreate0V1Responses = {
1511
+ 201: CreateCampaignResponse;
1512
+ };
1513
+
1514
+ export type CampaignsControllerCreate0V1Response =
1515
+ CampaignsControllerCreate0V1Responses[keyof CampaignsControllerCreate0V1Responses];
1516
+
1517
+ export type CampaignsControllerGetMany1Data = {
1518
+ body?: never;
1519
+ path?: never;
1520
+ query?: never;
1521
+ url: "/campaigns";
1522
+ };
1523
+
1524
+ export type CampaignsControllerGetMany1Errors = {
1525
+ 401: unknown;
1526
+ 403: unknown;
1527
+ };
1528
+
1529
+ export type CampaignsControllerGetMany1Responses = {
1530
+ 200: GetCampaignsResponse;
1531
+ };
1532
+
1533
+ export type CampaignsControllerGetMany1Response =
1534
+ CampaignsControllerGetMany1Responses[keyof CampaignsControllerGetMany1Responses];
1535
+
1536
+ export type CampaignsControllerCreate1Data = {
1537
+ body: CreateCampaignBody;
1538
+ path?: never;
1539
+ query?: never;
1540
+ url: "/campaigns";
1541
+ };
1542
+
1543
+ export type CampaignsControllerCreate1Errors = {
1544
+ 401: unknown;
1545
+ 403: unknown;
1546
+ /**
1547
+ * Campaign name already exists
1548
+ */
1549
+ 409: unknown;
1550
+ };
1551
+
1552
+ export type CampaignsControllerCreate1Responses = {
1553
+ 201: CreateCampaignResponse;
1554
+ };
1555
+
1556
+ export type CampaignsControllerCreate1Response =
1557
+ CampaignsControllerCreate1Responses[keyof CampaignsControllerCreate1Responses];
1558
+
1559
+ export type CampaignsControllerDelete0V1Data = {
1560
+ body?: never;
1561
+ path: {
1562
+ id: string;
1563
+ };
1564
+ query?: never;
1565
+ url: "/v1/campaigns/{id}";
1566
+ };
1567
+
1568
+ export type CampaignsControllerDelete0V1Errors = {
1569
+ 401: unknown;
1570
+ 403: unknown;
1571
+ /**
1572
+ * Campaign is referenced by one or more missions
1573
+ */
1574
+ 409: unknown;
1575
+ };
1576
+
1577
+ export type CampaignsControllerDelete0V1Responses = {
1578
+ 200: DeleteCampaignResponse;
1579
+ };
1580
+
1581
+ export type CampaignsControllerDelete0V1Response =
1582
+ CampaignsControllerDelete0V1Responses[keyof CampaignsControllerDelete0V1Responses];
1583
+
1584
+ export type CampaignsControllerGet0V1Data = {
1585
+ body?: never;
1586
+ path: {
1587
+ id: string;
1588
+ };
1589
+ query?: never;
1590
+ url: "/v1/campaigns/{id}";
1591
+ };
1592
+
1593
+ export type CampaignsControllerGet0V1Errors = {
1594
+ 401: unknown;
1595
+ 403: unknown;
1596
+ /**
1597
+ * Campaign not found
1598
+ */
1599
+ 404: unknown;
1600
+ };
1601
+
1602
+ export type CampaignsControllerGet0V1Responses = {
1603
+ 200: GetCampaignResponse;
1604
+ };
1605
+
1606
+ export type CampaignsControllerGet0V1Response =
1607
+ CampaignsControllerGet0V1Responses[keyof CampaignsControllerGet0V1Responses];
1608
+
1609
+ export type CampaignsControllerUpdate0V1Data = {
1610
+ body: UpdateCampaignBody;
1611
+ path: {
1612
+ id: string;
1613
+ };
1614
+ query?: never;
1615
+ url: "/v1/campaigns/{id}";
1616
+ };
1617
+
1618
+ export type CampaignsControllerUpdate0V1Errors = {
1619
+ 401: unknown;
1620
+ 403: unknown;
1621
+ /**
1622
+ * Campaign not found
1623
+ */
1624
+ 404: unknown;
1625
+ /**
1626
+ * Campaign name already exists
1627
+ */
1628
+ 409: unknown;
1629
+ };
1630
+
1631
+ export type CampaignsControllerUpdate0V1Responses = {
1632
+ 200: UpdateCampaignResponse;
1633
+ };
1634
+
1635
+ export type CampaignsControllerUpdate0V1Response =
1636
+ CampaignsControllerUpdate0V1Responses[keyof CampaignsControllerUpdate0V1Responses];
1637
+
1638
+ export type CampaignsControllerDelete1Data = {
1639
+ body?: never;
1640
+ path: {
1641
+ id: string;
1642
+ };
1643
+ query?: never;
1644
+ url: "/campaigns/{id}";
1645
+ };
1646
+
1647
+ export type CampaignsControllerDelete1Errors = {
1648
+ 401: unknown;
1649
+ 403: unknown;
1650
+ /**
1651
+ * Campaign is referenced by one or more missions
1652
+ */
1653
+ 409: unknown;
1654
+ };
1655
+
1656
+ export type CampaignsControllerDelete1Responses = {
1657
+ 200: DeleteCampaignResponse;
1658
+ };
1659
+
1660
+ export type CampaignsControllerDelete1Response =
1661
+ CampaignsControllerDelete1Responses[keyof CampaignsControllerDelete1Responses];
1662
+
1663
+ export type CampaignsControllerGet1Data = {
1664
+ body?: never;
1665
+ path: {
1666
+ id: string;
1667
+ };
1668
+ query?: never;
1669
+ url: "/campaigns/{id}";
1670
+ };
1671
+
1672
+ export type CampaignsControllerGet1Errors = {
1673
+ 401: unknown;
1674
+ 403: unknown;
1675
+ /**
1676
+ * Campaign not found
1677
+ */
1678
+ 404: unknown;
1679
+ };
1680
+
1681
+ export type CampaignsControllerGet1Responses = {
1682
+ 200: GetCampaignResponse;
1683
+ };
1684
+
1685
+ export type CampaignsControllerGet1Response =
1686
+ CampaignsControllerGet1Responses[keyof CampaignsControllerGet1Responses];
1687
+
1688
+ export type CampaignsControllerUpdate1Data = {
1689
+ body: UpdateCampaignBody;
1690
+ path: {
1691
+ id: string;
1692
+ };
1693
+ query?: never;
1694
+ url: "/campaigns/{id}";
1695
+ };
1696
+
1697
+ export type CampaignsControllerUpdate1Errors = {
1698
+ 401: unknown;
1699
+ 403: unknown;
1700
+ /**
1701
+ * Campaign not found
1702
+ */
1703
+ 404: unknown;
1704
+ /**
1705
+ * Campaign name already exists
1706
+ */
1707
+ 409: unknown;
1708
+ };
1709
+
1710
+ export type CampaignsControllerUpdate1Responses = {
1711
+ 200: UpdateCampaignResponse;
1712
+ };
1713
+
1714
+ export type CampaignsControllerUpdate1Response =
1715
+ CampaignsControllerUpdate1Responses[keyof CampaignsControllerUpdate1Responses];
1716
+
1275
1717
  export type ConditionsControllerGetSunAltitudeTimeLimits0V1Data = {
1276
1718
  body?: never;
1277
1719
  path?: never;
@@ -2382,6 +2824,118 @@ export type MissionsControllerRepriceMissions1Responses = {
2382
2824
  export type MissionsControllerRepriceMissions1Response =
2383
2825
  MissionsControllerRepriceMissions1Responses[keyof MissionsControllerRepriceMissions1Responses];
2384
2826
 
2827
+ export type ListProposalsData = {
2828
+ body?: never;
2829
+ path?: never;
2830
+ query?: {
2831
+ status?:
2832
+ | "pending"
2833
+ | "approved"
2834
+ | "rejected"
2835
+ | "dispatched"
2836
+ | "verified"
2837
+ | "error";
2838
+ created_by?: string;
2839
+ created_after?: Date;
2840
+ created_before?: Date;
2841
+ page?: number;
2842
+ };
2843
+ url: "/v1/proposals";
2844
+ };
2845
+
2846
+ export type ListProposalsErrors = {
2847
+ /**
2848
+ * Missing manageProposals permission
2849
+ */
2850
+ 403: unknown;
2851
+ };
2852
+
2853
+ export type ListProposalsResponses = {
2854
+ 200: GetProposalsResponseDto;
2855
+ };
2856
+
2857
+ export type ListProposalsResponse =
2858
+ ListProposalsResponses[keyof ListProposalsResponses];
2859
+
2860
+ export type SubmitProposalData = {
2861
+ body: CreateProposalRequestDto;
2862
+ path?: never;
2863
+ query?: never;
2864
+ url: "/v1/proposals";
2865
+ };
2866
+
2867
+ export type SubmitProposalErrors = {
2868
+ /**
2869
+ * Schema validation failed
2870
+ */
2871
+ 400: unknown;
2872
+ 401: unknown;
2873
+ 403: unknown;
2874
+ };
2875
+
2876
+ export type SubmitProposalResponses = {
2877
+ 201: CreateProposalResponseDto;
2878
+ };
2879
+
2880
+ export type SubmitProposalResponse =
2881
+ SubmitProposalResponses[keyof SubmitProposalResponses];
2882
+
2883
+ export type GetProposalData = {
2884
+ body?: never;
2885
+ path: {
2886
+ id: string;
2887
+ };
2888
+ query?: never;
2889
+ url: "/v1/proposals/{id}";
2890
+ };
2891
+
2892
+ export type GetProposalErrors = {
2893
+ /**
2894
+ * Missing manageProposals permission
2895
+ */
2896
+ 403: unknown;
2897
+ /**
2898
+ * Proposal not found
2899
+ */
2900
+ 404: unknown;
2901
+ };
2902
+
2903
+ export type GetProposalResponses = {
2904
+ 200: GetProposalResponseDto;
2905
+ };
2906
+
2907
+ export type GetProposalResponse =
2908
+ GetProposalResponses[keyof GetProposalResponses];
2909
+
2910
+ export type ReviewProposalData = {
2911
+ body: ReviewProposalRequestDto;
2912
+ path: {
2913
+ id: string;
2914
+ };
2915
+ query?: never;
2916
+ url: "/v1/proposals/{id}/review";
2917
+ };
2918
+
2919
+ export type ReviewProposalErrors = {
2920
+ 401: unknown;
2921
+ 403: unknown;
2922
+ /**
2923
+ * Proposal not found
2924
+ */
2925
+ 404: unknown;
2926
+ /**
2927
+ * Another proposal is already running
2928
+ */
2929
+ 409: unknown;
2930
+ };
2931
+
2932
+ export type ReviewProposalResponses = {
2933
+ 200: ReviewProposalResponseDto;
2934
+ };
2935
+
2936
+ export type ReviewProposalResponse =
2937
+ ReviewProposalResponses[keyof ReviewProposalResponses];
2938
+
2385
2939
  export type ProtocolTriggersApiControllerTriggerPayout0V1Data = {
2386
2940
  body: TriggerPayoutRequestDto;
2387
2941
  path?: never;