@greensecurity/javascript-sdk 0.46.0 → 0.47.0-beta.0

package/src/models/operations/listappactivations.ts

@@ -0,0 +1,140 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * The one field to sort by. Anything else is refused with `422`.
+ */
+export const ListAppActivationsQueryParamSort = {
+  Id: "id",
+  CreatedAt: "created_at",
+} as const;
+/**
+ * The one field to sort by. Anything else is refused with `422`.
+ */
+export type ListAppActivationsQueryParamSort = ClosedEnum<
+  typeof ListAppActivationsQueryParamSort
+>;
+
+export type ListAppActivationsRequest = {
+  /**
+   * A 1-based offset for which page to request (defaults to `1`)
+   */
+  page?: number | undefined;
+  /**
+   * Number of activations per page, from 1 to 100. Anything outside that range is refused with `422`.
+   */
+  itemsPerPage?: number | undefined;
+  /**
+   * Sort desc.
+   */
+  desc?: components.Desc | undefined;
+  /**
+   * The one field to sort by. Anything else is refused with `422`.
+   */
+  sort?: ListAppActivationsQueryParamSort | undefined;
+};
+
+/**
+ * Your apps' activations.
+ */
+export type ListAppActivationsListAppActivationsOk = {
+  /**
+   * Pagination information for a pageable list
+   */
+  pager: components.Pager;
+  items: Array<components.MarketplaceAppActivation>;
+};
+
+export type ListAppActivationsResponse = {
+  result: ListAppActivationsListAppActivationsOk;
+};
+
+/** @internal */
+export const ListAppActivationsQueryParamSort$outboundSchema: z.ZodNativeEnum<
+  typeof ListAppActivationsQueryParamSort
+> = z.nativeEnum(ListAppActivationsQueryParamSort);
+
+/** @internal */
+export type ListAppActivationsRequest$Outbound = {
+  page?: number | undefined;
+  items_per_page: number;
+  desc?: components.Desc$Outbound | undefined;
+  sort: string;
+};
+
+/** @internal */
+export const ListAppActivationsRequest$outboundSchema: z.ZodType<
+  ListAppActivationsRequest$Outbound,
+  z.ZodTypeDef,
+  ListAppActivationsRequest
+> = z.object({
+  page: z.number().int().optional(),
+  itemsPerPage: z.number().int().default(25),
+  desc: components.Desc$outboundSchema.optional(),
+  sort: ListAppActivationsQueryParamSort$outboundSchema.default("id"),
+}).transform((v) => {
+  return remap$(v, {
+    itemsPerPage: "items_per_page",
+  });
+});
+
+export function listAppActivationsRequestToJSON(
+  listAppActivationsRequest: ListAppActivationsRequest,
+): string {
+  return JSON.stringify(
+    ListAppActivationsRequest$outboundSchema.parse(listAppActivationsRequest),
+  );
+}
+
+/** @internal */
+export const ListAppActivationsListAppActivationsOk$inboundSchema: z.ZodType<
+  ListAppActivationsListAppActivationsOk,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  pager: components.Pager$inboundSchema,
+  items: z.array(components.MarketplaceAppActivation$inboundSchema),
+});
+
+export function listAppActivationsListAppActivationsOkFromJSON(
+  jsonString: string,
+): SafeParseResult<ListAppActivationsListAppActivationsOk, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListAppActivationsListAppActivationsOk$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListAppActivationsListAppActivationsOk' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListAppActivationsResponse$inboundSchema: z.ZodType<
+  ListAppActivationsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Result: z.lazy(() => ListAppActivationsListAppActivationsOk$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "Result": "result",
+  });
+});
+
+export function listAppActivationsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListAppActivationsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListAppActivationsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListAppActivationsResponse' from JSON`,
+  );
+}

package/src/models/operations/listappdevelopers.ts

