@cycleplatform/api-client-typescript 0.3.22 → 0.3.23

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cycleplatform/api-client-typescript",
3
- "version": "0.3.22",
3
+ "version": "0.3.23",
4
4
  "description": "A Cycle API client for the web/nodejs with type safety.",
5
5
  "main": "./dist/index.umd.cjs",
6
6
  "module": "./dist/index.js",
@@ -5994,7 +5994,7 @@ export interface components {
5994
5994
  * @description The public network settings for the given container
5995
5995
  * @enum {string}
5996
5996
  */
5997
- public: "enable" | "egress-only" | "disable";
5997
+ public: "enable" | "egress-only" | "environment-limited" | "disable";
5998
5998
  /** @description The hostname for the given container. */
5999
5999
  hostname: string;
6000
6000
  /** @description An array of port mappings for the container. */
@@ -6593,6 +6593,8 @@ export interface components {
6593
6593
  external?: {
6594
6594
  id?: components["schemas"]["ID"];
6595
6595
  } | null;
6596
+ /** @description The timestamp of the volume's removal, if applicable. */
6597
+ removed?: components["schemas"]["DateTime"] | null;
6596
6598
  };
6597
6599
  /** ContainerState */
6598
6600
  ContainerState: {
@@ -8358,7 +8360,7 @@ export interface components {
8358
8360
  */
8359
8361
  StackSpecContainerConfigNetwork: {
8360
8362
  /** @description The level of public network access this container should have. */
8361
- public: ("enable" | "disable" | "egress-only") | components["schemas"]["StackVariable"];
8363
+ public: ("enable" | "disable" | "egress-only" | "environment-limited") | components["schemas"]["StackVariable"];
8362
8364
  /** @description The hostname of the container. This is how it can be referenced by other containers in the same environment. */
8363
8365
  hostname: string | components["schemas"]["StackVariable"];
8364
8366
  /** @description A list of port mappings on this container. */
@@ -11241,7 +11243,7 @@ export interface components {
11241
11243
  * @description Controls the public network mode for the virtual machine.
11242
11244
  * @enum {string}
11243
11245
  */
11244
- public: "enable" | "disable" | "egress-only";
11246
+ public: "enable" | "disable" | "egress-only" | "environment-limited";
11245
11247
  /** @description The hostname assigned to the virtual machine. */
11246
11248
  hostname: string;
11247
11249
  /** @description Port configurations for the virtual machine. */
@@ -11540,6 +11542,8 @@ export interface components {
11540
11542
  hash: string;
11541
11543
  /** @description The configuration details for the virtual machine's volume. */
11542
11544
  config: components["schemas"]["VirtualMachineVolumeConfig"];
11545
+ /** @description The timestamp of the volume's removal, if applicable. */
11546
+ removed?: components["schemas"]["DateTime"] | null;
11543
11547
  };
11544
11548
  /** VirtualMachineState */
11545
11549
  VirtualMachineState: {
@@ -11943,6 +11947,22 @@ export interface components {
11943
11947
  deleted: components["schemas"]["DateTime"];
11944
11948
  };
11945
11949
  };
11950
+ /**
11951
+ * LoadBalancerInfo
11952
+ * @description Information about an environments load balancer configuration, state, and availability settings.
11953
+ */
11954
+ LoadBalancerInfo: {
11955
+ default_config: components["schemas"]["LoadBalancerConfig"];
11956
+ /** @enum {string} */
11957
+ default_type: "haproxy" | "v1";
11958
+ /** @enum {string} */
11959
+ current_type: "haproxy" | "v1";
11960
+ base_configs?: {
11961
+ haproxy: components["schemas"]["HaProxyConfig"];
11962
+ v1: components["schemas"]["V1LbConfig"];
11963
+ };
11964
+ service: components["schemas"]["LoadBalancerEnvironmentService"] | null;
11965
+ };
11946
11966
  /**
11947
11967
  * Range
11948
11968
  * @description A start and end date-time pair indicating a range of time
@@ -12517,7 +12537,7 @@ export interface components {
12517
12537
  * @description The activity event.
12518
12538
  * @enum {string}
12519
12539
  */
12520
- event: "hub.images.prune" | "hub.update" | "hub.create" | "hub.task.delete" | "hub.task.images.prune" | "environment.services.discovery.reconfigure" | "environment.services.lb.reconfigure" | "environment.services.vpn.reconfigure" | "environment.services.scheduler.reconfigure" | "environment.delete" | "environment.initialize" | "environment.start" | "environment.stop" | "environment.create" | "environment.update" | "environment.task.delete" | "environment.services.discovery.task.reconfigure" | "environment.services.lb.task.reconfigure" | "environment.services.vpn.task.reconfigure" | "environment.services.scheduler.task.reconfigure" | "environment.services.vpn.user.create" | "environment.services.vpn.login" | "environment.services.vpn.reset" | "environment.services.vpn.task.reset" | "environment.task.initialize" | "environment.task.start" | "environment.task.stop" | "environment.task.deployments.reconfigure" | "environment.deployments.reconfigure" | "environment.task.monitoring.reconfigure" | "environment.monitoring.reconfigure" | "environment.deployments.prune" | "environment.deployment.start" | "environment.deployment.stop" | "environment.scoped-variable.delete" | "environment.scoped-variable.update" | "environment.scoped-variable.task.delete" | "environment.scoped-variable.create" | "image.delete" | "image.import" | "image.create" | "image.update" | "image.task.delete" | "image.task.import" | "image.source.delete" | "image.source.create" | "image.source.update" | "image.source.task.delete" | "billing.invoice.task.void" | "billing.invoice.task.credit" | "billing.invoice.task.refund" | "billing.invoice.pay" | "billing.invoice.task.pay" | "billing.order.confirm" | "billing.order.task.confirm" | "billing.method.update" | "billing.method.delete" | "billing.method.task.delete" | "billing.method.create" | "hub.apikey.update" | "hub.apikey.delete" | "hub.apikey.create" | "hub.role.update" | "hub.role.delete" | "hub.role.create" | "hub.role.task.delete" | "hub.membership.delete" | "hub.membership.create" | "hub.membership.update" | "hub.integration.create" | "hub.integration.update" | "hub.integration.delete" | "hub.integration.task.verify" | "hub.integration.task.delete" | "hub.inactive" | "container.initialize" | "container.task.start" | "container.start" | "container.task.stop" | "container.stop" | "container.task.restart" | "container.restart" | "container.task.reconfigure" | "container.reconfigure" | "container.task.volumes.reconfigure" | "container.function.trigger" | "container.function.task.trigger" | "container.volumes.reconfigure" | "container.create" | "container.restart" | "container.task.reimage" | "container.reimage" | "container.deprecate" | "container.update" | "container.task.delete" | "container.delete" | "container.task.scale" | "container.scale" | "container.instances.create" | "container.instances.delete" | "container.instances.autoscale.up" | "container.instances.autoscale.down" | "container.instance.healthcheck.restarted" | "container.instance.volume.extend" | "container.instance.task.volume.extend" | "container.instance.healthcheck.failed" | "container.instance.error" | "container.instance.ssh.login" | "container.instance.migration.start" | "container.instance.migration.revert" | "container.instance.delete" | "container.instance.task.migration.revert" | "container.instance.task.migration.start" | "container.instance.traffic-drain.reconfigure" | "container.backup.create" | "container.backup.restore" | "container.backup.delete" | "container.backup.task.delete" | "container.backup.task.restore" | "dns.zone.verify" | "dns.zone.delete" | "dns.zone.task.verify" | "dns.zone.update" | "dns.zone.task.delete" | "dns.zone.create" | "dns.zone.record.delete" | "dns.zone.record.cert.generate" | "dns.zone.record.cert.generate.auto" | "dns.zone.record.task.cert.generate" | "dns.zone.record.update" | "dns.zone.record.task.delete" | "dns.zone.record.create" | "dns.certificate.associate" | "dns.certificate.deprecate" | "dns.certificate.create" | "dns.certificate.task.deprecate" | "stack.update" | "stack.task.delete" | "stack.delete" | "stack.create" | "stack.task.prune" | "stack.prune" | "stack.build.create" | "stack.build.generate" | "stack.build.deploy" | "stack.build.delete" | "stack.build.task.delete" | "stack.build.task.generate" | "stack.build.task.deploy" | "infrastructure.provider.update" | "infrastructure.provider.task.delete" | "infrastructure.provider.create" | "infrastructure.provider.task.verify" | "infrastructure.virtual-providers.iso.create" | "infrastructure.virtual-providers.iso.generate" | "infrastructure.virtual-providers.iso.update" | "infrastructure.virtual-providers.iso.delete" | "infrastructure.virtual-providers.iso.task.delete" | "infrastructure.server.task.delete" | "infrastructure.server.task.restart" | "infrastructure.server.services.sftp.auth" | "infrastructure.server.live" | "infrastructure.server.delete" | "infrastructure.server.restart" | "infrastructure.server.unquarantine" | "infrastructure.server.compute.restart" | "infrastructure.server.compute.spawner.restart" | "infrastructure.server.features.reconfigure" | "infrastructure.server.sharedfs.reconfigure" | "infrastructure.server.provision" | "infrastructure.server.console" | "infrastructure.server.update" | "infrastructure.server.task.provision" | "infrastructure.server.ssh.token" | "infrastructure.server.task.features.reconfigure" | "infrastructure.server.task.sharedfs.reconfigure" | "infrastructure.server.services.sftp.lockdown" | "infrastructure.server.services.internal-api.throttle" | "infrastructure.server.evacuation.start" | "infrastructure.server.task.evacuation.start" | "infrastructure.server.evacuation.reset" | "infrastructure.server.task.evacuation.reset" | "infrastructure.server.power-off" | "infrastructure.server.auth.reset" | "infrastructure.autoscale.group.create" | "infrastructure.autoscale.group.update" | "infrastructure.autoscale.group.task.delete" | "infrastructure.autoscale.group.delete" | "infrastructure.external-volume.create" | "infrastructure.external-volume.update" | "infrastructure.external-volume.task.delete" | "infrastructure.external-volume.delete" | "infrastructure.external-volume.task.servers.reconfigure" | "infrastructure.external-volume.task.attachment.reconfigure" | "infrastructure.external-volume.servers.reconfigure" | "infrastructure.external-volume.attachment.reconfigure" | "infrastructure.external-volumes.task.scan" | "infrastructure.cluster.create" | "infrastructure.cluster.update" | "infrastructure.cluster.task.delete" | "infrastructure.cluster.delete" | "infrastructure.cluster.features.monitoring.tier.reconfigure" | "infrastructure.ips.pool.task.delete" | "infrastructure.ips.pool.create" | "sdn.network.update" | "sdn.network.task.delete" | "sdn.network.create" | "sdn.network.task.reconfigure" | "pipeline.delete" | "pipeline.trigger" | "pipeline.update" | "pipeline.task.delete" | "pipeline.create" | "pipeline.task.trigger" | "pipeline.run.completed" | "pipeline.key.update" | "pipeline.key.delete" | "pipeline.key.create" | "virtual-machine.create" | "virtual-machine.initialize" | "virtual-machine.task.start" | "virtual-machine.start" | "virtual-machine.task.stop" | "virtual-machine.stop" | "virtual-machine.reconfigure" | "virtual-machine.task.reconfigure" | "virtual-machine.update" | "virtual-machine.task.delete" | "virtual-machine.delete" | "virtual-machine.sos.login" | "virtual-machine.rootpw.change" | "virtual-machine.task.volumes.reconfigure" | "virtual-machine.volumes.reconfigure" | "virtual-machine.ssh-key.create" | "virtual-machine.ssh-key.update" | "virtual-machine.ssh-key.task.delete" | "virtual-machine.ssh-key.delete" | "virtual-machine.ip.allocate" | "virtual-machine.task.ip.allocate" | "virtual-machine.ip.unallocate" | "virtual-machine.task.ip.unallocate";
12540
+ event: "hub.images.prune" | "hub.update" | "hub.create" | "hub.task.delete" | "hub.task.images.prune" | "environment.services.discovery.reconfigure" | "environment.services.lb.reconfigure" | "environment.services.vpn.reconfigure" | "environment.services.scheduler.reconfigure" | "environment.delete" | "environment.initialize" | "environment.start" | "environment.stop" | "environment.create" | "environment.update" | "environment.task.delete" | "environment.services.discovery.task.reconfigure" | "environment.services.lb.task.reconfigure" | "environment.services.vpn.task.reconfigure" | "environment.services.scheduler.task.reconfigure" | "environment.services.vpn.user.create" | "environment.services.vpn.login" | "environment.services.vpn.reset" | "environment.services.vpn.task.reset" | "environment.task.initialize" | "environment.task.start" | "environment.task.stop" | "environment.task.deployments.reconfigure" | "environment.deployments.reconfigure" | "environment.task.monitoring.reconfigure" | "environment.monitoring.reconfigure" | "environment.deployments.prune" | "environment.deployment.start" | "environment.deployment.stop" | "environment.scoped-variable.delete" | "environment.scoped-variable.update" | "environment.scoped-variable.task.delete" | "environment.scoped-variable.create" | "image.delete" | "image.import" | "image.create" | "image.update" | "image.task.delete" | "image.task.import" | "image.source.delete" | "image.source.create" | "image.source.update" | "image.source.task.delete" | "billing.invoice.task.void" | "billing.invoice.task.credit" | "billing.invoice.task.refund" | "billing.invoice.pay" | "billing.invoice.task.pay" | "billing.order.confirm" | "billing.order.task.confirm" | "billing.method.update" | "billing.method.delete" | "billing.method.task.delete" | "billing.method.create" | "hub.apikey.update" | "hub.apikey.delete" | "hub.apikey.create" | "hub.role.update" | "hub.role.delete" | "hub.role.create" | "hub.role.task.delete" | "hub.membership.delete" | "hub.membership.create" | "hub.membership.update" | "hub.integration.create" | "hub.integration.update" | "hub.integration.delete" | "hub.integration.task.verify" | "hub.integration.task.delete" | "hub.inactive" | "container.initialize" | "container.task.start" | "container.start" | "container.task.stop" | "container.stop" | "container.task.restart" | "container.restart" | "container.task.reconfigure" | "container.reconfigure" | "container.task.volumes.reconfigure" | "container.function.trigger" | "container.function.task.trigger" | "container.volumes.reconfigure" | "container.create" | "container.restart" | "container.task.reimage" | "container.reimage" | "container.deprecate" | "container.update" | "container.task.delete" | "container.delete" | "container.task.scale" | "container.scale" | "container.instances.create" | "container.instances.delete" | "container.instances.autoscale.up" | "container.instances.autoscale.down" | "container.instance.healthcheck.restarted" | "container.instance.volume.extend" | "container.instance.task.volume.extend" | "container.instance.healthcheck.failed" | "container.instance.error" | "container.instance.ssh.login" | "container.instance.migration.start" | "container.instance.migration.revert" | "container.instance.delete" | "container.instance.task.migration.revert" | "container.instance.task.migration.start" | "container.instance.traffic-drain.reconfigure" | "container.backup.create" | "container.backup.restore" | "container.backup.delete" | "container.backup.task.delete" | "container.backup.task.restore" | "dns.zone.verify" | "dns.zone.delete" | "dns.zone.task.verify" | "dns.zone.update" | "dns.zone.task.delete" | "dns.zone.create" | "dns.zone.record.delete" | "dns.zone.record.cert.generate" | "dns.zone.record.cert.generate.auto" | "dns.zone.record.task.cert.generate" | "dns.zone.record.update" | "dns.zone.record.task.delete" | "dns.zone.record.create" | "dns.certificate.associate" | "dns.certificate.deprecate" | "dns.certificate.create" | "dns.certificate.task.deprecate" | "stack.update" | "stack.task.delete" | "stack.delete" | "stack.create" | "stack.task.prune" | "stack.prune" | "stack.build.create" | "stack.build.generate" | "stack.build.deploy" | "stack.build.delete" | "stack.build.task.delete" | "stack.build.task.generate" | "stack.build.task.deploy" | "infrastructure.provider.update" | "infrastructure.provider.task.delete" | "infrastructure.provider.create" | "infrastructure.provider.task.verify" | "infrastructure.virtual-providers.iso.create" | "infrastructure.virtual-providers.iso.generate" | "infrastructure.virtual-providers.iso.update" | "infrastructure.virtual-providers.iso.delete" | "infrastructure.virtual-providers.iso.task.delete" | "infrastructure.server.task.delete" | "infrastructure.server.task.restart" | "infrastructure.server.services.sftp.auth" | "infrastructure.server.live" | "infrastructure.server.delete" | "infrastructure.server.restart" | "infrastructure.server.unquarantine" | "infrastructure.server.compute.restart" | "infrastructure.server.compute.spawner.restart" | "infrastructure.server.features.reconfigure" | "infrastructure.server.sharedfs.reconfigure" | "infrastructure.server.provision" | "infrastructure.server.console" | "infrastructure.server.update" | "infrastructure.server.task.provision" | "infrastructure.server.ssh.token" | "infrastructure.server.task.features.reconfigure" | "infrastructure.server.task.sharedfs.reconfigure" | "infrastructure.server.services.sftp.lockdown" | "infrastructure.server.services.internal-api.throttle" | "infrastructure.server.evacuation.start" | "infrastructure.server.task.evacuation.start" | "infrastructure.server.evacuation.reset" | "infrastructure.server.task.evacuation.reset" | "infrastructure.server.power-off" | "infrastructure.server.auth.reset" | "infrastructure.autoscale.group.create" | "infrastructure.autoscale.group.update" | "infrastructure.autoscale.group.task.delete" | "infrastructure.autoscale.group.delete" | "infrastructure.external-volume.create" | "infrastructure.external-volume.update" | "infrastructure.external-volume.task.delete" | "infrastructure.external-volume.delete" | "infrastructure.external-volume.task.servers.reconfigure" | "infrastructure.external-volume.task.attachment.reconfigure" | "infrastructure.external-volume.servers.reconfigure" | "infrastructure.external-volume.attachment.reconfigure" | "infrastructure.external-volumes.task.scan" | "infrastructure.cluster.create" | "infrastructure.cluster.update" | "infrastructure.cluster.task.delete" | "infrastructure.cluster.delete" | "infrastructure.cluster.features.monitoring.tier.reconfigure" | "infrastructure.ips.pool.task.delete" | "infrastructure.ips.pool.create" | "sdn.network.update" | "sdn.network.task.delete" | "sdn.network.create" | "sdn.network.task.reconfigure" | "pipeline.delete" | "pipeline.trigger" | "pipeline.update" | "pipeline.task.delete" | "pipeline.create" | "pipeline.task.trigger" | "pipeline.run.completed" | "pipeline.key.update" | "pipeline.key.delete" | "pipeline.key.create" | "virtual-machine.create" | "virtual-machine.initialize" | "virtual-machine.task.start" | "virtual-machine.start" | "virtual-machine.task.stop" | "virtual-machine.stop" | "virtual-machine.reconfigure" | "virtual-machine.task.reconfigure" | "virtual-machine.update" | "virtual-machine.task.delete" | "virtual-machine.delete" | "virtual-machine.sos.login" | "virtual-machine.rootpw.change" | "virtual-machine.task.volumes.reconfigure" | "virtual-machine.volumes.reconfigure" | "virtual-machine.volumes.remove" | "virtual-machine.task.volumes.remove" | "virtual-machine.volumes.add" | "virtual-machine.task.volumes.add" | "virtual-machine.ssh-key.create" | "virtual-machine.ssh-key.update" | "virtual-machine.ssh-key.task.delete" | "virtual-machine.ssh-key.delete" | "virtual-machine.ip.allocate" | "virtual-machine.task.ip.allocate" | "virtual-machine.ip.unallocate" | "virtual-machine.task.ip.unallocate";
12521
12541
  /** @description A timestamp for when the activity took place. */
12522
12542
  time: components["schemas"]["DateTime"];
12523
12543
  };
@@ -15436,8 +15456,28 @@ export interface components {
15436
15456
  [key: string]: components["schemas"]["VirtualMachineVolumeConfig"];
15437
15457
  };
15438
15458
  };
15459
+ /** VirtualMachineAddVolumesAction */
15460
+ VirtualMachineAddVolumesAction: {
15461
+ /**
15462
+ * @description discriminator enum property added by openapi-typescript
15463
+ * @enum {string}
15464
+ */
15465
+ action: "volumes.add";
15466
+ /** @description Array of volume configs to add. */
15467
+ contents: components["schemas"]["VirtualMachineVolumeConfig"][];
15468
+ };
15469
+ /** VirtualMachineRemoveVolumesAction */
15470
+ VirtualMachineRemoveVolumesAction: {
15471
+ /**
15472
+ * @description discriminator enum property added by openapi-typescript
15473
+ * @enum {string}
15474
+ */
15475
+ action: "volumes.remove";
15476
+ /** @description Array of volume IDs to remove. */
15477
+ contents: components["schemas"]["ID"][];
15478
+ };
15439
15479
  /** VirtualMachineTask.yml */
15440
- VirtualMachineTask: components["schemas"]["VirtualMachineStartAction"] | components["schemas"]["VirtualMachineStopAction"] | components["schemas"]["VirtualMachineRestartAction"] | components["schemas"]["VirtualMachineReconfigureAction"] | components["schemas"]["VirtualMachineRootPwChangeAction"] | components["schemas"]["VirtualMachineIpAllocateAction"] | components["schemas"]["VirtualMachineIpUnallocateAction"] | components["schemas"]["VirtualMachineReconfigureVolumesAction"];
15480
+ VirtualMachineTask: components["schemas"]["VirtualMachineStartAction"] | components["schemas"]["VirtualMachineStopAction"] | components["schemas"]["VirtualMachineRestartAction"] | components["schemas"]["VirtualMachineReconfigureAction"] | components["schemas"]["VirtualMachineRootPwChangeAction"] | components["schemas"]["VirtualMachineIpAllocateAction"] | components["schemas"]["VirtualMachineIpUnallocateAction"] | components["schemas"]["VirtualMachineReconfigureVolumesAction"] | components["schemas"]["VirtualMachineAddVolumesAction"] | components["schemas"]["VirtualMachineRemoveVolumesAction"];
15441
15481
  /**
15442
15482
  * VirtualMachineBaseImage
15443
15483
  * @description Represents a virtual machine base OS image provided by Cycle.
@@ -16796,7 +16836,7 @@ export interface operations {
16796
16836
  deprecated?: string;
16797
16837
  /** @description `filter[service]=value` service filtering will allow you to filter by service type: `loadbalancer`, `discovery`, `vpn`. */
16798
16838
  service?: string;
16799
- /** @description `filter[public_network]=value` public network filtering will allow you to filter by the containers network settings: `enabled`, `disabled`, `egress-only`. */
16839
+ /** @description `filter[public_network]=value` public network filtering will allow you to filter by the containers network settings: `enabled`, `disabled`, `egress-only`, `environment-limited`. */
16800
16840
  public_network?: string;
16801
16841
  /** @description `filter[image]=ID` image filtering by ID. Submit the ID of the image you wish to filter for and the return will be any containers currently using the image. */
16802
16842
  image?: string;
@@ -19069,19 +19109,7 @@ export interface operations {
19069
19109
  };
19070
19110
  content: {
19071
19111
  "application/json": {
19072
- /** @description Information about an environments load balancer configuration, state, and availability settings. */
19073
- data: {
19074
- default_config: components["schemas"]["LoadBalancerConfig"];
19075
- /** @enum {string} */
19076
- default_type: "haproxy" | "v1";
19077
- /** @enum {string} */
19078
- current_type: "haproxy" | "v1";
19079
- base_configs?: {
19080
- haproxy: components["schemas"]["HaProxyConfig"];
19081
- v1: components["schemas"]["V1LbConfig"];
19082
- };
19083
- service: components["schemas"]["LoadBalancerEnvironmentService"] | null;
19084
- };
19112
+ data: components["schemas"]["LoadBalancerInfo"];
19085
19113
  };
19086
19114
  };
19087
19115
  };