infrawrench-sdk 0.9.0 → 0.12.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.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/infrawrench-sdk.gemspec +4 -4
- data/lib/infrawrench/client.rb +376 -2
- data/lib/infrawrench/sdk.rb +2 -2
- data/lib/infrawrench/transport.rb +2 -2
- data/lib/infrawrench/version.rb +3 -3
- data/lib/infrawrench-sdk.rb +2 -2
- data/sig/infrawrench/sdk.rbs +128 -3
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 14c93bfdcc3a68b5f941a098b17b6a19857f0e8279628d1ecb805b84b3e40cd4
|
|
4
|
+
data.tar.gz: 824899a16f77fec6be9233a1994fec8e84a5709ef0a72d4b145f677f904d232a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d6b20fe647cb3962a3454dca0e660c68c0061d2b895774e167661bbd155906212eb092175d173d786100dba6ac24afd9fb4917ae484c4e4b1dd1e285afd36706
|
|
7
|
+
data.tar.gz: 4ed2b4dc41a1bc68506e72c76a178b5e417ed5f2c7524feca4f851cf82cb585adb685b86fff75f2618710a9f9679a3e36196d3a0542ab5abc86922c1746923da
|
data/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# infrawrench-sdk
|
|
2
2
|
|
|
3
|
-
Generated Ruby client for the Infrawrench API (API version `0.
|
|
3
|
+
Generated Ruby client for the Infrawrench API (API version `0.12.0`).
|
|
4
4
|
|
|
5
5
|
**Do not edit this gem by hand** — it is regenerated from `openapi.json` and is
|
|
6
6
|
not checked into the repository. Run
|
|
@@ -41,7 +41,7 @@ Every method takes an optional trailing `request_options:` hash (`:headers`,
|
|
|
41
41
|
Responses are the plain `Hash`/`Array` that `JSON.parse` returns, with String
|
|
42
42
|
keys spelled exactly as the wire spells them. There are no model classes — see
|
|
43
43
|
[`sig/infrawrench/sdk.rbs`](./sig/infrawrench/sdk.rbs) for the shape of every one of the
|
|
44
|
-
|
|
44
|
+
212 schemas, as RBS type aliases that steep and TypeProf can read.
|
|
45
45
|
|
|
46
46
|
Non-2xx responses raise `Infrawrench::ApiError`, which carries `#status`,
|
|
47
47
|
the parsed `#body`, and the machine-readable `#code` when the API sends one —
|
data/infrawrench-sdk.gemspec
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
# infrawrench-sdk v0.
|
|
3
|
+
# infrawrench-sdk v0.12.0 | MIT | Copyright (c) 2026 Infrawrench LLC
|
|
4
4
|
# https://github.com/Infrawrench/Infrawrench
|
|
5
5
|
#
|
|
6
|
-
# Generated from the Infrawrench API OpenAPI 3.1 spec (API version 0.
|
|
6
|
+
# Generated from the Infrawrench API OpenAPI 3.1 spec (API version 0.12.0).
|
|
7
7
|
#
|
|
8
8
|
# DO NOT EDIT. Regenerate with:
|
|
9
9
|
# pnpm --filter @infrawrench/web generate:sdk
|
|
@@ -17,8 +17,8 @@ require_relative "lib/infrawrench/version"
|
|
|
17
17
|
Gem::Specification.new do |spec|
|
|
18
18
|
spec.name = "infrawrench-sdk"
|
|
19
19
|
spec.version = Infrawrench::VERSION
|
|
20
|
-
spec.summary = "Generated Ruby client for the Infrawrench API (v0.
|
|
21
|
-
spec.description = "Generated Ruby client for the Infrawrench API (v0.
|
|
20
|
+
spec.summary = "Generated Ruby client for the Infrawrench API (v0.12.0)."
|
|
21
|
+
spec.description = "Generated Ruby client for the Infrawrench API (v0.12.0). Covers the published API surface only — operations marked x-internal in the spec are not generated. No runtime dependencies."
|
|
22
22
|
spec.authors = ["Infrawrench LLC", "Astrid Gealer"]
|
|
23
23
|
spec.email = ["astrid@infrawrench.com"]
|
|
24
24
|
spec.homepage = "https://infrawrench.com/docs/team-and-billing/client-sdks"
|
data/lib/infrawrench/client.rb
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
# infrawrench-sdk v0.
|
|
3
|
+
# infrawrench-sdk v0.12.0 | MIT | Copyright (c) 2026 Infrawrench LLC
|
|
4
4
|
# https://github.com/Infrawrench/Infrawrench
|
|
5
5
|
#
|
|
6
|
-
# Generated from the Infrawrench API OpenAPI 3.1 spec (API version 0.
|
|
6
|
+
# Generated from the Infrawrench API OpenAPI 3.1 spec (API version 0.12.0).
|
|
7
7
|
#
|
|
8
8
|
# DO NOT EDIT. Regenerate with:
|
|
9
9
|
# pnpm --filter @infrawrench/web generate:sdk
|
|
@@ -1796,6 +1796,373 @@ module Infrawrench
|
|
|
1796
1796
|
end
|
|
1797
1797
|
end
|
|
1798
1798
|
|
|
1799
|
+
# `client.deployments.runs`
|
|
1800
|
+
class DeploymentsRunsNamespace
|
|
1801
|
+
# @api private
|
|
1802
|
+
# @param transport [Transport]
|
|
1803
|
+
def initialize(transport)
|
|
1804
|
+
@transport = transport
|
|
1805
|
+
end
|
|
1806
|
+
|
|
1807
|
+
# Record a deployment that ran elsewhere
|
|
1808
|
+
#
|
|
1809
|
+
# The CLI builds on the operator's own machine, so the server never sees
|
|
1810
|
+
# that run. Reporting it here keeps one history across both origins.
|
|
1811
|
+
#
|
|
1812
|
+
# _Requires permission: `deployments:write`._
|
|
1813
|
+
#
|
|
1814
|
+
# POST /api/org/{orgId}/deployments/runs
|
|
1815
|
+
#
|
|
1816
|
+
# Raises on 400: Bad request
|
|
1817
|
+
#
|
|
1818
|
+
# Raises on 401: Unauthenticated
|
|
1819
|
+
#
|
|
1820
|
+
# Raises on 403: Forbidden
|
|
1821
|
+
#
|
|
1822
|
+
# @param org_id [String, nil] Organization id. Defaults to the `org_id` the client was
|
|
1823
|
+
# constructed with.
|
|
1824
|
+
# @param body [Hash, nil] Request body, shaped as `DeploymentRunInput`.
|
|
1825
|
+
# @param request_options [Hash, nil] Per-call `:headers`, `:timeout` and `:open_timeout`.
|
|
1826
|
+
# @return [Hash] Parsed JSON, shaped as `Hash` — see `sig/infrawrench/sdk.rbs`.
|
|
1827
|
+
# @raise [Infrawrench::ApiError] On any non-2xx response.
|
|
1828
|
+
def create(org_id: nil, body: nil, request_options: nil)
|
|
1829
|
+
@transport.request(
|
|
1830
|
+
http_method: "POST",
|
|
1831
|
+
path: "/api/org/{orgId}/deployments/runs",
|
|
1832
|
+
path_params: { "orgId" => org_id },
|
|
1833
|
+
body: body,
|
|
1834
|
+
request_options: request_options
|
|
1835
|
+
)
|
|
1836
|
+
end
|
|
1837
|
+
|
|
1838
|
+
# Get one deployment run, with its logs and rendered Dockerfile
|
|
1839
|
+
#
|
|
1840
|
+
# _Requires permission: `deployments:read`._
|
|
1841
|
+
#
|
|
1842
|
+
# GET /api/org/{orgId}/deployments/runs/{id}
|
|
1843
|
+
#
|
|
1844
|
+
# Raises on 401: Unauthenticated
|
|
1845
|
+
#
|
|
1846
|
+
# Raises on 403: Forbidden
|
|
1847
|
+
#
|
|
1848
|
+
# Raises on 404: Not found
|
|
1849
|
+
#
|
|
1850
|
+
# @param org_id [String, nil] Organization id. Defaults to the `org_id` the client was
|
|
1851
|
+
# constructed with.
|
|
1852
|
+
# @param id [String]
|
|
1853
|
+
# @param request_options [Hash, nil] Per-call `:headers`, `:timeout` and `:open_timeout`.
|
|
1854
|
+
# @return [Hash] Parsed JSON, shaped as `DeploymentRun` — see `sig/infrawrench/sdk.rbs`.
|
|
1855
|
+
# @raise [Infrawrench::ApiError] On any non-2xx response.
|
|
1856
|
+
def get(id:, org_id: nil, request_options: nil)
|
|
1857
|
+
@transport.request(
|
|
1858
|
+
http_method: "GET",
|
|
1859
|
+
path: "/api/org/{orgId}/deployments/runs/{id}",
|
|
1860
|
+
path_params: { "orgId" => org_id, "id" => id },
|
|
1861
|
+
request_options: request_options
|
|
1862
|
+
)
|
|
1863
|
+
end
|
|
1864
|
+
|
|
1865
|
+
# List deployment runs
|
|
1866
|
+
#
|
|
1867
|
+
# _Requires permission: `deployments:read`._
|
|
1868
|
+
#
|
|
1869
|
+
# GET /api/org/{orgId}/deployments/runs
|
|
1870
|
+
#
|
|
1871
|
+
# Raises on 401: Unauthenticated
|
|
1872
|
+
#
|
|
1873
|
+
# Raises on 403: Forbidden
|
|
1874
|
+
#
|
|
1875
|
+
# @param org_id [String, nil] Organization id. Defaults to the `org_id` the client was
|
|
1876
|
+
# constructed with.
|
|
1877
|
+
# @param env [String, nil]
|
|
1878
|
+
# @param limit [Integer, nil]
|
|
1879
|
+
# @param request_options [Hash, nil] Per-call `:headers`, `:timeout` and `:open_timeout`.
|
|
1880
|
+
# @return [Array<Hash>] Parsed JSON, shaped as `Array<DeploymentRun>` — see
|
|
1881
|
+
# `sig/infrawrench/sdk.rbs`.
|
|
1882
|
+
# @raise [Infrawrench::ApiError] On any non-2xx response.
|
|
1883
|
+
def list(org_id: nil, env: nil, limit: nil, request_options: nil)
|
|
1884
|
+
@transport.request(
|
|
1885
|
+
http_method: "GET",
|
|
1886
|
+
path: "/api/org/{orgId}/deployments/runs",
|
|
1887
|
+
path_params: { "orgId" => org_id },
|
|
1888
|
+
query: { "env" => env, "limit" => limit },
|
|
1889
|
+
request_options: request_options
|
|
1890
|
+
)
|
|
1891
|
+
end
|
|
1892
|
+
|
|
1893
|
+
# Roll back to a previous deployment
|
|
1894
|
+
#
|
|
1895
|
+
# Re-runs that run's `deploy()` with the image and plan it recorded,
|
|
1896
|
+
# building nothing — the exact artifact that was known good ships again. The
|
|
1897
|
+
# Infrafile is read at the commit that run deployed, not at the branch head.
|
|
1898
|
+
# Only a successful run that produced an image can be rolled back to.
|
|
1899
|
+
#
|
|
1900
|
+
# _Requires permission: `deployments:write`._
|
|
1901
|
+
#
|
|
1902
|
+
# POST /api/org/{orgId}/deployments/runs/{id}/rollback
|
|
1903
|
+
#
|
|
1904
|
+
# Raises on 400: Bad request
|
|
1905
|
+
#
|
|
1906
|
+
# Raises on 401: Unauthenticated
|
|
1907
|
+
#
|
|
1908
|
+
# Raises on 402: Payment required — the organization's plan does not include
|
|
1909
|
+
# this
|
|
1910
|
+
#
|
|
1911
|
+
# Raises on 403: Forbidden
|
|
1912
|
+
#
|
|
1913
|
+
# Raises on 404: Not found
|
|
1914
|
+
#
|
|
1915
|
+
# Raises on 409: Conflict
|
|
1916
|
+
#
|
|
1917
|
+
# @param org_id [String, nil] Organization id. Defaults to the `org_id` the client was
|
|
1918
|
+
# constructed with.
|
|
1919
|
+
# @param id [String]
|
|
1920
|
+
# @param request_options [Hash, nil] Per-call `:headers`, `:timeout` and `:open_timeout`.
|
|
1921
|
+
# @return [Hash] Parsed JSON, shaped as `DeployPlanResult` — see `sig/infrawrench/sdk.rbs`.
|
|
1922
|
+
# @raise [Infrawrench::ApiError] On any non-2xx response.
|
|
1923
|
+
def rollback(id:, org_id: nil, request_options: nil)
|
|
1924
|
+
@transport.request(
|
|
1925
|
+
http_method: "POST",
|
|
1926
|
+
path: "/api/org/{orgId}/deployments/runs/{id}/rollback",
|
|
1927
|
+
path_params: { "orgId" => org_id, "id" => id },
|
|
1928
|
+
request_options: request_options
|
|
1929
|
+
)
|
|
1930
|
+
end
|
|
1931
|
+
end
|
|
1932
|
+
|
|
1933
|
+
# `client.deployments.triggers`
|
|
1934
|
+
class DeploymentsTriggersNamespace
|
|
1935
|
+
# @api private
|
|
1936
|
+
# @param transport [Transport]
|
|
1937
|
+
def initialize(transport)
|
|
1938
|
+
@transport = transport
|
|
1939
|
+
end
|
|
1940
|
+
|
|
1941
|
+
# Deploy an environment whenever a branch moves
|
|
1942
|
+
#
|
|
1943
|
+
# Arming a trigger records the branch's current commit WITHOUT deploying it
|
|
1944
|
+
# — the trigger fires on the next push, not on the state at the moment it
|
|
1945
|
+
# was created. The environment is validated against the Infrafile at that
|
|
1946
|
+
# branch head, so a typo fails here rather than silently never firing.
|
|
1947
|
+
#
|
|
1948
|
+
# _Requires permission: `deployments:write`._
|
|
1949
|
+
#
|
|
1950
|
+
# POST /api/org/{orgId}/deployments/triggers
|
|
1951
|
+
#
|
|
1952
|
+
# Raises on 400: Bad request
|
|
1953
|
+
#
|
|
1954
|
+
# Raises on 401: Unauthenticated
|
|
1955
|
+
#
|
|
1956
|
+
# Raises on 403: Forbidden
|
|
1957
|
+
#
|
|
1958
|
+
# Raises on 404: Not found
|
|
1959
|
+
#
|
|
1960
|
+
# @param org_id [String, nil] Organization id. Defaults to the `org_id` the client was
|
|
1961
|
+
# constructed with.
|
|
1962
|
+
# @param body [Hash, nil] Request body, shaped as `DeployTriggerInput`.
|
|
1963
|
+
# @param request_options [Hash, nil] Per-call `:headers`, `:timeout` and `:open_timeout`.
|
|
1964
|
+
# @return [Hash] Parsed JSON, shaped as `DeployTrigger` — see `sig/infrawrench/sdk.rbs`.
|
|
1965
|
+
# @raise [Infrawrench::ApiError] On any non-2xx response.
|
|
1966
|
+
def create(org_id: nil, body: nil, request_options: nil)
|
|
1967
|
+
@transport.request(
|
|
1968
|
+
http_method: "POST",
|
|
1969
|
+
path: "/api/org/{orgId}/deployments/triggers",
|
|
1970
|
+
path_params: { "orgId" => org_id },
|
|
1971
|
+
body: body,
|
|
1972
|
+
request_options: request_options
|
|
1973
|
+
)
|
|
1974
|
+
end
|
|
1975
|
+
|
|
1976
|
+
# Delete a deploy trigger
|
|
1977
|
+
#
|
|
1978
|
+
# _Requires permission: `deployments:write`._
|
|
1979
|
+
#
|
|
1980
|
+
# DELETE /api/org/{orgId}/deployments/triggers/{id}
|
|
1981
|
+
#
|
|
1982
|
+
# Raises on 401: Unauthenticated
|
|
1983
|
+
#
|
|
1984
|
+
# Raises on 403: Forbidden
|
|
1985
|
+
#
|
|
1986
|
+
# @param org_id [String, nil] Organization id. Defaults to the `org_id` the client was
|
|
1987
|
+
# constructed with.
|
|
1988
|
+
# @param id [String]
|
|
1989
|
+
# @param request_options [Hash, nil] Per-call `:headers`, `:timeout` and `:open_timeout`.
|
|
1990
|
+
# @return [Hash] Parsed JSON, shaped as `Ok` — see `sig/infrawrench/sdk.rbs`.
|
|
1991
|
+
# @raise [Infrawrench::ApiError] On any non-2xx response.
|
|
1992
|
+
def delete(id:, org_id: nil, request_options: nil)
|
|
1993
|
+
@transport.request(
|
|
1994
|
+
http_method: "DELETE",
|
|
1995
|
+
path: "/api/org/{orgId}/deployments/triggers/{id}",
|
|
1996
|
+
path_params: { "orgId" => org_id, "id" => id },
|
|
1997
|
+
request_options: request_options
|
|
1998
|
+
)
|
|
1999
|
+
end
|
|
2000
|
+
|
|
2001
|
+
# List deploy-on-push triggers
|
|
2002
|
+
#
|
|
2003
|
+
# _Requires permission: `deployments:read`._
|
|
2004
|
+
#
|
|
2005
|
+
# GET /api/org/{orgId}/deployments/triggers
|
|
2006
|
+
#
|
|
2007
|
+
# Raises on 401: Unauthenticated
|
|
2008
|
+
#
|
|
2009
|
+
# Raises on 403: Forbidden
|
|
2010
|
+
#
|
|
2011
|
+
# @param org_id [String, nil] Organization id. Defaults to the `org_id` the client was
|
|
2012
|
+
# constructed with.
|
|
2013
|
+
# @param request_options [Hash, nil] Per-call `:headers`, `:timeout` and `:open_timeout`.
|
|
2014
|
+
# @return [Array<Hash>] Parsed JSON, shaped as `Array<DeployTrigger>` — see
|
|
2015
|
+
# `sig/infrawrench/sdk.rbs`.
|
|
2016
|
+
# @raise [Infrawrench::ApiError] On any non-2xx response.
|
|
2017
|
+
def list(org_id: nil, request_options: nil)
|
|
2018
|
+
@transport.request(
|
|
2019
|
+
http_method: "GET",
|
|
2020
|
+
path: "/api/org/{orgId}/deployments/triggers",
|
|
2021
|
+
path_params: { "orgId" => org_id },
|
|
2022
|
+
request_options: request_options
|
|
2023
|
+
)
|
|
2024
|
+
end
|
|
2025
|
+
|
|
2026
|
+
# Enable or disable a deploy trigger
|
|
2027
|
+
#
|
|
2028
|
+
# _Requires permission: `deployments:write`._
|
|
2029
|
+
#
|
|
2030
|
+
# PATCH /api/org/{orgId}/deployments/triggers/{id}
|
|
2031
|
+
#
|
|
2032
|
+
# Raises on 401: Unauthenticated
|
|
2033
|
+
#
|
|
2034
|
+
# Raises on 403: Forbidden
|
|
2035
|
+
#
|
|
2036
|
+
# Raises on 404: Not found
|
|
2037
|
+
#
|
|
2038
|
+
# @param org_id [String, nil] Organization id. Defaults to the `org_id` the client was
|
|
2039
|
+
# constructed with.
|
|
2040
|
+
# @param id [String]
|
|
2041
|
+
# @param body [Hash, nil] Request body, shaped as `Hash`.
|
|
2042
|
+
# @param request_options [Hash, nil] Per-call `:headers`, `:timeout` and `:open_timeout`.
|
|
2043
|
+
# @return [Hash] Parsed JSON, shaped as `DeployTrigger` — see `sig/infrawrench/sdk.rbs`.
|
|
2044
|
+
# @raise [Infrawrench::ApiError] On any non-2xx response.
|
|
2045
|
+
def update(id:, org_id: nil, body: nil, request_options: nil)
|
|
2046
|
+
@transport.request(
|
|
2047
|
+
http_method: "PATCH",
|
|
2048
|
+
path: "/api/org/{orgId}/deployments/triggers/{id}",
|
|
2049
|
+
path_params: { "orgId" => org_id, "id" => id },
|
|
2050
|
+
body: body,
|
|
2051
|
+
request_options: request_options
|
|
2052
|
+
)
|
|
2053
|
+
end
|
|
2054
|
+
end
|
|
2055
|
+
|
|
2056
|
+
# `client.deployments`
|
|
2057
|
+
class DeploymentsNamespace
|
|
2058
|
+
# @return [DeploymentsRunsNamespace] `client.deployments.runs`
|
|
2059
|
+
attr_reader :runs
|
|
2060
|
+
# @return [DeploymentsTriggersNamespace] `client.deployments.triggers`
|
|
2061
|
+
attr_reader :triggers
|
|
2062
|
+
|
|
2063
|
+
# @api private
|
|
2064
|
+
# @param transport [Transport]
|
|
2065
|
+
def initialize(transport)
|
|
2066
|
+
@transport = transport
|
|
2067
|
+
@runs = DeploymentsRunsNamespace.new(@transport)
|
|
2068
|
+
@triggers = DeploymentsTriggersNamespace.new(@transport)
|
|
2069
|
+
end
|
|
2070
|
+
|
|
2071
|
+
# List the environments a repository's Infrafile declares
|
|
2072
|
+
#
|
|
2073
|
+
# Reads `Infrafile` at the branch head and returns its declared
|
|
2074
|
+
# environments. The file is parsed, not executed.
|
|
2075
|
+
#
|
|
2076
|
+
# _Requires permission: `deployments:read`._
|
|
2077
|
+
#
|
|
2078
|
+
# POST /api/org/{orgId}/deployments/envs
|
|
2079
|
+
#
|
|
2080
|
+
# Raises on 400: Bad request
|
|
2081
|
+
#
|
|
2082
|
+
# Raises on 401: Unauthenticated
|
|
2083
|
+
#
|
|
2084
|
+
# Raises on 403: Forbidden
|
|
2085
|
+
#
|
|
2086
|
+
# Raises on 404: Not found
|
|
2087
|
+
#
|
|
2088
|
+
# @param org_id [String, nil] Organization id. Defaults to the `org_id` the client was
|
|
2089
|
+
# constructed with.
|
|
2090
|
+
# @param body [Hash, nil] Request body, shaped as `DeployEnvsInput`.
|
|
2091
|
+
# @param request_options [Hash, nil] Per-call `:headers`, `:timeout` and `:open_timeout`.
|
|
2092
|
+
# @return [Hash] Parsed JSON, shaped as `DeployEnvs` — see `sig/infrawrench/sdk.rbs`.
|
|
2093
|
+
# @raise [Infrawrench::ApiError] On any non-2xx response.
|
|
2094
|
+
def envs(org_id: nil, body: nil, request_options: nil)
|
|
2095
|
+
@transport.request(
|
|
2096
|
+
http_method: "POST",
|
|
2097
|
+
path: "/api/org/{orgId}/deployments/envs",
|
|
2098
|
+
path_params: { "orgId" => org_id },
|
|
2099
|
+
body: body,
|
|
2100
|
+
request_options: request_options
|
|
2101
|
+
)
|
|
2102
|
+
end
|
|
2103
|
+
|
|
2104
|
+
# Preview a deploy without building
|
|
2105
|
+
#
|
|
2106
|
+
# Runs the Infrafile's `plan()` and renders its Dockerfile, then stops.
|
|
2107
|
+
# Nothing is built or deployed.
|
|
2108
|
+
#
|
|
2109
|
+
# _Requires permission: `deployments:plan`._
|
|
2110
|
+
#
|
|
2111
|
+
# POST /api/org/{orgId}/deployments/plan
|
|
2112
|
+
#
|
|
2113
|
+
# Raises on 400: Bad request
|
|
2114
|
+
#
|
|
2115
|
+
# Raises on 401: Unauthenticated
|
|
2116
|
+
#
|
|
2117
|
+
# Raises on 403: Forbidden
|
|
2118
|
+
#
|
|
2119
|
+
# Raises on 404: Not found
|
|
2120
|
+
#
|
|
2121
|
+
# @param org_id [String, nil] Organization id. Defaults to the `org_id` the client was
|
|
2122
|
+
# constructed with.
|
|
2123
|
+
# @param body [Hash, nil] Request body, shaped as `DeployPlanInput`.
|
|
2124
|
+
# @param request_options [Hash, nil] Per-call `:headers`, `:timeout` and `:open_timeout`.
|
|
2125
|
+
# @return [Hash] Parsed JSON, shaped as `DeployPlanResult` — see `sig/infrawrench/sdk.rbs`.
|
|
2126
|
+
# @raise [Infrawrench::ApiError] On any non-2xx response.
|
|
2127
|
+
def plan(org_id: nil, body: nil, request_options: nil)
|
|
2128
|
+
@transport.request(
|
|
2129
|
+
http_method: "POST",
|
|
2130
|
+
path: "/api/org/{orgId}/deployments/plan",
|
|
2131
|
+
path_params: { "orgId" => org_id },
|
|
2132
|
+
body: body,
|
|
2133
|
+
request_options: request_options
|
|
2134
|
+
)
|
|
2135
|
+
end
|
|
2136
|
+
|
|
2137
|
+
# List repositories this organization can deploy from
|
|
2138
|
+
#
|
|
2139
|
+
# Repositories visible to the organization's GitHub App installations. Empty
|
|
2140
|
+
# when the app is not configured.
|
|
2141
|
+
#
|
|
2142
|
+
# _Requires permission: `deployments:read`._
|
|
2143
|
+
#
|
|
2144
|
+
# GET /api/org/{orgId}/deployments/repos
|
|
2145
|
+
#
|
|
2146
|
+
# Raises on 401: Unauthenticated
|
|
2147
|
+
#
|
|
2148
|
+
# Raises on 403: Forbidden
|
|
2149
|
+
#
|
|
2150
|
+
# @param org_id [String, nil] Organization id. Defaults to the `org_id` the client was
|
|
2151
|
+
# constructed with.
|
|
2152
|
+
# @param request_options [Hash, nil] Per-call `:headers`, `:timeout` and `:open_timeout`.
|
|
2153
|
+
# @return [Array<Hash>] Parsed JSON, shaped as `Array<DeployRepo>` — see
|
|
2154
|
+
# `sig/infrawrench/sdk.rbs`.
|
|
2155
|
+
# @raise [Infrawrench::ApiError] On any non-2xx response.
|
|
2156
|
+
def repos(org_id: nil, request_options: nil)
|
|
2157
|
+
@transport.request(
|
|
2158
|
+
http_method: "GET",
|
|
2159
|
+
path: "/api/org/{orgId}/deployments/repos",
|
|
2160
|
+
path_params: { "orgId" => org_id },
|
|
2161
|
+
request_options: request_options
|
|
2162
|
+
)
|
|
2163
|
+
end
|
|
2164
|
+
end
|
|
2165
|
+
|
|
1799
2166
|
# `client.docker`
|
|
1800
2167
|
class DockerNamespace
|
|
1801
2168
|
# @api private
|
|
@@ -4253,6 +4620,10 @@ module Infrawrench
|
|
|
4253
4620
|
#
|
|
4254
4621
|
# POST /api/org/{orgId}/team/invitations
|
|
4255
4622
|
#
|
|
4623
|
+
# Raises on 409: All seats are in use; retry with addSeat to buy one more
|
|
4624
|
+
#
|
|
4625
|
+
# Raises on 502: Buying the extra seat failed; the invitation was not sent
|
|
4626
|
+
#
|
|
4256
4627
|
# @param org_id [String, nil] Organization id. Defaults to the `org_id` the client was
|
|
4257
4628
|
# constructed with.
|
|
4258
4629
|
# @param body [Hash] Request body, shaped as `InviteRequest`.
|
|
@@ -4589,6 +4960,8 @@ module Infrawrench
|
|
|
4589
4960
|
attr_reader :costs
|
|
4590
4961
|
# @return [DashboardsNamespace] `client.dashboards`
|
|
4591
4962
|
attr_reader :dashboards
|
|
4963
|
+
# @return [DeploymentsNamespace] `client.deployments`
|
|
4964
|
+
attr_reader :deployments
|
|
4592
4965
|
# @return [DockerNamespace] `client.docker`
|
|
4593
4966
|
attr_reader :docker
|
|
4594
4967
|
# @return [InvitationsNamespace] `client.invitations`
|
|
@@ -4640,6 +5013,7 @@ module Infrawrench
|
|
|
4640
5013
|
@connect = ConnectNamespace.new(@transport)
|
|
4641
5014
|
@costs = CostsNamespace.new(@transport)
|
|
4642
5015
|
@dashboards = DashboardsNamespace.new(@transport)
|
|
5016
|
+
@deployments = DeploymentsNamespace.new(@transport)
|
|
4643
5017
|
@docker = DockerNamespace.new(@transport)
|
|
4644
5018
|
@invitations = InvitationsNamespace.new(@transport)
|
|
4645
5019
|
@kv = KvNamespace.new(@transport)
|
data/lib/infrawrench/sdk.rb
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
# infrawrench-sdk v0.
|
|
3
|
+
# infrawrench-sdk v0.12.0 | MIT | Copyright (c) 2026 Infrawrench LLC
|
|
4
4
|
# https://github.com/Infrawrench/Infrawrench
|
|
5
5
|
#
|
|
6
|
-
# Generated from the Infrawrench API OpenAPI 3.1 spec (API version 0.
|
|
6
|
+
# Generated from the Infrawrench API OpenAPI 3.1 spec (API version 0.12.0).
|
|
7
7
|
#
|
|
8
8
|
# DO NOT EDIT. Regenerate with:
|
|
9
9
|
# pnpm --filter @infrawrench/web generate:sdk
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
# infrawrench-sdk v0.
|
|
3
|
+
# infrawrench-sdk v0.12.0 | MIT | Copyright (c) 2026 Infrawrench LLC
|
|
4
4
|
# https://github.com/Infrawrench/Infrawrench
|
|
5
5
|
#
|
|
6
|
-
# Generated from the Infrawrench API OpenAPI 3.1 spec (API version 0.
|
|
6
|
+
# Generated from the Infrawrench API OpenAPI 3.1 spec (API version 0.12.0).
|
|
7
7
|
#
|
|
8
8
|
# DO NOT EDIT. Regenerate with:
|
|
9
9
|
# pnpm --filter @infrawrench/web generate:sdk
|
data/lib/infrawrench/version.rb
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
# infrawrench-sdk v0.
|
|
3
|
+
# infrawrench-sdk v0.12.0 | MIT | Copyright (c) 2026 Infrawrench LLC
|
|
4
4
|
# https://github.com/Infrawrench/Infrawrench
|
|
5
5
|
#
|
|
6
|
-
# Generated from the Infrawrench API OpenAPI 3.1 spec (API version 0.
|
|
6
|
+
# Generated from the Infrawrench API OpenAPI 3.1 spec (API version 0.12.0).
|
|
7
7
|
#
|
|
8
8
|
# DO NOT EDIT. Regenerate with:
|
|
9
9
|
# pnpm --filter @infrawrench/web generate:sdk
|
|
@@ -15,5 +15,5 @@
|
|
|
15
15
|
# Kept in its own file so the gemspec can read the version without loading the
|
|
16
16
|
# client — a gemspec that pulls in net/http is a gemspec that can fail to parse.
|
|
17
17
|
module Infrawrench
|
|
18
|
-
VERSION = "0.
|
|
18
|
+
VERSION = "0.12.0"
|
|
19
19
|
end
|
data/lib/infrawrench-sdk.rb
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
# infrawrench-sdk v0.
|
|
3
|
+
# infrawrench-sdk v0.12.0 | MIT | Copyright (c) 2026 Infrawrench LLC
|
|
4
4
|
# https://github.com/Infrawrench/Infrawrench
|
|
5
5
|
#
|
|
6
|
-
# Generated from the Infrawrench API OpenAPI 3.1 spec (API version 0.
|
|
6
|
+
# Generated from the Infrawrench API OpenAPI 3.1 spec (API version 0.12.0).
|
|
7
7
|
#
|
|
8
8
|
# DO NOT EDIT. Regenerate with:
|
|
9
9
|
# pnpm --filter @infrawrench/web generate:sdk
|
data/sig/infrawrench/sdk.rbs
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
# infrawrench-sdk v0.
|
|
1
|
+
# infrawrench-sdk v0.12.0 | MIT | Copyright (c) 2026 Infrawrench LLC
|
|
2
2
|
# https://github.com/Infrawrench/Infrawrench
|
|
3
3
|
#
|
|
4
|
-
# Generated from the Infrawrench API OpenAPI 3.1 spec (API version 0.
|
|
4
|
+
# Generated from the Infrawrench API OpenAPI 3.1 spec (API version 0.12.0).
|
|
5
5
|
#
|
|
6
6
|
# DO NOT EDIT. Regenerate with:
|
|
7
7
|
# pnpm --filter @infrawrench/web generate:sdk
|
|
@@ -662,6 +662,94 @@ module Infrawrench
|
|
|
662
662
|
"metrics" => Array[{ "key" => String, "label" => String, "unit" => String | nil, ?"value" => untyped }]
|
|
663
663
|
}
|
|
664
664
|
|
|
665
|
+
# Spec schema: `DeployEnvs`.
|
|
666
|
+
type deploy_envs = { "envs" => Array[String], "sha" => String, "repo" => String, "branch" => String }
|
|
667
|
+
|
|
668
|
+
# Spec schema: `DeployEnvsInput`.
|
|
669
|
+
type deploy_envs_input = { "repo" => String, ?"branch" => String }
|
|
670
|
+
|
|
671
|
+
# Spec schema: `DeployPlanInput`.
|
|
672
|
+
type deploy_plan_input = {
|
|
673
|
+
"repo" => String,
|
|
674
|
+
?"branch" => String,
|
|
675
|
+
?"env" => String,
|
|
676
|
+
?"answers" => Hash[String, String]
|
|
677
|
+
}
|
|
678
|
+
|
|
679
|
+
# Spec schema: `DeployPlanResult`.
|
|
680
|
+
type deploy_plan_result = {
|
|
681
|
+
"runId" => String,
|
|
682
|
+
"result" => {
|
|
683
|
+
"status" => deploy_status,
|
|
684
|
+
"env" => String,
|
|
685
|
+
?"plan" => untyped,
|
|
686
|
+
?"dockerfile" => String,
|
|
687
|
+
?"image" => String,
|
|
688
|
+
"notes" => Array[String],
|
|
689
|
+
"logs" => Array[deploy_run_log],
|
|
690
|
+
?"reachedStage" => deploy_stage,
|
|
691
|
+
?"error" => { "message" => String, ?"stack" => String },
|
|
692
|
+
"durationMs" => Integer
|
|
693
|
+
}
|
|
694
|
+
}
|
|
695
|
+
|
|
696
|
+
# Spec schema: `DeployRepo`.
|
|
697
|
+
type deploy_repo = { "fullName" => String, "defaultBranch" => String }
|
|
698
|
+
|
|
699
|
+
# Spec schema: `DeployRunLog`.
|
|
700
|
+
type deploy_run_log = { "at" => Integer, "level" => "debug" | "info" | "warn" | "error", "message" => String }
|
|
701
|
+
|
|
702
|
+
# Spec schema: `DeployStage`.
|
|
703
|
+
type deploy_stage = "plan" | "dockerfile" | "build" | "deploy"
|
|
704
|
+
|
|
705
|
+
# Spec schema: `DeployStatus`.
|
|
706
|
+
type deploy_status = "pending" | "running" | "success" | "failure" | "canceled"
|
|
707
|
+
|
|
708
|
+
# Spec schema: `DeployTrigger`.
|
|
709
|
+
type deploy_trigger = {
|
|
710
|
+
"id" => String,
|
|
711
|
+
"repo" => String,
|
|
712
|
+
"branch" => String,
|
|
713
|
+
"env" => String,
|
|
714
|
+
"enabled" => bool,
|
|
715
|
+
"lastSha" => String | nil,
|
|
716
|
+
"lastRunAt" => String | nil | nil
|
|
717
|
+
}
|
|
718
|
+
|
|
719
|
+
# Spec schema: `DeployTriggerInput`.
|
|
720
|
+
type deploy_trigger_input = { "repo" => String, "branch" => String, "env" => String, ?"answers" => Hash[String, String] }
|
|
721
|
+
|
|
722
|
+
# Spec schema: `DeploymentRun`.
|
|
723
|
+
type deployment_run = {
|
|
724
|
+
"id" => String,
|
|
725
|
+
"env" => String,
|
|
726
|
+
"repo" => String | nil,
|
|
727
|
+
"branch" => String | nil,
|
|
728
|
+
"gitSha" => String | nil,
|
|
729
|
+
"image" => String | nil,
|
|
730
|
+
"status" => deploy_status,
|
|
731
|
+
"origin" => "web" | "cli" | "trigger",
|
|
732
|
+
"stage" => deploy_stage | nil | nil,
|
|
733
|
+
"durationMs" => Integer | nil,
|
|
734
|
+
"buildSeconds" => Integer | nil,
|
|
735
|
+
"buildRunner" => "cloud-build" | "ssh" | nil | nil,
|
|
736
|
+
"startedAt" => String
|
|
737
|
+
}
|
|
738
|
+
|
|
739
|
+
# Spec schema: `DeploymentRunInput`.
|
|
740
|
+
type deployment_run_input = {
|
|
741
|
+
"env" => String,
|
|
742
|
+
"status" => deploy_status,
|
|
743
|
+
?"repo" => String,
|
|
744
|
+
?"branch" => String,
|
|
745
|
+
?"gitSha" => String,
|
|
746
|
+
?"image" => String,
|
|
747
|
+
?"stage" => deploy_stage,
|
|
748
|
+
?"notes" => Array[String],
|
|
749
|
+
?"durationMs" => Integer,
|
|
750
|
+
?"error" => { "message" => String } | nil
|
|
751
|
+
}
|
|
752
|
+
|
|
665
753
|
# Spec schema: `DescribeRequest`.
|
|
666
754
|
type describe_request = { "accountId" => String, "resourceId" => resource_id, ?"parentResourceId" => resource_id }
|
|
667
755
|
|
|
@@ -763,7 +851,7 @@ module Infrawrench
|
|
|
763
851
|
}
|
|
764
852
|
|
|
765
853
|
# Spec schema: `InviteRequest`.
|
|
766
|
-
type invite_request = { "email" => String, ?"role" => organization_role, ?"roleId" => String }
|
|
854
|
+
type invite_request = { "email" => String, ?"role" => organization_role, ?"roleId" => String, ?"addSeat" => bool }
|
|
767
855
|
|
|
768
856
|
# Spec schema: `InviteResponse`.
|
|
769
857
|
type invite_response = { "id" => String, "token" => String }
|
|
@@ -969,6 +1057,9 @@ module Infrawrench
|
|
|
969
1057
|
| "storage:write"
|
|
970
1058
|
| "dashboards:read"
|
|
971
1059
|
| "dashboards:write"
|
|
1060
|
+
| "deployments:read"
|
|
1061
|
+
| "deployments:plan"
|
|
1062
|
+
| "deployments:write"
|
|
972
1063
|
| "costs:read"
|
|
973
1064
|
| "costs:write"
|
|
974
1065
|
| "budgets:read"
|
|
@@ -1581,6 +1672,14 @@ module Infrawrench
|
|
|
1581
1672
|
?"subtitle" => String
|
|
1582
1673
|
}
|
|
1583
1674
|
|
|
1675
|
+
# Spec schema: `SeatLimitResponse`.
|
|
1676
|
+
type seat_limit_response = {
|
|
1677
|
+
"error" => String,
|
|
1678
|
+
"code" => "seat_limit_reached",
|
|
1679
|
+
"seatCount" => Integer,
|
|
1680
|
+
"seatsUsed" => Integer
|
|
1681
|
+
}
|
|
1682
|
+
|
|
1584
1683
|
# Spec schema: `SecretAccessRequest`.
|
|
1585
1684
|
type secret_access_request = {
|
|
1586
1685
|
"accountId" => String,
|
|
@@ -2066,6 +2165,31 @@ module Infrawrench
|
|
|
2066
2165
|
def workflow_unpin: (body: workflow_pin_request, ?org_id: String?, ?request_options: Hash[Symbol, untyped]?) -> ok
|
|
2067
2166
|
end
|
|
2068
2167
|
|
|
2168
|
+
class DeploymentsRunsNamespace
|
|
2169
|
+
def initialize: (Transport) -> void
|
|
2170
|
+
def create: (?org_id: String?, ?body: deployment_run_input?, ?request_options: Hash[Symbol, untyped]?) -> { "id" => String }
|
|
2171
|
+
def get: (id: String, ?org_id: String?, ?request_options: Hash[Symbol, untyped]?) -> deployment_run
|
|
2172
|
+
def list: (?org_id: String?, ?env: String?, ?limit: Integer?, ?request_options: Hash[Symbol, untyped]?) -> Array[deployment_run]
|
|
2173
|
+
def rollback: (id: String, ?org_id: String?, ?request_options: Hash[Symbol, untyped]?) -> deploy_plan_result
|
|
2174
|
+
end
|
|
2175
|
+
|
|
2176
|
+
class DeploymentsTriggersNamespace
|
|
2177
|
+
def initialize: (Transport) -> void
|
|
2178
|
+
def create: (?org_id: String?, ?body: deploy_trigger_input?, ?request_options: Hash[Symbol, untyped]?) -> deploy_trigger
|
|
2179
|
+
def delete: (id: String, ?org_id: String?, ?request_options: Hash[Symbol, untyped]?) -> ok
|
|
2180
|
+
def list: (?org_id: String?, ?request_options: Hash[Symbol, untyped]?) -> Array[deploy_trigger]
|
|
2181
|
+
def update: (id: String, ?org_id: String?, ?body: { "enabled" => bool }?, ?request_options: Hash[Symbol, untyped]?) -> deploy_trigger
|
|
2182
|
+
end
|
|
2183
|
+
|
|
2184
|
+
class DeploymentsNamespace
|
|
2185
|
+
attr_reader runs: DeploymentsRunsNamespace
|
|
2186
|
+
attr_reader triggers: DeploymentsTriggersNamespace
|
|
2187
|
+
def initialize: (Transport) -> void
|
|
2188
|
+
def envs: (?org_id: String?, ?body: deploy_envs_input?, ?request_options: Hash[Symbol, untyped]?) -> deploy_envs
|
|
2189
|
+
def plan: (?org_id: String?, ?body: deploy_plan_input?, ?request_options: Hash[Symbol, untyped]?) -> deploy_plan_result
|
|
2190
|
+
def repos: (?org_id: String?, ?request_options: Hash[Symbol, untyped]?) -> Array[deploy_repo]
|
|
2191
|
+
end
|
|
2192
|
+
|
|
2069
2193
|
class DockerNamespace
|
|
2070
2194
|
def initialize: (Transport) -> void
|
|
2071
2195
|
def command: (body: docker_command_request, ?org_id: String?, ?request_options: Hash[Symbol, untyped]?) -> docker_command_response
|
|
@@ -2300,6 +2424,7 @@ module Infrawrench
|
|
|
2300
2424
|
attr_reader connect: ConnectNamespace
|
|
2301
2425
|
attr_reader costs: CostsNamespace
|
|
2302
2426
|
attr_reader dashboards: DashboardsNamespace
|
|
2427
|
+
attr_reader deployments: DeploymentsNamespace
|
|
2303
2428
|
attr_reader docker: DockerNamespace
|
|
2304
2429
|
attr_reader invitations: InvitationsNamespace
|
|
2305
2430
|
attr_reader kv: KvNamespace
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: infrawrench-sdk
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.12.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Infrawrench LLC
|
|
@@ -11,7 +11,7 @@ bindir: bin
|
|
|
11
11
|
cert_chain: []
|
|
12
12
|
date: 2026-07-28 00:00:00.000000000 Z
|
|
13
13
|
dependencies: []
|
|
14
|
-
description: Generated Ruby client for the Infrawrench API (v0.
|
|
14
|
+
description: Generated Ruby client for the Infrawrench API (v0.12.0). Covers the published
|
|
15
15
|
API surface only — operations marked x-internal in the spec are not generated. No
|
|
16
16
|
runtime dependencies.
|
|
17
17
|
email:
|
|
@@ -58,5 +58,5 @@ requirements: []
|
|
|
58
58
|
rubygems_version: 3.5.22
|
|
59
59
|
signing_key:
|
|
60
60
|
specification_version: 4
|
|
61
|
-
summary: Generated Ruby client for the Infrawrench API (v0.
|
|
61
|
+
summary: Generated Ruby client for the Infrawrench API (v0.12.0).
|
|
62
62
|
test_files: []
|