@@ -0,0 +1,114 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ListAppDevelopersRequest = {
+  /**
+   * The marketplace app's id.
+   */
+  id: number;
+  /**
+   * A 1-based page number, at most 1000.
+   */
+  page?: number | undefined;
+  /**
+   * Number of developers per page, from 1 to 100.
+   */
+  itemsPerPage?: number | undefined;
+};
+
+/**
+ * The app's developers.
+ */
+export type ListAppDevelopersListAppDevelopersOk = {
+  /**
+   * Pagination information for a pageable list
+   */
+  pager: components.Pager;
+  items: Array<components.AppDeveloper>;
+};
+
+export type ListAppDevelopersResponse = {
+  result: ListAppDevelopersListAppDevelopersOk;
+};
+
+/** @internal */
+export type ListAppDevelopersRequest$Outbound = {
+  id: number;
+  page: number;
+  items_per_page: number;
+};
+
+/** @internal */
+export const ListAppDevelopersRequest$outboundSchema: z.ZodType<
+  ListAppDevelopersRequest$Outbound,
+  z.ZodTypeDef,
+  ListAppDevelopersRequest
+> = z.object({
+  id: z.number().int(),
+  page: z.number().int().default(1),
+  itemsPerPage: z.number().int().default(25),
+}).transform((v) => {
+  return remap$(v, {
+    itemsPerPage: "items_per_page",
+  });
+});
+
+export function listAppDevelopersRequestToJSON(
+  listAppDevelopersRequest: ListAppDevelopersRequest,
+): string {
+  return JSON.stringify(
+    ListAppDevelopersRequest$outboundSchema.parse(listAppDevelopersRequest),
+  );
+}
+
+/** @internal */
+export const ListAppDevelopersListAppDevelopersOk$inboundSchema: z.ZodType<
+  ListAppDevelopersListAppDevelopersOk,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  pager: components.Pager$inboundSchema,
+  items: z.array(components.AppDeveloper$inboundSchema),
+});
+
+export function listAppDevelopersListAppDevelopersOkFromJSON(
+  jsonString: string,
+): SafeParseResult<ListAppDevelopersListAppDevelopersOk, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListAppDevelopersListAppDevelopersOk$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListAppDevelopersListAppDevelopersOk' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListAppDevelopersResponse$inboundSchema: z.ZodType<
+  ListAppDevelopersResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Result: z.lazy(() => ListAppDevelopersListAppDevelopersOk$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "Result": "result",
+  });
+});
+
+export function listAppDevelopersResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListAppDevelopersResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListAppDevelopersResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListAppDevelopersResponse' from JSON`,
+  );
+}

package/src/models/operations/listappsecrets.ts

@@ -0,0 +1,153 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * The one field to sort by. Anything else is refused with `422`.
+ */
+export const ListAppSecretsQueryParamSort = {
+  Name: "name",
+  Created: "created",
+  ExpiresAt: "expires_at",
+} as const;
+/**
+ * The one field to sort by. Anything else is refused with `422`.
+ */
+export type ListAppSecretsQueryParamSort = ClosedEnum<
+  typeof ListAppSecretsQueryParamSort
+>;
+
+export type ListAppSecretsRequest = {
+  /**
+   * The scope to list, as `scope[type]` and, for user secrets, `scope[user_id]`.
+   */
+  scope: components.AppSecretScope;
+  /**
+   * Service account only, and required there (`422` without it). Leave it out with an app token, which carries its own activation; if sent, it must be that activation (`403` otherwise).
+   */
+  activationId?: number | undefined;
+  /**
+   * A 1-based offset for which page to request (defaults to `1`)
+   */
+  page?: number | undefined;
+  /**
+   * Number of secrets per page, from 1 to 100. Anything outside that range is refused with `422`.
+   */
+  itemsPerPage?: number | undefined;
+  /**
+   * Sort desc.
+   */
+  desc?: components.Desc | undefined;
+  /**
+   * The one field to sort by. Anything else is refused with `422`.
+   */
+  sort?: ListAppSecretsQueryParamSort | undefined;
+};
+
+/**
+ * The secrets in the scope, without payloads.
+ */
+export type ListAppSecretsListAppSecretsOk = {
+  /**
+   * Pagination information for a pageable list
+   */
+  pager: components.Pager;
+  items: Array<components.AppSecret>;
+};
+
+export type ListAppSecretsResponse = {
+  result: ListAppSecretsListAppSecretsOk;
+};
+
+/** @internal */
+export const ListAppSecretsQueryParamSort$outboundSchema: z.ZodNativeEnum<
+  typeof ListAppSecretsQueryParamSort
+> = z.nativeEnum(ListAppSecretsQueryParamSort);
+
+/** @internal */
+export type ListAppSecretsRequest$Outbound = {
+  scope: components.AppSecretScope$Outbound;
+  activation_id?: number | undefined;
+  page?: number | undefined;
+  items_per_page: number;
+  desc?: components.Desc$Outbound | undefined;
+  sort: string;
+};
+
+/** @internal */
+export const ListAppSecretsRequest$outboundSchema: z.ZodType<
+  ListAppSecretsRequest$Outbound,
+  z.ZodTypeDef,
+  ListAppSecretsRequest
+> = z.object({
+  scope: components.AppSecretScope$outboundSchema,
+  activationId: z.number().int().optional(),
+  page: z.number().int().optional(),
+  itemsPerPage: z.number().int().default(25),
+  desc: components.Desc$outboundSchema.optional(),
+  sort: ListAppSecretsQueryParamSort$outboundSchema.default("name"),
+}).transform((v) => {
+  return remap$(v, {
+    activationId: "activation_id",
+    itemsPerPage: "items_per_page",
+  });
+});
+
+export function listAppSecretsRequestToJSON(
+  listAppSecretsRequest: ListAppSecretsRequest,
+): string {
+  return JSON.stringify(
+    ListAppSecretsRequest$outboundSchema.parse(listAppSecretsRequest),
+  );
+}
+
+/** @internal */
+export const ListAppSecretsListAppSecretsOk$inboundSchema: z.ZodType<
+  ListAppSecretsListAppSecretsOk,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  pager: components.Pager$inboundSchema,
+  items: z.array(components.AppSecret$inboundSchema),
+});
+
+export function listAppSecretsListAppSecretsOkFromJSON(
+  jsonString: string,
+): SafeParseResult<ListAppSecretsListAppSecretsOk, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListAppSecretsListAppSecretsOk$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListAppSecretsListAppSecretsOk' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListAppSecretsResponse$inboundSchema: z.ZodType<
+  ListAppSecretsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Result: z.lazy(() => ListAppSecretsListAppSecretsOk$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "Result": "result",
+  });
+});
+
+export function listAppSecretsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListAppSecretsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListAppSecretsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListAppSecretsResponse' from JSON`,
+  );
+}

