Skip to content

feat(product_catalog): add environmental impact #2019

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 15, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ export type {
ListPublicCatalogProductsResponse,
PublicCatalogApiListPublicCatalogProductsRequest,
PublicCatalogProduct,
PublicCatalogProductEnvironmentalImpact,
PublicCatalogProductLocality,
PublicCatalogProductPrice,
PublicCatalogProductPriceUnitOfMeasure,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {
import type {
ListPublicCatalogProductsResponse,
PublicCatalogProduct,
PublicCatalogProductEnvironmentalImpact,
PublicCatalogProductLocality,
PublicCatalogProductPrice,
PublicCatalogProductPriceUnitOfMeasure,
Expand Down Expand Up @@ -246,6 +247,21 @@ const unmarshalPublicCatalogProductPropertiesInstance = (
} as PublicCatalogProductPropertiesInstance
}

const unmarshalPublicCatalogProductEnvironmentalImpact = (
data: unknown,
): PublicCatalogProductEnvironmentalImpact => {
if (!isJSONObject(data)) {
throw new TypeError(
`Unmarshalling the type 'PublicCatalogProductEnvironmentalImpact' failed as data isn't a dictionary.`,
)
}

return {
kgCo2Equivalent: data.kg_co2_equivalent,
m3WaterUsage: data.m3_water_usage,
} as PublicCatalogProductEnvironmentalImpact
}

const unmarshalPublicCatalogProductLocality = (
data: unknown,
): PublicCatalogProductLocality => {
Expand Down Expand Up @@ -319,6 +335,11 @@ const unmarshalPublicCatalogProduct = (data: unknown): PublicCatalogProduct => {

return {
description: data.description,
environmentalImpact: data.environmental_impact
? unmarshalPublicCatalogProductEnvironmentalImpact(
data.environmental_impact,
)
: undefined,
locality: data.locality
? unmarshalPublicCatalogProductLocality(data.locality)
: undefined,
Expand Down
15 changes: 15 additions & 0 deletions packages/clients/src/api/product_catalog/v2alpha1/types.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,17 @@ export interface PublicCatalogProductPropertiesInstance {
range: string
}

export interface PublicCatalogProductEnvironmentalImpact {
/**
* Kilograms of CO2 that would need to be released to produce the equivalent warming impact.
*/
kgCo2Equivalent?: number
/**
* Cubic meters of water used.
*/
m3WaterUsage?: number
}

export interface PublicCatalogProductLocality {
/**
* Whether or not the product is global.
Expand Down Expand Up @@ -326,6 +337,10 @@ export interface PublicCatalogProduct {
* The properties of the product.
*/
properties?: PublicCatalogProductProperties
/**
* The environmental impact of the product.
*/
environmentalImpact?: PublicCatalogProductEnvironmentalImpact
}

export interface ListPublicCatalogProductsResponse {
Expand Down
Loading