@layer-drone/protocol 1.0.0 → 1.0.2

package/src/client/types.gen.ts

@@ -22,6 +22,7 @@ export type CreateApiTokenResponseDto = {
     | "manageProposals"
     | "approveProposals"
     | "manageProtocolTriggers"
+    | "manageCampaigns"
     | "all"
   >;
 };
@@ -44,6 +45,7 @@ export type CreateApiTokenRequestDto = {
     | "manageProposals"
     | "approveProposals"
     | "manageProtocolTriggers"
+    | "manageCampaigns"
     | "all"
   >;
   orgId: number;
@@ -67,6 +69,7 @@ export type UpdateApiTokenRequestDto = {
     | "manageProposals"
     | "approveProposals"
     | "manageProtocolTriggers"
+    | "manageCampaigns"
     | "all"
   >;
 };
@@ -93,10 +96,52 @@ export type UpdateApiTokenResponseDto = {
     | "manageProposals"
     | "approveProposals"
     | "manageProtocolTriggers"
+    | "manageCampaigns"
     | "all"
   >;
 };
 
+export type CreateCampaignBody = {
+  id: string;
+  name: string;
+};
+
+export type CreateCampaignResponse = {
+  id: string;
+  name: string;
+  created_at: string;
+  updated_at: string;
+};
+
+export type GetCampaignsResponse = Array<{
+  id: string;
+  name: string;
+  created_at: string;
+  updated_at: string;
+}>;
+
+export type GetCampaignResponse = {
+  id: string;
+  name: string;
+  created_at: string;
+  updated_at: string;
+};
+
+export type UpdateCampaignBody = {
+  name: string;
+};
+
+export type UpdateCampaignResponse = {
+  id: string;
+  name: string;
+  created_at: string;
+  updated_at: string;
+};
+
+export type DeleteCampaignResponse = {
+  message: string;
+};
+
 export type GetTimeLimitsForSunAltitudeResponse = {
   OptimalSunAltitudePeriod: {
     StartTime: Date;
@@ -724,6 +769,7 @@ export type UpdateMissionsRequestDto = {
     isOpen?: boolean;
     collateralToken?: string;
     decimals?: number;
+    campaigns?: Array<string>;
   }>;
   treasuryAddress: string;
 };
@@ -734,6 +780,7 @@ export type UpdateMissionsResponseDto = {
     escrowRequestsQueued: Array<string>;
     withdrawalRequestsQueued: Array<string>;
     cancelRequestsQueued: Array<string>;
+    campaignsUpdated: Array<string>;
   };
 };
 
@@ -755,6 +802,159 @@ export type RepriceMissionsResponseDto = {
   };
 };
 
+export type CreateProposalRequestDto = {
+  name: string;
+  created_by: string;
+  description?: string;
+  source?: {
+    tool: "arcgis-plugin";
+    version?: string;
+  };
+  changes: Array<
+    | {
+        payload: {
+          id: string;
+          region_id: number;
+          is_flyable?: boolean;
+        };
+        action: "zone.create";
+      }
+    | {
+        resource_id: string;
+        payload: {
+          is_flyable: boolean;
+        };
+        action: "zone.update";
+      }
+    | {
+        resource_id: string;
+        action: "zone.delete";
+      }
+    | {
+        payload: {
+          id: string;
+          name: string;
+        };
+        action: "campaign.create";
+      }
+    | {
+        resource_id: string;
+        payload: {
+          name?: string;
+        };
+        action: "campaign.update";
+      }
+    | {
+        resource_id: string;
+        action: "campaign.delete";
+      }
+    | {
+        payload: {
+          requestor: string;
+          zone_id: string;
+          campaigns: Array<string>;
+          flight_plan_id: number;
+          amount: string | number | bigint;
+          collateral_token: string;
+          decimals: number;
+          capture_start_time: Date;
+          capture_end_time: Date;
+          is_reservable?: boolean;
+          tags?: {
+            [key: string]: string;
+          };
+        };
+        action: "mission.create";
+      }
+    | {
+        resource_id: string;
+        payload: {
+          amount?: string | number | bigint;
+          is_open?: boolean;
+          collateral_token?: string;
+          decimals?: number;
+          campaigns?: Array<string>;
+        };
+        action: "mission.update";
+      }
+  >;
+};
+
+export type CreateProposalResponseDto = {
+  proposal_id: string;
+  total_items_changed: number;
+  estimated_cost: number;
+};
+
+export type GetProposalsResponseDto = {
+  proposals: Array<{
+    id: string;
+    name: string;
+    created_at: Date;
+    created_by: string;
+    total_items: number;
+    pending_count: number;
+    dispatched_count: number;
+    verified_count: number;
+    failed_count: number;
+    status:
+      | "pending"
+      | "approved"
+      | "rejected"
+      | "dispatched"
+      | "verified"
+      | "error";
+  }>;
+  hasNextPage: boolean;
+};
+
+export type GetProposalResponseDto = {
+  id: string;
+  name: string;
+  description: string;
+  source: {
+    tool: "arcgis-plugin";
+    version?: string;
+  };
+  created_at: Date;
+  created_by: string;
+  total_items: number;
+  pending_count: number;
+  dispatched_count: number;
+  verified_count: number;
+  failed_count: number;
+  estimated_cost: string;
+  status:
+    | "pending"
+    | "approved"
+    | "rejected"
+    | "dispatched"
+    | "verified"
+    | "error";
+  changes: Array<{
+    id: string;
+    resource: string;
+    action: string;
+    resource_id: string;
+    payload: {
+      [key: string]: unknown;
+    };
+    dispatched_at: Date;
+    verified_at: Date;
+    failed_at: Date;
+    error: string;
+  }>;
+};
+
+export type ReviewProposalRequestDto = {
+  approved: boolean;
+  reviewed_by: string;
+};
+
+export type ReviewProposalResponseDto = {
+  review_id: string;
+};
+
 export type TriggerPayoutRequestDto = {
   missionIds: Array<string>;
 };