package/src/models/operations/listappversions.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type ListAppVersionsRequest = {
+  /**
+   * The marketplace app's id.
+   */
+  appId: number;
+};
+
+/** @internal */
+export type ListAppVersionsRequest$Outbound = {
+  app_id: number;
+};
+
+/** @internal */
+export const ListAppVersionsRequest$outboundSchema: z.ZodType<
+  ListAppVersionsRequest$Outbound,
+  z.ZodTypeDef,
+  ListAppVersionsRequest
+> = z.object({
+  appId: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    appId: "app_id",
+  });
+});
+
+export function listAppVersionsRequestToJSON(
+  listAppVersionsRequest: ListAppVersionsRequest,
+): string {
+  return JSON.stringify(
+    ListAppVersionsRequest$outboundSchema.parse(listAppVersionsRequest),
+  );
+}

package/src/models/operations/listorsearchsecurityzones.ts

@@ -38,6 +38,10 @@ export type ListOrSearchSecurityZonesRequest = {
    * A partial string to search in the object name. Do not include any wildcard characters. Searches are not case-sensitive by default.
    */
   nameLike?: string | undefined;
+  /**
+   * An array-style parameter to identify which sections of an object to expand. See documentation for the endpoint for a list of valid expansion values.
+   */
+  expand?: Array<components.Expand> | undefined;
   /**
    * The `contact_id` value.
    */
@@ -76,6 +80,7 @@ export type ListOrSearchSecurityZonesRequest$Outbound = {
   latitude?: number | undefined;
   longitude?: number | undefined;
   name_like?: string | undefined;
+  expand?: Array<string> | undefined;
   contact_id?: number | undefined;
   facility_id?: number | undefined;
   green_location_id?: number | undefined;
@@ -94,6 +99,7 @@ export const ListOrSearchSecurityZonesRequest$outboundSchema: z.ZodType<
   latitude: z.number().optional(),
   longitude: z.number().optional(),
   nameLike: z.string().optional(),
+  expand: z.array(components.Expand$outboundSchema).optional(),
   contactId: z.number().optional(),
   facilityId: z.number().optional(),
   greenLocationId: z.number().optional(),

package/src/models/operations/publishappmanifest.ts

@@ -0,0 +1,126 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * What the review decided. `accepted`: published, and rolled out to the
+ *
+ * @remarks
+ * installations it adds nothing for. `screening`: the network sources it adds
+ * are being checked; it is published, held or rejected once that finishes.
+ * `pending_review`: held for a Green Security admin. `rejected`: not
+ * published; see `review_reasons`.
+ */
+export const PublishAppManifestStatus = {
+  Accepted: "accepted",
+  Screening: "screening",
+  PendingReview: "pending_review",
+  Rejected: "rejected",
+} as const;
+/**
+ * What the review decided. `accepted`: published, and rolled out to the
+ *
+ * @remarks
+ * installations it adds nothing for. `screening`: the network sources it adds
+ * are being checked; it is published, held or rejected once that finishes.
+ * `pending_review`: held for a Green Security admin. `rejected`: not
+ * published; see `review_reasons`.
+ */
+export type PublishAppManifestStatus = OpenEnum<
+  typeof PublishAppManifestStatus
+>;
+
+/**
+ * The submission was recorded and reviewed; `status` says whether it was published.
+ */
+export type PublishAppManifestPublishAppManifestOk = {
+  /**
+   * False only when the submission was rejected.
+   */
+  success: boolean;
+  /**
+   * The manifest a marketplace app publishes (`green-app.json`). Besides the constraints
+   *
+   * @remarks
+   * below, the server rejects a manifest that declares two views for one viewport, declares
+   * views without a
+   * `bundle`, declares a `bundle` or views without a `version`, sets
+   * `post_install_action.type` to `url` without a `url`, or lists CSP sources over the
+   * 4096-character budget described on `AppCsp`. `version` is optional only for
+   * manifests without UI.
+   *
+   * `ui_extensions` is optional. Leave it out to publish a back-end-only app: one with no
+   * views and no bundle, which works only through its service account (installation
+   * tokens from `client_credentials` with `activation_id`, the Secret Store and webhooks).
+   *
+   * A manifest with a `version` may only send installers to a view it has:
+   * `post_install_action.type` `app_settings_view` requires a view for the `settings`
+   * viewport, and `app_main_view` requires a view for a viewport other than `settings`.
+   * An app whose only view is `settings` therefore uses `app_settings_view`, and a
+   * back-end-only app uses `url`, pointing at its own setup page, or leaves
+   * `post_install_action` out for no post-install step. Manifests without a `version` are
+   * not checked this way. A left-out action follows the app's views; see
+   * `AppPostInstallAction`.
+   */
+  published: components.AppManifest;
+  /**
+   * The submission's `version`; null for a manifest without one.
+   */
+  version: string | null;
+  /**
+   * What the review decided. `accepted`: published, and rolled out to the
+   *
+   * @remarks
+   * installations it adds nothing for. `screening`: the network sources it adds
+   * are being checked; it is published, held or rejected once that finishes.
+   * `pending_review`: held for a Green Security admin. `rejected`: not
+   * published; see `review_reasons`.
+   */
+  status: PublishAppManifestStatus;
+  reviewReasons: Array<components.AppReviewReason>;
+};
+
+/** @internal */
+export const PublishAppManifestStatus$inboundSchema: z.ZodType<
+  PublishAppManifestStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PublishAppManifestStatus);
+
+/** @internal */
+export const PublishAppManifestPublishAppManifestOk$inboundSchema: z.ZodType<
+  PublishAppManifestPublishAppManifestOk,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  success: types.boolean(),
+  published: components.AppManifest$inboundSchema,
+  version: types.nullable(types.string()),
+  status: PublishAppManifestStatus$inboundSchema,
+  review_reasons: z.array(components.AppReviewReason$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "review_reasons": "reviewReasons",
+  });
+});
+
+export function publishAppManifestPublishAppManifestOkFromJSON(
+  jsonString: string,
+): SafeParseResult<PublishAppManifestPublishAppManifestOk, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PublishAppManifestPublishAppManifestOk$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PublishAppManifestPublishAppManifestOk' from JSON`,
+  );
+}