@@ -801,6 +1001,7 @@ export type CreateWebhookBody = {
     | "protocol.mission.paid"
     | "protocol.flight.submitted"
     | "protocol.flight.reviewed"
+    | "protocol.zone"
     | "*"
   >;
   active: boolean;
@@ -822,6 +1023,7 @@ export type GetWebhooksResponse = Array<{
     | "protocol.mission.paid"
     | "protocol.flight.submitted"
     | "protocol.flight.reviewed"
+    | "protocol.zone"
     | "*"
   >;
   active: boolean;
@@ -843,6 +1045,7 @@ export type GetWebhookResponse = {
     | "protocol.mission.paid"
     | "protocol.flight.submitted"
     | "protocol.flight.reviewed"
+    | "protocol.zone"
     | "*"
   >;
   active: boolean;
@@ -863,6 +1066,7 @@ export type UpdateWebhookBody = {
     | "protocol.mission.paid"
     | "protocol.flight.submitted"
     | "protocol.flight.reviewed"
+    | "protocol.zone"
     | "*"
   >;
   active?: boolean;
@@ -879,6 +1083,7 @@ export type UpdateWebhookResponse = {
     | "protocol.mission.paid"
     | "protocol.flight.submitted"
     | "protocol.flight.reviewed"
+    | "protocol.zone"
     | "*"
   >;
   active: boolean;
@@ -1272,6 +1477,248 @@ export type ApiTokenControllerUpdateToken1Responses = {
 export type ApiTokenControllerUpdateToken1Response =
   ApiTokenControllerUpdateToken1Responses[keyof ApiTokenControllerUpdateToken1Responses];
 
+export type CampaignsControllerGetMany0V1Data = {
+  body?: never;
+  path?: never;
+  query?: never;
+  url: "/v1/campaigns";
+};
+
+export type CampaignsControllerGetMany0V1Errors = {
+  401: unknown;
+  403: unknown;
+};
+
+export type CampaignsControllerGetMany0V1Responses = {
+  200: GetCampaignsResponse;
+};
+
+export type CampaignsControllerGetMany0V1Response =
+  CampaignsControllerGetMany0V1Responses[keyof CampaignsControllerGetMany0V1Responses];
+
+export type CampaignsControllerCreate0V1Data = {
+  body: CreateCampaignBody;
+  path?: never;
+  query?: never;
+  url: "/v1/campaigns";
+};
+
+export type CampaignsControllerCreate0V1Errors = {
+  401: unknown;
+  403: unknown;
+  /**
+   * Campaign name already exists
+   */
+  409: unknown;
+};
+
+export type CampaignsControllerCreate0V1Responses = {
+  201: CreateCampaignResponse;
+};
+
+export type CampaignsControllerCreate0V1Response =
+  CampaignsControllerCreate0V1Responses[keyof CampaignsControllerCreate0V1Responses];
+
+export type CampaignsControllerGetMany1Data = {
+  body?: never;
+  path?: never;
+  query?: never;
+  url: "/campaigns";
+};
+
+export type CampaignsControllerGetMany1Errors = {
+  401: unknown;
+  403: unknown;
+};
+
+export type CampaignsControllerGetMany1Responses = {
+  200: GetCampaignsResponse;
+};
+
+export type CampaignsControllerGetMany1Response =
+  CampaignsControllerGetMany1Responses[keyof CampaignsControllerGetMany1Responses];
+
+export type CampaignsControllerCreate1Data = {
+  body: CreateCampaignBody;
+  path?: never;
+  query?: never;
+  url: "/campaigns";
+};
+
+export type CampaignsControllerCreate1Errors = {
+  401: unknown;
+  403: unknown;
+  /**
+   * Campaign name already exists
+   */
+  409: unknown;
+};
+
+export type CampaignsControllerCreate1Responses = {
+  201: CreateCampaignResponse;
+};
+
+export type CampaignsControllerCreate1Response =
+  CampaignsControllerCreate1Responses[keyof CampaignsControllerCreate1Responses];
+
+export type CampaignsControllerDelete0V1Data = {
+  body?: never;
+  path: {
+    id: string;
+  };
+  query?: never;
+  url: "/v1/campaigns/{id}";
+};
+
+export type CampaignsControllerDelete0V1Errors = {
+  401: unknown;
+  403: unknown;
+  /**
+   * Campaign is referenced by one or more missions
+   */
+  409: unknown;
+};
+
+export type CampaignsControllerDelete0V1Responses = {
+  200: DeleteCampaignResponse;
+};
+
+export type CampaignsControllerDelete0V1Response =
+  CampaignsControllerDelete0V1Responses[keyof CampaignsControllerDelete0V1Responses];
+
+export type CampaignsControllerGet0V1Data = {
+  body?: never;
+  path: {
+    id: string;
+  };
+  query?: never;
+  url: "/v1/campaigns/{id}";
+};
+
+export type CampaignsControllerGet0V1Errors = {
+  401: unknown;
+  403: unknown;
+  /**
+   * Campaign not found
+   */
+  404: unknown;
+};
+
+export type CampaignsControllerGet0V1Responses = {
+  200: GetCampaignResponse;
+};
+
+export type CampaignsControllerGet0V1Response =
+  CampaignsControllerGet0V1Responses[keyof CampaignsControllerGet0V1Responses];
+
+export type CampaignsControllerUpdate0V1Data = {
+  body: UpdateCampaignBody;
+  path: {
+    id: string;
+  };
+  query?: never;
+  url: "/v1/campaigns/{id}";
+};
+
+export type CampaignsControllerUpdate0V1Errors = {
+  401: unknown;
+  403: unknown;
+  /**
+   * Campaign not found
+   */
+  404: unknown;
+  /**
+   * Campaign name already exists
+   */
+  409: unknown;
+};
+
+export type CampaignsControllerUpdate0V1Responses = {
+  200: UpdateCampaignResponse;
+};
+
+export type CampaignsControllerUpdate0V1Response =
+  CampaignsControllerUpdate0V1Responses[keyof CampaignsControllerUpdate0V1Responses];
+
+export type CampaignsControllerDelete1Data = {
+  body?: never;
+  path: {
+    id: string;
+  };
+  query?: never;
+  url: "/campaigns/{id}";
+};
+
+export type CampaignsControllerDelete1Errors = {
+  401: unknown;
+  403: unknown;
+  /**
+   * Campaign is referenced by one or more missions
+   */
+  409: unknown;
+};
+
+export type CampaignsControllerDelete1Responses = {
+  200: DeleteCampaignResponse;
+};
+
+export type CampaignsControllerDelete1Response =
+  CampaignsControllerDelete1Responses[keyof CampaignsControllerDelete1Responses];
+
+export type CampaignsControllerGet1Data = {
+  body?: never;
+  path: {
+    id: string;
+  };
+  query?: never;
+  url: "/campaigns/{id}";
+};
+
+export type CampaignsControllerGet1Errors = {
+  401: unknown;
+  403: unknown;
+  /**
+   * Campaign not found
+   */
+  404: unknown;
+};
+
+export type CampaignsControllerGet1Responses = {
+  200: GetCampaignResponse;
+};
+
+export type CampaignsControllerGet1Response =
+  CampaignsControllerGet1Responses[keyof CampaignsControllerGet1Responses];
+
+export type CampaignsControllerUpdate1Data = {
+  body: UpdateCampaignBody;
+  path: {
+    id: string;
+  };
+  query?: never;
+  url: "/campaigns/{id}";
+};
+
+export type CampaignsControllerUpdate1Errors = {
+  401: unknown;
+  403: unknown;
+  /**
+   * Campaign not found
+   */
+  404: unknown;
+  /**
+   * Campaign name already exists
+   */
+  409: unknown;
+};
+
+export type CampaignsControllerUpdate1Responses = {
+  200: UpdateCampaignResponse;
+};
+
+export type CampaignsControllerUpdate1Response =
+  CampaignsControllerUpdate1Responses[keyof CampaignsControllerUpdate1Responses];
+
 export type ConditionsControllerGetSunAltitudeTimeLimits0V1Data = {
   body?: never;
   path?: never;
@@ -2382,6 +2829,118 @@ export type MissionsControllerRepriceMissions1Responses = {
 export type MissionsControllerRepriceMissions1Response =
   MissionsControllerRepriceMissions1Responses[keyof MissionsControllerRepriceMissions1Responses];
 
+export type ListProposalsData = {
+  body?: never;
+  path?: never;
+  query?: {
+    status?:
+      | "pending"
+      | "approved"
+      | "rejected"
+      | "dispatched"
+      | "verified"
+      | "error";
+    created_by?: string;
+    created_after?: Date;
+    created_before?: Date;
+    page?: number;
+  };
+  url: "/v1/proposals";
+};
+
+export type ListProposalsErrors = {
+  /**
+   * Missing manageProposals permission
+   */
+  403: unknown;
+};
+
+export type ListProposalsResponses = {
+  200: GetProposalsResponseDto;
+};
+
+export type ListProposalsResponse =
+  ListProposalsResponses[keyof ListProposalsResponses];
+
+export type SubmitProposalData = {
+  body: CreateProposalRequestDto;
+  path?: never;
+  query?: never;
+  url: "/v1/proposals";
+};
+
+export type SubmitProposalErrors = {
+  /**
+   * Schema validation failed
+   */
+  400: unknown;
+  401: unknown;
+  403: unknown;
+};
+
+export type SubmitProposalResponses = {
+  201: CreateProposalResponseDto;
+};
+
+export type SubmitProposalResponse =
+  SubmitProposalResponses[keyof SubmitProposalResponses];
+
+export type GetProposalData = {
+  body?: never;
+  path: {
+    id: string;
+  };
+  query?: never;
+  url: "/v1/proposals/{id}";
+};
+
+export type GetProposalErrors = {
+  /**
+   * Missing manageProposals permission
+   */
+  403: unknown;
+  /**
+   * Proposal not found
+   */
+  404: unknown;
+};
+
+export type GetProposalResponses = {
+  200: GetProposalResponseDto;
+};
+
+export type GetProposalResponse =
+  GetProposalResponses[keyof GetProposalResponses];
+
+export type ReviewProposalData = {
+  body: ReviewProposalRequestDto;
+  path: {
+    id: string;
+  };
+  query?: never;
+  url: "/v1/proposals/{id}/review";
+};
+
+export type ReviewProposalErrors = {
+  401: unknown;
+  403: unknown;
+  /**
+   * Proposal not found
+   */
+  404: unknown;
+  /**
+   * Another proposal is already running
+   */
+  409: unknown;
+};
+
+export type ReviewProposalResponses = {
+  200: ReviewProposalResponseDto;
+};
+
+export type ReviewProposalResponse =
+  ReviewProposalResponses[keyof ReviewProposalResponses];
+
 export type ProtocolTriggersApiControllerTriggerPayout0V1Data = {
   body: TriggerPayoutRequestDto;
   path?: never;

package/src/event/types.gen.ts

@@ -132,6 +132,34 @@ export const Event = z.union([
         .catchall(z.any()),
     })
     .catchall(z.any()),
+  z
+    .object({
+      id: z.string(),
+      event_type: z.literal("protocol.zone"),
+      timestamp: z.string(),
+      data: z
+        .object({
+          version: z.literal(1),
+          data: z
+            .object({
+              id: z.string(),
+              region_id: z.number(),
+              is_flyable: z.boolean(),
+              deleted_at: z.string().datetime({ offset: true }).optional(),
+            })
+            .catchall(z.any()),
+          changes: z
+            .object({
+              region_id: z.number().optional(),
+              is_flyable: z.boolean().optional(),
+              deleted_at: z.string().datetime({ offset: true }).optional(),
+            })
+            .catchall(z.any())
+            .optional(),
+        })
+        .catchall(z.any()),
+    })
+    .catchall(z.any()),
 ]);
 export type Event = z.infer<typeof Event>;
 
@@ -156,3 +184,4 @@ export type FlightReviewedEvent = Extract<
   Event,
   { event_type: "protocol.flight.reviewed" }
 >;
+export type ZoneEvent = Extract<Event, { event_type: "protocol.zone" }>;