package/src/models/operations/removeappdeveloper.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type RemoveAppDeveloperRequest = {
+  /**
+   * The marketplace app's id.
+   */
+  id: number;
+  /**
+   * The user to remove.
+   */
+  userId: number;
+};
+
+/** @internal */
+export type RemoveAppDeveloperRequest$Outbound = {
+  id: number;
+  user_id: number;
+};
+
+/** @internal */
+export const RemoveAppDeveloperRequest$outboundSchema: z.ZodType<
+  RemoveAppDeveloperRequest$Outbound,
+  z.ZodTypeDef,
+  RemoveAppDeveloperRequest
+> = z.object({
+  id: z.number().int(),
+  userId: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    userId: "user_id",
+  });
+});
+
+export function removeAppDeveloperRequestToJSON(
+  removeAppDeveloperRequest: RemoveAppDeveloperRequest,
+): string {
+  return JSON.stringify(
+    RemoveAppDeveloperRequest$outboundSchema.parse(removeAppDeveloperRequest),
+  );
+}

package/src/models/operations/revoketoken.ts

@@ -0,0 +1,30 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Always empty.
+ */
+export type RevokeTokenRevokeTokenOk = {};
+
+/** @internal */
+export const RevokeTokenRevokeTokenOk$inboundSchema: z.ZodType<
+  RevokeTokenRevokeTokenOk,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+export function revokeTokenRevokeTokenOkFromJSON(
+  jsonString: string,
+): SafeParseResult<RevokeTokenRevokeTokenOk, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RevokeTokenRevokeTokenOk$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RevokeTokenRevokeTokenOk' from JSON`,
+  );
+}